A Guide To Excel Spreadsheets in Python With Openpyxl - Real Python

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 41

7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

A Guide to Excel Spreadsheets in Python With


openpyxl
by Pedro Pregueiro
 86 Comments

intermediate

Mark as Completed   Tweet


 Share
 Email

Table of Contents
Before You Begin
Practical Use Cases
Learning Some Basic Excel Terminology
Getting Started With openpyxl
Reading Excel Spreadsheets With openpyxl
Dataset for This Tutorial
A Simple Approach to Reading an Excel Spreadsheet
Importing Data From a Spreadsheet
Appending New Data
Writing Excel Spreadsheets With openpyxl
Creating a Simple Spreadsheet
Basic Spreadsheet Operations
Adding Formulas
Adding Styles
Conditional Formatting
Adding Images
Adding Pretty Charts
Convert Python Classes to Excel Spreadsheet
Bonus: Working With Pandas
Conclusion

 Remove ads Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 1/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

 Watch Now This tutorial has a related video course created by the Real Python team. Watch it together with the
written tutorial to deepen your understanding: Editing Excel Spreadsheets in Python With openpyxl

Excel spreadsheets are one of those things you might have to deal with at some point. Either it’s because your boss
loves them or because marketing needs them, you might have to learn how to work with spreadsheets, and that’s
when knowing openpyxl comes in handy!

Spreadsheets are a very intuitive and user-friendly way to manipulate large datasets without any prior technical
background. That’s why they’re still so commonly used today.

In this article, you’ll learn how to use openpyxl to: Improve Your Python
Manipulate Excel spreadsheets with confidence ...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:


Extract information from spreadsheets
Create simple or more complex spreadsheets, including adding styles, charts,Email
and so on
Address

This article is written for intermediate developers who have a pretty good knowledge of Python data structures, such
as dicts and lists, but also feel comfortable around OOP and more intermediate levelSend
topics.
Python Tricks »

Download Dataset: Click here to download the dataset for the openpyxl exercise you’ll be following in this
tutorial.

 Remove ads

Before You Begin


If you ever get asked to extract some data from a database or log file into an Excel spreadsheet, or if you often have to
convert an Excel spreadsheet into some more usable programmatic form, then this tutorial is perfect for you. Let’s
jump into the openpyxl caravan!

Practical Use Cases


First things first, when would you need to use a package like openpyxl in a real-world scenario? You’ll see a few
examples below, but really, there are hundreds of possible scenarios where this knowledge could come in handy.

Importing New Products Into a Database


You are responsible for tech in an online store company, and your boss doesn’t want to pay for a cool and expensive
CMS system.

Every time they want to add new products to the online store, they come to you with an Excel spreadsheet with a few
hundred rows and, for each of them, you have the product name, description, price, and so forth.

Now, to import the data, you’ll have to iterate over each spreadsheet row and add each product to the online store.

Exporting Database Data Into a Spreadsheet


Say you have a Database table where you record all your users’ information, including name, phone number, email
address, and so forth.

Now, the Marketing team wants to contact all users to give them some discounted offer or promotion. However, they
don’t have access to the Database, or they don’t know how to use SQL to extract that information easily.

What can you do to help? Well, you can make a quick script using openpyxl that iterates over every single User record
and puts all the essential information into an Excel spreadsheet.
Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 2/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

That’s gonna earn you an extra slice of cake at your company’s next birthday party!

Appending Information to an Existing Spreadsheet


You may also have to open a spreadsheet, read the information in it and, according to some business logic, append
more data to it.

For example, using the online store scenario again, say you get an Excel spreadsheet with a list of users and you need
to append to each row the total amount they’ve spent in your store.

This data is in the Database and, in order to do this, you have to read the spreadsheet, iterate through each row, fetch
the total amount spent from the Database and then write back to the spreadsheet.
Improve Your Python
Not a problem for openpyxl!
...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:


Learning Some Basic Excel Terminology
Email Address
Here’s a quick list of basic terms you’ll see when you’re working with Excel spreadsheets:

Term Explanation Send Python Tricks »

Spreadsheet or A Spreadsheet is the main file you are creating or working with.
Workbook

Worksheet or A Sheet is used to split different kinds of content within the same spreadsheet. A
Sheet Spreadsheet can have one or more Sheets.

Column A Column is a vertical line, and it’s represented by an uppercase letter: A.

Row A Row is a horizontal line, and it’s represented by a number: 1.

Cell A Cell is a combination of Column and Row, represented by both an uppercase letter and a
number: A1.

 Remove ads

Getting Started With openpyxl


Now that you’re aware of the benefits of a tool like openpyxl, let’s get down to it and start by installing the package.
For this tutorial, you should use Python 3.7 and openpyxl 2.6.2. To install the package, you can do the following:

Shell

$ pip install openpyxl

After you install the package, you should be able to create a super simple spreadsheet with the following code:

Python

from openpyxl import Workbook

workbook = Workbook()

sheet = workbook.active

Improve Your Python


sheet["A1"] = "hello"

https://realpython.com/openpyxl-excel-spreadsheets-python/ 3/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

sheet["B1"] = "world!"

workbook.save(filename="hello_world.xlsx")

The code above should create a file called hello_world.xlsx in the folder you are using to run the code. If you open
that file with Excel you should see something like this:

Improve Your Python


...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:

Email Address

Send Python Tricks »

Woohoo, your first spreadsheet created!

Reading Excel Spreadsheets With openpyxl


Let’s start with the most essential thing one can do with a spreadsheet: read it.

You’ll go from a straightforward approach to reading a spreadsheet to more complex examples where you read the
data and convert it into more useful Python structures.

Dataset for This Tutorial


Before you dive deep into some code examples, you should download this sample dataset and store it somewhere
as sample.xlsx:

Download Dataset: Click here to download the dataset for the openpyxl exercise you’ll be following in this
tutorial.

This is one of the datasets you’ll be using throughout this tutorial, and it’s a spreadsheet with a sample of real data
from Amazon’s online product reviews. This dataset is only a tiny fraction of what Amazon provides, but for testing
purposes, it’s more than enough.

A Simple Approach to Reading an Excel Spreadsheet


Finally, let’s start reading some spreadsheets! To begin with, open our sample spreadsheet:

Python >>>

>>> from openpyxl import load_workbook


>>> workbook = load_workbook(filename="sample.xlsx")

>>> workbook.sheetnames

['Sheet 1']

>>> sheet = workbook.active

>>> sheet

<Worksheet "Sheet 1">


Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 4/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

>>> sheet.title

'Sheet 1'

In the code above, you first open the spreadsheet sample.xlsx using load_workbook(), and then you can use
workbook.sheetnames to see all the sheets you have available to work with. After that, workbook.active selects the first
available sheet and, in this case, you can see that it selects Sheet 1 automatically. Using these methods is the default
way of opening a spreadsheet, and you’ll see it many times during this tutorial.

Now, after opening a spreadsheet, you can easily retrieve data from it like this:

Python >>>

>>> sheet["A1"]

Improve Your Python


<Cell 'Sheet 1'.A1>


...with a fresh 🐍 Python Trick 💌  

>>> sheet["A1"].value
code snippet every couple of days:
'marketplace'

Email Address
>>> sheet["F10"].value

"G-Shock Men's Grey Sport Watch"

Send Python Tricks »


To return the actual value of a cell, you need to do .value. Otherwise, you’ll get the main Cell object. You can also use
the method .cell() to retrieve a cell using index notation. Remember to add .value to get the actual value and not a
Cell object:

Python >>>

>>> sheet.cell(row=10, column=6)

<Cell 'Sheet 1'.F10>

>>> sheet.cell(row=10, column=6).value

"G-Shock Men's Grey Sport Watch"

You can see that the results returned are the same, no matter which way you decide to go with. However, in this
tutorial, you’ll be mostly using the first approach: ["A1"].

Note: Even though in Python you’re used to a zero-indexed notation, with spreadsheets you’ll always use a one-
indexed notation where the first row or column always has index 1.

The above shows you the quickest way to open a spreadsheet. However, you can pass additional parameters to
change the way a spreadsheet is loaded.

Additional Reading Options


There are a few arguments you can pass to load_workbook() that change the way a spreadsheet is loaded. The most
important ones are the following two Booleans:

1. read_only loads a spreadsheet in read-only mode allowing you to open very large Excel files.
2. data_only ignores loading formulas and instead loads only the resulting values.

 Remove ads

Importing Data From a Spreadsheet


Now that you’ve learned the basics about loading a spreadsheet, it’s about time you get to the fun part: the iteration
and actual usage of the values within the spreadsheet.

This section is where you’ll learn all the different ways you can iterate through the data, but also how to convert that
data into something usable and, more importantly, how to do it in a Pythonic way.
Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 5/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

Iterating Through the Data


There are a few different ways you can iterate through the data depending on your needs.

You can slice the data with a combination of columns and rows:

Python >>>

>>> sheet["A1:C2"]

((<Cell 'Sheet 1'.A1>, <Cell 'Sheet 1'.B1>, <Cell 'Sheet 1'.C1>),

(<Cell 'Sheet 1'.A2>, <Cell 'Sheet 1'.B2>, <Cell 'Sheet 1'.C2>))

You can get ranges of rows or columns:


Improve Your Python
...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:

Email Address

Send Python Tricks »

Python >>>

>>> # Get all cells from column A

>>> sheet["A"]

(<Cell 'Sheet 1'.A1>,

<Cell 'Sheet 1'.A2>,

...

<Cell 'Sheet 1'.A99>,

<Cell 'Sheet 1'.A100>)

>>> # Get all cells for a range of columns

>>> sheet["A:B"]

((<Cell 'Sheet 1'.A1>,

<Cell 'Sheet 1'.A2>,

...

<Cell 'Sheet 1'.A99>,

<Cell 'Sheet 1'.A100>),

(<Cell 'Sheet 1'.B1>,

<Cell 'Sheet 1'.B2>,

...

<Cell 'Sheet 1'.B99>,


Improve Your Python
<Cell 'Sheet 1' B100>))
https://realpython.com/openpyxl-excel-spreadsheets-python/ 6/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python
<Cell 'Sheet 1'.B100>))

>>> # Get all cells from row 5

>>> sheet[5]

(<Cell 'Sheet 1'.A5>,

<Cell 'Sheet 1'.B5>,

...

<Cell 'Sheet 1'.N5>,

<Cell 'Sheet 1'.O5>)

>>> # Get all cells for a range of rows

>>> sheet[5:6]

((<Cell 'Sheet 1'.A5>,

<Cell 'Sheet 1'.B5>,

...
Improve Your Python
<Cell 'Sheet 1'.N5>,

<Cell 'Sheet 1'.O5>),


...with a fresh 🐍 Python Trick 💌  

(<Cell 'Sheet 1'.A6>,

code snippet every couple of days:


<Cell 'Sheet 1'.B6>,

...

<Cell 'Sheet 1'.N6>,


Email Address
<Cell 'Sheet 1'.O6>))

Send Python Tricks »


You’ll notice that all of the above examples return a tuple. If you want to refresh your memory on how to handle
tuples in Python, check out the article on Lists and Tuples in Python.

There are also multiple ways of using normal Python generators to go through the data. The main methods you can
use to achieve this are:

.iter_rows()

.iter_cols()

Both methods can receive the following arguments:

min_row

max_row

min_col

max_col

These arguments are used to set boundaries for the iteration:

Python >>>

>>> for row in sheet.iter_rows(min_row=1,

... max_row=2,

... min_col=1,

... max_col=3):

... print(row)

(<Cell 'Sheet 1'.A1>, <Cell 'Sheet 1'.B1>, <Cell 'Sheet 1'.C1>)


(<Cell 'Sheet 1'.A2>, <Cell 'Sheet 1'.B2>, <Cell 'Sheet 1'.C2>)

>>> for column in sheet.iter_cols(min_row=1,

... max_row=2,

... min_col=1,

... max_col=3):

... print(column)

(<Cell 'Sheet 1'.A1>, <Cell 'Sheet 1'.A2>)

(<Cell 'Sheet 1'.B1>, <Cell 'Sheet 1'.B2>)

(<Cell 'Sheet 1'.C1>, <Cell 'Sheet 1'.C2>)

You’ll notice that in the first example, when iterating through the rows using .iter_rows(), you get one tuple element
per row selected. While when using .iter_cols() and iterating through columns, you’ll get one tuple per column
instead.
Improve Your Python
O dditi l t
https://realpython.com/openpyxl-excel-spreadsheets-python/
t b th th d i th B l l l Wh it’ tt th l 7/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python
One additional argument you can pass to both methods is the Boolean values_only. When it’s set to True, the values
of the cell are returned, instead of the Cell object:

Python >>>

>>> for value in sheet.iter_rows(min_row=1,

... max_row=2,

... min_col=1,

... max_col=3,

... values_only=True):

... print(value)

('marketplace', 'customer_id', 'review_id')

('US', 3653882, 'R3O9SGZBVQBV76')

Improve Your Python


If you want to iterate through the whole dataset, then you can also use the attributes .rows or .columns directly, which
are shortcuts to using .iter_rows() and .iter_cols() without any arguments: ...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:


Python >>>

>>> for row in sheet.rows:


Email Address
... print(row)

(<Cell 'Sheet 1'.A1>, <Cell 'Sheet 1'.B1>, <Cell 'Sheet 1'.C1>

...
Send Python Tricks »
<Cell 'Sheet 1'.M100>, <Cell 'Sheet 1'.N100>, <Cell 'Sheet 1'.O100>)

These shortcuts are very useful when you’re iterating through the whole dataset.

Manipulate Data Using Python’s Default Data Structures


Now that you know the basics of iterating through the data in a workbook, let’s look at smart ways of converting that
data into Python structures.

As you saw earlier, the result from all iterations comes in the form of tuples. However, since a tuple is nothing more
than an immutable list, you can easily access its data and transform it into other structures.

For example, say you want to extract product information from the sample.xlsx spreadsheet and into a dictionary
where each key is a product ID.

A straightforward way to do this is to iterate over all the rows, pick the columns you know are related to product
information, and then store that in a dictionary. Let’s code this out!

First of all, have a look at the headers and see what information you care most about:
Python >>>

>>> for value in sheet.iter_rows(min_row=1,

... max_row=1,

... values_only=True):

... print(value)

('marketplace', 'customer_id', 'review_id', 'product_id', ...)

This code returns a list of all the column names you have in the spreadsheet. To start, grab the columns with names:

product_id

product_parent

product_title

product_category

Lucky for you, the columns you need are all next to each other so you can use the min_column and max_column to easily
get the data you want:

Python >>>

>>> for value in sheet.iter_rows(min_row=2,

... min_col=4,

... max_col=7,

... values_only=True):

... print(value)

('B00FALQ1ZC', 937001370, 'Invicta Women\'s 15150 "Angel" 18k Yellow...)

Improve Your Python


('B00D3RGO20', 484010722, "Kenneth Cole New York Women's KC4944...)

https://realpython.com/openpyxl-excel-spreadsheets-python/ 8/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python
...

Nice! Now that you know how to get all the important product information you need, let’s put that data into a
dictionary:

Python

import json

from openpyxl import load_workbook

workbook = load_workbook(filename="sample.xlsx")

sheet = workbook.active

products = {}

Improve Your Python


# Using the values_only because you want to return the cells' values

...with a fresh 🐍 Python Trick 💌  

for row in sheet.iter_rows(min_row=2,

min_col=4,
code snippet every couple of days:
max_col=7,

values_only=True):
Email Address
product_id = row[0]

product = {

"parent": row[1],

Send Python Tricks »


"title": row[2],

"category": row[3]

products[product_id] = product

# Using json here to be able to format the output for displaying later

print(json.dumps(products))

The code above returns a JSON similar to this:

JSON

"B00FALQ1ZC": {

"parent": 937001370,

"title": "Invicta Women's 15150 ...",

"category": "Watches"

},

"B00D3RGO20": {

"parent": 484010722,

"title": "Kenneth Cole New York ...",

"category": "Watches"

Here you can see that the output is trimmed to 2 products only, but if you run the script as it is, then you should get 98
products.

Convert Data Into Python Classes


To finalize the reading section of this tutorial, let’s dive into Python classes and see how you could improve on the
example above and better structure the data.

For this, you’ll be using the new Python Data Classes that are available from Python 3.7. If you’re using an older
version of Python, then you can use the default Classes instead.

So, first things first, let’s look at the data you have and decide what you want to store and how you want to store it.

As you saw right at the start, this data comes from Amazon, and it’s a list of product reviews. You can check the list of
all the columns and their meaning on Amazon.
Improve Your Python
There are two significant elements you can extract from the data available:
https://realpython.com/openpyxl-excel-spreadsheets-python/ 9/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python
There are two significant elements you can extract from the data available:

1. Products
2. Reviews

A Product has:

ID
Title
Parent
Category

The Review has a few more fields:


Improve Your Python
...with a fresh 🐍 Python Trick 💌  

ID
code snippet every couple of days:
Customer ID
Stars Email Address
Headline
Body Send Python Tricks »
Date

You can ignore a few of the review fields to make things a bit simpler.

So, a straightforward implementation of these two classes could be written in a separate file classes.py:

Python

import datetime

from dataclasses import dataclass

@dataclass

class Product:

id: str

parent: str

title: str

category: str

@dataclass

class Review:

id: str

customer_id: str

stars: int

headline: str

body: str

date: datetime.datetime

After defining your data classes, you need to convert the data from the spreadsheet into these new structures.

Before doing the conversion, it’s worth looking at our header again and creating a mapping between columns and the
fields you need:

Python >>>

>>> for value in sheet.iter_rows(min_row=1,

... max_row=1,

... values_only=True):

... print(value)

('marketplace', 'customer_id', 'review_id', 'product_id', ...)

>>> # Or an alternative

>>> for cell in sheet[1]:

... print(cell.value)

Improve Your Python


marketplace

https://realpython.com/openpyxl-excel-spreadsheets-python/ 10/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

customer_id

review_id

product_id

product_parent

...

Let’s create a file mapping.py where you have a list of all the field names and their column location (zero-indexed) on
the spreadsheet:

Python

# Product fields

PRODUCT_ID = 3
PRODUCT_PARENT = 4
Improve Your Python
PRODUCT_TITLE = 5

PRODUCT_CATEGORY = 6
...with a fresh 🐍 Python Trick 💌  


code snippet every couple of days:
# Review fields

REVIEW_ID = 2

REVIEW_CUSTOMER = 1
Email Address
REVIEW_STARS = 7

REVIEW_HEADLINE = 12

REVIEW_BODY = 13
Send Python Tricks »
REVIEW_DATE = 14

You don’t necessarily have to do the mapping above. It’s more for readability when parsing the row data, so you don’t
end up with a lot of magic numbers lying around.

Finally, let’s look at the code needed to parse the spreadsheet data into a list of product and review objects:

Python

from datetime import datetime

from openpyxl import load_workbook

from classes import Product, Review

from mapping import PRODUCT_ID, PRODUCT_PARENT, PRODUCT_TITLE, \

PRODUCT_CATEGORY, REVIEW_DATE, REVIEW_ID, REVIEW_CUSTOMER, \

REVIEW_STARS, REVIEW_HEADLINE, REVIEW_BODY

# Using the read_only method since you're not gonna be editing the spreadsheet

workbook = load_workbook(filename="sample.xlsx", read_only=True)

sheet = workbook.active

products = []

reviews = []

# Using the values_only because you just want to return the cell value

for row in sheet.iter_rows(min_row=2, values_only=True):

product = Product(id=row[PRODUCT_ID],

parent=row[PRODUCT_PARENT],

title=row[PRODUCT_TITLE],

category=row[PRODUCT_CATEGORY])

products.append(product)

# You need to parse the date from the spreadsheet into a datetime format

spread_date = row[REVIEW_DATE]

parsed_date = datetime.strptime(spread_date, "%Y-%m-%d")

review = Review(id=row[REVIEW_ID],

customer_id=row[REVIEW_CUSTOMER],

stars=row[REVIEW_STARS],

headline=row[REVIEW_HEADLINE],

body=row[REVIEW_BODY],

date=parsed_date)

reviews.append(review)

print(products[0])

print(reviews[0])

After you run the code above, you should get some output like this:

Python Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 11/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

Product(id='B00FALQ1ZC', parent=937001370, ...)

Review(id='R3O9SGZBVQBV76', customer_id=3653882, ...)

That’s it! Now you should have the data in a very simple and digestible class format, and you can start thinking of
storing this in a Database or any other type of data storage you like.

Using this kind of OOP strategy to parse spreadsheets makes handling the data much simpler later on.

Improve Your Python


 Remove ads
...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:


Appending New Data
Email
Before you start creating very complex spreadsheets, have a quick look at an example of Address
how to append data to an
existing spreadsheet.
Send Python Tricks »
Go back to the first example spreadsheet you created (hello_world.xlsx) and try opening it and appending some data
to it, like this:

Python

from openpyxl import load_workbook

# Start by opening the spreadsheet and selecting the main sheet


workbook = load_workbook(filename="hello_world.xlsx")

sheet = workbook.active

# Write what you want into a specific cell

sheet["C1"] = "writing ;)"

# Save the spreadsheet

workbook.save(filename="hello_world_append.xlsx"

Et voilà, if you open the new hello_world_append.xlsx spreadsheet, you’ll see the following change:

Notice the additional writing ;) on cell C1.

Improve Your Python


Writing Excel Spreadsheets With openpyxl
https://realpython.com/openpyxl-excel-spreadsheets-python/ 12/41
Writing Excel Spreadsheets With openpyxl
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

There are a lot of different things you can write to a spreadsheet, from simple text or number values to complex
formulas, charts, or even images.

Let’s start creating some spreadsheets!

Creating a Simple Spreadsheet


Previously, you saw a very quick example of how to write “Hello world!” into a spreadsheet, so you can start with that:

Improve Your Python


...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:

Email Address

Send Python Tricks »


Python

1 from openpyxl import Workbook

3 filename = "hello_world.xlsx"

5 workbook = Workbook()

6 sheet = workbook.active

8 sheet["A1"] = "hello"

9 sheet["B1"] = "world!"

10

11 workbook.save(filename=filename)

The highlighted lines in the code above are the most important ones for writing. In the code, you can see that:

Line 5 shows you how to create a new empty workbook.


Lines 8 and 9 show you how to add data to specific cells.
Line 11 shows you how to save the spreadsheet when you’re done.

Even though these lines above can be straightforward, it’s still good to know them well for when things get a bit more
complicated.

Note: You’ll be using the hello_world.xlsx spreadsheet for some of the upcoming examples, so keep it handy.

One thing you can do to help with coming code examples is add the following method to your Python file or console:

Python >>>

>>> def print_rows():

... for row in sheet.iter_rows(values_only=True):

... print(row)

It makes it easier to print all of your spreadsheet values by just calling print_rows().

 Remove ads

Basic Spreadsheet Operations


Before you get into the more advanced topics, it’s good for you to know how to manage the most simple elements of a
spreadsheet. Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 13/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

Adding and Updating Cell Values


You already learned how to add values to a spreadsheet like this:

Python >>>

>>> sheet["A1"] = "value"

There’s another way you can do this, by first selecting a cell and then changing its value:

Improve Your Python


...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:

Python Email Address >>>

>>> cell = sheet["A1"]

>>> cell
Send Python Tricks »
<Cell 'Sheet'.A1>

>>> cell.value

'hello'

>>> cell.value = "hey"

>>> cell.value

'hey'

The new value is only stored into the spreadsheet once you call workbook.save().

The openpyxl creates a cell when adding a value, if that cell didn’t exist before:

Python >>>

>>> # Before, our spreadsheet has only 1 row

>>> print_rows()

('hello', 'world!')

>>> # Try adding a value to row 10

>>> sheet["B10"] = "test"

>>> print_rows()

('hello', 'world!')

(None, None)

(None, None)

(None, None)

(None, None)

(None, None)

(None, None)

(None, None)

(None, None)

(None, 'test')

As you can see, when trying to add a value to cell B10, you end up with a tuple with 10 rows, just so you can have that
test value.

Managing Rows and Columns


One of the most common things you have to do when manipulating spreadsheets is adding or removing rows and
columns. The openpyxl package allows you to do that in a very straightforward way by using the methods:

.insert_rows()

.delete_rows()

.insert_cols()

.delete_cols()

Every single one of those methods can receive two arguments:


Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 14/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

1. idx
2. amount

Using our basic hello_world.xlsx example again, let’s see how these methods work:

Improve Your Python


Python >>>
...with a fresh 🐍 Python Trick 💌  

>>> print_rows()
code snippet every couple of days:
('hello', 'world!')

Email Address
>>> # Insert a column before the existing column 1 ("A")

>>> sheet.insert_cols(idx=1)

>>> print_rows()

(None, 'hello', 'world!')


Send Python Tricks »

>>> # Insert 5 columns between column 2 ("B") and 3 ("C")

>>> sheet.insert_cols(idx=3, amount=5)

>>> print_rows()

(None, 'hello', None, None, None, None, None, 'world!')

>>> # Delete the created columns

>>> sheet.delete_cols(idx=3, amount=5)

>>> sheet.delete_cols(idx=1)

>>> print_rows()

('hello', 'world!')

>>> # Insert a new row in the beginning

>>> sheet.insert_rows(idx=1)

>>> print_rows()

(None, None)

('hello', 'world!')

>>> # Insert 3 new rows in the beginning

>>> sheet.insert_rows(idx=1, amount=3)

>>> print_rows()

(None, None)

(None, None)

(None, None)

(None, None)

('hello', 'world!')

>>> # Delete the first 4 rows

>>> sheet.delete_rows(idx=1, amount=4)

>>> print_rows()

('hello', 'world!')

The only thing you need to remember is that when inserting new data (rows or columns), the insertion happens
before the idx parameter.

So, if you do insert_rows(1), it inserts a new row before the existing first row.

It’s the same for columns: when you call insert_cols(2), it inserts a new column right before the already existing
second column (B).

However, when deleting rows or columns, .delete_... deletes data starting from the index passed as an argument.

For example, when doing delete_rows(2) it deletes row 2, and when doing delete_cols(3) it deletes the third column
(C).

Managing Sheets
Sheet management is also one of those things you might need to know, even though it might be something that you
Improve Your Python
don’t use that often.
https://realpython.com/openpyxl-excel-spreadsheets-python/ 15/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

If you look back at the code examples from this tutorial, you’ll notice the following recurring piece of code:

Python

sheet = workbook.active

This is the way to select the default sheet from a spreadsheet. However, if you’re opening a spreadsheet with multiple
sheets, then you can always select a specific one like this:

Python >>>

>>> # Let's say you have two sheets: "Products" and "Company Sales"

>>> workbook.sheetnames
Improve Your Python
['Products', 'Company Sales']


...with a fresh 🐍 Python Trick 💌  

>>> # You can select a sheet using its title

code snippet every couple of days:


>>> products_sheet = workbook["Products"]

>>> sales_sheet = workbook["Company Sales"]

Email Address

You can also change a sheet title very easily:


Send Python Tricks »
Python >>>

>>> workbook.sheetnames

['Products', 'Company Sales']

>>> products_sheet = workbook["Products"]

>>> products_sheet.title = "New Products"

>>> workbook.sheetnames

['New Products', 'Company Sales']

If you want to create or delete sheets, then you can also do that with .create_sheet() and .remove():

Python >>>

>>> workbook.sheetnames

['Products', 'Company Sales']

>>> operations_sheet = workbook.create_sheet("Operations")

>>> workbook.sheetnames

['Products', 'Company Sales', 'Operations']

>>> # You can also define the position to create the sheet at

>>> hr_sheet = workbook.create_sheet("HR", 0)

>>> workbook.sheetnames

['HR', 'Products', 'Company Sales', 'Operations']

>>> # To remove them, just pass the sheet as an argument to the .remove()

>>> workbook.remove(operations_sheet)

>>> workbook.sheetnames

['HR', 'Products', 'Company Sales']

>>> workbook.remove(hr_sheet)

>>> workbook.sheetnames

['Products', 'Company Sales']

One other thing you can do is make duplicates of a sheet using copy_worksheet():

Python >>>

>>> workbook.sheetnames

['Products', 'Company Sales']

>>> products_sheet = workbook["Products"]

>>> workbook.copy_worksheet(products_sheet)

<Worksheet "Products Copy">

>>> workbook.sheetnames

['Products', 'Company Sales', 'Products Copy']

Improve Your Python


If you open your spreadsheet after saving the above code, you’ll notice that the sheet Products Copy is a duplicate of
https://realpython.com/openpyxl-excel-spreadsheets-python/ 16/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

the sheet Products.

Freezing Rows and Columns

Something that you might want to do when working with big spreadsheets is to freeze a few rows or columns, so they
remain visible when you scroll right or down.

Freezing data allows you to keep an eye on important rows or columns, regardless of where you scroll in the
spreadsheet.

Improve Your Python


Again, openpyxl also has a way to accomplish this by using the worksheet freeze_panes attribute. For this example, go
back to our sample.xlsx spreadsheet and try doing the following:
...with a fresh 🐍 Python Trick 💌  

Python >>>
code snippet every couple of days:
>>> workbook = load_workbook(filename="sample.xlsx")

>>> sheet = workbook.active


Email Address
>>> sheet.freeze_panes = "C2"

>>> workbook.save("sample_frozen.xlsx")

Send Python Tricks »


If you open the sample_frozen.xlsx spreadsheet in your favorite spreadsheet editor, you’ll notice that row 1 and
columns A and B are frozen and are always visible no matter where you navigate within the spreadsheet.

This feature is handy, for example, to keep headers within sight, so you always know what each column represents.

Here’s how it looks in the editor:

Notice how you’re at the end of the spreadsheet, and yet, you can see both row 1 and columns A and B.

Adding Filters
You can use openpyxl to add filters and sorts to your spreadsheet. However, when you open the spreadsheet, the data
won’t be rearranged according to these sorts and filters.

At first, this might seem like a pretty useless feature, but when you’re programmatically creating a spreadsheet that is
going to be sent and used by somebody else, it’s still nice to at least create the filters and allow people to use it
afterward.

The code below is an example of how you would add some filters to our existing sample.xlsx spreadsheet:

Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 17/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

Python >>>

>>> # Check the used spreadsheet space using the attribute "dimensions"

>>> sheet.dimensions

'A1:O100'

>>> sheet.auto_filter.ref = "A1:O100"

>>> workbook.save(filename="sample_with_filters.xlsx")

You should now see the filters created when opening the spreadsheet in your editor:

Improve Your Python


...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:

Email Address

Send Python Tricks »

You don’t have to use sheet.dimensions if you know precisely which part of the spreadsheet you want to apply filters
to.

 Remove ads

Adding Formulas
Formulas (or formulae) are one of the most powerful features of spreadsheets.

They gives you the power to apply specific mathematical equations to a range of cells. Using formulas with openpyxl is
as simple as editing the value of a cell.

You can see the list of formulas supported by openpyxl:

Python >>>
Improve Your Python
>>> from openpyxl utils import FORMULAE
https://realpython.com/openpyxl-excel-spreadsheets-python/ 18/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python
>>> from openpyxl.utils import FORMULAE

>>> FORMULAE

frozenset({'ABS',

'ACCRINT',

'ACCRINTM',

'ACOS',

'ACOSH',

'AMORDEGRC',

'AMORLINC',

'AND',

...

'YEARFRAC',

'YIELD',

'YIELDDISC',

'YIELDMAT',

'ZTEST'})

Improve Your Python


...with a fresh 🐍 Python Trick 💌  

Let’s add some formulas to our sample.xlsx spreadsheet. code snippet every couple of days:

Starting with something easy, let’s check the average star rating for the 99 reviews within the spreadsheet:
Email Address

Python >>>

>>> # Star rating is column "H"

Send Python Tricks »


>>> sheet["P2"] = "=AVERAGE(H2:H100)"

>>> workbook.save(filename="sample_formulas.xlsx")

If you open the spreadsheet now and go to cell P2, you should see that its value is: 4.18181818181818. Have a look in
the editor:

You can use the same methodology to add any formulas to your spreadsheet. For example, let’s count the number of
reviews that had helpful votes:

Python >>>

>>> # The helpful votes are counted on column "I"

>>> sheet["P3"] = '=COUNTIF(I2:I100, ">0")'

>>> workbook.save(filename="sample_formulas.xlsx")

You should get the number 21 on your P3 spreadsheet cell like so:

Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 19/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

Improve Your Python


...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:

Email Address
You’ll have to make sure that the strings within a formula are always in double quotes, so you either have to use single
quotes around the formula like in the example above or you’ll have to escape the double quotes inside the formula:
"=COUNTIF(I2:I100, \">0\")". Send Python Tricks »

There are a ton of other formulas you can add to your spreadsheet using the same procedure you tried above. Give it a
go yourself!

Adding Styles
Even though styling a spreadsheet might not be something you would do every day, it’s still good to know how to do
it.

Using openpyxl, you can apply multiple styling options to your spreadsheet, including fonts, borders, colors, and so
on. Have a look at the openpyxl documentation to learn more.

You can also choose to either apply a style directly to a cell or create a template and reuse it to apply styles to multiple
cells.

Let’s start by having a look at simple cell styling, using our sample.xlsx again as the base spreadsheet:

Python >>>

>>> # Import necessary style classes

>>> from openpyxl.styles import Font, Color, Alignment, Border, Side

>>> # Create a few styles

>>> bold_font = Font(bold=True)

>>> big_red_text = Font(color="00FF0000", size=20)

>>> center_aligned_text = Alignment(horizontal="center")

>>> double_border_side = Side(border_style="double")

>>> square_border = Border(top=double_border_side,


Improve Your Python
right double border side
https://realpython.com/openpyxl-excel-spreadsheets-python/ 20/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python
... right=double_border_side,

... bottom=double_border_side,

... left=double_border_side)

>>> # Style some cells!

>>> sheet["A2"].font = bold_font

>>> sheet["A3"].font = big_red_text

>>> sheet["A4"].alignment = center_aligned_text

>>> sheet["A5"].border = square_border

>>> workbook.save(filename="sample_styles.xlsx")

If you open your spreadsheet now, you should see quite a few different styles on the first 5 cells of column A:

Improve Your Python


...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:

Email Address

Send Python Tricks »

There you go. You got:

A2 with the text in bold


A3 with the text in red and bigger font size
A4 with the text centered
A5 with a square border around the text

Note: For the colors, you can also use HEX codes instead by doing Font(color="C70E0F").

You can also combine styles by simply adding them to the cell at the same time:

Python >>>

>>> # Reusing the same styles from the example above

>>> sheet["A6"].alignment = center_aligned_text

>>> sheet["A6"].font = big_red_text

>>> sheet["A6"].border = square_border

>>> workbook.save(filename="sample_styles.xlsx")

Have a look at cell A6 here:

Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 21/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

Improve Your Python


...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:

Email Address

When you want to apply multiple styles to one or several cells, you can use a NamedStyle class instead, which is like a
Send Python Tricks »
style template that you can use over and over again. Have a look at the example below:

Python >>>

>>> from openpyxl.styles import NamedStyle

>>> # Let's create a style template for the header row

>>> header = NamedStyle(name="header")

>>> header.font = Font(bold=True)

>>> header.border = Border(bottom=Side(border_style="thin"))

>>> header.alignment = Alignment(horizontal="center", vertical="center")

>>> # Now let's apply this to all first row (header) cells

>>> header_row = sheet[1]

>>> for cell in header_row:

... cell.style = header

>>> workbook.save(filename="sample_styles.xlsx")

If you open the spreadsheet now, you should see that its first row is bold, the text is aligned to the center, and there’s
a small bottom border! Have a look below:

Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 22/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

As you saw above, there are many options when it comes to styling, and it depends on the use case, so feel free to
check openpyxl documentation and see what other things you can do.

Improve Your Python


 Remove ads ...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:

Conditional Formatting Email Address


This feature is one of my personal favorites when it comes to adding styles to a spreadsheet.

Send Python
It’s a much more powerful approach to styling because it dynamically applies styles according Tricks
to how » in the
the data
spreadsheet changes.

In a nutshell, conditional formatting allows you to specify a list of styles to apply to a cell (or cell range) according to
specific conditions.

For example, a widespread use case is to have a balance sheet where all the negative totals are in red, and the positive
ones are in green. This formatting makes it much more efficient to spot good vs bad periods.

Without further ado, let’s pick our favorite spreadsheet—sample.xlsx—and add some conditional formatting.

You can start by adding a simple one that adds a red background to all reviews with less than 3 stars:

Python >>>

>>> from openpyxl.styles import PatternFill

>>> from openpyxl.styles.differential import DifferentialStyle


>>> from openpyxl.formatting.rule import Rule

>>> red_background = PatternFill(bgColor="00FF0000")

>>> diff_style = DifferentialStyle(fill=red_background)

>>> rule = Rule(type="expression", dxf=diff_style)

>>> rule.formula = ["$H1<3"]

>>> sheet.conditional_formatting.add("A1:O100", rule)

>>> workbook.save("sample_conditional_formatting.xlsx")

Now you’ll see all the reviews with a star rating below 3 marked with a red background:

Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 23/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

Code-wise, the only things that are new here are the objects DifferentialStyle and Rule:

DifferentialStyle is quite similar to NamedStyle, which you already saw above, and it’s used to aggregate
multiple styles such as fonts, borders, alignment, and so forth.
Rule is responsible for selecting the cells and applying the styles if the cells match the rule’s logic.

Using a Rule object, you can create numerous conditional formatting scenarios.

Improve Your Python


However, for simplicity sake, the openpyxl package offers 3 built-in formats that make it easier to create a few
common conditional formatting patterns. These built-ins are:
...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:


ColorScale

IconSet
Email Address
DataBar

The ColorScale gives you the ability to create color gradients: Send Python Tricks »

Python >>>

>>> from openpyxl.formatting.rule import ColorScaleRule

>>> color_scale_rule = ColorScaleRule(start_type="min",

... start_color="00FF0000", # Red

... end_type="max",

... end_color="0000FF00") # Green

>>> # Again, let's add this gradient to the star ratings, column "H"

>>> sheet.conditional_formatting.add("H2:H100", color_scale_rule)

>>> workbook.save(filename="sample_conditional_formatting_color_scale.xlsx")

Now you should see a color gradient on column H, from red to green, according to the star rating:

You can also add a third color and make two gradients instead: Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 24/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

Python >>>

>>> from openpyxl.formatting.rule import ColorScaleRule

>>> color_scale_rule = ColorScaleRule(start_type="num",

... start_value=1,

... start_color="00FF0000", # Red

... mid_type="num",

... mid_value=3,

... mid_color="00FFFF00", # Yellow

... end_type="num",

... end_value=5,

... end_color="0000FF00") # Green

>>>
>>>
# Again, let's add this gradient to the star ratings, column "H"

sheet.conditional_formatting.add("H2:H100", color_scale_rule)
Improve Your Python
>>> workbook.save(filename="sample_conditional_formatting_color_scale_3.xlsx")

...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:


This time, you’ll notice that star ratings between 1 and 3 have a gradient from red to yellow, and star ratings between
3 and 5 have a gradient from yellow to green: Email Address

Send Python Tricks »

The IconSet allows you to add an icon to the cell according to its value:

Python >>>

>>> from openpyxl.formatting.rule import IconSetRule


Improve Your Python
i t l I S tR l ("5A " " " [1 2 3 4 5])
https://realpython.com/openpyxl-excel-spreadsheets-python/ 25/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python
>>> icon_set_rule = IconSetRule("5Arrows", "num", [1, 2, 3, 4, 5])

>>> sheet.conditional_formatting.add("H2:H100", icon_set_rule)

>>> workbook.save("sample_conditional_formatting_icon_set.xlsx")

You’ll see a colored arrow next to the star rating. This arrow is red and points down when the value of the cell is 1 and,
as the rating gets better, the arrow starts pointing up and becomes green:

Improve Your Python


...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:

Email Address

Send Python Tricks »

The openpyxl package has a full list of other icons you can use, besides the arrow.

Finally, the DataBar allows you to create progress bars:


Python >>>

>>> from openpyxl.formatting.rule import DataBarRule

>>> data_bar_rule = DataBarRule(start_type="num",

... start_value=1,

... end_type="num",

... end_value="5",

... color="0000FF00") # Green

>>> sheet.conditional_formatting.add("H2:H100", data_bar_rule)

>>> workbook.save("sample_conditional_formatting_data_bar.xlsx")

You’ll now see a green progress bar that gets fuller the closer the star rating is to the number 5:

Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 26/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

As you can see, there are a lot of cool things you can do with conditional formatting.

Here, you saw only a few examples of what you can achieve with it, but check the openpyxl documentation to see a
bunch of other options.

Improve Your Python


 Remove ads
...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:


Adding Images
Email
Even though images are not something that you’ll often see in a spreadsheet, it’s quite Address
cool to be able to add them.
Maybe you can use it for branding purposes or to make spreadsheets more personal.
Send Python Tricks »
To be able to load images to a spreadsheet using openpyxl, you’ll have to install Pillow:

Shell

$ pip install Pillow

Apart from that, you’ll also need an image. For this example, you can grab the Real Python logo below and convert it
from .webp to .png using an online converter such as cloudconvert.com, save the final file as logo.png, and copy it to
the root folder where you’re running your examples:

Afterward, this is the code you need to import that image into the hello_word.xlsx spreadsheet:

Python

from openpyxl import load_workbook

from openpyxl.drawing.image import Image

# Let's use the hello_world spreadsheet since it has less data

workbook = load_workbook(filename="hello_world.xlsx")

sheet = workbook.active

logo = Image("logo.png")

# A bit of resizing to not fill the whole spreadsheet with the logo

logo.height = 150

logo.width = 150

sheet.add_image(logo, "A3")

workbook.save(filename="hello_world_logo.xlsx")

You have an image on your spreadsheet! Here it is:

Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 27/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

Improve Your Python


...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:

The image’s left top corner is on the cell you chose, in this case, A3.
Email Address

Adding Pretty Charts Send Python Tricks »


Another powerful thing you can do with spreadsheets is create an incredible variety of charts.

Charts are a great way to visualize and understand loads of data quickly. There are a lot of different chart types: bar
chart, pie chart, line chart, and so on. openpyxl has support for a lot of them.

Here, you’ll see only a couple of examples of charts because the theory behind it is the same for every single chart
type:

Note: A few of the chart types that openpyxl currently doesn’t have support for are Funnel, Gantt, Pareto,
Treemap, Waterfall, Map, and Sunburst.

For any chart you want to build, you’ll need to define the chart type: BarChart, LineChart, and so forth, plus the data
to be used for the chart, which is called Reference.

Before you can build your chart, you need to define what data you want to see represented in it. Sometimes, you can
use the dataset as is, but other times you need to massage the data a bit to get additional information.

Let’s start by building a new workbook with some sample data:

Python

1 from openpyxl import Workbook

2 from openpyxl.chart import BarChart, Reference

4 workbook = Workbook()

5 sheet = workbook.active

7 # Let's create some sample sales data

8 rows = [

9 ["Product", "Online", "Store"],

10 [1, 30, 45],

11 [2, 40, 30],

12 [3, 40, 25],

13 [4, 50, 30],

14 [5, 30, 25],

15 [6, 25, 35],

16 [7, 20, 40],

17 ]

18

19 for row in rows:

20 sheet.append(row)

Now you’re going to start by creating a bar chart that displays the total number of sales per product:

Python

22 chart = BarChart()

23 data = Reference(worksheet=sheet,
Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 28/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python
24 min_row=1,

25 max_row=8,

26 min_col=2,

27 max_col=3)

28

29 chart.add_data(data, titles_from_data=True)

30 sheet.add_chart(chart, "E2")

31

32 workbook.save("chart.xlsx")

There you have it. Below, you can see a very straightforward bar chart showing the difference between online product
sales online and in-store product sales:

Improve Your Python


...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:

Email Address

Send Python Tricks »

Like with images, the top left corner of the chart is on the cell you added the chart to. In your case, it was on cell E2.

Note: Depending on whether you’re using Microsoft Excel or an open-source alternative (LibreOffice or
OpenOffice), the chart might look slightly different.

Try creating a line chart instead, changing the data a bit:

Python

1 import random

2 from openpyxl import Workbook

3 from openpyxl.chart import LineChart, Reference

5 workbook = Workbook()

6 sheet = workbook.active

8 # Let's create some sample sales data

9 rows = [

10 ["", "January", "February", "March", "April",


11 "May", "June", "July", "August", "September",

12 "October", "November", "December"],

13 [1, ],
Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 29/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python
14 [2, ],

15 [3, ],

16 ]

17

18 for row in rows:

19 sheet.append(row)

20

21 for row in sheet.iter_rows(min_row=2,

22 max_row=4,

23 min_col=2,

24 max_col=13):

25 for cell in row:

26 cell.value = random.randrange(5, 100)

Improve Your Python


With the above code, you’ll be able to generate some random data regarding the sales of 3 different products across a
whole year. ...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:


Once that’s done, you can very easily create a line chart with the following code:
Email Address
Python

28 chart = LineChart()
Send Python Tricks »
29 data = Reference(worksheet=sheet,

30 min_row=2,

31 max_row=4,

32 min_col=1,

33 max_col=13)

34

35 chart.add_data(data, from_rows=True, titles_from_data=True)

36 sheet.add_chart(chart, "C6")

37

38 workbook.save("line_chart.xlsx")

Here’s the outcome of the above piece of code:

One thing to keep in mind here is the fact that you’re using from_rows=True when adding the data. This argument
makes the chart plot row by row instead of column by column.

In your sample data, you see that each product has a row with 12 values (1 column per month). That’s why you use
from_rows. If you don’t pass that argument, by default, the chart tries to plot by column, and you’ll get a month-by-
month comparison of sales.

Another difference that has to do with the above argument change is the fact that our Reference now starts from the
Improve Your Python
first column, min_col=1, instead of the second one. This change is needed because the chart now expects the first
https://realpython.com/openpyxl-excel-spreadsheets-python/ 30/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

column to have the titles.

There are a couple of other things you can also change regarding the style of the chart. For example, you can add
specific categories to the chart:

Python

cats = Reference(worksheet=sheet,

min_row=1,

max_row=1,

min_col=2,

max_col=13)

chart.set_categories(cats)
Improve Your Python
...with a fresh 🐍 Python Trick 💌  

Add this piece of code before saving the workbook, and you should see the month names appearing instead of
code snippet every couple of days:
numbers:

Email Address

Send Python Tricks »

Code-wise, this is a minimal change. But in terms of the readability of the spreadsheet, this makes it much easier for
someone to open the spreadsheet and understand the chart straight away.

Another thing you can do to improve the chart readability is to add an axis. You can do it using the attributes x_axis
and y_axis:

Python

chart.x_axis.title = "Months"

chart.y_axis.title = "Sales (per unit)"

This will generate a spreadsheet like the below one:

Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 31/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

Improve Your Python


...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:

Email Address

Send Python Tricks »

As you can see, small changes like the above make reading your chart a much easier and quicker task.

There is also a way to style your chart by using Excel’s default ChartStyle property. In this case, you have to choose a
number between 1 and 48. Depending on your choice, the colors of your chart change as well:

Python

# You can play with this by choosing any number between 1 and 48

chart.style = 24

With the style selected above, all lines have some shade of orange:

Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 32/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

There is no clear documentation on what each style number looks like, but this spreadsheet has a few examples of the
styles available.

Complete Code Example Show/Hide


Improve Your Python
There are a lot more chart types and customization you can apply, so be sure to check out the package
...with a fresh 🐍 Python Trick 💌  

documentation on this if you need some specific formatting.


code snippet every couple of days:

Email Address

Send Python Tricks »


 Remove ads

Convert Python Classes to Excel Spreadsheet


You already saw how to convert an Excel spreadsheet’s data into Python classes, but now let’s do the opposite.

Let’s imagine you have a database and are using some Object-Relational Mapping (ORM) to map DB objects into
Python classes. Now, you want to export those same objects into a spreadsheet.

Let’s assume the following data classes to represent the data coming from your database regarding product sales:

Python

from dataclasses import dataclass

from typing import List

@dataclass

class Sale:

quantity: int

@dataclass

class Product:

id: str

name: str

sales: List[Sale]

Now, let’s generate some random data, assuming the above classes are stored in a db_classes.py file:

Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 33/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

Python

1 import random

3 # Ignore these for now. You'll use them in a sec ;)


4 from openpyxl import Workbook

5 from openpyxl.chart import LineChart, Reference

7 from db_classes import Product, Sale

9 products = []

10
Improve Your Python
11 # Let's create 5 products

12 for idx in range(1, 6):


...with a fresh 🐍 Python Trick 💌  

13 sales = []
code snippet every couple of days:
14

15 # Create 5 months of sales

16 for _ in range(5):
Email Address
17 sale = Sale(quantity=random.randrange(5, 100))

18 sales.append(sale)

19
Send Python Tricks »
20 product = Product(id=str(idx),

21 name="Product %s" % idx,

22 sales=sales)

23 products.append(product)

By running this piece of code, you should get 5 products with 5 months of sales with a random quantity of sales for
each month.

Now, to convert this into a spreadsheet, you need to iterate over the data and append it to the spreadsheet:

Python

25 workbook = Workbook()

26 sheet = workbook.active

27

28 # Append column names first

29 sheet.append(["Product ID", "Product Name", "Month 1",

30 "Month 2", "Month 3", "Month 4", "Month 5"])

31

32 # Append the data

33 for product in products:

34 data = [product.id, product.name]


35 for sale in product.sales:

36 data.append(sale.quantity)

37 sheet.append(data)

That’s it. That should allow you to create a spreadsheet with some data coming from your database.

However, why not use some of that cool knowledge you gained recently to add a chart as well to display that data
more visually?

All right, then you could probably do something like this:

Python Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 34/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

38 chart = LineChart()

39 data = Reference(worksheet=sheet,

40 min_row=2,

41 max_row=6,

42 min_col=2,

43 max_col=7)

44

45 chart.add_data(data, titles_from_data=True, from_rows=True)

46 sheet.add_chart(chart, "B8")

47

48 cats = Reference(worksheet=sheet,

49 min_row=1,

50 max_row=1,

51 min_col=3,
Improve Your Python
52 max_col=7)

53 chart.set_categories(cats)

...with a fresh 🐍 Python Trick 💌  

54

code snippet every couple of days:


55 chart.x_axis.title = "Months"

56 chart.y_axis.title = "Sales (per unit)"

57
Email Address
58 workbook.save(filename="oop_sample.xlsx")

Send Python Tricks »


Now we’re talking! Here’s a spreadsheet generated from database objects and with a chart and everything:

That’s a great way for you to wrap up your new knowledge of charts!

Bonus: Working With Pandas


Even though you can use Pandas to handle Excel files, there are few things that you either can’t accomplish with
Pandas or that you’d be better off just using openpyxl directly.

For example, some of the advantages of using openpyxl are the ability to easily customize your spreadsheet with
styles, conditional formatting, and such.

But guess what, you don’t have to worry about picking. In fact, openpyxl has support for both converting data from a
Pandas DataFrame into a workbook or the opposite, converting an openpyxl workbook into a Pandas DataFrame.

Note: If you’re new to Pandas, check our course on Pandas DataFrames beforehand.

First things first, remember to install the pandas package:


Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 35/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

Shell

$ pip install pandas

Then, let’s create a sample DataFrame:

Python

1 import pandas as pd

3 data = {

4 "Product Name": ["Product 1", "Product 2"],

5 "Sales Month 1": [10, 20],

6
7 }

"Sales Month 2": [5, 35],

Improve Your Python


8 df = pd.DataFrame(data)

...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:


Now that you have some data, you can use .dataframe_to_rows() to convert it from a DataFrame into a worksheet:
Email Address
Python

10 from openpyxl import Workbook

11 from openpyxl.utils.dataframe import dataframe_to_rows


Send Python Tricks »
12

13 workbook = Workbook()

14 sheet = workbook.active

15

16 for row in dataframe_to_rows(df, index=False, header=True):

17 sheet.append(row)

18

19 workbook.save("pandas.xlsx")

You should see a spreadsheet that looks like this:

If you want to add the DataFrame’s index, you can change index=True, and it adds each row’s index into your
spreadsheet.

On the other hand, if you want to convert a spreadsheet into a DataFrame, you can also do it in a very straightforward
way like so:

Python

import pandas as pd
Improve Your Python
from openpyxl import load workbook
https://realpython.com/openpyxl-excel-spreadsheets-python/ 36/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python
from openpyxl import load_workbook

workbook = load_workbook(filename="sample.xlsx")

sheet = workbook.active

values = sheet.values

df = pd.DataFrame(values)

Alternatively, if you want to add the correct headers and use the review ID as the index, for example, then you can also
do it like this instead:

Python

import pandas as pd

from openpyxl import load_workbook

Improve Your Python


from mapping import REVIEW_ID

...with a fresh 🐍 Python Trick 💌  

workbook = load_workbook(filename="sample.xlsx")
code snippet every couple of days:
sheet = workbook.active


Email Address
data = sheet.values

# Set the first row as the columns for the DataFrame

Send Python Tricks »


cols = next(data)

data = list(data)

# Set the field "review_id" as the indexes for each row

idx = [row[REVIEW_ID] for row in data]

df = pd.DataFrame(data, index=idx, columns=cols)

Using indexes and columns allows you to access data from your DataFrame easily:

Python >>>

>>> df.columns

Index(['marketplace', 'customer_id', 'review_id', 'product_id',


'product_parent', 'product_title', 'product_category', 'star_rating',

'helpful_votes', 'total_votes', 'vine', 'verified_purchase',

'review_headline', 'review_body', 'review_date'],

dtype='object')

>>> # Get first 10 reviews' star rating

>>> df["star_rating"][:10]

R3O9SGZBVQBV76 5

RKH8BNC3L5DLF 5

R2HLE8WKZSU3NL 2
Improve Your Python
R31U3UH5AZ42LL 5

https://realpython.com/openpyxl-excel-spreadsheets-python/ 37/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

R2SV659OUJ945Y 4

RA51CP8TR5A2L 5

RB2Q7DLDN6TH6 5

R2RHFJV0UYBK3Y 1

R2Z6JOQ94LFHEP 5

RX27XIIWY5JPB 4

Name: star_rating, dtype: int64

>>> # Grab review with id "R2EQL1V1L6E0C9", using the index

>>> df.loc["R2EQL1V1L6E0C9"]

marketplace US

customer_id 15305006

review_id R2EQL1V1L6E0C9

product_id
product_parent
B004LURNO6

892860326

Improve Your Python


review_headline Five Stars

review_body Love it
...with a fresh 🐍 Python Trick 💌  

review_date 2015-08-31
code snippet every couple of days:
Name: R2EQL1V1L6E0C9, dtype: object

Email Address
There you go, whether you want to use openpyxl to prettify your Pandas dataset or use Pandas to do some hardcore
algebra, you now know how to switch between both packages. Send Python Tricks »

 Remove ads

Conclusion
Phew, after that long read, you now know how to work with spreadsheets in Python! You can rely on openpyxl, your
trustworthy companion, to:

Extract valuable information from spreadsheets in a Pythonic manner


Create your own spreadsheets, no matter the complexity level
Add cool features such as conditional formatting or charts to your spreadsheets

There are a few other things you can do with openpyxl that might not have been covered in this tutorial, but you can
always check the package’s official documentation website to learn more about it. You can even venture into
checking its source code and improving the package further.

Feel free to leave any comments below if you have any questions, or if there’s any section you’d love to hear more
about.

Download Dataset: Click here to download the dataset for the openpyxl exercise you’ll be following in this
tutorial.

Mark as Completed 

 Watch Now This tutorial has a related video course created by the Real Python team. Watch it together with the
written tutorial to deepen your understanding: Editing Excel Spreadsheets in Python With openpyxl

🐍 Python Tricks 💌

Get a short & sweet Python Trick delivered to your inbox every couple of
days. No spam ever. Unsubscribe any time. Curated by the Real Python
team.

Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 38/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

Email Address Improve Your Python


About Pedro Pregueiro ...with a fresh 🐍 Python Trick 💌  

Send Me Python Tricks »code snippet every couple of days:

Email
Hi! My name is Pedro and I'm a Python developer Address
who loves coding, burgers and playing guitar.

» More about Pedro


Send Python Tricks »

Each tutorial at Real Python is created by a team of developers so that it meets our high quality standards. The team members who
worked on this tutorial are:

Aldren Joanna Mike

Master Real-World Python Skills

With Unlimited Access to Real Python

Join us and get access to hundreds of tutorials, hands-


on video courses, and a community of expert
Pythonistas:

Level Up Your Python Skills »

What Do You Think?

 Tweet
 Share
 Email
Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 39/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

Real Python Comment Policy: The most useful comments are those written with the goal of learning
from or helping out other readers—after reading the whole article and all the earlier comments.
Complaints and insults generally won’t make the cut here.

What’s your #1 takeaway or favorite thing you learned? How are you going to put your newfound skills to use?
Leave a comment below and let us know.

Keep Learning
Improve Your Python
Related Tutorial Categories:
intermediate ...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:


Recommended Video Course: Editing Excel Spreadsheets in Python With openpyxl
Email Address

— FREE Email Series — Send Python Tricks »


🐍 Python Tricks 💌

Email…

Get Python Tricks »

🔒 No spam. Unsubscribe any time.

All Tutorial Topics


advanced
api
basics
best-practices
community
databases
data-science

devops
django
docker
flask
front-end
gamedev
gui
intermediate

machine-learning
projects
python
testing
tools
web-dev
web-scraping

Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 40/41
7/10/2021 A Guide to Excel Spreadsheets in Python With openpyxl – Real Python

Table of Contents
Before You Begin
→ Reading Excel Spreadsheets With openpyxl Improve Your Python
Writing Excel Spreadsheets With openpyxl
Conclusion ...with a fresh 🐍 Python Trick 💌  

code snippet every couple of days:

Mark as Completed 
Email Address

 Tweet
 Share
 Email

Send Python Tricks »

 Recommended Video Course

Editing Excel Spreadsheets in Python With openpyxl

© 2012–2021 Real Python ⋅ Newsletter ⋅ Podcast ⋅ YouTube ⋅ Twitter ⋅ Facebook ⋅ Instagram ⋅


Python Tutorials ⋅ Search ⋅ Privacy Policy ⋅ Energy Policy ⋅ Advertise ⋅ Contact

❤️Happy Pythoning!

Improve Your Python

https://realpython.com/openpyxl-excel-spreadsheets-python/ 41/41

You might also like