Python 的 Aspose.PDF FOSS

API reference 用于 Aspose.Pdf FOSS 用于 Python. 265 个公共类型,按模块组织。

核心 API

类描述
Action交互操作的基类。
AsposePdfException所有 aspose_pdf 异常的基类。
ByteArrayDataSource一个以内存字节为后端的数据源。
CdrLoadOptions加载 CDR 文件的选项。
CgmLoadOptions加载 CGM 文件的选项。
ColorPrimitive支持透明度的极小颜色原语。
DataSource插件输入输出的基类。
DeprecatedFeatureException当使用已弃用的 PDF 功能且在较新 PDF 版本中不被允许时抛出。
Destination文档页面上视图目标的基类。
Document-document用于 PDF 文档生命周期和核心操作的 Pythonic 包装器。
Field交互式表单的字段。
FileDataSource基于磁盘文件的数据源。
FileFontSource发现单个文件中包含的字体。
FileSpecification带有类型化元数据的文档级嵌入文件(/Filespec)。
FillMode路径操作的填充模式枚举。
FitBDestination将页面的边界框适配到窗口中。
FitBHDestination将边界框宽度适配,使 top 位于窗口顶部。
FitBVDestination在窗口左侧使用 left 来适配边界框高度。
FitDestination将整页适配至窗口内。
FitHDestination将页面宽度适配,使 top 位于窗口顶部。
FitRDestination将矩形 (left, bottom, right, top) 适配至窗口内。
FitVDestination将页面高度适配,使 left 位于窗口左侧。
FolderFontSource从目录收集字体(可选地递归子文件夹)。
FontDescriptor表示可发现的字体。
FontEmbeddingException当在 PDF 中嵌入字体时出现错误时抛出此异常。
FontRegistry用于解析常用字体名称的单例注册表。
FontRepository聚合字体来源并按名称解析字体。
FontSource外部字体提供者的基类。
FontSubstitutionOptions渲染器可能替换的字体来源。
Form表示 PDF 文档中的交互式表单(AcroForm)。
GoToAction跳转到本文件中的目标。
GoToRAction跳转到另一个(远程)PDF 文件中的目标。
GradientAxialShading表示轴向(线性)渐变着色。
GraphicElement绘制的路径或放置的图像,读取自页面的内容流。
GraphicElementCollection内存中的 :class:GraphicElement 对象列表。
GraphicsAbsorber从 PDF 页面吸收图形元素。
HtmlLoadOptions加载 HTML 文档的选项。
HtmlSaveOptions将 PDF 文档保存为 HTML 的选项。
ImagePlacement-images表示放置在 PDF 页面上的图像。
ImagePlacementAbsorber-images用于从 PDF 页面收集图像位置的吸收器。
IncorrectCMapUsageException当 CMap 使用不正确时抛出。
InvalidFormTypeOperationException在尝试无效的表单类型操作时抛出的异常。
InvalidOperationException当图形元素附加到错误的父级时抛出。
InvalidPasswordException当为加密文档提供错误的密码时抛出。
InvalidPdfFileFormatException当 PDF 文件格式无效或已损坏时抛出。
InvalidValueFormatException当在解析或转换过程中遇到无效值时抛出。
JavaScriptAction运行一个 JavaScript 脚本(逐字序列化,未验证)。
LatexFragment存储 LaTeX 源文本的小值对象。
LaunchAction启动应用程序或打开文件(逐字序列化)。
Layer一个可选的内容组,以及它当前是否显示。
LayerCollection文档的层,可按位置或按名称索引。
License针对 Aspose.PDF. 的许可证管理类
MarginMargin 提供一个用于页面边距值的简单容器(top, left, bottom, right)可传递给布局相关的 API。
MarkdownSaveOptionsMarkdownSaveOptions 让开发者配置 Markdown 导出,包括目标 resources_directory_name, markdown_format,是否 extract_images,以及 image_directory;设置可以序列化为 to_dict.
Matrix3D表示一个 3D 变换矩阵。
MemoryFontSource公开以内存字节形式提供的字体程序。
MergeOptions针对 :class:Merger: 的选项:按顺序连接所有输入。
Merger将每个输入的 PDF 合并为单个文档。
NamedAction预定义的命名操作,例如。
NamespaceProvider解析 XMP 命名空间前缀和 URI。
OfdLoadOptions加载 OFD 文件的选项。
OperationResult插件生成的单个结果。
OptimizationOptionsOptimizationOptions.to_dict 将所有优化标志序列化为字典,以便检查或 JSON 输出。
OptimizeOptions用于 :class:Optimizer 的选项。
Optimizer优化每个输入的 PDF(压缩 + 未使用对象清理)。
OutlineCollection顶层的 :class:OutlineItem 书签集合。
OutlineItemPDF 大纲树中的单个书签条目。
PagePDF 文档的一页。
PageCollection用于在文档中管理 PDF 页面的一组集合。
PageInfo拥有 1 个属性的类。
PdfAConversionResultPDF/A 转换操作的结果。
PdfAValidateOptions-pdfa用于 PDF/A 验证设置的容器。
PdfAValidationResult-pdfa对 PDF/A 验证运行的详细结果。
PdfAValidator插件,在一个或多个输入上运行 PDF/A 验证。
PdfConsts包含 2 个方法的类。
PdfExceptionPDF 相关异常的基类。
PdfExtractor简单的 PDF 文本和图像提取器。
PdfFileEditorPDF 文件编辑操作的外观。
PdfIOException当在 PDF 处理期间出现 I/O 错误时抛出。
PdfLoadLimits对不可信的 PDF 输入和创作资产的不可变安全限制。
PdfParseException当在解析 PDF 文档时出现错误时抛出。
PdfPlugin低代码插件的基类。
PdfResourceLimitException当处理 PDF 时,如果超出已配置的资源限制,则会抛出此异常。
PdfSecurityException当出现加密、签名或权限错误时抛出。
PdfSignature表示 PDF 数字签名。
PdfUaValidateOptions批量 PDF/UA 验证设置的容器。
PdfUaValidationResult对 PDF/UA 结构检查(启发式)的详细结果。
PdfUaValidator在一个或多个输入上运行启发式 PDF/UA 验证的插件。
PdfValidationException当 PDF 文档未通过验证或合规检查时抛出。
PerformanceLoggerPerformanceLogger.log_line(line) 将诊断行记录到记录器的 log 属性,以用于自定义性能跟踪。
PluginOptions保存输入/输出数据源及其 PDF 资源限制策略。
Point表示二维空间中的一点。
Point3D表示一个 3D 点。
PrinterSettings具有 11 个属性的类。
Recipient一个可能打开文档的证书,以及它随后可能执行的操作。
Rectangle表示 PDF 页面上图像放置边界的矩形。
RegexResult封装在 PDF 页面上找到的单个正则表达式匹配。
ResetFormAction将表单的字段重置为默认值。
ResultContainer保存插件操作的有序结果。
SplitOptions选项用于 :class:Splitter: 将第一个输入拆分为单独的页面。
Splitter将第一个输入 PDF 拆分为每页一个文档。
StatisticsEntry用于跟踪统计信息和时间信息的条目。
StreamDataSource由二进制流支持的数据源(例如.
StructureElement标记 PDF 中可变的逻辑结构元素。
SubmitFormAction将表单的字段值发送到 url.
SvgLoadOptions-load_options加载 SVG 文件的选项。
SvgLoadOptions-svg包含 1 个方法和 2 个属性的类。
SystemFontSource从常见的系统字体目录收集字体。
TaggedContent文档逻辑结构树的可编辑视图。
TaggedContext具有4个属性的类。
TextAbsorber从 PDF 页面吸收文本(旧版类,是 TextFragmentAbsorber 的别名)。
TextExtractionOptionsPDF 页面文本提取的选项。
TextExtractor从每个输入的 PDF 中提取纯文本。
TextExtractorOptions用于 :class:TextExtractor: 从每个输入中提取文本的选项。
TextFormattingMode用于文本提取的文本格式模式。
TextFragment在 PDF 页面中发现的文本片段。
TextFragmentAbsorber-text从 PDF 页面或文档中吸收文本片段。
TextFragmentCollection一个可变的有序集合,包含 :class:TextFragment 对象。
TextLayoutOptions为 Page.add_text 配置复杂文本的整形和行布局。
TextSearchOptions控制文本搜索执行方式的选项。
URIAction解析统一资源标识符(通常是网页链接)。
UnsignedContent-forms表示 PDF 文档中未签名内容元素的集合。
UnsignedContentAbsorber-forms从 PDF 文档中提取未签名的表单字段和注释。
UnsupportedFeatureException当兼容层引用了本包缺少的功能时抛出此异常。
ValidationOptions签名验证的配置。
ValidationResult签名验证返回的结构化结果。
VirtualizationPerformance包含5个方法的类。
WarichuWPElement用于API兼容性的最小标记元素类型。
XYZDestination将(left, top)定位于左上角,可选地使用zoom。

枚举

枚举描述
CertificationLevelDocMDP 签名的认证级别.
DocFormat保存操作的目标格式。
Duplex具有 4 个成员的枚举。
FieldType表单字段的类型。
FormTypePDF 表单的类型。
PadesLevel签名所达到的 PAdES 基线合规级别。
Plugin可用低代码插件的标识符。
PrintRange包含4个成员的枚举。
RevocationStatus证书撤销结果(OCSP/CRL)。
SaveFormat用于保存 PDF 文档的格式。
StructureTypeStandard具有 15 个成员的枚举。
TrustStatus构建/验证签名者证书链的结果。
ValidationMethod选择签名格式/验证算法。
ValidationMode控制是否通过网络检查证书吊销。
ValidationStatus:class:ValidationResult 的结果。

注释

类描述
Annotation在页面上实时查看单个注释。
AnnotationCollection可变的类似序列的包装器,用于页面注释。
LinkAnnotation具体的注释类型,为了兼容 tests/API 而保留。
MarkupAnnotation标记注释的基类。
PDF3DAnnotation用于预发布导入的最小注释包装器。
PDF3DArtwork用于3D内容和命名视图的容器。
PDF3DContent对存储在磁盘上的 3D 内容的引用。
PDF3DView已保存 3D 视图的轻量描述。

枚举

枚举描述
AnnotationFlags定义注释行为的标志。
AnnotationType已知的注释子类型名称(PDF 32000-1:2008,表 169)。
PDF3DLightingScheme具有5个成员的枚举。
PDF3DRenderModePDF3DRenderMode 和 PDF3DLightingScheme 枚举让开发者能够为 3D 注释选择渲染样式(SOLID、WIREFRAME、TRANSPARENT)和光照(HEADLAMP、WHITE 等)。

Clustering

类描述
Cluster表示一组数据点。
ClusterCollection一组集群。
DataPoint表示聚类操作中的数据点。

Engine

类描述
AbsorbedElement在页面(用户)空间中的单个绘制路径或放置的图像。
AnnotationName一个 str 子类,用于标记一个值以序列化为 PDF 名称。
AuthoredFont一个标准化的嵌入字体以及用于创作文本的可变 CID 映射。
AuthoredImage已准备的图像数据和 PDF 图像 XObject 元数据。
BitStream兼容性代码使用的最小位导向缓冲区。
Block导出结构的一个片段。
CffOutlines解码来自 CFF(Type 2 charstring)字体程序的字形轮廓。
ChainResult构建并验证证书路径的结果。
CharacterCollectionCIDSystemInfo 注册表、排序和补充三元组。
CidTextCodec用于复合 (Type0) 字体的 show 字符串的代码编解码器。
Codestream包含 2 个方法和 8 个属性的类。
Color表示 PDF 文档中的颜色。
CompositeFontMetric复合(Type0)字体的前进度量。
ContentStreamParser解析 PDF 内容流并提取纯文本。
CosExtractor从 PdfDocument 中提取页面、流、图像和元数据。
DecodedImage已解码的 JPEG 2000 图像,以交错的 8 位样本表示。
DecodedJpeg已解码的 JPEG 图像。
Decoder-ccitt具有 2 个方法的类。
Decoder-jbig2解析段结构并提取位图数据的 JBIG2 解码器。
Decoder-jpxJPEG 2000(JPX)流解码器。
DssMaterial用于(或从)/DSS获取的验证材料。
Encoding类有 1 个方法和 4 个成员。
EncryptionUtils用于 PDF 兼容的 AES-CBC、RC4 加密和密钥派生的工具类。
FontResolver索引外部字体来源并根据它们解析 PDF 字体名称。
GeneratedAppearance合成的外观:内容字节加上任何必需的 ExtGState 条目。
GlyphPlacement在已布局的行中位于 em 相对位置的单个成形字形。
ImagePlacement-simple_pdf表示页面上的图像放置。
ImagePlacementAbsorber-simple_pdf用于在 PDF 中查找图像放置位置的 Absorber。
IncrementalUpdate为现有 PDF 生成增量更新节。
IncrementalWriter能够向现有 PDF 追加增量更新的实用程序。
Jpeg2000Error无法解码的 JPEG 2000 编码流。
LayoutElement页面内容的定位块(文本对象或图像绘制)。
LayoutLine一行可视文本,包含逻辑替换文本和形状化字形。
LayoutResult完整的行布局;字形坐标和宽度以 em 为单位。
LazyImageDict在需要时解码图像流以节省内存的字典。
LazyPdfObjectStore对象编号 → COS 对象映射,在需要时从 :class:PdfCosParser 解析。
MQDecoder附录 C 的 MQ 算术解码器。
MatrixMatrix.translate(x, y) 将坐标系平移,而 Matrix.multiply(other) 将两个变换组合起来,暴露底层的 a‑f 组件。
OptionalContent文档的可选内容组及其默认可见性。
OptionalContentGroup文档的一个可选内容组(/OCG)。
ParseWarnings在解析过程中收集警告。
PdfArrayPdfArray 提供一个 items 集合和一个 append 方法来构建 PDF 数组对象。
PdfBooleanPdfBoolean 通过其 ‘value’ 属性表示 PDF 布尔值。
PdfCorruptedError不可恢复的 PDF 损坏。
PdfCosParser将 PDF 文件(字节)解析为 :class:PdfDocument。
PdfCosWriter将 :class:PdfDocument 序列化为 PDF 字节序列。
PdfDictionaryPdfDictionary 的行为类似映射,可使用 get 和 pop 方法访问条目。
PdfDocumentPDF 的 COS 对象图的容器。
PdfEncodingError字体或内容流编码错误。
PdfIndirectReferencePdfIndirectReference 显示间接 PDF 对象的对象号和代号。
PdfMalformedError可恢复的 PDF 结构错误。
PdfName包含 1 个方法和 1 个属性的类。
PdfNull表示 PDF 空对象。
PdfNumber具有 1 个方法和 1 个属性的类。
PdfObject所有 PDF COS 对象的基类。
PdfObjectIDPdfObjectID 公开间接 PDF 对象的 object_number 和 generation_number,从而在交叉引用表中实现精确定位。
PdfObjectRegistryPdfObjectRegistry 允许您注册任意 PdfObject,并通过 register() 和 get() 方法使用其 PdfObjectID 在以后检索。
PdfParseErrorPDF 解析错误的基础异常。
PdfParseWarning已恢复的非致命解析问题。
PdfSecurityError加密或权限相关错误。
PdfStreamPdfStream 表现得像一个可变映射;你可以使用 get(key, default) 检索值,并使用 pop(key, default) 删除条目。
PdfString包含 1 个方法和 1 个属性的类。
PdfTrailerable类含有 1 个方法。
PdfValidationErrorPDF/A 或一般结构验证错误。
PdfWriterV0将 SimplePdf 写入 PDF 1.7 格式。
PredefinedCMap已解析的预定义 CMap 及其语义 Unicode 映射。
PredefinedCMapEncoding预定义 CMap 的紧凑代码到 CID 视图。
RasterizedPage已渲染的 PDF 页面,采用打包 RGB 格式。
RecipientPayload打开的信封所携带的内容。
Reshaper文本编辑期间对复杂脚本替换进行整形的策略。
ResolvedFace为非嵌入式 PDF 字体选择的字体程序。
RevocationResult拥有 3 个属性的类。
RichRun具有2个属性的类。
RichStyle文本运行的已解析样式。
SfntFace从单个 SFNT 字体面恢复的元数据。
Shading用于在着色目标空间中进行受限 RGB 采样的基类。
SignedDataInfo我们从已解析的 CMS SignedData 中所需的全部内容。
SignerVerification验证单个签名者的结果。
SigningUtils用于生成证书和 PKCS#7 签名的实用类。
SimpleFontMetric单字节简体字体的前进度量,使用 1000 单位的字形空间。
SimplePdf本机 Python PDF 文档表示。
StandardFonts用于 PDF 标准 14 种字体的实用类。
StreamDecoder使用支持的过滤器解码 PDF 流数据。
StreamEncoder将原始字节编码为 PDF 流数据,:class:StreamDecoder 的逆操作。
TagTreeB.10.2 的标签树,用于包含和零位平面信号传递。
TextFragmentAbsorber-simple_pdf从 SimplePdf 实例中提取文本片段的吸收器。
TextObjectA BT …
TiffPageTIFF 文件中的单个图像。
TimestampInfo验证 RFC 3161 时间戳令牌的结果。
TrueTypeOutlines从嵌入的 TrueType(glyf)程序中解码字形轮廓。
Type1Outlines从 Type 1(/FontFile)字体程序中解码字形轮廓。
XmpArray有序的 XMP 数组值。
XmpField单个 XMP 属性。
XmpNamespaceProvider双向 XMP 命名空间前缀 URI 解析器。
XmpPacket内存中的 XMP 包:属性的有序集合。
XmpProperty携带任意限定符的属性。
XmpStruct结构化的 XMP 值(一个 rdf:parseType="Resource" 块)。

枚举

枚举描述
EncodingType具有 5 个成员的枚举。
FilterTypeFilterType 枚举列出了支持的流过滤器名称,例如 FLATE_DECODE、LZW_DECODE 和 DCT_DECODE。

Generated

类描述
Document-generated_document针对 PDF 文档生命周期和核心操作的 Pythonic 包装器。
PdfAValidateOptions-generated_pdfa用于 PDF/A 验证运行的选项。
PdfAValidationResult-generated_pdfaPDF/A 验证运行的结果。
UnsignedContent-generated_forms未签名内容(页面、表单字段、注释)的容器。
UnsignedContentAbsorber-generated_forms提取未签名的内容元素;包括表单字段/注释信息。

Security

类描述
CompromiseCheckResult具有4个属性的类。
SignaturesCompromiseDetector检测已签名PDF的潜在妥协指示指标。

 中文