openpyxl.workbook.workbook模块

工作簿是所有文档信息的顶级容器。

class openpyxl.workbook.workbook.Workbook(write_only=False, iso_dates=False)[源代码]

基类:object

工作簿是文档所有其他部分的容器。

property active

获取当前活动的工作表或不获取任何工作表

类型

openpyxl.worksheet.worksheet.Worksheet

add_named_range(named_range)[源代码]

将现有的命名范围添加到命名范围列表中。

注解

已弃用:使用workbook.defined_name.append

add_named_style(style)[源代码]

添加命名样式

property chartsheets

此工作簿中的图表列表

类型

名单 openpyxl.chartsheet.chartsheet.Chartsheet

close()[源代码]

打开时关闭工作簿文件。只影响只读和只写模式。

copy_worksheet(from_worksheet)[源代码]

复制当前工作簿中的现有工作表

警告

此功能无法在工作簿之间复制工作表。工作表只能在其所属的工作簿中复制

参数

from_worksheet -- 要从中复制的工作表

返回

初始工作表副本

create_chartsheet(title=None, index=None)[源代码]
create_named_range(name, worksheet=None, value=None, scope=None)[源代码]

在工作表上创建新的命名区域

create_sheet(title=None, index=None)[源代码]

创建工作表(在可选索引处)。

参数
  • title (str) -- 工作表的可选标题

  • index (int) -- 插入板材的可选位置

property data_only
property excel_base_date
get_index(worksheet)[源代码]

返回工作表的索引。

注解

已弃用:使用wb.index(工作表)

get_named_range(name)[源代码]

返回由名称指定的范围。

注解

已弃用:使用工作簿。已定义的名称 [name]

get_named_ranges()[源代码]

返回所有命名范围

注解

已弃用:使用workbook.definedu name.definedname

get_sheet_by_name(name)[源代码]

按名称返回工作表。

参数名称

要查找的工作表的名称

类型名

一串

注解

已弃用:使用WB [片名]

get_sheet_names()[源代码]

注解

已弃用:使用wb.sheetname

index(worksheet)[源代码]

返回工作表的索引。

property mime_type

mime类型由工作簿是否为模板以及是否包含宏决定。Excel要求文件扩展名匹配,但OpenPYXL不强制执行此操作。

move_sheet(sheet, offset=0)[源代码]

移动图纸或图纸名

property named_styles

列出可用的命名样式

path = '/xl/workbook.xml'
property read_only
remove(worksheet)[源代码]

去除 worksheet 来自此工作簿。

remove_named_range(named_range)[源代码]

从此工作簿中删除一个命名的u区域。

注解

已弃用:使用del workbook.definedu名称 [name]

remove_sheet(worksheet)[源代码]

去除 worksheet 来自此工作簿。

注解

已弃用:使用wb.remove(工作表)或del wb [片名]

save(filename)[源代码]

将当前工作簿保存在给定的 filename . 使用此函数而不是使用 ExcelWriter .

警告

使用创建工作簿时 write_only 如果设置为true,则只能调用此函数一次。子序列尝试修改或保存文件将引发 openpyxl.shared.exc.WorkbookAlreadySaved 例外。

property sheetnames

返回此工作簿中工作表的名称列表。

按工作表顺序返回名称。

类型

字符串表

property style_names

命名样式列表

template = False
property worksheets

此工作簿中的工作表列表

类型

名单 openpyxl.worksheet.worksheet.Worksheet

property write_only