本文由 大侠(AhcaoZhu)原创,转载请声明。
链接: https://blog.csdn.net/Ahcao2008
全文介绍系统内置 python- docx 模块、函数、类及类的方法和属性。
它通过代码抓取并经AI智能翻译和人工校对。
是一部不可多得的权威字典类工具书。它是系列集的一部分。后续陆续发布、敬请关注。【原创:AhcaoZhu大侠】
docx
docx.opc◎
docx.compat
docx.shared
docx.image◎
docx.exceptions
docx.enum◎
docx.oxml◎
docx.parts◎
docx.package
docx.api
docx.text◎
docx.dml◎
docx.shape
docx.blkcntnr
docx.section
docx.document
docx.settings
docx.styles◎
docx.table??
◎--package
??--需要单独装载
◆object
◆BaseException
◆Exception
docx.exceptions.PythonDocxError
docx.exceptions.InvalidSpanError
docx.exceptions.InvalidXmlError
◆collections.abc.Container
◆collections.abc.Iterable
◆collections.abc.Sized
◆collections.abc.Collection
◆collections.abc.Reversible
◆collections.abc.Sequence
docx.section.Sections
docx.enum.Enumeration
docx.enum.base.Enumeration
docx.enum.base.XmlEnumeration
docx.enum.section.WD_HEADER_FOOTER_INDEX
docx.enum.section.WD_SECTION_START
docx.enum.style.WD_STYLE_TYPE
docx.enum.shape.WD_INLINE_SHAPE_TYPE
docx.enum.text.WD_BREAK_TYPE
docx.image.image.BaseImageHeader
docx.image.bmp.Bmp
docx.image.gif.Gif
docx.image.jpeg.Jpeg
docx.image.jpeg.Exif
docx.image.jpeg.Jfif
docx.image.png.Png
docx.image.tiff.Tiff
docx.image.image.Image
docx.opc.constants.CONTENT_TYPE
docx.opc.constants.RELATIONSHIP_TYPE
docx.opc.package.OpcPackage
docx.package.Package
docx.opc.part.Part
docx.parts.image.ImagePart
docx.oxml.simpletypes.BaseSimpleType
docx.oxml.simpletypes.BaseStringType
docx.oxml.simpletypes.BaseStringEnumerationType
docx.oxml.simpletypes.XsdStringEnumeration
docx.oxml.simpletypes.ST_Merge
docx.package.ImageParts
docx.section.Section
docx.shape.InlineShape
docx.shared.ElementProxy
docx.document.Document
docx.settings.Settings
docx.shared.Parented
docx.blkcntnr.BlockItemContainer
docx.document._Body
docx.section._BaseHeaderFooter
docx.section._Footer
docx.section._Header
docx.table._Cell
docx.shape.InlineShapes
docx.table.Table
docx.table._Column
docx.table._Columns
docx.table._Row
docx.table._Rows
docx.text.paragraph.Paragraph
docx.styles.BabelFish
◆int
docx.shared.Length
docx.shared.Cm
docx.shared.Emu
docx.shared.Inches
docx.shared.Mm
docx.shared.Pt
docx.shared.Twips
◆lxml.etree._Element
◆lxml.etree.ElementBase
docx.oxml.xmlchemy.BaseOxmlElement
docx.oxml.coreprops.CT_CoreProperties
docx.oxml.document.CT_Body
docx.oxml.document.CT_Document
docx.oxml.numbering.CT_Num
docx.oxml.numbering.CT_NumLvl
docx.oxml.numbering.CT_NumPr
docx.oxml.numbering.CT_Numbering
docx.oxml.section.CT_HdrFtr
docx.oxml.section.CT_HdrFtrRef
docx.oxml.section.CT_PageMar
docx.oxml.section.CT_PageSz
docx.oxml.section.CT_SectPr
docx.oxml.section.CT_SectType
docx.oxml.settings.CT_Settings
docx.oxml.shape.CT_Blip
docx.oxml.shape.CT_BlipFillProperties
docx.oxml.shape.CT_GraphicalObject
docx.oxml.shape.CT_GraphicalObjectData
docx.oxml.shape.CT_Inline
docx.oxml.shape.CT_NonVisualDrawingProps
docx.oxml.shape.CT_Picture
docx.oxml.shape.CT_PictureNonVisual
docx.oxml.shape.CT_Point2D
docx.oxml.shape.CT_PositiveSize2D
docx.oxml.shape.CT_ShapeProperties
docx.oxml.shape.CT_Transform2D
docx.oxml.shared.CT_DecimalNumber
docx.oxml.shared.CT_OnOff
docx.oxml.shared.CT_String
docx.oxml.styles.CT_LatentStyles
docx.oxml.styles.CT_LsdException
docx.oxml.styles.CT_Style
docx.oxml.styles.CT_Styles
docx.oxml.table.CT_Height
docx.oxml.table.CT_Row
docx.oxml.table.CT_Tbl
docx.oxml.table.CT_TblGrid
docx.oxml.table.CT_TblGridCol
docx.oxml.table.CT_TblLayoutType
docx.oxml.table.CT_TblPr
docx.oxml.table.CT_TblWidth
docx.oxml.table.CT_Tc
docx.oxml.table.CT_TcPr
docx.oxml.table.CT_TrPr
docx.oxml.table.CT_VMerge
docx.oxml.table.CT_VerticalJc
docx.oxml.text.font.CT_Color
docx.oxml.text.font.CT_Fonts
docx.oxml.text.font.CT_Highlight
docx.oxml.text.font.CT_HpsMeasure
docx.oxml.text.font.CT_RPr
docx.oxml.text.font.CT_Underline
docx.oxml.text.font.CT_VerticalAlignRun
docx.oxml.text.paragraph.CT_P
docx.oxml.text.parfmt.CT_Ind
docx.oxml.text.parfmt.CT_Jc
docx.oxml.text.parfmt.CT_PPr
docx.oxml.text.parfmt.CT_Spacing
docx.oxml.text.parfmt.CT_TabStop
docx.oxml.text.parfmt.CT_TabStops
docx.oxml.text.run.CT_Br
docx.oxml.text.run.CT_R
docx.oxml.text.run.CT_Text
◆str
docx.opc.packuri.PackURI
docx.oxml.ns.NamespacePrefixedTag
◆tuple
docx.shared.RGBColor
◆-- External class, not in docx module
序号 | 类别 | 数量 |
---|---|---|
4 | str | 5 |
6 | list | 1 |
8 | dict | 1 |
9 | module | 19 |
10 | class | 2 |
11 | function | 1 |
13 | residual | 3 |
14 | system | 10 |
16 | all | 32 |
docx, fullname=docx, file=docx_init_.py
opc, fullname=docx.opc, file=docx\opc_init_.py
compat, fullname=docx.compat, file=docx\compat.py
提供Python 2/3兼容性对象
shared, fullname=docx.shared, file=docx\shared.py
docx模块共享的对象。
image, fullname=docx.image, file=docx\image_init_.py
提供可以根据内容类型和大小来描述图像流的对象,作为在文档中包含它们的必要步骤。
exceptions, fullname=docx.exceptions, file=docx\exceptions.py
python-docx使用的异常。基异常类是PythonDocxError。
enum, fullname=docx.enum, file=docx\enum_init_.py
python-docx中使用的枚举
oxml, fullname=docx.oxml, file=docx\oxml_init_.py
初始化oxml子包,包括注册对应于Open XML元素的自定义元素类。
parts, fullname=docx.parts, file=docx\parts_init_.py
package, fullname=docx.package, file=docx\package.py
Wordprocessing ML Package 包类和相关对象
api, fullname=docx.api, file=docx\api.py
直接公开API函数和类:func:`Document`。提供一个语法上更方便的API来与OpcPackage图交互。
text, fullname=docx.text, file=docx\text_init_.py
dml, fullname=docx.dml, file=docx\dml_init_.py
shape, fullname=docx.shape, file=docx\shape.py
与形状相关的对象,出现在文档的绘图层上的可视对象。
blkcntnr, fullname=docx.blkcntnr, file=docx\blkcntnr.py
块项目容器,用于主体,单元格,标题等。块级项目包括段落和表格,尽管还有其他一些特殊的项目,如结构化文档标记。
section, fullname=docx.section, file=docx\section.py
|Section|对象和相关的代理类
document, fullname=docx.document, file=docx\document.py
|Document|及密切相关的对象
settings, fullname=docx.settings, file=docx\settings.py
对象,提供对文档级设置的访问
styles, fullname=docx.styles, file=docx\styles_init_.py
docx的子包模块,样式子包docx.styles。
table, fullname=docx.table, file=docx\table.py
|Table|对象和相关的代理类。
Document(docx=None), module=docx.api, line:17 at site-packages\docx\api.py
返回一个从 *docx* 加载的|Document|对象,其中*docx*可以是一个``.docx`` 文件(字符串)的路径或一个类文件对象。
如果*docx*缺失或“None”,则加载内置的默认文档“template”。
RELATIONSHIP_TYPE, docx.opc.constants.RELATIONSHIP_TYPE, module=docx.opc.constants
1 AUDIO kind:data type:str class:
2 A_F_CHUNK kind:data type:str class:
3 CALC_CHAIN kind:data type:str class:
4 CERTIFICATE kind:data type:str class:
5 CHART kind:data type:str class:
6 CHARTSHEET kind:data type:str class:
7 CHART_USER_SHAPES kind:data type:str class:
8 COMMENTS kind:data type:str class:
9 COMMENT_AUTHORS kind:data type:str class:
10 CONNECTIONS kind:data type:str class:
11 CONTROL kind:data type:str class:
12 CORE_PROPERTIES kind:data type:str class:
13 CUSTOM_PROPERTIES kind:data type:str class:
14 CUSTOM_PROPERTY kind:data type:str class:
15 CUSTOM_XML kind:data type:str class:
16 CUSTOM_XML_PROPS kind:data type:str class:
17 DIAGRAM_COLORS kind:data type:str class:
18 DIAGRAM_DATA kind:data type:str class:
19 DIAGRAM_LAYOUT kind:data type:str class:
20 DIAGRAM_QUICK_STYLE kind:data type:str class:
21 DIALOGSHEET kind:data type:str class:
22 DRAWING kind:data type:str class:
23 ENDNOTES kind:data type:str class:
24 EXTENDED_PROPERTIES kind:data type:str class:
25 EXTERNAL_LINK kind:data type:str class:
26 FONT kind:data type:str class:
27 FONT_TABLE kind:data type:str class:
28 FOOTER kind:data type:str class:
29 FOOTNOTES kind:data type:str class:
30 GLOSSARY_DOCUMENT kind:data type:str class:
31 HANDOUT_MASTER kind:data type:str class:
32 HEADER kind:data type:str class:
33 HYPERLINK kind:data type:str class:
34 IMAGE kind:data type:str class:
35 NOTES_MASTER kind:data type:str class:
36 NOTES_SLIDE kind:data type:str class:
37 NUMBERING kind:data type:str class:
38 OFFICE_DOCUMENT kind:data type:str class:
39 OLE_OBJECT kind:data type:str class:
40 ORIGIN kind:data type:str class:
41 PACKAGE kind:data type:str class:
42 PIVOT_CACHE_DEFINITION kind:data type:str class:
43 PIVOT_CACHE_RECORDS kind:data type:str class:
44 PIVOT_TABLE kind:data type:str class:
45 PRES_PROPS kind:data type:str class:
46 PRINTER_SETTINGS kind:data type:str class:
47 QUERY_TABLE kind:data type:str class:
48 REVISION_HEADERS kind:data type:str class:
49 REVISION_LOG kind:data type:str class:
50 SETTINGS kind:data type:str class:
51 SHARED_STRINGS kind:data type:str class:
52 SHEET_METADATA kind:data type:str class:
53 SIGNATURE kind:data type:str class:
54 SLIDE kind:data type:str class:
55 SLIDE_LAYOUT kind:data type:str class:
56 SLIDE_MASTER kind:data type:str class:
57 SLIDE_UPDATE_INFO kind:data type:str class:
58 STYLES kind:data type:str class:
59 TABLE kind:data type:str class:
60 TABLE_SINGLE_CELLS kind:data type:str class:
61 TABLE_STYLES kind:data type:str class:
62 TAGS kind:data type:str class:
63 THEME kind:data type:str class:
64 THEME_OVERRIDE kind:data type:str class:
65 THUMBNAIL kind:data type:str class:
66 USERNAMES kind:data type:str class:
67 VIDEO kind:data type:str class:
68 VIEW_PROPS kind:data type:str class:
69 VML_DRAWING kind:data type:str class:
70 VOLATILE_DEPENDENCIES kind:data type:str class:
71 WEB_SETTINGS kind:data type:str class:
72 WORKSHEET_SOURCE kind:data type:str class:
73 XML_MAPS kind:data type:str class:
ImagePart, docx.parts.image.ImagePart, module=docx.parts.image
图像部分。对应关系的目标部分,类型为 RELATIONSHIP_TYPE.IMAGE。
1 default_cx=
kind:property type:property class:
2 default_cy=kind:property type:property class:
3 filename=kind:property type:property class:
4 image=kind:property type:property class:
5 sha1=kind:property type:property class:
6 from_image()
kind=class method class=ImagePart objtype=classmethod
classmethod(function) -> method
转换函数为类方法。
类方法接收类作为隐式的第一个参数,就像实例方法接收实例一样。
要声明一个类方法,请使用这个习惯用法:
它可以在类上(例如C.f())或在实例上(例如C().f())被调用。除了它的类,实例将被忽略。
如果为派生类调用类方法,则派生类对象将作为隐含的第一个参数传递。类方法不同于c++或Java的静态方法。
如果你想要这些,请查看内置的staticmethod。
7 load()
kind=class method class=ImagePart objtype=classmethod
序号 | 类别 | 数量 |
---|---|---|
4 | str | 4 |
6 | list | 1 |
8 | dict | 1 |
9 | module | 15 |
13 | residual | 3 |
14 | system | 9 |
16 | all | 24 |
opc, fullname=docx.opc, file=docx\opc_init_.py
constants, fullname=docx.opc.constants, file=docx\opc\constants.py
与开放包装公约相关的常量值,特别是内容类型和关系类型。
packuri, fullname=docx.opc.packuri, file=docx\opc\packuri.py
提供PackURI值类型以及一些有用的已知包URI字符串,如 PACKAGE_URI。
compat, fullname=docx.opc.compat, file=docx\opc\compat.py
提供Python 2/3兼容性对象
oxml, fullname=docx.opc.oxml, file=docx\opc\oxml.py
PackageReader移植时遇到的主要oxml模块的临时替代品。
可能大部分内容将被来自pptx.oxml.core的对象替换,然后这个模块要么被删除,要么只保存包相关的自定义元素类。
rel, fullname=docx.opc.rel, file=docx\opc\rel.py
Relationship-related对象。
shared, fullname=docx.opc.shared, file=docx\opc\shared.py
opc模块共享的对象。
part, fullname=docx.opc.part, file=docx\opc\part.py
与包装部件相关的OPC (Open Packaging Convention)对象。
parts, fullname=docx.opc.parts, file=docx\opc\parts_init_.py
coreprops, fullname=docx.opc.coreprops, file=docx\opc\coreprops.py
:mod:`pptx.packaging` 模块围绕着从.pptx文件中读取和写入演示文稿的关注点。
exceptions, fullname=docx.opc.exceptions, file=docx\opc\exceptions.py
python-opc特有的异常基异常类是OpcError。
phys_pkg, fullname=docx.opc.phys_pkg, file=docx\opc\phys_pkg.py
提供一个 *physical* OPC包的通用接口,例如zip文件。
pkgreader, fullname=docx.opc.pkgreader, file=docx\opc\pkgreader.py
为序列化的开放打包约定(OPC)包提供低级的只读API。
OPC——Open Packaging Convention——开放打包约定
spec, fullname=docx.opc.spec, file=docx\opc\spec.py
提供包含开放XML规范ISO/IEC 29500方面的映射。
pkgwriter, fullname=docx.opc.pkgwriter, file=docx\opc\pkgwriter.py
为序列化的开放打包约定(OPC)包提供一个低级的、只写的API,本质上是OpcPackage.save()的实现。
package, fullname=docx.opc.package, file=docx\opc\package.py
实现读写OPC包的对象。
序号 | 类别 | 数量 |
---|---|---|
4 | str | 5 |
8 | dict | 1 |
9 | module | 1 |
10 | class | 3 |
11 | function | 1 |
13 | residual | 6 |
14 | system | 8 |
16 | all | 17 |
compat, fullname=docx.compat, file=docx\compat.py
提供Python 2/3兼容性对象
sys, fullname=sys, file=
这个模块提供了对解释器使用或维护的一些对象的访问,以及对与解释器强烈交互的函数的访问。
参见:sys 模块。
is_string(obj), module=docx.compat, line:20 at site-packages\docx\compat.py
如果*obj*是字符串则返回True,否则返回False。
Sequence, collections.abc.Sequence, module=collections.abc, line:-1 at collections\abc.py
对只读序列的所有操作。具体的子类必须重写 __new__ 或 __init__, __getitem__, 和 __len__.
1 count()
kind=method class=Sequence objtype=function
S.count(value) -> integer -返回值的出现次数
2 index()
kind=method class=Sequence objtype=function
S.index(value, [start, [stop]]) -> integer -返回值的第一个索引。
如果值不存在则引发ValueError。支持start和stop参数是可选的,但推荐使用。
BytesIO, _io.BytesIO, module=_io
使用内存字节缓冲区的缓冲I/O实现。
1 closed=
kind:data type:getset_descriptor class:
2 close(self, *args, **kwargs)
kind=method class=BytesIO objtype=method_descriptor line:772 at …-1026899380_io.py
禁用所有I/O操作。
3 flush(self, *args, **kwargs)
kind=method class=BytesIO objtype=method_descriptor line:776 at …-1026899380_io.py
什么也不做。
4 getbuffer(self, *args, **kwargs)
kind=method class=BytesIO objtype=method_descriptor line:780 at …-1026899380_io.py
获取BytesIO对象内容的读写视图。
5 getvalue(self, *args, **kwargs)
kind=method class=BytesIO objtype=method_descriptor line:784 at …-1026899380_io.py
检索BytesIO对象的全部内容。
6 isatty(self, *args, **kwargs)
kind=method class=BytesIO objtype=method_descriptor line:788 at …-1026899380_io.py
总是返回False。BytesIO对象没有连接到类似tty的设备。
7 read(self, *args, **kwargs)
kind=method class=BytesIO objtype=method_descriptor line:796 at …-1026899380_io.py
读取最多大小字节,作为bytes对象返回。如果size参数为负,则读取直到到达EOF。在EOF处返回一个空字节对象。
8 read1(self, *args, **kwargs)
kind=method class=BytesIO objtype=method_descriptor line:805 at …-1026899380_io.py
读取最多大小字节,作为bytes对象返回。如果size参数为负或省略,则读取直到到达EOF。在EOF处返回一个空字节对象。
9 readable(self, *args, **kwargs)
kind=method class=BytesIO objtype=method_descriptor line:814 at …-1026899380_io.py
如果IO对象可以读取,则返回True。
10 readinto(self, *args, **kwargs)
kind=method class=BytesIO objtype=method_descriptor line:818 at …-1026899380_io.py
将字节读入缓冲区。返回读取的字节数(EOF为0),如果对象设置为不阻塞且没有数据要读取,则返回None。
11 readline(self, *args, **kwargs)
kind=method class=BytesIO objtype=method_descriptor line:827 at …-1026899380_io.py
文件中的下一行,作为一个字节对象。保留换行符。非负的size参数限制要返回的最大字节数(这时可能返回不完整的行)。在EOF处返回一个空字节对象。
12 readlines(self, *args, **kwargs)
kind=method class=BytesIO objtype=method_descriptor line:837 at …-1026899380_io.py
bytes对象列表,每一行从文件开始。反复调用readline()并返回已读取的行列表。如果给出可选的size参数,则是返回行的总字节数的近似边界。
13 seek(self, *args, **kwargs)
kind=method class=BytesIO objtype=method_descriptor line:847 at …-1026899380_io.py
改变流位置。参见 io 模块。
14 seekable(self, *args, **kwargs)
kind=method class=BytesIO objtype=method_descriptor line:859 at …-1026899380_io.py
如果IO对象可以被查找,则返回True。
15 tell(self, *args, **kwargs)
kind=method class=BytesIO objtype=method_descriptor line:863 at …-1026899380_io.py
参见 io 模块。
16 truncate(self, *args, **kwargs)
kind=method class=BytesIO objtype=method_descriptor line:867 at …-1026899380_io.py
将文件截断为最多字节大小。Size默认为当前文件位置,由tell()返回。当前文件位置不变。返回新的大小。
17 writable(self, *args, **kwargs)
kind=method class=BytesIO objtype=method_descriptor line:876 at …-1026899380_io.py
如果IO对象可以写入,则返回True。
18 write(self, *args, **kwargs)
kind=method class=BytesIO objtype=method_descriptor line:880 at …-1026899380_io.py
将字节写入文件。返回写入的字节数。
19 writelines(self, *args, **kwargs)
kind=method class=BytesIO objtype=method_descriptor line:888 at …-1026899380_io.py
向文件中写入行。注意,没有添加换行符。行可以是任何产生字节类对象的可迭代对象。这相当于为每个元素调用write()。
str, str, module=builtins
str(object=) -> str str(bytes or buffer[, encoding[, errors]]) -> str
从给定对象中创建一个新的字符串对象。参见:str
1 capitalize()
kind=method class=str objtype=method_descriptor
返回字符串的大写版本。更具体地说,使第一个字符大写,其余字符小写。
2 casefold()
kind=method class=str objtype=method_descriptor
返回适合于无大小写比较的字符串版本。
3 center()
kind=method class=str objtype=method_descriptor
返回长度为width的居中字符串。填充使用指定的填充字符(默认为空格)。
4 count()
kind=method class=str objtype=method_descriptor
S.count(sub[, start[, end]]) -> int
返回子字符串sub在字符串S[start:end]中不重叠出现的次数。可选参数start和end被解释为片表示法。
5 encode()
kind=method class=str objtype=method_descriptor
使用为编码注册的编解码器对字符串进行编码。encoding对字符串进行编码的编码。
用于编码错误的错误处理方案。默认值是'strict',这意味着编码错误会引发UnicodeEncodeError。
其他可能的值是'ignore', 'replace'和'xmlcharrefreplace'以及任何其他用编解码器注册的名称。寄存器错误,可以处理UnicodeEncodeErrors。
6 endswith()
kind=method class=str objtype=method_descriptor
S.endswith(suffix[, start[, end]]) -> bool
如果S以指定后缀结束则返回True,否则返回False。使用可选启动,测试S从该位置开始。
使用可选结束,在该位置停止比较S。Suffix也可以是字符串的元组来尝试。
7 expandtabs()
kind=method class=str objtype=method_descriptor
返回一个副本,其中所有制表符都使用空格展开。如果没有给出tabsize,则假定制表符大小为8个字符。
8 find()
kind=method class=str objtype=method_descriptor
S.find(sub[, start[, end]]) -> int
返回S中找到子字符串sub的最低索引,使sub包含在S[start:end]中。可选参数start和end被解释为片表示法。失败时返回-1。
9 format()
kind=method class=str objtype=method_descriptor
S.format(*args, **kwargs) -> str
返回S的格式化版本,使用args和kwargs的替换。替换由大括号('{'和'}')标识。
10 format_map()
kind=method class=str objtype=method_descriptor
S.format map(mapping) -> str
返回S的格式化版本,使用mapping中的替换。替换由大括号('{'和'}')标识。
11 index()
kind=method class=str objtype=method_descriptor
S.index(sub[, start[, end]]) -> int
返回S中子串sub所在位置的最低索引,使sub包含在S[start:end]中。可选参数start和end被解释为片表示法。当子字符串未找到时引发ValueError。
12 isalnum()
kind=method class=str objtype=method_descriptor
如果字符串是字母-数字字符串则返回True,否则返回False。如果字符串中的所有字符都是字母-数字,并且字符串中至少有一个字符,则字符串为字母-数字。
13 isalpha()
kind=method class=str objtype=method_descriptor
如果字符串是字母字符串则返回True,否则返回False。如果字符串中的所有字符都是字母,并且字符串中至少有一个字符,则字符串为字母字符串。
14 isascii()
kind=method class=str objtype=method_descriptor
如果字符串中的所有字符都是ASCII,则返回True,否则返回False。ASCII字符的码位范围为U+0000-U+007F。空字符串也是ASCII。
15 isdecimal()
kind=method class=str objtype=method_descriptor
如果字符串是十进制字符串则返回True,否则返回False。如果字符串中的所有字符都是十进制,并且字符串中至少有一个字符,则字符串是十进制字符串。
16 isdigit()
kind=method class=str objtype=method_descriptor
如果字符串是数字字符串则返回True,否则返回False。如果字符串中的所有字符都是数字,并且字符串中至少有一个字符,则字符串是数字字符串。
17 isidentifier()
kind=method class=str objtype=method_descriptor
如果字符串是有效的Python标识符,则返回True,否则返回False。使用keyword.iskeyword()测试保留的标识符,如“def”和“class”。
18 islower()
kind=method class=str objtype=method_descriptor
如果字符串是小写字符串则返回True,否则返回False。如果字符串中所有的分大小写字符都是小写的,并且字符串中至少有一个分大小写字符,则字符串是小写的。
19 isnumeric()
kind=method class=str objtype=method_descriptor
如果字符串是数字字符串则返回True,否则返回False。如果字符串中的所有字符都是数字,并且字符串中至少有一个字符,则字符串为数字。
20 isprintable()
kind=method class=str objtype=method_descriptor
如果字符串是可打印的返回True,否则返回False。如果一个字符串的所有字符在repr()中都被认为是可打印的,或者字符串为空,则该字符串是可打印的。
21 isspace()
kind=method class=str objtype=method_descriptor
如果字符串是空白字符串则返回True,否则返回False。如果字符串中所有字符都是空白,并且字符串中至少有一个字符,则字符串为空白。
22 istitle()
kind=method class=str objtype=method_descriptor
如果字符串是标题大小写字符串,则返回True,否则返回False。在标题大小写字符串中,大写字符和标题大小写字符只能跟在无大小写字符后面,小写字符只能跟在有大小写字符后面。
23 isupper()
kind=method class=str objtype=method_descriptor
如果字符串是大写字串则返回True,否则返回False。如果字符串中所有的大小写字符都是大写字符,并且字符串中至少有一个大小写字符,则字符串为大写字符。
24 join()
kind=method class=str objtype=method_descriptor
Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'
25 ljust()
kind=method class=str objtype=method_descriptor
返回一个长度为width的左对齐字符串。填充使用指定的填充字符(默认为空格)。
26 lower()
kind=method class=str objtype=method_descriptor
返回一个转换成小写字母的字符串副本。
27 lstrip()
kind=method class=str objtype=method_descriptor
返回删除前导空格的字符串副本。如果给出了chars而不是None,则改为删除chars中的字符。
28 partition()
kind=method class=str objtype=method_descriptor
使用给定的分隔符将字符串分成三部分。这将搜索字符串中的分隔符。如果找到分隔符,则返回一个3元组,其中包含分隔符之前的部分、分隔符本身和分隔符之后的部分。如果分隔符未找到,则返回一个包含原始字符串和两个空字符串的3元组。
29 replace()
kind=method class=str objtype=method_descriptor
返回一个副本,将所有出现的子字符串old替换为new。count最大替换次数。-1(默认值)表示替换所有出现的情况。
如果给出了可选参数count,则只替换第一次出现的计数。
30 rfind()
kind=method class=str objtype=method_descriptor
S.rfind(sub[, start[, end]]) -> int
返回S中子字符串sub所在位置的最高索引,使sub包含在S[start:end]中。可选参数start和end被解释为片表示法。失败时返回-1。
31 rindex()
kind=method class=str objtype=method_descriptor
S.rindex(sub[, start[, end]]) -> int
返回S中子串sub所在位置的最高索引,使sub包含在S[start:end]中。可选参数start和end被解释为片表示法。当子字符串未找到时引发ValueError。
32 rjust()
kind=method class=str objtype=method_descriptor
返回一个长度为width的右对齐字符串。填充使用指定的填充字符(默认为空格)。
33 rpartition()
kind=method class=str objtype=method_descriptor
使用给定的分隔符将字符串分成三部分。这将搜索字符串中的分隔符,从末尾开始。
如果找到分隔符,则返回一个3元组,其中包含分隔符之前的部分、分隔符本身和分隔符之后的部分。如果分隔符未找到,则返回包含两个空字符串和原始字符串的3元组。
34 rsplit()
kind=method class=str objtype=method_descriptor
返回字符串中的单词列表,使用sep作为分隔符字符串。sep分隔符,用于分隔字符串。None(默认值)表示根据任何空白进行分割,并丢弃结果中的空字符串。
maxsplit最大拆分次数。-1(默认值)表示没有限制。劈叉是从弦的末端开始,一直到前面。
35 rstrip()
kind=method class=str objtype=method_descriptor
返回一个删除了尾随空格的字符串副本。如果给出了chars而不是None,则改为删除chars中的字符。
36 split()
kind=method class=str objtype=method_descriptor
返回字符串中的单词列表,使用sep作为分隔符字符串。sep分隔符,用于分隔字符串。
None(默认值)表示根据任何空白进行分割,并丢弃结果中的空字符串。maxsplit最大拆分次数。-1(默认值)表示没有限制。
37 splitlines()
kind=method class=str objtype=method_descriptor
返回字符串中的行列表,在行边界处断行。结果列表中不包括换行符,除非给出keepends并为true。
38 startswith()
kind=method class=str objtype=method_descriptor
S.startswith(prefix[, start[, end]]) -> bool
如果S以指定的前缀开始返回True,否则返回False。使用可选启动,测试S从该位置开始。使用可选结束,在该位置停止比较S。前缀也可以是字符串的元组来尝试。
39 strip()
kind=method class=str objtype=method_descriptor
返回删除前导和尾随空格的字符串副本。如果给出了chars而不是None,则改为删除chars中的字符。
40 swapcase()
kind=method class=str objtype=method_descriptor
将大写字符转换为小写字符,将小写字符转换为大写字符。
41 title()
kind=method class=str objtype=method_descriptor
返回字符串的一个版本,其中每个单词都有标题。更具体地说,单词以大写字符开头,其余的大小写字符都是小写字符。
42 translate()
kind=method class=str objtype=method_descriptor
使用给定的转换表替换字符串中的每个字符。table转换表,必须是Unicode序数到Unicode序数、字符串或None的映射。
表必须通过getitem实现查找/索引,例如字典或列表。如果此操作引发LookupError,则该字符将保持不变。映射为None的字符将被删除。
43 upper()
kind=method class=str objtype=method_descriptor
返回一个转换为大写字母的字符串副本。
44 zfill()
kind=method class=str objtype=method_descriptor
填充数字字符串左侧的零,以填充给定宽度的字段。字符串永远不会被截断。
45 maketrans()
kind=static method class=str objtype=staticmethod
6 loader <_frozen_importlib_external.SourceFileLoader object at 0x0000000003928708>
7 spec ModuleSpec(name=‘docx.compat’, loader=<_frozen_importlib_external.SourceFileLoader object at 0x0000000003928708>, origin=‘…\lib\site-packages\docx\compat.py’)
8 absolute_import _Feature((2, 5, 0, ‘alpha’, 1), (3, 0, 0, ‘alpha’, 0), 16384)
9 division _Feature((2, 2, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 8192)
10 print_function _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 65536)
11 unicode_literals _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 131072)
序号 | 类别 | 数量 |
---|---|---|
4 | str | 5 |
8 | dict | 1 |
10 | class | 10 |
11 | function | 2 |
13 | residual | 5 |
14 | system | 8 |
16 | all | 23 |
shared, fullname=docx.shared, file=docx\shared.py
docx模块共享的对象。
lazyproperty(f), module=docx.shared, line:158 at site-packages\docx\shared.py
@lazyprop装饰器。
方法将只在第一次访问时调用,以计算缓存的属性值。之后,返回缓存的值。
write_only_property(f), module=docx.shared, line:178 at site-packages\docx\shared.py
只写属性装饰器。创建接受赋值的属性(描述符属性),但不接受getattr(在表达式中使用)。
Length, docx.shared.Length, module=docx.shared
长度构造函数类Inch、Cm、Mm、Px和Emu的基类。表现为英制公制单位的int计数,英寸为914,400,毫米为36,000。
以只读属性的形式提供方便的单位转换方法。不可变的。
1 cm=
kind:property type:property class:
2 emu=kind:property type:property class:
3 inches=kind:property type:property class:
4 mm=kind:property type:property class:
5 pt=kind:property type:property class:
6 twips=kind:property type:property class:
Inches, docx.shared.Inches, module=docx.shared
以英寸为单位的长度方便构造函数,例如。``width = Inches(0.5)``。
Cm, docx.shared.Cm, module=docx.shared
以厘米为单位的方便构造函数,例如。``height = Cm(12)``。
Emu, docx.shared.Emu, module=docx.shared
长度的英文公制单位的方便构造函数,例如。``width = Emu(457200)``。
Mm, docx.shared.Mm, module=docx.shared
以毫米为单位的长度方便构造函数,例如。``width = Mm(240.5)``。
Pt, docx.shared.Pt, module=docx.shared
方便值类,用于指定以点为单位的长度
Twips, docx.shared.Twips, module=docx.shared
长度单位为twips的方便构造函数,例如 ``width = Twips(42)``。twip是二十分之一点,635 EMU。
RGBColor, docx.shared.RGBColor, module=docx.shared
定义特定RGB颜色的不可变值对象。
1 from_string()
kind=class method class=RGBColor objtype=classmethod
ElementProxy, docx.shared.ElementProxy, module=docx.shared
lxml元素代理类的基类。元素代理类的主要职责是操作XML元素的属性和子元素。它们是python-docx中除了自定义元素(oxml)类之外最常见类的类型。
1 element=
kind:property type:property class:
2 part=kind:property type:property class:
Parented, docx.shared.Parented, module=docx.shared
为部分下面出现的文档元素提供公共服务,但偶尔可能需要一个祖先对象来提供服务,例如添加或删除关系。提供了``self._parent``属性给子类。
1 part=
kind:property type:property class:
13 loader <_frozen_importlib_external.SourceFileLoader object at 0x0000000003928A08>
14 spec ModuleSpec(name=‘docx.shared’, loader=<_frozen_importlib_external.SourceFileLoader object at 0x0000000003928A08>, origin=‘…\lib\site-packages\docx\shared.py’)
15 absolute_import _Feature((2, 5, 0, ‘alpha’, 1), (3, 0, 0, ‘alpha’, 0), 16384)
16 print_function _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 65536)
17 unicode_literals _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 131072)
序号 | 类别 | 数量 |
---|---|---|
4 | str | 5 |
5 | tuple | 1 |
6 | list | 1 |
8 | dict | 1 |
9 | module | 9 |
10 | class | 6 |
13 | residual | 6 |
14 | system | 9 |
16 | all | 29 |
image, fullname=docx.image, file=docx\image_init_.py
提供可以将图像流描述为内容类型和对象大小,作为在文档中包含它们的必要步骤。
1 SIGNATURES (( constants, fullname=docx.image.constants, file=docx\image\constants.py exceptions, fullname=docx.image.exceptions, file=docx\image\exceptions.py helpers, fullname=docx.image.helpers, file=docx\image\helpers.py image, fullname=docx.image.image, file=docx\image\image.py bmp, fullname=docx.image.bmp, file=docx\image\bmp.py gif, fullname=docx.image.gif, file=docx\image\gif.py tiff, fullname=docx.image.tiff, file=docx\image\tiff.py jpeg, fullname=docx.image.jpeg, file=docx\image\jpeg.py png, fullname=docx.image.png, file=docx\image\png.py Bmp, docx.image.bmp.Bmp, module=docx.image.bmp 1 content_type= kind=class method class=Bmp objtype=classmethod Gif, docx.image.gif.Gif, module=docx.image.gif 1 content_type= kind=class method class=Gif objtype=classmethod Exif, docx.image.jpeg.Exif, module=docx.image.jpeg kind=class method class=Exif objtype=classmethod Jfif, docx.image.jpeg.Jfif, module=docx.image.jpeg kind=class method class=Jfif objtype=classmethod Png, docx.image.png.Png, module=docx.image.png 1 content_type= kind=class method class=Png objtype=classmethod Tiff, docx.image.tiff.Tiff, module=docx.image.tiff 1 content_type= kind=class method class=Tiff objtype=classmethod 17 loader <_frozen_importlib_external.SourceFileLoader object at 0x0000000003914FC8> exceptions, fullname=docx.exceptions, file=docx\exceptions.py PythonDocxError, docx.exceptions.PythonDocxError, module=docx.exceptions InvalidSpanError, docx.exceptions.InvalidSpanError, module=docx.exceptions InvalidXmlError, docx.exceptions.InvalidXmlError, module=docx.exceptions enum, fullname=docx.enum, file=docx\enum_init_.py base, fullname=docx.enum.base, file=docx\enum\base.py section, fullname=docx.enum.section, file=docx\enum\section.py style, fullname=docx.enum.style, file=docx\enum\style.py table, fullname=docx.enum.table, file=docx\enum\table.py dml, fullname=docx.enum.dml, file=docx\enum\dml.py text, fullname=docx.enum.text, file=docx\enum\text.py shape, fullname=docx.enum.shape, file=docx\enum\shape.py Enumeration, docx.enum.Enumeration, module=docx.enum kind=class method class=Enumeration objtype=classmethod kind=class method class=Enumeration objtype=classmethod 9 loader <_frozen_importlib_external.SourceFileLoader object at 0x0000000003A5D5C8> oxml, fullname=docx.oxml, file=docx\oxml_init_.py 1 nsmap {‘a’: ‘http://schemas.openxmlformats.org/drawingml/2006/main’, ‘c’: 'http://sche… etree, fullname=lxml.etree, file=lxml\etree.cp37-win_amd64.pyd ns, fullname=docx.oxml.ns, file=docx\oxml\ns.py simpletypes, fullname=docx.oxml.simpletypes, file=docx\oxml\simpletypes.py exceptions, fullname=docx.oxml.exceptions, file=docx\oxml\exceptions.py xmlchemy, fullname=docx.oxml.xmlchemy, file=docx\oxml\xmlchemy.py shared, fullname=docx.oxml.shared, file=docx\oxml\shared.py coreprops, fullname=docx.oxml.coreprops, file=docx\oxml\coreprops.py document, fullname=docx.oxml.document, file=docx\oxml\document.py numbering, fullname=docx.oxml.numbering, file=docx\oxml\numbering.py section, fullname=docx.oxml.section, file=docx\oxml\section.py settings, fullname=docx.oxml.settings, file=docx\oxml\settings.py shape, fullname=docx.oxml.shape, file=docx\oxml\shape.py styles, fullname=docx.oxml.styles, file=docx\oxml\styles.py table, fullname=docx.oxml.table, file=docx\oxml\table.py text, fullname=docx.oxml.text, file=docx\oxml\text_init_.py parse_xml(xml), module=docx.oxml, line:21 at site-packages\docx\oxml_init_.py register_element_cls(tag, cls), module=docx.oxml, line:32 at site-packages\docx\oxml_init_.py OxmlElement(nsptag_str, attrs=None, nsdecls=None), module=docx.oxml, line:43 at site-packages\docx\oxml_init_.py NamespacePrefixedTag, docx.oxml.ns.NamespacePrefixedTag, module=docx.oxml.ns 1 clark_name= kind=class method class=NamespacePrefixedTag objtype=classmethod CT_DecimalNumber, docx.oxml.shared.CT_DecimalNumber, module=docx.oxml.shared 1 val= kind=class method class=CT_DecimalNumber objtype=classmethod CT_OnOff, docx.oxml.shared.CT_OnOff, module=docx.oxml.shared 1 val= CT_String, docx.oxml.shared.CT_String, module=docx.oxml.shared 1 val= kind=class method class=CT_String objtype=classmethod CT_CoreProperties, docx.oxml.coreprops.CT_CoreProperties, module=docx.oxml.coreprops 1 author_text= kind=method class=CT_CoreProperties objtype=function kind=method class=CT_CoreProperties objtype=function kind=method class=CT_CoreProperties objtype=function kind=method class=CT_CoreProperties objtype=function kind=method class=CT_CoreProperties objtype=function kind=method class=CT_CoreProperties objtype=function kind=method class=CT_CoreProperties objtype=function kind=method class=CT_CoreProperties objtype=function kind=method class=CT_CoreProperties objtype=function kind=method class=CT_CoreProperties objtype=function kind=method class=CT_CoreProperties objtype=function kind=method class=CT_CoreProperties objtype=function kind=method class=CT_CoreProperties objtype=function kind=method class=CT_CoreProperties objtype=function kind=method class=CT_CoreProperties objtype=function kind=class method class=CT_CoreProperties objtype=classmethod CT_Body, docx.oxml.document.CT_Body, module=docx.oxml.document 1 p_lst= kind=method class=CT_Body objtype=function kind=method class=CT_Body objtype=function kind=method class=CT_Body objtype=function kind=method class=CT_Body objtype=function kind=method class=CT_Body objtype=function CT_Document, docx.oxml.document.CT_Document, module=docx.oxml.document 1 body= kind=method class=CT_Document objtype=function CT_Num, docx.oxml.numbering.CT_Num, module=docx.oxml.numbering 1 abstractNumId= kind=method class=CT_Num objtype=function kind=class method class=CT_Num objtype=classmethod CT_Numbering, docx.oxml.numbering.CT_Numbering, module=docx.oxml.numbering 1 num_lst= kind=method class=CT_Numbering objtype=function kind=method class=CT_Numbering objtype=function CT_NumLvl, docx.oxml.numbering.CT_NumLvl, module=docx.oxml.numbering 1 ilvl= kind=method class=CT_NumLvl objtype=function kind=method class=CT_NumLvl objtype=function CT_NumPr, docx.oxml.numbering.CT_NumPr, module=docx.oxml.numbering 1 ilvl= kind=method class=CT_NumPr objtype=function kind=method class=CT_NumPr objtype=function CT_HdrFtr, docx.oxml.section.CT_HdrFtr, module=docx.oxml.section 1 p_lst= kind=method class=CT_HdrFtr objtype=function kind=method class=CT_HdrFtr objtype=function CT_HdrFtrRef, docx.oxml.section.CT_HdrFtrRef, module=docx.oxml.section 1 rId= CT_PageMar, docx.oxml.section.CT_PageMar, module=docx.oxml.section 1 bottom= CT_PageSz, docx.oxml.section.CT_PageSz, module=docx.oxml.section 1 h= CT_SectPr, docx.oxml.section.CT_SectPr, module=docx.oxml.section 1 bottom_margin= kind=method class=CT_SectPr objtype=function kind=method class=CT_SectPr objtype=function kind=method class=CT_SectPr objtype=function kind=method class=CT_SectPr objtype=function kind=method class=CT_SectPr objtype=function kind=method class=CT_SectPr objtype=function kind=method class=CT_SectPr objtype=function kind=method class=CT_SectPr objtype=function kind=method class=CT_SectPr objtype=function kind=method class=CT_SectPr objtype=function kind=method class=CT_SectPr objtype=function CT_SectType, docx.oxml.section.CT_SectType, module=docx.oxml.section 1 val= CT_Settings, docx.oxml.settings.CT_Settings, module=docx.oxml.settings 1 evenAndOddHeaders= kind=method class=CT_Settings objtype=function CT_Blip, docx.oxml.shape.CT_Blip, module=docx.oxml.shape 1 embed= CT_BlipFillProperties, docx.oxml.shape.CT_BlipFillProperties, module=docx.oxml.shape 1 blip= kind=method class=CT_BlipFillProperties objtype=function CT_GraphicalObject, docx.oxml.shape.CT_GraphicalObject, module=docx.oxml.shape 1 graphicData= CT_GraphicalObjectData, docx.oxml.shape.CT_GraphicalObjectData, module=docx.oxml.shape 1 pic= kind=method class=CT_GraphicalObjectData objtype=function CT_Inline, docx.oxml.shape.CT_Inline, module=docx.oxml.shape 1 docPr= kind=class method class=CT_Inline objtype=classmethod kind=class method class=CT_Inline objtype=classmethod CT_NonVisualDrawingProps, docx.oxml.shape.CT_NonVisualDrawingProps, module=docx.oxml.shape 1 id= CT_Picture, docx.oxml.shape.CT_Picture, module=docx.oxml.shape 1 blipFill= kind=class method class=CT_Picture objtype=classmethod CT_PictureNonVisual, docx.oxml.shape.CT_PictureNonVisual, module=docx.oxml.shape 1 cNvPr= CT_Point2D, docx.oxml.shape.CT_Point2D, module=docx.oxml.shape 1 x= CT_PositiveSize2D, docx.oxml.shape.CT_PositiveSize2D, module=docx.oxml.shape 1 cx= CT_ShapeProperties, docx.oxml.shape.CT_ShapeProperties, module=docx.oxml.shape 1 cx= kind=method class=CT_ShapeProperties objtype=function CT_Transform2D, docx.oxml.shape.CT_Transform2D, module=docx.oxml.shape 1 cx= kind=method class=CT_Transform2D objtype=function kind=method class=CT_Transform2D objtype=function CT_LatentStyles, docx.oxml.styles.CT_LatentStyles, module=docx.oxml.styles 1 count= kind=method class=CT_LatentStyles objtype=function kind=method class=CT_LatentStyles objtype=function kind=method class=CT_LatentStyles objtype=function kind=method class=CT_LatentStyles objtype=function CT_LsdException, docx.oxml.styles.CT_LsdException, module=docx.oxml.styles 1 locked= kind=method class=CT_LsdException objtype=function kind=method class=CT_LsdException objtype=function kind=method class=CT_LsdException objtype=function CT_Style, docx.oxml.styles.CT_Style, module=docx.oxml.styles 1 base_style= kind=method class=CT_Style objtype=function kind=method class=CT_Style objtype=function kind=method class=CT_Style objtype=function kind=method class=CT_Style objtype=function kind=method class=CT_Style objtype=function kind=method class=CT_Style objtype=function kind=method class=CT_Style objtype=function kind=method class=CT_Style objtype=function kind=method class=CT_Style objtype=function kind=method class=CT_Style objtype=function kind=method class=CT_Style objtype=function CT_Styles, docx.oxml.styles.CT_Styles, module=docx.oxml.styles 1 latentStyles= kind=method class=CT_Styles objtype=function kind=method class=CT_Styles objtype=function kind=method class=CT_Styles objtype=function kind=method class=CT_Styles objtype=function kind=method class=CT_Styles objtype=function kind=method class=CT_Styles objtype=function CT_Height, docx.oxml.table.CT_Height, module=docx.oxml.table 1 hRule= CT_Row, docx.oxml.table.CT_Row, module=docx.oxml.table 1 tblPrEx= kind=method class=CT_Row objtype=function kind=method class=CT_Row objtype=function kind=method class=CT_Row objtype=function kind=method class=CT_Row objtype=function CT_Tbl, docx.oxml.table.CT_Tbl, module=docx.oxml.table 1 bidiVisual_val= kind=method class=CT_Tbl objtype=function kind=method class=CT_Tbl objtype=function kind=class method class=CT_Tbl objtype=classmethod CT_TblGrid, docx.oxml.table.CT_TblGrid, module=docx.oxml.table 1 gridCol_lst= kind=method class=CT_TblGrid objtype=function CT_TblGridCol, docx.oxml.table.CT_TblGridCol, module=docx.oxml.table 1 gridCol_idx= CT_TblLayoutType, docx.oxml.table.CT_TblLayoutType, module=docx.oxml.table 1 type= CT_TblPr, docx.oxml.table.CT_TblPr, module=docx.oxml.table 1 alignment= kind=method class=CT_TblPr objtype=function kind=method class=CT_TblPr objtype=function kind=method class=CT_TblPr objtype=function kind=method class=CT_TblPr objtype=function CT_TblWidth, docx.oxml.table.CT_TblWidth, module=docx.oxml.table 1 type= CT_Tc, docx.oxml.table.CT_Tc, module=docx.oxml.table 1 bottom= kind=method class=CT_Tc objtype=function kind=method class=CT_Tc objtype=function kind=method class=CT_Tc objtype=function kind=method class=CT_Tc objtype=function kind=method class=CT_Tc objtype=function kind=method class=CT_Tc objtype=function kind=class method class=CT_Tc objtype=classmethod CT_TcPr, docx.oxml.table.CT_TcPr, module=docx.oxml.table 1 gridSpan= kind=method class=CT_TcPr objtype=function kind=method class=CT_TcPr objtype=function kind=method class=CT_TcPr objtype=function kind=method class=CT_TcPr objtype=function CT_TrPr, docx.oxml.table.CT_TrPr, module=docx.oxml.table 1 trHeight= kind=method class=CT_TrPr objtype=function CT_VMerge, docx.oxml.table.CT_VMerge, module=docx.oxml.table 1 val= CT_VerticalJc, docx.oxml.table.CT_VerticalJc, module=docx.oxml.table 1 val= CT_Color, docx.oxml.text.font.CT_Color, module=docx.oxml.text.font 1 themeColor= CT_Fonts, docx.oxml.text.font.CT_Fonts, module=docx.oxml.text.font 1 ascii= CT_Highlight, docx.oxml.text.font.CT_Highlight, module=docx.oxml.text.font 1 val= CT_HpsMeasure, docx.oxml.text.font.CT_HpsMeasure, module=docx.oxml.text.font 1 val= CT_RPr, docx.oxml.text.font.CT_RPr, module=docx.oxml.text.font 1 b= kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function kind=method class=CT_RPr objtype=function CT_Underline, docx.oxml.text.font.CT_Underline, module=docx.oxml.text.font 1 val= CT_VerticalAlignRun, docx.oxml.text.font.CT_VerticalAlignRun, module=docx.oxml.text.font 1 val= CT_P, docx.oxml.text.paragraph.CT_P, module=docx.oxml.text.paragraph 1 alignment= kind=method class=CT_P objtype=function kind=method class=CT_P objtype=function kind=method class=CT_P objtype=function kind=method class=CT_P objtype=function kind=method class=CT_P objtype=function CT_Ind, docx.oxml.text.parfmt.CT_Ind, module=docx.oxml.text.parfmt 1 firstLine= CT_Jc, docx.oxml.text.parfmt.CT_Jc, module=docx.oxml.text.parfmt 1 val= CT_PPr, docx.oxml.text.parfmt.CT_PPr, module=docx.oxml.text.parfmt 1 first_line_indent= kind=method class=CT_PPr objtype=function kind=method class=CT_PPr objtype=function kind=method class=CT_PPr objtype=function kind=method class=CT_PPr objtype=function kind=method class=CT_PPr objtype=function kind=method class=CT_PPr objtype=function kind=method class=CT_PPr objtype=function kind=method class=CT_PPr objtype=function kind=method class=CT_PPr objtype=function kind=method class=CT_PPr objtype=function kind=method class=CT_PPr objtype=function CT_Spacing, docx.oxml.text.parfmt.CT_Spacing, module=docx.oxml.text.parfmt 1 after= CT_TabStop, docx.oxml.text.parfmt.CT_TabStop, module=docx.oxml.text.parfmt 1 leader= CT_TabStops, docx.oxml.text.parfmt.CT_TabStops, module=docx.oxml.text.parfmt 1 tab_lst= kind=method class=CT_TabStops objtype=function kind=method class=CT_TabStops objtype=function CT_Br, docx.oxml.text.run.CT_Br, module=docx.oxml.text.run 1 clear= CT_R, docx.oxml.text.run.CT_R, module=docx.oxml.text.run 1 br_lst= kind=method class=CT_R objtype=function kind=method class=CT_R objtype=function kind=method class=CT_R objtype=function kind=method class=CT_R objtype=function kind=method class=CT_R objtype=function kind=method class=CT_R objtype=function kind=method class=CT_R objtype=function CT_Text, docx.oxml.text.run.CT_Text, module=docx.oxml.text.run 84 loader <_frozen_importlib_external.SourceFileLoader object at 0x00000000039F1A08> parts, fullname=docx.parts, file=docx\parts_init_.py image, fullname=docx.parts.image, file=docx\parts\image.py story, fullname=docx.parts.story, file=docx\parts\story.py hdrftr, fullname=docx.parts.hdrftr, file=docx\parts\hdrftr.py numbering, fullname=docx.parts.numbering, file=docx\parts\numbering.py settings, fullname=docx.parts.settings, file=docx\parts\settings.py styles, fullname=docx.parts.styles, file=docx\parts\styles.py document, fullname=docx.parts.document, file=docx\parts\document.py package, fullname=docx.package, file=docx\package.py lazyproperty(f), module=docx.shared, line:158 at site-packages\docx\shared.py Image, docx.image.image.Image, module=docx.image.image 1 blob= kind=method class=Image objtype=function kind=class method class=Image objtype=classmethod kind=class method class=Image objtype=classmethod RELATIONSHIP_TYPE, docx.opc.constants.RELATIONSHIP_TYPE, module=docx.opc.constants 1 AUDIO kind:data type:str class: OpcPackage, docx.opc.package.OpcPackage, module=docx.opc.package 1 core_properties= kind=method class=OpcPackage objtype=function kind=method class=OpcPackage objtype=function kind=method class=OpcPackage objtype=function kind=method class=OpcPackage objtype=function kind=method class=OpcPackage objtype=function kind=method class=OpcPackage objtype=function kind=method class=OpcPackage objtype=function kind=method class=OpcPackage objtype=function kind=class method class=OpcPackage objtype=classmethod PackURI, docx.opc.packuri.PackURI, module=docx.opc.packuri 1 baseURI= kind=method class=PackURI objtype=function kind=static method class=PackURI objtype=staticmethod ImagePart, docx.parts.image.ImagePart, module=docx.parts.image 1 default_cx= kind=class method class=ImagePart objtype=classmethod kind=class method class=ImagePart objtype=classmethod Package, docx.package.Package, module=docx.package 1 image_parts= kind=method class=Package objtype=function kind=method class=Package objtype=function ImageParts, docx.package.ImageParts, module=docx.package kind=method class=ImageParts objtype=function kind=method class=ImageParts objtype=function 9 loader <_frozen_importlib_external.SourceFileLoader object at 0x0000000003913FC8> api, fullname=docx.api, file=docx\api.py os, fullname=os, file=os.py Document(docx=None), module=docx.api, line:17 at site-packages\docx\api.py _default_docx_path(), module=docx.api, line:32 at site-packages\docx\api.py CONTENT_TYPE, docx.opc.constants.CONTENT_TYPE, module=docx.opc.constants 1 BMP=image/bmp kind:data type:str class: Package, docx.package.Package, module=docx.package 1 image_parts= kind=method class=Package objtype=function kind=method class=Package objtype=function 6 _default_docx_path 7 loader <_frozen_importlib_external.SourceFileLoader object at 0x00000000038EE8C8> text, fullname=docx.text, file=docx\text_init_.py tabstops, fullname=docx.text.tabstops, file=docx\text\tabstops.py parfmt, fullname=docx.text.parfmt, file=docx\text\parfmt.py font, fullname=docx.text.font, file=docx\text\font.py run, fullname=docx.text.run, file=docx\text\run.py paragraph, fullname=docx.text.paragraph, file=docx\text\paragraph.py dml, fullname=docx.dml, file=docx\dml_init_.py color, fullname=docx.dml.color, file=docx\dml\color.py shape, fullname=docx.shape, file=docx\shape.py 1 nsmap {‘a’: main, ‘c’: 'http://sche… WD_INLINE_SHAPE_TYPE, docx.enum.shape.WD_INLINE_SHAPE_TYPE, module=docx.enum.shape 1 CHART=12 kind:data type:int class: Parented, docx.shared.Parented, module=docx.shared 1 part= InlineShapes, docx.shape.InlineShapes, module=docx.shape InlineShape, docx.shape.InlineShape, module=docx.shape 1 height= 6 loader <_frozen_importlib_external.SourceFileLoader object at 0x0000000003B82B48> blkcntnr, fullname=docx.blkcntnr, file=docx\blkcntnr.py CT_Tbl, docx.oxml.table.CT_Tbl, module=docx.oxml.table 1 bidiVisual_val= kind=method class=CT_Tbl objtype=function kind=method class=CT_Tbl objtype=function kind=class method class=CT_Tbl objtype=classmethod Parented, docx.shared.Parented, module=docx.shared 1 part= Paragraph, docx.text.paragraph.Paragraph, module=docx.text.paragraph 1 alignment= kind=method class=Paragraph objtype=function kind=method class=Paragraph objtype=function kind=method class=Paragraph objtype=function BlockItemContainer, docx.blkcntnr.BlockItemContainer, module=docx.blkcntnr 1 paragraphs= kind=method class=BlockItemContainer objtype=function kind=method class=BlockItemContainer objtype=function 5 loader <_frozen_importlib_external.SourceFileLoader object at 0x0000000003B63EC8> section, fullname=docx.section, file=docx\section.py lazyproperty(f), module=docx.shared, line:158 at site-packages\docx\shared.py BlockItemContainer, docx.blkcntnr.BlockItemContainer, module=docx.blkcntnr 1 paragraphs= kind=method class=BlockItemContainer objtype=function kind=method class=BlockItemContainer objtype=function Sequence, collections.abc.Sequence, module=collections.abc, line:-1 at collections\abc.py kind=method class=Sequence objtype=function kind=method class=Sequence objtype=function WD_HEADER_FOOTER_INDEX, docx.enum.section.WD_HEADER_FOOTER_INDEX, module=docx.enum.section 1 EVEN_PAGE=EVEN_PAGE (3) kind:data type:EnumValue class: Sections, docx.section.Sections, module=docx.section Section, docx.section.Section, module=docx.section 1 bottom_margin= _BaseHeaderFooter, docx.section._BaseHeaderFooter, module=docx.section 1 is_linked_to_previous= _Footer, docx.section._Footer, module=docx.section _Header, docx.section._Header, module=docx.section 10 _BaseHeaderFooter 13 loader <_frozen_importlib_external.SourceFileLoader object at 0x0000000003B6C4C8> document, fullname=docx.document, file=docx\document.py BlockItemContainer, docx.blkcntnr.BlockItemContainer, module=docx.blkcntnr 1 paragraphs= kind=method class=BlockItemContainer objtype=function kind=method class=BlockItemContainer objtype=function WD_SECTION_START, docx.enum.section.WD_SECTION_START, module=docx.enum.section 1 CONTINUOUS=CONTINUOUS (0) kind:data type:EnumValue class: WD_BREAK_TYPE, docx.enum.text.WD_BREAK_TYPE, module=docx.enum.text 对应于WdBreakType枚举 1 COLUMN=8 kind:data type:int class: Section, docx.section.Section, module=docx.section 1 bottom_margin= Sections, docx.section.Sections, module=docx.section ElementProxy, docx.shared.ElementProxy, module=docx.shared 1 element= Emu, docx.shared.Emu, module=docx.shared Document, docx.document.Document, module=docx.document 1 core_properties= kind=method class=Document objtype=function kind=method class=Document objtype=function kind=method class=Document objtype=function kind=method class=Document objtype=function kind=method class=Document objtype=function kind=method class=Document objtype=function kind=method class=Document objtype=function _Body, docx.document._Body, module=docx.document kind=method class=_Body objtype=function 10 _Body 11 loader <_frozen_importlib_external.SourceFileLoader object at 0x0000000003B5FAC8> settings, fullname=docx.settings, file=docx\settings.py ElementProxy, docx.shared.ElementProxy, module=docx.shared 1 element= Settings, docx.settings.Settings, module=docx.settings 1 odd_and_even_pages_header_footer= 3 loader <_frozen_importlib_external.SourceFileLoader object at 0x0000000003BA2148> styles, fullname=docx.styles, file=docx\styles_init_.py latent, fullname=docx.styles.latent, file=docx\styles\latent.py style, fullname=docx.styles.style, file=docx\styles\style.py styles, fullname=docx.styles.styles, file=docx\styles\styles.py BabelFish, docx.styles.BabelFish, module=docx.styles 1 internal_style_names={‘Caption’: ‘caption’, ‘Footer’: ‘footer’, ‘Header’: ‘header’, ‘Heading 1’: 'hea… kind:data type:dict class: kind=class method class=BabelFish objtype=classmethod kind=class method class=BabelFish objtype=classmethod 5 loader <_frozen_importlib_external.SourceFileLoader object at 0x0000000003BA2708> table, fullname=docx.table, file=docx\table.py lazyproperty(f), module=docx.shared, line:158 at site-packages\docx\shared.py BlockItemContainer, docx.blkcntnr.BlockItemContainer, module=docx.blkcntnr 1 paragraphs= kind=method class=BlockItemContainer objtype=function kind=method class=BlockItemContainer objtype=function WD_STYLE_TYPE, docx.enum.style.WD_STYLE_TYPE, module=docx.enum.style 1 CHARACTER=CHARACTER (2) kind:data type:EnumValue class: ST_Merge, docx.oxml.simpletypes.ST_Merge, module=docx.oxml.simpletypes 1 CONTINUE=continue kind:data type:str class: Inches, docx.shared.Inches, module=docx.shared Parented, docx.shared.Parented, module=docx.shared 1 part= Table, docx.table.Table, module=docx.table 1 alignment= kind=method class=Table objtype=function kind=method class=Table objtype=function kind=method class=Table objtype=function kind=method class=Table objtype=function kind=method class=Table objtype=function _Cell, docx.table._Cell, module=docx.table 1 paragraphs= kind=method class=_Cell objtype=function kind=method class=_Cell objtype=function kind=method class=_Cell objtype=function _Column, docx.table._Column, module=docx.table 1 cells= _Columns, docx.table._Columns, module=docx.table 1 table= _Row, docx.table._Row, module=docx.table 1 cells= _Rows, docx.table._Rows, module=docx.table 1 table= 13 _Cell 18 loader <_frozen_importlib_external.SourceFileLoader object at 0x0000000003B5F908>模块
2 docx.image.constants
特定于图像子包的常量
3 docx.image.exceptions
特定于映像子包的异常
4 docx.image.helpers
5 docx.image.image
提供可以根据内容类型和大小来描述图像流的对象,作为在文档中包含它们的必要步骤。
6 docx.image.bmp
7 docx.image.gif
8 docx.image.tiff
9 docx.image.jpeg
与JPEG图像流的解析头相关的对象,包括JFIF和Exif子格式。
10 docx.image.png
类
11 docx.image.bmp.Bmp
BMP图像的图像头解析器
property
2 default_ext=class method
3 from_stream()
12 docx.image.gif.Gif
GIF图像的图像头解析器。注意,GIF格式不支持分辨率(DPI)信息。水平和垂直DPI默认为72。
property
2 default_ext=class method
3 from_stream()
13 docx.image.jpeg.Exif
用于Exif图像格式的图像头解析器
class method
1 from_stream()
14 docx.image.jpeg.Jfif
图像头解析器用于JFIF图像格式
class method
1 from_stream()
15 docx.image.png.Png
PNG图像的图像头解析器
property
2 default_ext=class method
3 from_stream()
16 docx.image.tiff.Tiff
TIFF图像的图像头解析器。处理大端和小端字节排序。
property
2 default_ext=class method
3 from_stream()
剩余
18 spec ModuleSpec(name=‘docx.image’, loader=<_frozen_importlib_external.SourceFileLoader object at 0x0000000003914FC8>, origin=‘…\lib\site-packages\docx\image\init.py’, submodule_search_locations=[‘…\lib\site-packages\docx\image’])
19 absolute_import _Feature((2, 5, 0, ‘alpha’, 1), (3, 0, 0, ‘alpha’, 0), 16384)
20 division _Feature((2, 2, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 8192)
21 print_function _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 65536)
22 unicode_literals _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 131072)统计
序号
类别
数量
4
str
5
8
dict
1
10
class
3
13
residual
2
14
system
8
16
all
11
【docx.exceptions】
python-docx使用的异常。基异常类是PythonDocxError。
类
1 docx.exceptions.PythonDocxError
泛型错误类。
2 docx.exceptions.InvalidSpanError
在合并表单元格的请求中指定无效的合并区域时将被引发。
3 docx.exceptions.InvalidXmlError
当遇到无效的XML时将被引发,例如试图访问缺少的必需子元素
统计
序号
类别
数量
4
str
5
6
list
1
8
dict
1
9
module
7
10
class
1
13
residual
5
14
system
9
16
all
20
【docx.enum】
python-docx中使用的枚举
模块
1 docx.enum.base
枚举使用的基类和其他对象
2 docx.enum.section
在WordprocessingML文件中与主文档相关的枚举
3 docx.enum.style
与样式相关的枚举
4 docx.enum.table
与WordprocessingML文件中的表相关的枚举
5 docx.enum.dml
DrawingML对象使用的枚举
6 docx.enum.text
与WordprocessingML文件中的文本相关的枚举
7 docx.enum.shape
在WordprocessingML文件中与DrawingML形状相关的枚举
类
8 docx.enum.Enumeration
class method
1 from_xml()
2 to_xml()
剩余
10 spec ModuleSpec(name=‘docx.enum’, loader=<_frozen_importlib_external.SourceFileLoader object at 0x0000000003A5D5C8>, origin=‘…\lib\site-packages\docx\enum\init.py’, submodule_search_locations=[‘…\lib\site-packages\docx\enum’])
11 absolute_import _Feature((2, 5, 0, ‘alpha’, 1), (3, 0, 0, ‘alpha’, 0), 16384)
12 print_function _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 65536)
13 unicode_literals _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 131072)统计
序号
类别
数量
4
str
5
6
list
1
8
dict
2
9
module
15
10
class
64
11
function
3
13
residual
5
14
system
9
16
all
95
【docx.oxml】
初始化oxml子包,包括注册对应于Open XML元素的自定义元素类。
常量
dict
模块
2 lxml.etree
“lxml。模块为XML实现了扩展的ElementTree API。
3 docx.oxml.ns
Namespace-related对象。
4 docx.oxml.simpletypes
简单类型类,为存储在XML元素属性中的值提供验证和格式转换。命名通常对应于相关XML模式中的简单类型。
5 docx.oxml.exceptions
oxml子包的异常
6 docx.oxml.xmlchemy
提供lxml的包装器,支持自定义元素类的声明性定义。
7 docx.oxml.shared
docx中模块共享的对象。oxml分包。
8 docx.oxml.coreprops
与核心属性相关的XML元素的自定义元素类
9 docx.oxml.document
对应于文档部分的自定义元素类,例如
10 docx.oxml.numbering
与编号部分相关的自定义元素类
11 docx.oxml.section
与节相关的自定义元素类
12 docx.oxml.settings
与文档设置相关的自定义元素类
13 docx.oxml.shape
形状相关元素的自定义元素类,如``
14 docx.oxml.styles
与样式部分相关的自定义元素类
15 docx.oxml.table
表的自定义元素类
16 docx.oxml.text
函数
17 parse_xml(xml)
返回通过解析* XML *中的XML字符串获得的根lxml元素,该元素可以是Python 2.X字符串或unicode。
使用自定义解析器,因此为*xml*中含有自定义元素的元素生成自定义元素类。
18 register_element_cls(tag, cls)
当oxml解析器遇到具有匹配*标记*的元素时,要构造注册*cls*。
*tag*是一个形式为``nspfx:tagroot``,例如:``'w:document'``。
19 OxmlElement(nsptag_str, attrs=None, nsdecls=None)
返回一个“松散的”lxml元素,其标签由*nsptag_str*指定。*nsptag_str*必须包含标准的命名空间前缀,例如:'a:tbl'。
结果元素是此标记名的自定义元素类的实例(如果定义了一个)。属性值的字典可以提供为*attrs*;如果存在,则设置它们。
dict *nsdecls*中定义的所有名称空间都在元素中声明,使用键作为前缀,值作为名称空间名称。
如果没有提供*nsdecls*,则根据*nsptag_str*上的前缀添加单个命名空间声明。
类
20 docx.oxml.ns.NamespacePrefixedTag
值对象,该对象知道具有名称空间前缀的XML标记的语义。
property
2 local_part=
3 nsmap=
4 nspfx=
5 nsuri=class method
6 from_clark_name()
21 docx.oxml.shared.CT_DecimalNumber
用于``
property
class method
2 new()
22 docx.oxml.shared.CT_OnOff
用于``
property
23 docx.oxml.shared.CT_String
用于``
property
class method
2 new()
24 docx.oxml.coreprops.CT_CoreProperties
``
property
2 category=
3 category_text=
4 comments_text=
5 contentStatus=
6 contentStatus_text=
7 created=
8 created_datetime=
9 creator=
10 description=
11 identifier=
12 identifier_text=
13 keywords=
14 keywords_text=
15 language=
16 language_text=
17 lastModifiedBy=
18 lastModifiedBy_text=
19 lastPrinted=
20 lastPrinted_datetime=
21 modified=
22 modified_datetime=
23 revision=
24 revision_number=
25 subject=
26 subject_text=
27 title=
28 title_text=
29 version=
30 version_text=method
31 get_or_add_category()
返回``
32 get_or_add_contentStatus()
返回``
33 get_or_add_created()
返回``
34 get_or_add_creator()
返回``
35 get_or_add_description()
返回``
36 get_or_add_identifier()
返回``
37 get_or_add_keywords()
返回``
38 get_or_add_language()
返回``
39 get_or_add_lastModifiedBy()
返回``
40 get_or_add_lastPrinted()
返回``
41 get_or_add_modified()
返回``
42 get_or_add_revision()
返回``
43 get_or_add_subject()
返回``
44 get_or_add_title()
返回``
45 get_or_add_version()
返回``
class method
46 new()
25 docx.oxml.document.CT_Body
``
property
2 sectPr=
3 tbl_lst=method
4 add_p()
无条件地添加一个新的``
5 add_section_break()
返回' w:sectPr '元素用于在文档末尾添加的新节。
最后一个`w:sectPr`变成倒数第二个,新的`w:sectPr`是前一个的完全克隆,除了所有的页眉和页脚引用都被删除了(因此现在是从前一个节“继承”的)。
上一个`w:sectPr`的副本现在将出现在文档末尾的新`w:p`中。返回的`w:sectPr`是文档的哨兵`w:sectPr`(并且在实现时,*是*先前的哨兵`w:sectPr`,删除了页眉和页脚)。
6 add_tbl()
无条件地添加一个新的``
7 clear_content()
从
8 get_or_add_sectPr()
返回``
26 docx.oxml.document.CT_Document
``
property
2 sectPr_lst=method
3 get_or_add_body()
返回``
27 docx.oxml.numbering.CT_Num
元素,它表示一个具体的列表定义实例,具有一个必需的子元素
property
2 lvlOverride_lst=
3 numId=method
4 add_lvlOverride()
返回一个新添加的 CT_NumLvl (
class method
5 new()
28 docx.oxml.numbering.CT_Numbering
``
property
method
2 add_num()
返回一个新添加的 CT_Num (
3 num_having_numId()
返回具有``numId``属性的``
29 docx.oxml.numbering.CT_NumLvl
``
property
2 startOverride=method
3 add_startOverride()
返回一个新添加的CT_DecimalNumber元素,其中tagname``w:startOverride``和``val``属性设置为*val*。
4 get_or_add_startOverride()
返回``
30 docx.oxml.numbering.CT_NumPr
``
property
2 numId=method
3 get_or_add_ilvl()
返回``
4 get_or_add_numId()
返回``
31 docx.oxml.section.CT_HdrFtr
`w:hdr`和`w:ftr`,分别是页眉部分和页脚部分的根元素
property
2 tbl_lst=method
3 add_p()
无条件地添加一个新的``
4 add_tbl()
无条件地添加一个新的``
32 docx.oxml.section.CT_HdrFtrRef
`w:headerReference` 和 `w:footerReference` 元素
property
2 type_=33 docx.oxml.section.CT_PageMar
``
property
2 footer=
3 gutter=
4 header=
5 left=
6 right=
7 top=34 docx.oxml.section.CT_PageSz
``
property
2 orient=
3 w=35 docx.oxml.section.CT_SectPr
`w:sectPr`元素,section属性的容器元素
property
2 footer=
3 footerReference_lst=
4 gutter=
5 header=
6 headerReference_lst=
7 left_margin=
8 orientation=
9 page_height=
10 page_width=
11 pgMar=
12 pgSz=
13 preceding_sectPr=
14 right_margin=
15 start_type=
16 titlePg=
17 titlePg_val=
18 top_margin=
19 type=method
20 add_footerReference()
返回新添加的带有*rId*的*type_*的CT_HdrFtrRef元素。元素标签是`w:footerReference`。
21 add_headerReference()
返回新添加的带有*rId*的*type_*的CT_HdrFtrRef元素。元素标签是`w:headerReference`。
22 clone()
返回此``
23 get_footerReference()
返回*type_*的footerReference元素,如果不存在则返回None。
24 get_headerReference()
返回*type_*的headerReference元素,如果不存在则返回None。
25 get_or_add_pgMar()
返回``
26 get_or_add_pgSz()
返回``
27 get_or_add_titlePg()
返回``
28 get_or_add_type()
返回``
29 remove_footerReference()
删除w:footerReference子元素*type_*后返回rId。
30 remove_headerReference()
删除w:headerReference子元素*type_*后返回rId。
36 docx.oxml.section.CT_SectType
``
property
37 docx.oxml.settings.CT_Settings
`w:settings` 元素,设置部分的根元素
property
2 evenAndOddHeaders_val=method
3 get_or_add_evenAndOddHeaders()
返回``
38 docx.oxml.shape.CT_Blip
``
property
2 link=39 docx.oxml.shape.CT_BlipFillProperties
``
property
method
2 get_or_add_blip()
返回``
40 docx.oxml.shape.CT_GraphicalObject
``
property
41 docx.oxml.shape.CT_GraphicalObjectData
``
property
2 uri=method
3 get_or_add_pic()
返回``
42 docx.oxml.shape.CT_Inline
``
property
2 extent=
3 graphic=class method
4 new()
5 new_pic_inline()
43 docx.oxml.shape.CT_NonVisualDrawingProps
用于``
property
2 name=44 docx.oxml.shape.CT_Picture
``
property
2 nvPicPr=
3 spPr=class method
4 new()
45 docx.oxml.shape.CT_PictureNonVisual
``
property
46 docx.oxml.shape.CT_Point2D
用于``
property
2 y=47 docx.oxml.shape.CT_PositiveSize2D
用于``
property
2 cy=48 docx.oxml.shape.CT_ShapeProperties
``
property
2 cy=
3 xfrm=method
4 get_or_add_xfrm()
返回``
49 docx.oxml.shape.CT_Transform2D
``
property
2 cy=
3 ext=
4 off=method
5 get_or_add_ext()
返回``
6 get_or_add_off()
返回``
50 docx.oxml.styles.CT_LatentStyles
`w:latentStyles`元素,定义了潜在样式的默认行为,并包含`w:lsdException`子元素,每个子元素覆盖了命名潜在样式的默认行为。
property
2 defLockedState=
3 defQFormat=
4 defSemiHidden=
5 defUIPriority=
6 defUnhideWhenUsed=
7 lsdException_lst=method
8 add_lsdException()
无条件地添加一个新的``
9 bool_prop()
返回具有*attr_name*的属性的布尔值,如果不存在则返回|False|。
10 get_by_name()
返回具有*name*的`w:lsdException`子节点,如果没有则返回|None|。
11 set_bool_prop()
将具有*attr_name*的on/off属性设置为*value*。
51 docx.oxml.styles.CT_LsdException
``
property
2 name=
3 qFormat=
4 semiHidden=
5 uiPriority=
6 unhideWhenUsed=method
7 delete()
从XML文档中删除`w:lsdException`元素。
8 on_off_prop()
返回具有*attr_name*的属性的布尔值,如果不存在则返回|None| 。
9 set_on_off_prop()
将具有*attr_name*的on/off属性设置为*value*。
52 docx.oxml.styles.CT_Style
``
property
2 basedOn=
3 basedOn_val=
4 customStyle=
5 default=
6 locked=
7 locked_val=
8 name=
9 name_val=
10 next=
11 next_style=
12 pPr=
13 qFormat=
14 qFormat_val=
15 rPr=
16 semiHidden=
17 semiHidden_val=
18 styleId=
19 type=
20 uiPriority=
21 uiPriority_val=
22 unhideWhenUsed=
23 unhideWhenUsed_val=method
24 delete()
从它的父元素`w:styles`中删除这个`w:style`元素。
25 get_or_add_basedOn()
返回``
26 get_or_add_locked()
返回``
27 get_or_add_name()
返回``
28 get_or_add_next()
返回``
29 get_or_add_pPr()
返回``
30 get_or_add_qFormat()
返回``
31 get_or_add_rPr()
返回``
32 get_or_add_semiHidden()
返回``
33 get_or_add_uiPriority()
返回``
34 get_or_add_unhideWhenUsed()
返回``
53 docx.oxml.styles.CT_Styles
``
property
2 style_lst=method
3 add_style()
无条件地添加一个新的``
4 add_style_of_type()
返回一个新添加的`w:style`元素,具有*name*和*style_type*。`w:style/@customStyle`是基于*builtin*的值设置的。
5 default_for()
如果没有,返回`w:style[@w:type="*{style_type}*][-1]`或|None|。
6 get_by_id()
返回具有styleId属性的``
7 get_by_name()
返回具有值为*name*的``
8 get_or_add_latentStyles()
返回``
54 docx.oxml.table.CT_Height
用于``
property
2 val=55 docx.oxml.table.CT_Row
``
property
2 tc_lst=
3 trHeight_hRule=
4 trHeight_val=
5 trPr=
6 tr_idx=method
7 add_tc()
无条件地添加一个新的``
8 get_or_add_tblPrEx()
返回``
9 get_or_add_trPr()
返回``
10 tc_at_grid_col()
``
56 docx.oxml.table.CT_Tbl
``
property
2 col_count=
3 tblGrid=
4 tblPr=
5 tblStyle_val=
6 tr_lst=method
7 add_tr()
无条件地添加一个新的``
8 iter_tcs()
生成这个表中的每个`w:tc`元素,从左到右,从上到下。生成第一行中的每个单元格,然后生成第二行中的每个单元格,等等。
class method
9 new_tbl()
57 docx.oxml.table.CT_TblGrid
元素``
property
method
2 add_gridCol()
无条件地添加一个新的``
58 docx.oxml.table.CT_TblGridCol
元素``
property
2 w=59 docx.oxml.table.CT_TblLayoutType
``
property
60 docx.oxml.table.CT_TblPr
元素``
property
2 autofit=
3 bidiVisual=
4 jc=
5 style=
6 tblLayout=
7 tblStyle=method
8 get_or_add_bidiVisual()
返回``
9 get_or_add_jc()
返回``
10 get_or_add_tblLayout()
返回``
11 get_or_add_tblStyle()
返回``
61 docx.oxml.table.CT_TblWidth
用于``
property
2 w=
3 width=62 docx.oxml.table.CT_Tc
`w:tc`表单元格元素
property
2 grid_span=
3 left=
4 p_lst=
5 right=
6 tbl_lst=
7 tcPr=
8 top=
9 vMerge=
10 width=method
11 add_p()
无条件地添加一个新的``
12 add_tbl()
无条件地添加一个新的``
13 clear_content()
删除所有内容子元素,保留``
14 get_or_add_tcPr()
返回``
15 iter_block_items()
生成对该单元格中每个块级内容元素的引用,按照它们出现的顺序。
16 merge()
返回一个新span的左上角``
class method
17 new()
63 docx.oxml.table.CT_TcPr
``
property
2 grid_span=
3 tcW=
4 vAlign=
5 vAlign_val=
6 vMerge=
7 vMerge_val=
8 width=method
9 get_or_add_gridSpan()
返回``
10 get_or_add_tcW()
返回``
11 get_or_add_vAlign()
返回``
12 get_or_add_vMerge()
返回``
64 docx.oxml.table.CT_TrPr
``
property
2 trHeight_hRule=
3 trHeight_val=method
4 get_or_add_trHeight()
返回``
65 docx.oxml.table.CT_VMerge
``
property
66 docx.oxml.table.CT_VerticalJc
`w:vAlign`元素,指定单元格的垂直对齐。
property
67 docx.oxml.text.font.CT_Color
`w:color`元素,指定字体和其他对象的颜色。
property
2 val=68 docx.oxml.text.font.CT_Fonts
``
property
2 hAnsi=69 docx.oxml.text.font.CT_Highlight
`w:highlight` 元素,指定字体高亮/背景色。
property
70 docx.oxml.text.font.CT_HpsMeasure
用于``
property
71 docx.oxml.text.font.CT_RPr
``
property
2 bCs=
3 caps=
4 color=
5 cs=
6 dstrike=
7 emboss=
8 highlight=
9 highlight_val=
10 i=
11 iCs=
12 imprint=
13 noProof=
14 oMath=
15 outline=
16 rFonts=
17 rFonts_ascii=
18 rFonts_hAnsi=
19 rStyle=
20 rtl=
21 shadow=
22 smallCaps=
23 snapToGrid=
24 specVanish=
25 strike=
26 style=
27 subscript=
28 superscript=
29 sz=
30 sz_val=
31 u=
32 u_val=
33 vanish=
34 vertAlign=
35 webHidden=method
36 get_or_add_b()
返回``
37 get_or_add_bCs()
返回``
38 get_or_add_caps()
返回``
39 get_or_add_color()
返回``
40 get_or_add_cs()
返回``
41 get_or_add_dstrike()
返回``
42 get_or_add_emboss()
返回``
43 get_or_add_highlight()
返回``
44 get_or_add_i()
返回``
45 get_or_add_iCs()
返回``
46 get_or_add_imprint()
返回``
47 get_or_add_noProof()
返回``
48 get_or_add_oMath()
返回``
49 get_or_add_outline()
返回``
50 get_or_add_rFonts()
返回``
51 get_or_add_rStyle()
返回``
52 get_or_add_rtl()
返回``
53 get_or_add_shadow()
返回``
54 get_or_add_smallCaps()
返回``
55 get_or_add_snapToGrid()
返回``
56 get_or_add_specVanish()
返回``
57 get_or_add_strike()
返回``
58 get_or_add_sz()
返回``
59 get_or_add_u()
返回``
60 get_or_add_vanish()
返回``
61 get_or_add_vertAlign()
返回``
62 get_or_add_webHidden()
返回``
72 docx.oxml.text.font.CT_Underline
``
property
73 docx.oxml.text.font.CT_VerticalAlignRun
``
property
74 docx.oxml.text.paragraph.CT_P
``
property
2 pPr=
3 r_lst=
4 style=method
5 add_p_before()
返回一个新的``
6 add_r()
无条件地添加一个新的``
7 clear_content()
删除所有子元素,除非存在``
8 get_or_add_pPr()
返回``
9 set_sectPr()
无条件地替换或添加*sectPr*作为孙子在正确的顺序。
75 docx.oxml.text.parfmt.CT_Ind
``
property
2 hanging=
3 left=
4 right=76 docx.oxml.text.parfmt.CT_Jc
``
property
77 docx.oxml.text.parfmt.CT_PPr
``
property
2 ind=
3 ind_left=
4 ind_right=
5 jc=
6 jc_val=
7 keepLines=
8 keepLines_val=
9 keepNext=
10 keepNext_val=
11 numPr=
12 pStyle=
13 pageBreakBefore=
14 pageBreakBefore_val=
15 sectPr=
16 spacing=
17 spacing_after=
18 spacing_before=
19 spacing_line=
20 spacing_lineRule=
21 style=
22 tabs=
23 widowControl=
24 widowControl_val=method
25 get_or_add_ind()
返回``
26 get_or_add_jc()
返回``
27 get_or_add_keepLines()
返回``
28 get_or_add_keepNext()
返回``
29 get_or_add_numPr()
返回``
30 get_or_add_pStyle()
返回``
31 get_or_add_pageBreakBefore()
返回``
32 get_or_add_sectPr()
返回``
33 get_or_add_spacing()
返回``
34 get_or_add_tabs()
返回``
35 get_or_add_widowControl()
返回``
78 docx.oxml.text.parfmt.CT_Spacing
``
property
2 before=
3 line=
4 lineRule=79 docx.oxml.text.parfmt.CT_TabStop
``
property
2 pos=
3 val=80 docx.oxml.text.parfmt.CT_TabStops
``
property
method
2 add_tab()
无条件地添加一个新的``
3 insert_tab_in_order()
按*pos*顺序插入新创建的`w:tab`子元素。
81 docx.oxml.text.run.CT_Br
``
property
2 type=82 docx.oxml.text.run.CT_R
``
property
2 cr_lst=
3 drawing_lst=
4 rPr=
5 style=
6 t_lst=
7 tab_lst=
8 text=method
9 add_br()
无条件地添加一个新的``
10 add_cr()
无条件地添加一个新的``
11 add_drawing()
返回新添加的``CT_Drawing`` (``
12 add_t()
返回新添加的包含*text*的 ``
13 add_tab()
无条件地添加一个新的``
14 clear_content()
删除除``
15 get_or_add_rPr()
返回``
83 docx.oxml.text.run.CT_Text
``
剩余
85 spec ModuleSpec(name=‘docx.oxml’, loader=<_frozen_importlib_external.SourceFileLoader object at 0x00000000039F1A08>, origin=‘…\lib\site-packages\docx\oxml\init.py’, submodule_search_locations=[‘…\lib\site-packages\docx\oxml’])
86 absolute_import _Feature((2, 5, 0, ‘alpha’, 1), (3, 0, 0, ‘alpha’, 0), 16384)
87 element_class_lookup
88 oxml_parser 统计
序号
类别
数量
4
str
4
6
list
1
8
dict
1
9
module
7
13
residual
3
14
system
9
16
all
16
【docx.parts】
常量
模块
1 docx.parts.image
映像部分的代理类,以及相关对象。
2 docx.parts.story
|BaseStoryPart|及相关对象
3 docx.parts.hdrftr
页眉和页脚部分对象
4 docx.parts.numbering
|NumberingPart|和密切相关的对象
5 docx.parts.settings
|SettingsPart|和密切相关的对象
6 docx.parts.styles
提供StylesPart和相关对象
7 docx.parts.document
|DocumentPart|和密切相关的对象
统计
序号
类别
数量
4
str
5
8
dict
1
10
class
7
11
function
1
13
residual
6
14
system
8
16
all
20
【docx.package】
包类和相关对象
函数
1 lazyproperty(f)
@lazyprop装饰。方法将只在第一次访问时调用,以计算缓存的属性值。之后,返回缓存的值。
类
2 docx.image.image.Image
图形图像流,如JPEG、PNG或GIF,具有ImagePart所需的属性和方法。
property
2 content_type=
3 ext=
4 filename=
5 height=
6 horz_dpi=
7 px_height=
8 px_width=
9 sha1=
10 vert_dpi=
11 width=method
12 scaled_dimensions()
返回一个(cx, cy) 2元组,表示通过对*width*和*height*应用以下规则缩放的图像的原始尺寸。
如果同时指定了*width*和*height*,则返回值为(*width*, *height*);不进行伸缩。
如果只指定了一个,它将用于计算缩放因子,然后应用于未指定的维度,保留图像的纵横比。如果*width*和*height*都为|None|,返回原始维度。
本机尺寸是使用嵌入在图像中的点/英寸(dpi)值计算的,默认值为72Dpi,如果没有指定值,这是通常的情况。返回值都是|Length|对象。
class method
13 from_blob()
14 from_file()
3 docx.opc.constants.RELATIONSHIP_TYPE
data
2 A_F_CHUNK kind:data type:str class:
3 CALC_CHAIN kind:data type:str class:
4 CERTIFICATE kind:data type:str class:
5 CHART kind:data type:str class:
6 CHARTSHEET kind:data type:str class:
7 CHART_USER_SHAPES kind:data type:str class:
8 COMMENTS kind:data type:str class:
9 COMMENT_AUTHORS kind:data type:str class:
10 CONNECTIONS kind:data type:str class:
11 CONTROL kind:data type:str class:
12 CORE_PROPERTIES kind:data type:str class:
13 CUSTOM_PROPERTIES kind:data type:str class:
14 CUSTOM_PROPERTY kind:data type:str class:
15 CUSTOM_XML kind:data type:str class:
16 CUSTOM_XML_PROPS kind:data type:str class:
17 DIAGRAM_COLORS kind:data type:str class:
18 DIAGRAM_DATA kind:data type:str class:
19 DIAGRAM_LAYOUT kind:data type:str class:
20 DIAGRAM_QUICK_STYLE kind:data type:str class:
21 DIALOGSHEET kind:data type:str class:
22 DRAWING kind:data type:str class:
23 ENDNOTES kind:data type:str class:
24 EXTENDED_PROPERTIES kind:data type:str class:
25 EXTERNAL_LINK kind:data type:str class:
26 FONT kind:data type:str class:
27 FONT_TABLE kind:data type:str class:
28 FOOTER kind:data type:str class:
29 FOOTNOTES kind:data type:str class:
30 GLOSSARY_DOCUMENT kind:data type:str class:
31 HANDOUT_MASTER kind:data type:str class:
32 HEADER kind:data type:str class:
33 HYPERLINK kind:data type:str class:
34 IMAGE kind:data type:str class:
35 NOTES_MASTER kind:data type:str class:
36 NOTES_SLIDE kind:data type:str class:
37 NUMBERING kind:data type:str class:
38 OFFICE_DOCUMENT kind:data type:str class:
39 OLE_OBJECT kind:data type:str class:
40 ORIGIN kind:data type:str class:
41 PACKAGE kind:data type:str class:
42 PIVOT_CACHE_DEFINITION kind:data type:str class:
43 PIVOT_CACHE_RECORDS kind:data type:str class:
44 PIVOT_TABLE kind:data type:str class:
45 PRES_PROPS kind:data type:str class:
46 PRINTER_SETTINGS kind:data type:str class:
47 QUERY_TABLE kind:data type:str class:
48 REVISION_HEADERS kind:data type:str class:
49 REVISION_LOG kind:data type:str class:
50 SETTINGS kind:data type:str class:
51 SHARED_STRINGS kind:data type:str class:
52 SHEET_METADATA kind:data type:str class:
53 SIGNATURE kind:data type:str class:
54 SLIDE kind:data type:str class:
55 SLIDE_LAYOUT kind:data type:str class:
56 SLIDE_MASTER kind:data type:str class:
57 SLIDE_UPDATE_INFO kind:data type:str class:
58 STYLES kind:data type:str class:
59 TABLE kind:data type:str class:
60 TABLE_SINGLE_CELLS kind:data type:str class:
61 TABLE_STYLES kind:data type:str class:
62 TAGS kind:data type:str class:
63 THEME kind:data type:str class:
64 THEME_OVERRIDE kind:data type:str class:
65 THUMBNAIL kind:data type:str class:
66 USERNAMES kind:data type:str class:
67 VIDEO kind:data type:str class:
68 VIEW_PROPS kind:data type:str class:
69 VML_DRAWING kind:data type:str class:
70 VOLATILE_DEPENDENCIES kind:data type:str class:
71 WEB_SETTINGS kind:data type:str class:
72 WORKSHEET_SOURCE kind:data type:str class:
73 XML_MAPS kind:data type:str class:4 docx.opc.package.OpcPackage
主要API类, 关于|python-opc|。通过调用:meth:`open`类方法构造一个新实例,该方法带有一个包文件或包含包文件的类文件对象的路径。
property
2 main_document_part=
3 parts=
4 rels=method
5 after_unmarshal()
任何解组后处理的入口点。可能会被覆盖, 通过子类不转发调用到super。
6 iter_parts()
通过对rels图执行深度优先遍历,生成对包中每个部分的精确引用。
7 iter_rels()
通过对rels图执行深度优先遍历,生成对包中每个关系的精确引用。
8 load_rel()
返回新添加的|_Relationship|此部分与*target*之间的*reltype*关系实例,键为*rId*。
目标模式设置为``RTM.EXTERNAL`` ,如果 *is_external* 为 |True|。
用于从序列化包加载期间使用,其中rId是众所周知的。还有其他方法用于在处理期间向包添加新的关系。
9 next_partname()
返回一个|PackURI|实例,表示partname匹配*template*。
返回的部件名称具有下一个可用的数字后缀,以将其与该类型的其他部件区分开来。
*template*是一个printf(%)样式的模板字符串,包含一个替换项,'%d'用于插入partname的整数部分。示例:"/word/header%d.xml"
10 part_related_by()
返回该包与之具有*reltype*关系的部分。如果没有找到这样的关系,则引发|KeyError|;如果找到多个这样的关系,则引发|ValueError|。
11 relate_to()
返回关系的rId键到*part*,如果有,则从现有关系返回,否则为新创建的关系。
12 save()
将此包保存到*pkg_file*,其中*file*可以是文件(字符串)的路径或类文件对象。
class method
13 open()
5 docx.opc.packuri.PackURI
提供对包URI组件(如baseURI和文件名切片)的访问。否则表现为|str|。
property
2 ext=
3 filename=
4 idx=
5 membername=
6 rels_uri=method
7 relative_ref()
从*baseURI*返回包含包项的相对引用的字符串。
例如,PackURI('/ppt/slideLayouts/slideLayout1.xml')将为baseURI '/ppt/slides'返回'../slideLayouts/slideLayout1.xml'。
static method
8 from_rel_ref()
6 docx.parts.image.ImagePart
图像部分。对应关系的目标部分,类型为RELATIONSHIP_TYPE.IMAGE。
property
2 default_cy=
3 filename=
4 image=
5 sha1=class method
6 from_image()
7 load()
7 docx.package.Package
特定于WordprocessingML包的定制
property
method
2 after_unmarshal()
在加载所有部件和关系后通过加载代码调用。这种方法为任何所需的后处理提供了机会。
3 get_or_add_image_part()
返回|ImagePart|,包含*image_descriptor*指定的图像。如果集合中还没有匹配的图像部分,则新创建图像部分。
8 docx.package.ImageParts
|ImagePart|对象的集合,对应于包中的图像
method
1 append()
2 get_or_add_image_part()
返回|ImagePart|对象,包含由 *image_descriptor* 标识的图像。如果集合中不存在匹配的图像部分,则新创建图像部分。
剩余
10 spec ModuleSpec(name=‘docx.package’, loader=<_frozen_importlib_external.SourceFileLoader object at 0x0000000003913FC8>, origin=‘…\lib\site-packages\docx\package.py’)
11 absolute_import _Feature((2, 5, 0, ‘alpha’, 1), (3, 0, 0, ‘alpha’, 0), 16384)
12 division _Feature((2, 2, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 8192)
13 print_function _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 65536)
14 unicode_literals _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 131072)统计
序号
类别
数量
4
str
5
8
dict
1
9
module
1
10
class
2
11
function
2
13
residual
5
14
system
8
15
private
1
16
all
16
【docx.api】
直接公开API函数和类:func:`Document`。提供一个语法上更方便的API来与OpcPackage图交互。
模块
1 os
参见:os 模块
函数
2 Document(docx=None)
返回一个从*docx*加载的|Document|对象,其中*docx*可以是一个``.docx``文件(字符串)的路径或一个类文件对象。如果*docx*缺失或“None”,则加载内置的默认文档“template”。
3 _default_docx_path()
返回内置默认.docx包的路径。
类
4 docx.opc.constants.CONTENT_TYPE
内容类型URIs(如mime类型)指定部件的格式
data
2 DML_CHART=application/vnd.openxmlformats-officedocument.drawingml.chart+xml kind:data type:str class:
3 DML_CHARTSHAPES=application/vnd.openxmlformats-officedocument.drawingml.chartshapes+xml kind:data type:str class:
4 DML_DIAGRAM_COLORS=application/vnd.openxmlformats-officedocument.drawingml.diagramColors+xml kind:data type:str class:
5 DML_DIAGRAM_DATA=application/vnd.openxmlformats-officedocument.drawingml.diagramData+xml kind:data type:str class:
6 DML_DIAGRAM_LAYOUT=application/vnd.openxmlformats-officedocument.drawingml.diagramLayout+xml kind:data type:str class:
7 DML_DIAGRAM_STYLE=application/vnd.openxmlformats-officedocument.drawingml.diagramStyle+xml kind:data type:str class:
8 GIF=image/gif kind:data type:str class:
9 JPEG=image/jpeg kind:data type:str class:
10 MS_PHOTO=image/vnd.ms-photo kind:data type:str class:
11 OFC_CUSTOM_PROPERTIES=application/vnd.openxmlformats-officedocument.custom-properties+xml kind:data type:str class:
12 OFC_CUSTOM_XML_PROPERTIES=application/vnd.openxmlformats-officedocument.customXmlProperties+xml kind:data type:str class:
13 OFC_DRAWING=application/vnd.openxmlformats-officedocument.drawing+xml kind:data type:str class:
14 OFC_EXTENDED_PROPERTIES=application/vnd.openxmlformats-officedocument.extended-properties+xml kind:data type:str class:
15 OFC_OLE_OBJECT=application/vnd.openxmlformats-officedocument.oleObject kind:data type:str class:
16 OFC_PACKAGE=application/vnd.openxmlformats-officedocument.package kind:data type:str class:
17 OFC_THEME=application/vnd.openxmlformats-officedocument.theme+xml kind:data type:str class:
18 OFC_THEME_OVERRIDE=application/vnd.openxmlformats-officedocument.themeOverride+xml kind:data type:str class:
19 OFC_VML_DRAWING=application/vnd.openxmlformats-officedocument.vmlDrawing kind:data type:str class:
20 OPC_CORE_PROPERTIES=application/vnd.openxmlformats-package.core-properties+xml kind:data type:str class:
21 OPC_DIGITAL_SIGNATURE_CERTIFICATE=application/vnd.openxmlformats-package.digital-signature-certificate kind:data type:str class:
22 OPC_DIGITAL_SIGNATURE_ORIGIN=application/vnd.openxmlformats-package.digital-signature-origin kind:data type:str class:
23 OPC_DIGITAL_SIGNATURE_XMLSIGNATURE=application/vnd.openxmlformats-package.digital-signature-xmlsignature+xml kind:data type:str class:
24 OPC_RELATIONSHIPS=application/vnd.openxmlformats-package.relationships+xml kind:data type:str class:
25 PML_COMMENTS=application/vnd.openxmlformats-officedocument.presentationml.comments+xml kind:data type:str class:
26 PML_COMMENT_AUTHORS=application/vnd.openxmlformats-officedocument.presentationml.commentAuthors+xml kind:data type:str class:
27 PML_HANDOUT_MASTER=application/vnd.openxmlformats-officedocument.presentationml.handoutMaster+xml kind:data type:str class:
28 PML_NOTES_MASTER=application/vnd.openxmlformats-officedocument.presentationml.notesMaster+xml kind:data type:str class:
29 PML_NOTES_SLIDE=application/vnd.openxmlformats-officedocument.presentationml.notesSlide+xml kind:data type:str class:
30 PML_PRESENTATION_MAIN=application/vnd.openxmlformats-officedocument.presentationml.presentation.main+x… kind:data type:str class:
31 PML_PRES_PROPS=application/vnd.openxmlformats-officedocument.presentationml.presProps+xml kind:data type:str class:
32 PML_PRINTER_SETTINGS=application/vnd.openxmlformats-officedocument.presentationml.printerSettings kind:data type:str class:
33 PML_SLIDE=application/vnd.openxmlformats-officedocument.presentationml.slide+xml kind:data type:str class:
34 PML_SLIDESHOW_MAIN=application/vnd.openxmlformats-officedocument.presentationml.slideshow.main+xml kind:data type:str class:
35 PML_SLIDE_LAYOUT=application/vnd.openxmlformats-officedocument.presentationml.slideLayout+xml kind:data type:str class:
36 PML_SLIDE_MASTER=application/vnd.openxmlformats-officedocument.presentationml.slideMaster+xml kind:data type:str class:
37 PML_SLIDE_UPDATE_INFO=application/vnd.openxmlformats-officedocument.presentationml.slideUpdateInfo+xml kind:data type:str class:
38 PML_TABLE_STYLES=application/vnd.openxmlformats-officedocument.presentationml.tableStyles+xml kind:data type:str class:
39 PML_TAGS=application/vnd.openxmlformats-officedocument.presentationml.tags+xml kind:data type:str class:
40 PML_TEMPLATE_MAIN=application/vnd.openxmlformats-officedocument.presentationml.template.main+xml kind:data type:str class:
41 PML_VIEW_PROPS=application/vnd.openxmlformats-officedocument.presentationml.viewProps+xml kind:data type:str class:
42 PNG=image/png kind:data type:str class:
43 SML_CALC_CHAIN=application/vnd.openxmlformats-officedocument.spreadsheetml.calcChain+xml kind:data type:str class:
44 SML_CHARTSHEET=application/vnd.openxmlformats-officedocument.spreadsheetml.chartsheet+xml kind:data type:str class:
45 SML_COMMENTS=application/vnd.openxmlformats-officedocument.spreadsheetml.comments+xml kind:data type:str class:
46 SML_CONNECTIONS=application/vnd.openxmlformats-officedocument.spreadsheetml.connections+xml kind:data type:str class:
47 SML_CUSTOM_PROPERTY=application/vnd.openxmlformats-officedocument.spreadsheetml.customProperty kind:data type:str class:
48 SML_DIALOGSHEET=application/vnd.openxmlformats-officedocument.spreadsheetml.dialogsheet+xml kind:data type:str class:
49 SML_EXTERNAL_LINK=application/vnd.openxmlformats-officedocument.spreadsheetml.externalLink+xml kind:data type:str class:
50 SML_PIVOT_CACHE_DEFINITION=application/vnd.openxmlformats-officedocument.spreadsheetml.pivotCacheDefinition… kind:data type:str class:
51 SML_PIVOT_CACHE_RECORDS=application/vnd.openxmlformats-officedocument.spreadsheetml.pivotCacheRecords+xm… kind:data type:str class:
52 SML_PIVOT_TABLE=application/vnd.openxmlformats-officedocument.spreadsheetml.pivotTable+xml kind:data type:str class:
53 SML_PRINTER_SETTINGS=application/vnd.openxmlformats-officedocument.spreadsheetml.printerSettings kind:data type:str class:
54 SML_QUERY_TABLE=application/vnd.openxmlformats-officedocument.spreadsheetml.queryTable+xml kind:data type:str class:
55 SML_REVISION_HEADERS=application/vnd.openxmlformats-officedocument.spreadsheetml.revisionHeaders+xml kind:data type:str class:
56 SML_REVISION_LOG=application/vnd.openxmlformats-officedocument.spreadsheetml.revisionLog+xml kind:data type:str class:
57 SML_SHARED_STRINGS=application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml kind:data type:str class:
58 SML_SHEET=application/vnd.openxmlformats-officedocument.spreadsheetml.sheet kind:data type:str class:
59 SML_SHEET_MAIN=application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml kind:data type:str class:
60 SML_SHEET_METADATA=application/vnd.openxmlformats-officedocument.spreadsheetml.sheetMetadata+xml kind:data type:str class:
61 SML_STYLES=application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml kind:data type:str class:
62 SML_TABLE=application/vnd.openxmlformats-officedocument.spreadsheetml.table+xml kind:data type:str class:
63 SML_TABLE_SINGLE_CELLS=application/vnd.openxmlformats-officedocument.spreadsheetml.tableSingleCells+xml kind:data type:str class:
64 SML_TEMPLATE_MAIN=application/vnd.openxmlformats-officedocument.spreadsheetml.template.main+xml kind:data type:str class:
65 SML_USER_NAMES=application/vnd.openxmlformats-officedocument.spreadsheetml.userNames+xml kind:data type:str class:
66 SML_VOLATILE_DEPENDENCIES=application/vnd.openxmlformats-officedocument.spreadsheetml.volatileDependencies… kind:data type:str class:
67 SML_WORKSHEET=application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml kind:data type:str class:
68 TIFF=image/tiff kind:data type:str class:
69 WML_COMMENTS=application/vnd.openxmlformats-officedocument.wordprocessingml.comments+xml kind:data type:str class:
70 WML_DOCUMENT=application/vnd.openxmlformats-officedocument.wordprocessingml.document kind:data type:str class:
71 WML_DOCUMENT_GLOSSARY=application/vnd.openxmlformats-officedocument.wordprocessingml.document.glossary… kind:data type:str class:
72 WML_DOCUMENT_MAIN=application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml kind:data type:str class:
73 WML_ENDNOTES=application/vnd.openxmlformats-officedocument.wordprocessingml.endnotes+xml kind:data type:str class:
74 WML_FONT_TABLE=application/vnd.openxmlformats-officedocument.wordprocessingml.fontTable+xml kind:data type:str class:
75 WML_FOOTER=application/vnd.openxmlformats-officedocument.wordprocessingml.footer+xml kind:data type:str class:
76 WML_FOOTNOTES=application/vnd.openxmlformats-officedocument.wordprocessingml.footnotes+xml kind:data type:str class:
77 WML_HEADER=application/vnd.openxmlformats-officedocument.wordprocessingml.header+xml kind:data type:str class:
78 WML_NUMBERING=application/vnd.openxmlformats-officedocument.wordprocessingml.numbering+xml kind:data type:str class:
79 WML_PRINTER_SETTINGS=application/vnd.openxmlformats-officedocument.wordprocessingml.printerSettings kind:data type:str class:
80 WML_SETTINGS=application/vnd.openxmlformats-officedocument.wordprocessingml.settings+xml kind:data type:str class:
81 WML_STYLES=application/vnd.openxmlformats-officedocument.wordprocessingml.styles+xml kind:data type:str class:
82 WML_WEB_SETTINGS=application/vnd.openxmlformats-officedocument.wordprocessingml.webSettings+xml kind:data type:str class:
83 XML=application/xml kind:data type:str class:
84 X_EMF=image/x-emf kind:data type:str class:
85 X_FONTDATA=application/x-fontdata kind:data type:str class:
86 X_FONT_TTF=application/x-font-ttf kind:data type:str class:
87 X_WMF=image/x-wmf kind:data type:str class:5 docx.package.Package
特定于WordprocessingML包的定制
property
method
2 after_unmarshal()
在加载所有部件和关系后通过加载代码调用。这种方法为任何所需的后处理提供了机会。
3 get_or_add_image_part()
返回|ImagePart|,包含*image_descriptor*指定的图像。如果集合中还没有匹配的图像部分,则新创建图像部分。
私有或局部
剩余
8 spec ModuleSpec(name=‘docx.api’, loader=<_frozen_importlib_external.SourceFileLoader object at 0x00000000038EE8C8>, origin=‘…\lib\site-packages\docx\api.py’)
9 absolute_import _Feature((2, 5, 0, ‘alpha’, 1), (3, 0, 0, ‘alpha’, 0), 16384)
10 division _Feature((2, 2, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 8192)
11 print_function _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 65536)统计
序号
类别
数量
4
str
4
6
list
1
8
dict
1
9
module
5
13
residual
3
14
system
9
16
all
14
【docx.text】
模块
1 docx.text.tabstops
选项卡相关的代理类型。
2 docx.text.parfmt
与段落相关的代理类型。
3 docx.text.font
与字体相关的代理对象。
4 docx.text.run
运行python-docx的相关代理对象,特别是Run。
5 docx.text.paragraph
与段落相关的代理类型。
统计
序号
类别
数量
4
str
4
6
list
1
8
dict
1
9
module
1
13
residual
3
14
system
9
16
all
10
【docx.dml】
模块
1 docx.dml.color
DrawingML对象与颜色相关,ColorFormat是最突出的。
统计
序号
类别
数量
4
str
5
8
dict
2
10
class
4
13
residual
6
14
system
8
16
all
17
【docx.shape】
与形状相关的对象,出现在文档的绘图层上的可视对象。
常量
dict
类
2 docx.enum.shape.WD_INLINE_SHAPE_TYPE
对应于 [WdInlineShapeType枚举](http://msdn.microsoft.com/en-us/library/office/ff192587.aspx)
data
2 LINKED_PICTURE=4 kind:data type:int class:
3 NOT_IMPLEMENTED=-6 kind:data type:int class:
4 PICTURE=3 kind:data type:int class:
5 SMART_ART=15 kind:data type:int class:3 docx.shared.Parented
为部分下面出现的文档元素提供公共服务,但偶尔可能需要一个祖先对象来提供服务,例如添加或删除关系。提供了``self._parent``属性给子类。
property
4 docx.shape.InlineShapes
|InlineShape|实例序列,支持len(),迭代和索引访问。
5 docx.shape.InlineShape
``
property
2 type=
3 width=剩余
7 spec ModuleSpec(name=‘docx.shape’, loader=<_frozen_importlib_external.SourceFileLoader object at 0x0000000003B82B48>, origin=‘…\lib\site-packages\docx\shape.py’)
8 absolute_import _Feature((2, 5, 0, ‘alpha’, 1), (3, 0, 0, ‘alpha’, 0), 16384)
9 division _Feature((2, 2, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 8192)
10 print_function _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 65536)
11 unicode_literals _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 131072)统计
序号
类别
数量
4
str
5
8
dict
1
10
class
4
13
residual
6
14
system
8
16
all
16
【docx.blkcntnr】
块项目容器,用于主体,单元格,标题等。块级项目包括段落和表格,尽管还有其他一些特殊的项目,如结构化文档标记。
类
1 docx.oxml.table.CT_Tbl
``
property
2 col_count=
3 tblGrid=
4 tblPr=
5 tblStyle_val=
6 tr_lst=method
7 add_tr()
无条件地添加一个新的``
8 iter_tcs()
生成这个表中的每个`w:tc`元素,从左到右,从上到下。生成第一行中的每个单元格,然后生成第二行中的每个单元格,等等。
class method
9 new_tbl()
2 docx.shared.Parented
为部分下面出现的文档元素提供公共服务,但偶尔可能需要一个祖先对象来提供服务,例如添加或删除关系。提供了``self._parent``子类的父属性。
property
3 docx.text.paragraph.Paragraph
代理对象包装``
property
2 paragraph_format=
3 runs=
4 style=
5 text=method
6 add_run()
附加一个运行到包含*text*的段落,并具有由样式ID *style*标识的字符样式。
*text*可以包含制表符(``\t``)字符,这些字符被转换为制表符的适当XML形式。
*text*也可以包含换行符(``\n``)或回车符(``\r``)字符,每个字符都转换为换行符。
7 clear()
删除该段的所有内容后返回该段。保留段落级格式,如样式。
8 insert_paragraph_before()
返回一个新创建的段落,直接插入到此段落之前。如果提供了*text*,新段落将在一次运行中包含该文本。如果提供了*style*,则将该样式分配给新段落。
4 docx.blkcntnr.BlockItemContainer
可包含块项的代理对象的基类。这些容器包括Body、Cell、页眉、页脚、脚注、尾注、注释和文本框对象。提供用于添加块项(如段落或表)的共享功能。
property
2 tables=method
3 add_paragraph()
返回新添加到此内容末尾的段落容器,如果存在,则在一次运行中具有*text*段落风格*风格*。
如果*style*为|None|,则没有段落样式应用,这与应用“Normal”样式有相同的效果。
4 add_table()
返回一个*width*的表,包含*rows* rows和*cols*列,新添加到容器的内容中。*width*均匀分布在表列之间。
剩余
6 spec ModuleSpec(name=‘docx.blkcntnr’, loader=<_frozen_importlib_external.SourceFileLoader object at 0x0000000003B63EC8>, origin=‘…\lib\site-packages\docx\blkcntnr.py’)
7 absolute_import _Feature((2, 5, 0, ‘alpha’, 1), (3, 0, 0, ‘alpha’, 0), 16384)
8 division _Feature((2, 2, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 8192)
9 print_function _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 65536)
10 unicode_literals _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 131072)统计
序号
类别
数量
4
str
5
8
dict
1
10
class
8
11
function
1
13
residual
6
14
system
8
15
private
3
16
all
21
【docx.section】
|Section|对象和相关的代理类
The |Section| object and related proxy classes
函数
1 lazyproperty(f)
@lazyprop装饰。方法将只在第一次访问时调用,以计算缓存的属性值。之后,返回缓存的值。
类
2 docx.blkcntnr.BlockItemContainer
可包含块项的代理对象的基类。这些容器包括Body、Cell、页眉、页脚、脚注、尾注、注释和文本框对象。提供用于添加块项(如段落或表)的共享功能。
property
2 tables=method
3 add_paragraph()
返回一个新添加到此容器内容末尾的段落,如果存在,则在一次运行中具有*text*,并且具有段落样式*style*。
如果*style*为|None|,则不应用任何段落样式,其效果与应用'Normal'样式相同。
4 add_table()
返回一个*width*的表,包含*rows* rows和*cols*列,新添加到容器的内容中。*width*均匀分布在表列之间。
3 collections.abc.Sequence
对只读序列的所有操作。具体的子类必须重写__new__ 或 __init__, __getitem__, 和 __len__。
method
1 count()
S.count(value) -> integer -返回值的出现次数
2 index()
S.index(value, [start, [stop]]) -> integer
-返回值的第一个索引。如果值不存在则引发ValueError。支持start和stop参数是可选的,但推荐使用。
4 docx.enum.section.WD_HEADER_FOOTER_INDEX
别名: **WD_HEADER_FOOTER**指定一个section的三个可能的页眉/页脚定义之一。
只供内部使用;不是python-docx API的一部分。
data
2 FIRST_PAGE=FIRST_PAGE (2) kind:data type:EnumValue class:
3 PRIMARY=PRIMARY (1) kind:data type:EnumValue class:5 docx.section.Sections
|Section|对象的顺序,对应文档中的Section。支持``len()``,迭代和索引访问。
6 docx.section.Section
文档部分,提供对部分和页面设置的访问。还提供对页眉和页脚的访问。
property
2 different_first_page_header_footer=
3 even_page_footer=
4 even_page_header=
5 first_page_footer=
6 first_page_header=
7 footer=
8 footer_distance=
9 gutter=
10 header=
11 header_distance=
12 left_margin=
13 orientation=
14 page_height=
15 page_width=
16 right_margin=
17 start_type=
18 top_margin=7 docx.section._BaseHeaderFooter
页眉和页脚类的基类
property
2 part=8 docx.section._Footer
页脚,用于所有三种类型(默认、偶数页和第一页)。
注意,与文档或表格单元格一样,页脚必须包含至少一个段落,而新的或其他“空”页脚只包含一个空段落。
9 docx.section._Header
页头,用于所有三种类型(默认、偶数页和第一页)。注意,像文档或表格单元格一样,标题必须包含至少一个段落,新的或其他“空”标题包含一个空段落。
第一段可以作为`header.paragraphs[0]`用于向其添加内容。单独使用:meth:`add_paragraph()`来添加内容会在新添加的段落上方留下一个空段落。
私有或局部
11 _Footer
12 _Header 剩余
14 spec ModuleSpec(name=‘docx.section’, loader=<_frozen_importlib_external.SourceFileLoader object at 0x0000000003B6C4C8>, origin=‘…\lib\site-packages\docx\section.py’)
15 absolute_import _Feature((2, 5, 0, ‘alpha’, 1), (3, 0, 0, ‘alpha’, 0), 16384)
16 division _Feature((2, 2, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 8192)
17 print_function _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 65536)
18 unicode_literals _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 131072)统计
序号
类别
数量
4
str
5
8
dict
1
10
class
9
13
residual
6
14
system
8
15
private
1
16
all
21
【docx.document】
|Document| 及密切相关的对象
常量
类
1 docx.blkcntnr.BlockItemContainer
可包含块项的代理对象的基类。这些容器包括Body、Cell、页眉、页脚、脚注、尾注、注释和文本框对象。提供用于添加块项(如段落或表)的共享功能。
property
2 tables=method
3 add_paragraph()
返回一个新添加到此容器内容末尾的段落,如果存在,则在一次运行中具有*text*,并且具有段落样式*style*。
如果*style*为|None|,则不应用任何段落样式,其效果与应用'Normal'样式相同。
4 add_table()
返回一个*width*的表,包含*rows* rows和*cols*列,新添加到容器的内容中。*width*均匀分布在表列之间。
2 docx.enum.section.WD_SECTION_START
alias: **WD SECTION**
指定分段符的开始类型。
示例:
from docx.enum.section import WD_SECTION
section = document.sections[0]
section.start_type = WD_SECTION.NEW_PAGE
data
2 EVEN_PAGE=EVEN_PAGE (3) kind:data type:EnumValue class:
3 NEW_COLUMN=NEW_COLUMN (1) kind:data type:EnumValue class:
4 NEW_PAGE=NEW_PAGE (2) kind:data type:EnumValue class:
5 ODD_PAGE=ODD_PAGE (4) kind:data type:EnumValue class:3 docx.enum.text.WD_BREAK_TYPE
data
2 LINE=6 kind:data type:int class:
3 LINE_CLEAR_ALL=11 kind:data type:int class:
4 LINE_CLEAR_LEFT=9 kind:data type:int class:
5 LINE_CLEAR_RIGHT=10 kind:data type:int class:
6 PAGE=7 kind:data type:int class:
7 SECTION_CONTINUOUS=3 kind:data type:int class:
8 SECTION_EVEN_PAGE=4 kind:data type:int class:
9 SECTION_NEXT_PAGE=2 kind:data type:int class:
10 SECTION_ODD_PAGE=5 kind:data type:int class:
11 TEXT_WRAPPING=11 kind:data type:int class:4 docx.section.Section
文档部分,提供对部分和页面设置的访问。还提供对页眉和页脚的访问。
property
2 different_first_page_header_footer=
3 even_page_footer=
4 even_page_header=
5 first_page_footer=
6 first_page_header=
7 footer=
8 footer_distance=
9 gutter=
10 header=
11 header_distance=
12 left_margin=
13 orientation=
14 page_height=
15 page_width=
16 right_margin=
17 start_type=
18 top_margin=5 docx.section.Sections
|Section|对象的顺序,对应文档中的Section。支持``len()``,迭代和索引访问。
6 docx.shared.ElementProxy
lxml元素代理类的基类。元素代理类的主要职责是操作XML元素的属性和子元素。它们是python-docx中除了自定义元素(oxml)类之外最常见的类类型。
property
2 part=7 docx.shared.Emu
长度的英文公制单位的方便构造函数,例如``width = Emu(457200)``。
8 docx.document.Document
WordprocessingML (WML)文档。不打算直接构造。用途 :func:`docx.Document` 以打开或创建文档。
property
2 inline_shapes=
3 paragraphs=
4 part=
5 sections=
6 settings=
7 styles=
8 tables=method
9 add_heading()
返回新添加到文档末尾的标题段。标题段落将包含*text*,其段落样式由*level*决定。
如果*level*为0,则样式设置为`Title`。
如果*level*为1(或省略),则使用`Heading 1`。
否则样式设置为`Heading {level}`。如果*level*在0-9范围之外,则引发|ValueError|。
10 add_page_break()
只包含一个换行符的段落对象|Paragraph|。
11 add_paragraph()
返回一个新添加到文档末尾的段落,填充为*text*,并具有段落样式*style*。
*text*可以包含制表符(``\t``)字符,这些字符被转换为制表符的适当XML形式。
*text*也可以包含换行符(``\n``)或回车符(``\r``)字符,每个字符都转换为换行符。
12 add_picture()
返回在文档末尾自己的段落中添加的新图片形状。这张图片包含在*image_path_or_stream* *图像路径或流*,
根据*width*和*height*缩放。如果既没有指定宽度也没有指定高度,则图片显示为其原始大小。
如果只指定了一个,它将用于计算缩放因子,然后应用于未指定的维度,保留图像的纵横比。
图片的原始大小是使用图像文件中指定的点/英寸(dpi)值来计算的,如果没有指定值,通常情况下默认为72 dpi。
13 add_section()
返回一个|Section|对象,表示在文档末尾添加的新节。
可选的*start type*参数必须是:ref:`WdSectionStart`枚举的成员,默认为``WD_SECTION.NEW_PAGE``,如果没有提供。
14 add_table()
添加一个行数为*rows*和列数为*cols*的表,表样式为*style*。
*style*可以是段落样式对象,也可以是段落样式名称。如果*style*为|None|,表将继承文档的默认表样式。
15 save()
将该文档保存到*path或stream*,可以是文件系统位置的路径(字符串)或类文件对象。
9 docx.document._Body
本文档中``
method
1 clear_content()
清除所有内容后返回|_Body|实例。主文档故事的节属性(如果存在)将被保留。
私有或局部
剩余
12 spec ModuleSpec(name=‘docx.document’, loader=<_frozen_importlib_external.SourceFileLoader object at 0x0000000003B5FAC8>, origin=‘…\lib\site-packages\docx\document.py’)
13 absolute_import _Feature((2, 5, 0, ‘alpha’, 1), (3, 0, 0, ‘alpha’, 0), 16384)
14 division _Feature((2, 2, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 8192)
15 print_function _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 65536)
16 unicode_literals _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 131072)统计
序号
类别
数量
4
str
5
8
dict
1
10
class
2
13
residual
6
14
system
8
16
all
14
【docx.settings】
对象,提供对文档级设置的访问
类
1 docx.shared.ElementProxy
lxml元素代理类的基类。元素代理类的主要职责是操作XML元素的属性和子元素。
它们是python-docx中除了自定义元素(oxml)类之外最常见的类类型。
property
2 part=2 docx.settings.Settings
提供对文档的文档级设置的访问。访问使用:attr:`.Document.settings`属性。
property
剩余
4 spec ModuleSpec(name=‘docx.settings’, loader=<_frozen_importlib_external.SourceFileLoader object at 0x0000000003BA2148>, origin=‘…\lib\site-packages\docx\settings.py’)
5 absolute_import _Feature((2, 5, 0, ‘alpha’, 1), (3, 0, 0, ‘alpha’, 0), 16384)
6 division _Feature((2, 2, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 8192)
7 print_function _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 65536)
8 unicode_literals _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 131072)统计
序号
类别
数量
4
str
5
6
list
1
8
dict
1
9
module
3
10
class
1
13
residual
6
14
system
9
16
all
17
【docx.styles】
docx的子包模块,样式子包。
模块
1 docx.styles.latent
潜在的样式相关对象。
2 docx.styles.style
样式对象层次结构。
3 docx.styles.styles
样式对象,是样式部分中所有对象的容器
类
4 docx.styles.BabelFish
将特殊情况下的样式名称从UI名称(例如Heading 1标题1)转换为internal/styles.xml名称(例如heading 1)。
data
2 style_aliases=((‘Caption’, ‘caption’), (‘Footer’, ‘footer’), (‘Header’, ‘header’), ('Heading 1… kind:data type:tuple class:
3 ui_style_names={‘caption’: ‘Caption’, ‘footer’: ‘Footer’, ‘header’: ‘Header’, ‘heading 1’: 'Hea… kind:data type:dict class:class method
4 internal2ui()
5 ui2internal()
剩余
6 spec ModuleSpec(name=‘docx.styles’, loader=<_frozen_importlib_external.SourceFileLoader object at 0x0000000003BA2708>, origin=‘…\lib\site-packages\docx\styles\init.py’, submodule_search_locations=[‘…\lib\site-packages\docx\styles’])
7 absolute_import _Feature((2, 5, 0, ‘alpha’, 1), (3, 0, 0, ‘alpha’, 0), 16384)
8 division _Feature((2, 2, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 8192)
9 print_function _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 65536)
10 unicode_literals _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 131072)统计
序号
类别
数量
4
str
5
8
dict
1
10
class
11
11
function
1
13
residual
5
14
system
8
15
private
5
16
all
23
【docx.table】
|表|对象和相关的代理类。
函数
1 lazyproperty(f)
@lazyprop装饰。方法将只在第一次访问时调用,以计算缓存的属性值。之后,返回缓存的值。
类
2 docx.blkcntnr.BlockItemContainer
可包含块项的代理对象的基类。这些容器包括Body、Cell、页眉、页脚、脚注、尾注、注释和文本框对象。提供用于添加块项(如段落或表)的共享功能。
property
2 tables=method
3 add_paragraph()
返回一个新添加到此容器内容末尾的段落,如果存在,则在一次运行中具有*text*,并且具有段落样式*style*。
如果*style*为|None|,则不应用任何段落样式,其效果与应用'Normal'样式相同。
4 add_table()
返回一个*width*的表,包含*rows* rows和*cols*列,新添加到容器的内容中。*width*均匀分布在表列之间。
3 docx.enum.style.WD_STYLE_TYPE
指定四种样式类型之一:段落、字符、列表或表格。
示例
from docx import Document
from docx.enum.style import WD_STYLE_TYPE
styles = Document().styles
assert styles[0].type == WD_STYLE_TYPE.PARAGRAPH
data
2 LIST=LIST (4) kind:data type:EnumValue class:
3 PARAGRAPH=PARAGRAPH (1) kind:data type:EnumValue class:
4 TABLE=TABLE (3) kind:data type:EnumValue class:4 docx.oxml.simpletypes.ST_Merge
data
2 RESTART=restart kind:data type:str class:5 docx.shared.Inches
以英寸为单位的长度方便构造函数,例如。``width = Inches(0.5)``。
6 docx.shared.Parented
为部分下面出现的文档元素提供公共服务,但偶尔可能需要一个祖先对象来提供服务,例如添加或删除关系。提供了``self._parent``属性给子类。
property
7 docx.table.Table
WordprocessingML ``
property
2 autofit=
3 columns=
4 rows=
5 style=
6 table=
7 table_direction=method
8 add_column()
返回一个*width*的|_Column|对象,新添加到表的最右边。
9 add_row()
返回一个|_Row|实例,新添加到表的最底部。
10 cell()
返回|_Cell|实例,对应于表Cell在*row_idx*, *col_idx*的交集,其中(0,0)是最左边的单元格。
11 column_cells()
本表中*column_idx*处的单元格序列。
12 row_cells()
本表中*row_idx*所在行的单元格序列。
8 docx.table._Cell
表的单元格
property
2 tables=
3 text=
4 vertical_alignment=
5 width=method
6 add_paragraph()
返回新添加到此单元格内容末尾的段落。如果存在,*text*将在一次运行中添加到段落中。
如果指定,则应用段落样式*style*。如果*style*未指定或为|None|,结果就好像应用了'Normal'样式。
请注意,单元格中文本的格式可能受到表格样式的影响。*text*可以包含制表符(``\t``)字符,这些字符被转换为制表符的适当XML形式。
*text*也可以包含换行符(``\n``)或回车符(``\r``)字符,每个字符都转换为换行符。
7 add_table()
返回一个新添加到此单元格的表,位于任何现有单元格内容之后,包含*rows* rows和*cols*列。
在表后添加一个空段落,因为Word要求每个单元格中的最后一个元素是段落元素。
8 merge()
返回一个合并的单元格,该单元格和*other_cell*作为对角角,跨越矩形区域。如果单元格没有定义矩形区域,则引发|InvalidSpanError|。
9 docx.table._Column
表列
property
2 table=
3 width=10 docx.table._Columns
|_Column|实例序列,对应表中的列。支持``len()``,迭代和索引访问。
property
11 docx.table._Row
表格行
property
2 height=
3 height_rule=
4 table=12 docx.table._Rows
|_Row|对象序列,对应表中的行。支持``len()``,迭代,索引访问和切片。
property
私有或局部
14 _Column
15 _Columns
16 _Row
17 _Rows 剩余
19 spec ModuleSpec(name=‘docx.table’, loader=<_frozen_importlib_external.SourceFileLoader object at 0x0000000003B5F908>, origin=‘…\lib\site-packages\docx\table.py’)
20 absolute_import _Feature((2, 5, 0, ‘alpha’, 1), (3, 0, 0, ‘alpha’, 0), 16384)
21 print_function _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 65536)
22 unicode_literals _Feature((2, 6, 0, ‘alpha’, 2), (3, 0, 0, ‘alpha’, 0), 131072)