Python win32com模块操作Excel：基本读写¶

发布于：2019-04-21 | 分类：process automation , python/vba/cpp

---

Python有很多强大的第三方库可以读写Excel，例如xlrd、xlwt、xlutils、openpyxl、xlwings等，它们主要在读写方面具备优势，但论起对Excel操作的全面性和基础性，则首推win32com，它是pywin32库 ¹ 的一部分。本文记录使用win32com操作Excel的几个案例，例如一般的读写、工作表保护、自动计算、引用管理等。

关于VBA宏的读写运行操作，单独列为一篇：

2019-09-13-Python win32com模块操作Excel：VBA模块读写

安装¶

pip install pywin32

# 如果需要用到系统功能例如注册COM对象、Windows服务，则需要继续执行如下安装
python Scripts/pywin32_postinstall.py -install

基本操作¶

由于win32com是对基本COM API的封装，所以基本功能的使用和VBA极为类似，因此本文不会在此方面花费篇幅，仅以如下例子作参考：

import win32com.client

# 获取Excel Application
# app = win32com.client.gencache.EnsureDispatch("Excel.Application")
app = win32com.client.Dispatch("Excel.Application")
app.Visible = False
app.DisplayAlerts = False
app.ScreenUpdating = False

# 打开工作簿
# UpdateLinks=False 避免打开工作簿时提示更新链接
wb = app.Workbooks.Open("path/to/workbook", UpdateLinks=False)

# 获取工作簿后则可类似VBA操作，例如获取当前工作表，进而获取Range等
# Range具有Value, Address, Formula属性
wb.ActiveSheet.Range("A1").Value = "Hello World"

其中使用Dispatch()和EnsureDispatch()获取COM对象的差别参考 ²。

我们更关心的是如何获取API，对于简单的应用，可以参考VBA代码提示或录制的宏进行转换，但是不能保证其正确性。考虑到win32com是对Windows COM组件API的封装，我们可以直接参考原始API文档。如果安装了Visual Studio，可以从如下目录找到oleview.exe ³：

C:\Program Files (x86)\Windows Kits\8.1\bin\x64\oleview.exe

注意 以管理员方式运行该程序，否则无法打开后续的文档。然后从左侧面板的Type Libraries节点查找需要的内容，例如对于Excel 2010，我们浏览找到Microsoft Excel 14.0 Object Library (Ver 1.7)。双击打开后即可看到详细的API文档，包括类及其属性和方法、常量等。

开启/关闭工作表保护¶

Protect()和Unprotect()开启/关闭工作表保护，适用于对有保护的工作表的自动化处理。下面示例代码检测工作表保护状态，如果被保护则取消保护以便修改操作，最后还原之前的保护状态：

# check protection status
status = sheet.ProtectContents
if status:
    sheet.Unprotect()

# DO SOMETHING

# reset protection status
if status:
    sheet.Protect()

开启/关闭自动计算 ^{4 5}¶

Excel默认开启自动计算，那么当工作表内单元格公式非常多时，每录入一个数据都将触发相关单元格的更新计算，影响操作效率。因此此种情况下，一般先设置为手动更新，待输入完成后设置自动更新。以下为示例代码：

# sample Excel and workbook
app = win32com.client.Dispatch("Excel.Application")
wb = app.Workbooks.open("path/to/workbook")

# turn off automatic calculation to improve performance
# otherwise, the entire worksheet will re-calculate every time a new input is entered
app.Calculation = -4135 # xlCalculationManual

# DO SOMETHING, e.g. ENTER DATA

# turn on automatic calculation: xlCalculationAutomatic
# but sometimes it's not able to re-calculate, so we should trigger it explicitly:
# https://docs.microsoft.com/en-us/office/client-developer/excel/excel-recalculation
# from the link, a simple way is adding an empty row, e.g. Row No.1000000,
# then the active worksheet is re-calculated
# 
# here we force to re-calculate the entire workbook
# 
app.Calculation = -4105
wb.Application.CalculateFullRebuild()

引用管理¶

VBA代码可能跨工作簿引用函数，例如COM组件中的类和方法，但前期可能没有正确加载该引用。手工加载引用的流程为：Developer -> Visual basic -> Tools -> References...，而workbook.VBProject.References则从程序设置的角度管理当前VBA工程已经添加的引用。

一个引用通常包含名称、路径、版本号等信息，我们首先可以遍历显示所有已加载引用的信息：

for ref in wb.VBProject.References:
    print(ref.Name, ref.FullPath, ref.GUID, ref.Major, ref.Minor, ref.Description)

AddFromFile()和AddFromGuid()方法可以通过文件路径和GUID的方式添加引用，其中GUID由创建COM组件时生成并已注册到系统。注意不能重复添加，即如果丢失则自动添加，否则不处理。

guid, major_version, minor_version = "{662901FC-6951-4854-9EB2-D9A2570F2B2E}", 1, 0
loaded = False
for ref in wb.VBProject.References:
    if ref.GUID == guid:
        if ref.IsBroken: # loaded but broken
            wb.VBProject.References.Remove(ref)
        else:
            loaded = True

if not loaded:
    wb.VBProject.References.AddFromGuid(guid, major_version, minor_version)

显然，这部分代码也需要设置 允许访问VBA工程对象模型，因为用到了wb.VBProject。