文档对象

主要文档和相关对象。

Document 构造函数

docx.Document(docx: str | IO[bytes] | None = None)

返回一个 Document 加载自的对象 docx ，在哪里 docx 可以是指向 .docx 文件(字符串)或类似文件的对象。

如果 docx 丢失或丢失 None ，将加载内置的默认文档“模板”。

Document 对象

class docx.document.Document

WordprocessingML（WML）文档。

不打算直接建造。使用 docx.Document() 打开或创建文档。

add_heading(text='', level=1)

返回新添加到文档末尾的标题段落。

标题段将包含 text 并使其段落样式由 level 。如果 level 为0，则样式设置为 Title 。如果 level 为1(或省略)， Heading 1 使用的是。否则，样式将设置为 Heading {level} 。加薪 ValueError 如果 level 超出了0-9的范围。

add_page_break()

新返回 Paragraph 对象只包含分页符。

add_paragraph(text: str = '', style=None) → Paragraph

将新添加到文档末尾的段落返回。

该段落中填充了 text 并具有段落样式 style 。

text 可以包含制表符 (\t )字符，这些字符被转换为用于选项卡的适当的XML形式。 text 还可以包括换行符 (\n )或回程 (\r )字符，每个字符都转换为换行符。

add_picture(image_path_or_stream, width=None, height=None)

返回在文档末尾自己的段落中添加的新图片形状。

该图片包含的图像位于 image_path_or_stream ，根据以下条件进行调整 width 和 height 。如果既未指定宽度也未指定高度，则图片以其原始大小显示。如果只指定了一个，则使用它来计算比例因子，然后将该比例因子应用于未指定的维度，从而保留图像的纵横比。图片的原始大小是使用图像文件中指定的每英寸点数(Dpi)值计算的，如果未指定值，则默认为72 dpi，这是通常的情况。

add_section(start_type=WD_SECTION_START.NEW_PAGE)

返回一个 Section 在文档末尾新添加的对象。

可选的 start_type 参数必须是 WD_SECTION_START 枚举，并默认为 WD_SECTION.NEW_PAGE 如未提供，请填写。

add_table(rows, cols, style=None)

添加行数和列数均为 rows 和 cols 分别进行了分析。

style 可以是表格样式对象或表格样式名称。如果 style 是 None 时，表格将继承文档的默认表格样式。

property core_properties

A CoreProperties 提供文档的Dublin Core属性的对象。

property inline_shapes

这个 InlineShapes 此文档的集合。

内联形状是一种图形对象，如图片，包含在一系列文本中，其行为类似于字符字形，与段落中的其他文本一样流动。

property paragraphs

这个 Paragraph 文档中的实例，按文档顺序排列。

请注意，修订标记内的段落，如 <w:ins> 或 <w:del> 不会出现在此列表中。

property part

这个 DocumentPart 此文档的对象。

save(path_or_stream)

将此文档保存到 path_or_stream 。

path_or_stream 可以是文件系统位置(字符串)的路径，也可以是类似文件的对象。

property sections

Sections 对象提供对此文档中每个节的访问权限。

property settings

A Settings 对象，提供对文档级设置的访问。

property styles

A Styles 对象提供对此文档中样式的访问。

property tables

全 Table 文档中的实例，按文档顺序排列。

请注意，只有出现在文档顶层的表格才会出现在此列表中；嵌套在表格单元格中的表格不会出现。修订标记内的表，如 <w:ins> 或 <w:del> 也不会出现在列表中。

CoreProperties 对象

各 Document 对象提供对其 CoreProperties 对象通过其 core_properties 属性。一 CoreProperties 对象提供对 核心属性 对于文件。核心属性包括作者、类别、注释、内容状态、创建、标识符、关键字、语言、上次修改者、上次打印、修改、修订、主题、标题和版本。

每种属性都是三种类型之一， str ， datetime.datetime 或 int . 字符串属性的长度限制为255个字符，如果未设置，则返回空字符串（“”）。日期属性被分配并返回为 datetime.datetime 不带时区的对象，即UTC格式。任何时区转换由客户负责。属性返回日期 None 如果没有设置。

python-docx 不自动设置任何文档核心属性，只将核心属性部分添加到没有核心属性的演示文稿中（非常罕见）。如果 python-docx 添加核心属性部分，它包含标题、上次修改者、修订和修改属性的默认值。如果需要的话，客户端代码应该更新诸如revision和last_modified_之类的属性。

class docx.opc.coreprops.CoreProperties

author

string --主要负责制作资源内容的实体。

category

string --对此包的内容进行分类。示例值可能包括：简历、信函、财务预测、建议或技术演示文稿。

comments

string --资源内容的说明。

content_status

string --文件的完成状态，例如‘草稿’

created

datetime --文档初始创建时间

identifier

string --明确引用给定上下文中的资源，例如ISBN。

keywords

string --可能用作本文档搜索词的描述性词语或短语

language

string --文档所使用的语言

last_modified_by

string --上次修改文档的人员的姓名或其他标识符(如电子邮件地址)

last_printed

datetime --上次打印文档的时间

modified

datetime --上次修改文档的时间

revision

int --此修订号，每次保存文档时按Word递增。不过，请注意 python-docx 保存文档时不会自动递增修订版本号。

subject

string --资源内容主题。

title

string --为资源指定的名称。

version

string --自由格式版本字符串