Driving Excel from Python in Windows

Question

We have various spreadsheets that employ deliciously complicated macros and third party extensions to produce complicated models. I'm working on a project that involves slightly tweaking various inputs and seeing the results. Rather than doing this by hand or writing VBA, I'd like to see if I can write a python script to drive this. In other words, the python script will start up, load the excel sheet, and then interact with the sheet by making minor changes in some cells and seeing how they affect other cells.

So, my question is twofold:

What is the best library to use to drive excel from python in such fashion?
Where's the best documentation/examples on using said library?

Cheers, /YGA

Check out Resolver One (http://www.resolversystems.com/products/, a Python-programmable spreadsheet. There is a free version for personal, non-commercial use available at http://www.resolversystems.com/download/. — codeape, Jan 15 '09 at 07:49
Why hasn't anyone mentioned xlrd/xlwt/xlutils? www.python-excel.org — caps, Jan 22 '15 at 15:51
@caps `xlrd/xlwt/xlutils` has severe limitations. To edit an existing excel, you must use`xlutils` to copy a read-only `xlrd.Book` to a writable `xlwt.Workbook`. A lot of things will be lost during the copy. According to its javadoc, it only `preserving as much information from the source object as possible.`, which makes it off my list. — smwikipedia, Jan 04 '16 at 08:56

codeape · Accepted Answer · 2011-09-27T08:15:34.127

For controlling Excel, use pywin32, like @igowen suggests.

Note that it is possible to use static dispatch. Use makepy.py from the pywin32 project to create a python module with the python wrappers. Using the generated wrappers simplifies development, since for instance ipython gives you tab completion and help during development.

Static dispatch example:

x:> makepy.py "Microsoft Excel 11.0 Object Library"
...
Generating...
Importing module
x:> ipython

> from win32com.client import Dispatch
> excel = Dispatch("Excel.Application")
> wb = excel.Workbooks.Append()
> range = wb.Sheets[0].Range("A1")
> range.[Press Tab]
range.Activate                 range.Merge
range.AddComment               range.NavigateArrow
range.AdvancedFilter           range.NoteText
...
range.GetOffset                range.__repr__
range.GetResize                range.__setattr__
range.GetValue                 range.__str__
range.Get_Default              range.__unicode__
range.GoalSeek                 range._get_good_object_
range.Group                    range._get_good_single_object_
range.Insert                   range._oleobj_
range.InsertIndent             range._prop_map_get_
range.Item                     range._prop_map_put_
range.Justify                  range.coclass_clsid
range.ListNames                range.__class__
> range.Value = 32
...

Documentation links:

The O'Reilly book Python Programming on Win32 has an Integrating with Excel chapter.
Same book, free sample chapter Advanced Python and COM covers makepy in detail.
Tutorials
win32com documentation, I suggest you read this first.

at least on my computer the line "wb = excel.Workbooks.Append()" has to be corrected to "wb = excel.Workbooks.Add()" — Boris Gorelik, Mar 21 '10 at 13:14
for those who are wondering, the API (for Excel 2007) is here: http://msdn.microsoft.com/en-us/library/bb149081(v=office.12) — trinth, Jun 13 '12 at 18:53
Its easy to fix on our end, but your link cuts off the last parenthesis, @trinth — TankorSmash, Aug 22 '12 at 16:41

score 22 · Answer 2 · edited Apr 07 '15 at 16:55

I've done this by using pywin32. It's not a particularly pleasant experience, since there's not really any abstraction; it's like using VBA, but with python syntax. You can't rely on docstrings, so you'll want to have the MSDN Excel reference handy (http://msdn.microsoft.com/en-us/library/aa220733.aspx is what I used, if I remember correctly. You should be able to find the Excel 2007 docs if you dig around a bit.).

See here for a simple example.

from win32com.client import Dispatch

xlApp = Dispatch("Excel.Application")
xlApp.Visible = 1
xlApp.Workbooks.Add()
xlApp.ActiveSheet.Cells(1,1).Value = 'Python Rules!'
xlApp.ActiveWorkbook.ActiveSheet.Cells(1,2).Value = 'Python Rules 2!'
xlApp.ActiveWorkbook.Close(SaveChanges=0) # see note 1
xlApp.Quit()
xlApp.Visible = 0 # see note 2
del xlApp

Good luck!

Check out my new project at http://xlwings.org that wraps this approach into an easy and Pythonic interface and provides possibilities to call it through Excel. — Felix Zumstein, Jul 03 '14 at 12:51

codeape · Answer 3 · 2012-08-23T09:13:34.053

8

Check out the DataNitro project (previous name IronSpread). It is a Python plug-in for Excel.

edited Aug 23 '12 at 09:13

answered Jun 11 '12 at 09:43

codeape

97,830
24
159
188

1

If you're a student, DataNitro is free, but otherwise the license costs $99. – twasbrillig Oct 05 '14 at 04:35
DataNitro is no longer available for purchase. – TanuAD Sep 08 '19 at 18:47

Alex · Answer 4 · 2014-09-28T05:27:37.997

1

I wrote python class that allows working with Excel via COM interface in Windows http://sourceforge.net/projects/excelcomforpython/

The class uses win32com to interact with Excel. You can use class directly or use it as example. A lot of options implemented like array formulas, conditional formatting, charts etc.

edited Sep 28 '14 at 05:27

answered Feb 10 '14 at 11:15

Alex

2,009
6
24
27

score 1 · Answer 5 · answered Aug 27 '15 at 07:36

I've spent about a week, and here's my implementation (or rather proof-of-concept): https://github.com/Winand/SimplePython

Main idea is to make Python code as easy to write and call from Microsoft Office as VBA macros (i've made Add-In only for Excel).

Client-server architecture (over TCP), so Python is started only once
Server is auto-started if it's not running
Server auto-reloads macro modules when user changes them
Easy-to-use control interface on Office ribbon

score 1 · Answer 6 · edited May 18 '15 at 22:35

I worked on a home project last year that involves a client written as a Python Excel plug-in. The project is essentially an online database simplified for end-user access. The Excel plug-in allows users to query data out of the database to display in Excel.

I never got very far with the Excel plug-in and my code for it is a bit ugly. But, what I do have is under a BSD license and available via Bazaar at

http://www.launchpad.net/analyz/trunk

The client won't work since I don't have a public server running right now, but at least you can look at what I did with the code to get some ideas how this could work. The code will also show you how to build an MFC dialog in 100% Python.

score 0 · Answer 7 · answered Feb 14 '14 at 16:43

There is an interesting project for integrating python into excel as an in-process DLL which can be fount at:

http://opentradingsystem.com/PythonForExcel/main.html

Another somewhat more simple project along the same idea exists at:

http://www.codeproject.com/Articles/639887/Calling-Python-code-from-Excel-with-ExcelPython

These projects seem to have a lot of promise but need more development.

Driving Excel from Python in Windows

7 Answers7

Linked