教程

创建工作簿

开始使用 openpyxl 时,不需要在文件系统上创建文件。只要导入 Workbook 类,然后开始工作

>>> from openpyxl import Workbook
>>> wb = Workbook()

工作簿总是由至少一个工作表创建。你可以使用 Workbook.active 属性获得它:

>>> ws = wb.active

备注

默认设置为 0。除非你修改了它的值,否则你总是会使用这个方法得到第一个工作表。

您可以使用 Workbook.create_sheet() 方法创建新的工作表:

>>> ws1 = wb.create_sheet("Mysheet") # insert at the end (default)
# or
>>> ws2 = wb.create_sheet("Mysheet", 0) # insert at first position
# or
>>> ws3 = wb.create_sheet("Mysheet", -1) # insert at the penultimate position

表在创建时自动指定名称。它们按顺序编号 (Sheet, Sheet1, Sheet2, …)。你可以在任何时候用 Worksheet.title 属性修改命名:

ws.title = "New Title"

默认情况下,包含该标题的标签的背景颜色为白色。你可以将 RRGGBB 颜色代码改为 Worksheet.sheet_properties.tabColor 属性:

ws.sheet_properties.tabColor = "1072BA"

一旦你给工作表一个名字,你可以得到它作为工作簿的键

>>> ws3 = wb["New Title"]

你可以使用 Workbook.sheetname 属性来查看工作簿中所有工作表的名称

>>> print(wb.sheetnames)
['Sheet2', 'New Title', 'Sheet1']

你可以循环工作表

>>> for sheet in wb:
...     print(sheet.title)

您可以在 单个工作簿 中创建工作表的副本:

Workbook.copy_worksheet() method:

>>> source = wb.active
>>> target = wb.copy_worksheet(source)

备注

只复制单元格(包括值、样式、超链接和注释)和某些工作表属性(包括尺寸、格式和属性)。所有其他工作簿/工作表属性不被复制——例如图像,图表。

您也不能在工作簿之间复制工作表。如果工作簿以 read-onlywrite-only 模式打开,则无法复制工作表。

玩数据

访问一个单元格

现在我们知道如何获得工作表,我们可以开始修改单元格的内容。单元格可以作为工作表的键直接访问:

>>> c = ws['A4']

这将返回 A4 单元格,或者如果它还不存在创建一个。值可以直接赋值:

>>> ws['A4'] = 4

还有 Worksheet.cell() 方法。

这提供了使用行和列表示法访问单元格

>>> d = ws.cell(row=4, column=2, value=10)

备注

在内存中创建工作表时,它不包含 cells。它们是在第一次访问时创建的。

警告

由于这个特性,即使你未对单元格赋值,滚动浏览而非直接访问时也会在内存中直接创建。

可能是

>>> for x in range(1,101):
...        for y in range(1,101):
...            ws.cell(row=x, column=y)

将在内存中创建 100x100 个单元格。

访问大量单元格

可以使用切片来访问一系列单元格:

>>> cell_range = ws['A1':'C2']

一系列的行和列也可以通过类似的方法获取:

>>> colC = ws['C']
>>> col_range = ws['C:D']
>>> row10 = ws[10]
>>> row_range = ws[5:10]

你也使用 Worksheet.iter_rows() 方法:

>>> for row in ws.iter_rows(min_row=1, max_col=3, max_row=2):
...    for cell in row:
...        print(cell)
<Cell Sheet1.A1>
<Cell Sheet1.B1>
<Cell Sheet1.C1>
<Cell Sheet1.A2>
<Cell Sheet1.B2>
<Cell Sheet1.C2>

同样 Worksheet.iter_cols() 方法会返回列:

>>> for col in ws.iter_cols(min_row=1, max_col=3, max_row=2):
...     for cell in col:
...         print(cell)
<Cell Sheet1.A1>
<Cell Sheet1.A2>
<Cell Sheet1.B1>
<Cell Sheet1.B2>
<Cell Sheet1.C1>
<Cell Sheet1.C2>

备注

由于性能原因 Worksheet.iter_cols() 方法在只读模式下不可用。

如果需要遍历文件中的所有行和列,可以使用 Worksheet.rows 属性:

>>> ws = wb.active
>>> ws['C9'] = 'hello world'
>>> tuple(ws.rows)
((<Cell Sheet.A1>, <Cell Sheet.B1>, <Cell Sheet.C1>),
(<Cell Sheet.A2>, <Cell Sheet.B2>, <Cell Sheet.C2>),
(<Cell Sheet.A3>, <Cell Sheet.B3>, <Cell Sheet.C3>),
(<Cell Sheet.A4>, <Cell Sheet.B4>, <Cell Sheet.C4>),
(<Cell Sheet.A5>, <Cell Sheet.B5>, <Cell Sheet.C5>),
(<Cell Sheet.A6>, <Cell Sheet.B6>, <Cell Sheet.C6>),
(<Cell Sheet.A7>, <Cell Sheet.B7>, <Cell Sheet.C7>),
(<Cell Sheet.A8>, <Cell Sheet.B8>, <Cell Sheet.C8>),
(<Cell Sheet.A9>, <Cell Sheet.B9>, <Cell Sheet.C9>))

或者 Worksheet.columns 属性:

>>> tuple(ws.columns)
((<Cell Sheet.A1>,
<Cell Sheet.A2>,
<Cell Sheet.A3>,
<Cell Sheet.A4>,
<Cell Sheet.A5>,
<Cell Sheet.A6>,
...
<Cell Sheet.B7>,
<Cell Sheet.B8>,
<Cell Sheet.B9>),
(<Cell Sheet.C1>,
<Cell Sheet.C2>,
<Cell Sheet.C3>,
<Cell Sheet.C4>,
<Cell Sheet.C5>,
<Cell Sheet.C6>,
<Cell Sheet.C7>,
<Cell Sheet.C8>,
<Cell Sheet.C9>))

备注

由于性能原因 Worksheet.columns 方法在只读模式下不可用。

Values only

如果你只想要工作薄的值,你可以使用 Worksheet.values 属性。这会遍历工作簿中所有的行但只返回单元格值:

for row in ws.values:
   for value in row:
     print(value)

Worksheet.iter_rows()Worksheet.iter_cols() 可以用 values_only 参数来返回单元格值:

>>> for row in ws.iter_rows(min_row=1, max_col=3, max_row=2, values_only=True):
...   print(row)

(None, None, None)
(None, None, None)

数据存储

一旦有了 Cell, 我们可以为其分配值:

>>> c.value = 'hello, world'
>>> print(c.value)
'hello, world'

>>> d.value = 3.14
>>> print(d.value)
3.14

保存至文件

保存工作表最简单和安全的方法就是使用 Workbook 类的 Workbook.save() 方法:

>>> wb = Workbook()
>>> wb.save('balances.xlsx')

警告

这个操作将会无警告直接覆盖已有文件。

备注

文件名后缀并不强制为 xlsx 或 xlsm,但是如果没使用官方后缀名,会在用其他应用打开时遇到一些麻烦。

由于 OOXML 文件基本上都是 ZIP 文件,你也可以用你喜欢的 ZIP 压缩管理器打开。

保存成流文件

如果你想把文件保存为流文件,例如当使用 web 应用程序,如 Pyramid,Flask 或 Django 时,你可以简单地提供 NamedTemporaryFile():

>>> from tempfile import NamedTemporaryFile
>>> from openpyxl import Workbook
>>> wb = Workbook()
>>> with NamedTemporaryFile() as tmp:
        wb.save(tmp.name)
        tmp.seek(0)
        stream = tmp.read()

你可以指定属性 template=True 将工作表保存为模板:

>>> wb = load_workbook('document.xlsx')
>>> wb.template = True
>>> wb.save('document_template.xltx')

或者设置属性为 False (默认) 将其保存为文档:

>>> wb = load_workbook('document_template.xltx')
>>> wb.template = False
>>> wb.save('document.xlsx', as_template=False)

警告

你应当在保存模板文档时监视数据的属性和文档拓展名,否则引擎可能会无法打开文档。

备注

以下操作将会失败:

>>> wb = load_workbook('document.xlsx')
>>> # Need to save with the extension *.xlsx
>>> wb.save('new_document.xlsm')
>>> # MS Excel can't open the document
>>>
>>> # or
>>>
>>> # Need specify attribute keep_vba=True
>>> wb = load_workbook('document.xlsm')
>>> wb.save('new_document.xlsm')
>>> # MS Excel will not open the document
>>>
>>> # or
>>>
>>> wb = load_workbook('document.xltm', keep_vba=True)
>>> # If we need a template document, then we must specify extension as *.xltm.
>>> wb.save('new_document.xlsm')
>>> # MS Excel will not open the document

从文件加载

可以使用 openpyxl.load_workbook() 方法来打开已存在的工作表:

>>> from openpyxl import load_workbook
>>> wb2 = load_workbook('test.xlsx')
>>> print(wb2.sheetnames)
['Sheet2', 'New Title', 'Sheet1']

教程到这里就结束了, 你可以继续 简单用法 部分