Copy and paste ranges in excel with OpenPyXl and Python 3 - Yagisanatode (2024)

OpenPyXl is a Python open library that allows you to read and write Microsoft Excel files. Specifically, the ‘*.xlsx’ file extension. It helps you to create programs to create and modify files and automate your processes in excel.

NOTE: This post requires that you have some knowledge of Python and the OpenPyXl library. The library also needs to be installed for you to use.

Quite often, I find that I have to work with ranges of data that I need to either copy and paste into a new file or files, or copy > modify > paste into files.

The OpenPyXl library allows you to look at every cell of a file and either copy it or modify it by using theopenpyxl.worksheet.Worksheet.cell() method. This method allows you to access each cell by the row and column as a numerical value.

Note! Unlike everything else in coding, rows and columns start with one(1) and not zero(0).

To select whole ranges of our data we need to iterate through it by both row and column and then store that data in a list to be pasted to the new file, spreadsheet or location that we desire.

The following example will take you through the process. For your own data you will need to modify thefile, sheetandrange locations. Everything else should be good to go.

You can find the whole code at the end of the post.

Why does your MS Excel look weird?

To be honest my screenshots of the ‘.xlsx files will be in Libreoffice. But this simple example will be able to load without issue in MS Excel.

The Example

Source Data

The source data for this example is a very simplified version of grade data that I work with day-to-day. The goal of our program is to simply copy theSection 12 results into a new file. The file for this spreadsheet is called:GradeSample.xlsx. I have put it in the same folder as my Python program.

Receiving File

For the purpose of this example, we have a file that we want to save this data into: Section12Grades.xlsx. We could just as easily use a template and save the file under a different name – for example, template.xlsx could save as sec12Grade.xlsx. This could be useful if I wanted to save a file for each section.

The receiving file looks like this:

Loading the Source Data and Receiving File

Okay, let’s get started with the program. First, we need to load both the source data and the receiving file.

We import he OpenPyXl library first.

Next, we’ll open the source data with wb = openpyxl.load_workbook("GradeSample.xlsx") . Once we have loaded the workbook we need to tell Python which sheet tab we want it to work in. We do this by calling the workbook (wb) and then get the sheet by its name: sheet = wb.get_sheet_by_name("Grades")

We repeat this step with the receiving data file that we want to paste our Section 12 grades into.

Copying the Section 12 data

Looking at the section 12 data, we want Python to be able to copy from column A2 to D14. the OpenPyXl .cell() method takes a number which is much easier to iterate, rather than the column letters. So let’s look at that range again:

• From: A2 is now column = 1 and row = 2
• To: D14 in now column = 4 and row = 14

Once we access this data, we need somewhere to store it before we paste it into the new file. We will use a nested list for this.

In line 3 we create our function copyRange. It contains 5 arguments that we could add with our information as follows:

• startCol = 1
• startRow = 2
• endCol = 4
• endRow = 14
• sheet = sheet ( The name of the sheet variablewe are copying the data from which is GradeSample.xlsxsheet Grades)

In line 4 we create an empty list called rangeSelected this list will have data from every row we have selected.

Line 5 starts the for loop through each row. Each row contains data in each column so we create an empty list (rowSelected) here in preparation to add the column data to in the next for loop (Line 6).

Line 6 loops through each item in each column of the selected row. Line 7 then adds the data from each column to the rowSelected lists.

Once it finishes this loop, it adds the data from the rowSelected lists into the rangeSelected lists. It then moves down to the next row and repeats the process continuing through the rows until the loop meets its end at row 14.

Finally the copyRange function returns the rangeSelected list to be used at our discretion.

Pasting the selected data

Now we have a nested list of all the rows and the information in the columns we require from those rows.

We will use that list add it to ourSection12Grades.xlsx in Sheet1.

We want to add the data starting at row 3 this time because we have a title on row 1 and column headers on row 2.

We will be up for two more for loops to do this.

Let’s take a look:

Line 3 starts our pasteRange function and contains the following arguments:

• startCol = 1
• startRow = 3 (because we want to paste the data 1 row down.)
• endCol = 4
• endRow = 15 (because we want to paste the data 1 row down.)
• sheetReceiving = temp_sheet (This is the variable forSection12Grades.xlsx with the sheet name, Sheet1.
• copiedData = rangeSelected ( The returned list from your copyRange function)

Line 5 creates a count number variable starting with zero(0) so we can start looking through our copiedDatalists by rows from the beginning.

Line 6 begins the row loop like the copyRange function.

Line 7 adds another count number variable so we can loop through our copiedData list by columns.

Line 8 begins the column loop.

Line 9 adds the copiedData cell-by-cell to the new file. It does not save it here but holds it in memory to be saved to the file we choose in the future.

Finally, we add 1 to each of the counters so we can move onto the next cell.

Running a Copy and Paste as a function

We are now going to create a function to copy the data using the copyRange function and paste the data using the pasteRange function and then we will save theSection12Grades.xlsx file contained in the variable, template.

This is how it will look:

Line 1 creates the function and then line 3 runs the copyRange process with the arguments we need.

Note! After line 3 you could call a function to manipulate the data or add styling here before you paste it.

Line 4 then runs the pasteRange function with the arguments we need.

Line 5 then saves the pasted data in the same file that we used in our memory. You could equally save the file with a different name and this will create a brand new file with the pasted data in it.

That’s it! Done.

Run the program

Now it’s time to run the program. Save the file and hit run (F5).

In the Python Shell run the program and then enter:

Your result will look like this:

Not too impressive, right?

Go into the folder and open yourSection12Grades.xlsx spreadsheet.

It should now look like this:

The full OpenPyXl copy and paste range code

Edit: 18 Nov 2018

From OpenPyXl version 2.5 onward, you might find that you get a Depreciation warning for:

• sheet = wb.get_sheet_by_name("foo") #Add Sheet name
• temp_sheet = template.get_sheet_by_name("foo2") #Add Sheet name

OpenPyXl 2.5 now provides the sheet names in a convenient list:

• sheet = wb["foo"]#Add Sheet name
• temp_sheet = template["foo2"]#Add Sheet name

Her is the updated code:

Big thanks to WY in the comments for reminding me to update this.

Related