文档对象

主要文档和相关对象。

Document 构造函数

docx.Document(docx=None)[源代码]

返回A Document 从加载的对象 docx 在哪里 docx 可以是指向 .docx 文件(字符串)或类似文件的对象。如果 docx 丢失或 None ,则加载内置的默认文档“模板”。

Document 对象

class docx.document.Document[源代码]

WordprocessingML(WML)文档。

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

add_heading(text='', level=1)[源代码]

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

标题段落将包含 text 其段落风格由 水平 .如果 水平 为0,样式设置为 Title .如果 水平 为1(或省略), Heading 1 被使用。否则样式设置为 Heading {{level}} . 加薪 ValueError 如果 水平 在0-9范围之外。

add_page_break()[源代码]

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

add_paragraph(text='', style=None)[源代码]

返回新添加到文档末尾的段落,填充 text 有段落风格 风格 . text 可以包含制表符 (\t )字符,这些字符将转换为选项卡的适当XML格式。 text 也可以包括换行符 (\n )或回车 (\r )字符,每个字符都转换为换行符。

add_picture(image_path_or_stream, width=None, height=None)[源代码]

返回在文档末尾添加到其自身段落中的新图片形状。图片包含位于的图像 image_path_or_stream ,基于 宽度高度 . 如果未指定宽度和高度,则图片将以其原始大小显示。如果只指定了一个,它将用于计算比例因子,然后应用于未指定的维度,保持图像的纵横比。图片的原始大小是使用图像文件中指定的每英寸点数(dpi)值来计算的,如果没有指定值,默认值为72 dpi(通常情况下)。

add_section(start_type=2)[源代码]

返回A Section 对象,表示在文档末尾添加的新节。可选的 start_type 参数必须是 WD_SECTION_START 枚举,默认为 WD_SECTION.NEW_PAGE 如果没有提供。

add_table(rows, cols, style=None)[源代码]

添加行和列计数为的表 rowscols 分别和表格样式 风格 . 风格 可以是段落样式对象或段落样式名称。如果 风格None ,表继承文档的默认表样式。

property core_properties

A CoreProperties 对象提供对此文档的核心属性的读/写访问权限。

property inline_shapes

InlineShapes 对象提供对此文档中内联形状的访问。内联形状是一个图形对象,如图片,包含在一系列文本中,其行为类似于字符glyph,与段落中的其他文本一样流动。

property paragraphs

列表 Paragraph 与文档中的段落相对应的实例,按文档顺序排列。请注意,修订标记中的段落,如 <w:ins><w:del> 不要出现在此列表中。

property part

这个 DocumentPart 此文档的对象。

save(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 对象提供对 核心属性 对于文件。核心属性包括作者、类别、注释、内容状态、创建、标识符、关键字、语言、上次修改者、上次打印、修改、修订、主题、标题和版本。

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

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

class docx.opc.coreprops.CoreProperties[源代码]
author

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

category

一串 --此包内容的分类。示例值可能包括:简历、信函、财务预测、提案或技术演示。

comments

一串 --对资源内容的描述。

content_status

一串 --文件的完成状态,例如“草稿”

created

日期时间 --文件初始创建时间

identifier

一串 --在给定上下文中对资源的明确引用,例如ISBN。

keywords

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

language

一串 --文档所用的语言

last_modified_by

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

last_printed

日期时间 --上次打印文档的时间

modified

日期时间 --上次修改文档的时间

revision

int --此修订的编号,每次保存文档时按Word递增。但是请注意 python-docx 保存文档时不会自动增加修订号。

subject

一串 --资源内容的主题。

title

一串 --为资源指定的名称。

version

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