Aspose.PDF FOSS для Python

API reference для Aspose.Pdf FOSS для Python. 265 публичных типов, организованных по модулю.

Основной API

КлассОписание:
ActionБазовый класс для интерактивного действия.
AsposePdfExceptionБазовый класс для всех исключений aspose_pdf.
ByteArrayDataSourceИсточник данных, основанный на байтах в памяти.
CdrLoadOptionsПараметры загрузки файлов CDR.
CgmLoadOptionsПараметры загрузки файлов CGM.
ColorPrimitiveОчень маленький цветовой примитив с поддержкой прозрачности.
DataSourceБазовый класс для входов и выходов плагина.
DeprecatedFeatureExceptionВыбрасывается, когда используется устаревшая возможность PDF, не разрешённая в более новых версиях PDF.
DestinationБазовый класс для назначения представления на странице документа.
Document-documentPython-обёртка для жизненного цикла PDF-документа и основных операций.
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Представляет интерактивную форму (AcroForm) в документе PDF.
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Разрешить префиксы и URI пространств имён XMP.
OfdLoadOptionsПараметры загрузки файлов OFD.
OperationResultОдин результат, генерируемый плагином.
OptimizationOptionsOptimizationOptions.to_dict сериализует все флаги оптимизации в словарь для инспекции или вывода JSON.
OptimizeOptionsПараметры для :class:Optimizer.
OptimizerОптимизировать каждый входной PDF (сжатие + очистка неиспользуемых объектов).
OutlineCollectionКоллекция верхнего уровня закладок :class:OutlineItem.
OutlineItemОдна запись закладки в дереве оглавления PDF.
PageСтраница PDF-документа.
PageCollectionКоллекция для управления страницами PDF внутри документа.
PageInfoКласс с 1 свойством.
PdfAConversionResultРезультат операции конвертации PDF/A.
PdfAValidateOptions-pdfaКонтейнер для настроек валидации PDF/A.
PdfAValidationResult-pdfaПодробный результат запуска валидации PDF/A.
PdfAValidatorПлагин, который выполняет валидацию PDF/A на одном или нескольких входных данных.
PdfConstsКласс с 2 методами.
PdfExceptionБазовый класс для исключений, связанных с PDF.
PdfExtractorПростой извлекатель текста и изображений из PDF.
PdfFileEditorФасад для операций редактирования PDF-файлов.
PdfIOExceptionВызывается, когда происходит ошибка ввода/вывода во время обработки PDF.
PdfLoadLimitsНеизменяемые ограничения безопасности для недоверенного ввода PDF и созданных ресурсов.
PdfParseExceptionВызывается, когда происходит ошибка разбора PDF-документа.
PdfPluginБазовый класс для low-code плагинов.
PdfResourceLimitExceptionВызывается, когда обработка PDF превысит настроенный лимит ресурсов.
PdfSecurityExceptionВызывается, когда происходит ошибка шифрования, подписи или прав доступа.
PdfSignatureПредставляет цифровую подпись PDF.
PdfUaValidateOptionsКонтейнер для пакетных настроек проверки PDF/UA.
PdfUaValidationResultПодробный результат проверки структуры PDF/UA (эвристика).
PdfUaValidatorПлагин, который выполняет эвристическую проверку PDF/UA на одном или нескольких вводах.
PdfValidationExceptionВызывается, когда PDF-документ не проходит проверку или проверку соответствия.
PerformanceLoggerPerformanceLogger.log_line(line) записывает диагностическую строку в свойство log логгера для пользовательского трассирования производительности.
PluginOptionsХранит источники входных/выходных данных и их политику ограничения ресурсов PDF.
PointПредставляет точку в 2-мерном пространстве.
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).
TextExtractionOptionsПараметры извлечения текста со страниц PDF.
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.

Перечисления

ПеречислениеОписание:
CertificationLevelУровень сертификации DocMDP подписи.
DocFormatЦелевой формат для операции сохранения.
DuplexEnum с 4 членами.
FieldTypeТип поля формы.
FormTypeТип PDF-формы.
PadesLevelУровень базового соответствия PAdES, достигнутый подписью.
PluginИдентификаторы доступных low-code плагинов.
PrintRangeEnum с 4 элементами.
RevocationStatusРезультат отзыва сертификата (OCSP/CRL).
SaveFormatФормат для сохранения PDF-документов.
StructureTypeStandardEnum с 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 элементами.
PDF3DRenderModeПеречисления PDF3DRenderMode и PDF3DLightingScheme позволяют разработчикам выбирать стиль рендеринга (SOLID, WIREFRAME, TRANSPARENT) и освещение (HEADLAMP, WHITE и др.) для 3D-аннотаций.

Clustering

КлассОписание:
ClusterПредставляет кластер точек данных.
ClusterCollectionКоллекция кластеров.
DataPointПредставляет точку данных в операциях кластеризации.

Engine

КлассОписание:
AbsorbedElementОдин нарисованный путь или размещённое изображение в пространстве страницы (пользователя).
AnnotationNameПодкласс str, который помечает значение для сериализации как имя PDF.
AuthoredFontНормализованный встроенный шрифт и изменяемое сопоставление CID для авторского текста.
AuthoredImageПодготовленные данные изображения и метаданные PDF-XObject изображения.
BitStreamМинимальный бит-ориентированный буфер, используемый кодом совместимости.
BlockОдин элемент экспортируемой структуры.
CffOutlinesДекодировать контуры глифов из программы шрифта CFF (Type 2 charstring).
ChainResultРезультат построения и проверки пути сертификата.
CharacterCollectionТройка реестра, порядка и дополнения CIDSystemInfo.
CidTextCodecКодек для show-строк составного (Type0) шрифта.
CodestreamКласс с 2 методами и 8 свойствами.
ColorПредставляет цвет в PDF-документах.
CompositeFontMetricРасширенные метрики для составного (Type0) шрифта.
ContentStreamParserРазбор PDF-потока содержимого и извлечение простого текста.
CosExtractorИзвлекать страницы, потоки, изображения и метаданные из PdfDocument.
DecodedImageДекодированное изображение JPEG 2000 в виде чередующихся 8-битных образцов.
DecodedJpegДекодированное изображение JPEG.
Decoder-ccittКласс с 2 методами.
Decoder-jbig2Декодер JBIG2, который разбирает структуру сегмента и извлекает данные битовой карты.
Decoder-jpxДекодер потока JPEG 2000 (JPX).
DssMaterialВалидационный материал, предназначенный для (или полученный из) /DSS.
EncodingКласс с 1 методом и 4 членами.
EncryptionUtilsУтилитный класс для PDF-совместимого AES-CBC, шифрования RC4 и вывода ключа.
FontResolverИндексировать внешние источники шрифтов и сопоставлять имена шрифтов PDF с ними.
GeneratedAppearanceСинтезированное отображение: байты содержимого плюс любые требуемые ExtGState записи.
GlyphPlacementОдин сформированный глиф в позиции, заданной относительно эм, внутри выстроенной строки.
ImagePlacement-simple_pdfПредставляет размещение изображения на странице.
ImagePlacementAbsorber-simple_pdfПоглотитель, который находит размещения изображений в PDF.
IncrementalUpdateСоздать секцию инкрементного обновления для существующего PDF.
IncrementalWriterУтилита, которая добавляет инкрементные обновления к существующему PDF.
Jpeg2000ErrorКодовый поток JPEG 2000, который не может быть декодирован.
LayoutElementРазмещённый элемент содержимого страницы (текстовый объект или image paint).
LayoutLineОдна визуальная строка с логическим заменяющим текстом и сформированными glyphs.
LayoutResultПолный макет строки; координаты глифов и их ширины указаны в единицах em.
LazyImageDictСловарь, который декодирует image streams по запросу для экономии памяти.
LazyPdfObjectStoreObject-number → карта COS-объектов, которая разбирает из :class:PdfCosParser по запросу.
MQDecoderMQ-арифметический декодер Приложения C.
MatrixMatrix.translate(x, y) сдвигает систему координат, тогда как Matrix.multiply(other) композирует два преобразования, раскрывая базовые компоненты a‑f.
OptionalContentОпциональные группы содержимого документа и их видимость по умолчанию.
OptionalContentGroupОдна необязательная группа содержимого (/OCG) документа.
ParseWarningsСобирает предупреждения во время парсинга.
PdfArrayPdfArray предоставляет коллекцию элементов и метод append для построения объектов массивов PDF.
PdfBooleanPdfBoolean представляет логическое значение PDF через его свойство ‘value’.
PdfCorruptedErrorНеисправимое повреждение PDF.
PdfCosParserРазобрать PDF-файл (байты) в :class:PdfDocument.
PdfCosWriterСериализовать :class:PdfDocument в последовательность байтов PDF.
PdfDictionaryPdfDictionary ведёт себя как отображение с методами get и pop для доступа к записям.
PdfDocumentКонтейнер для графа COS-объектов PDF.
PdfEncodingErrorОшибка кодировки шрифта или потока содержимого.
PdfIndirectReferencePdfIndirectReference раскрывает номер объекта и номер поколения косвенного PDF-объекта.
PdfMalformedErrorВосстанавливаемая некорректная структура PDF.
PdfNameКласс с 1 методом и 1 свойством.
PdfNullПредставляет нулевой объект PDF.
PdfNumberКласс с 1 методом и 1 свойством.
PdfObjectБазовый класс для всех объектов PDF COS.
PdfObjectIDPdfObjectID раскрывает object_number и generation_number косвенного PDF‑объекта, позволяя точно идентифицировать его в таблице перекрёстных ссылок.
PdfObjectRegistryPdfObjectRegistry позволяет регистрировать любой PdfObject и позже получать его по его PdfObjectID с помощью методов register() и get().
PdfParseErrorБазовое исключение для ошибок разбора PDF.
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Компактный просмотр сопоставления кода с CID предопределённой CMap.
RasterizedPageОтрисованная страница PDF в упакованном формате RGB.
RecipientPayloadТо, что несёт открытый конверт.
ReshaperПолитика формирования замен сложных сценариев при редактировании текста.
ResolvedFaceПрограммный шрифт, выбранный для не встроенного шрифта PDF.
RevocationResultКласс с 3 свойствами.
RichRunКласс с 2 свойствами.
RichStyleРазрешённый стиль текстового фрагмента.
SfntFaceМетаданные, полученные из одного SFNT-face.
ShadingБазовый класс для ограниченной выборки RGB в целевом пространстве затенения.
SignedDataInfoВсе, что нам нужно из разобранного CMS SignedData.
SignerVerificationРезультат проверки одного подписанта.
SigningUtilsВспомогательный класс для генерации сертификатов и подписей PKCS#7.
SimpleFontMetricМетрики advance для простого однобайтового шрифта в глифовом пространстве 1000 единиц.
SimplePdfСобственное представление PDF-документа Python.
StandardFontsВспомогательный класс для 14 стандартных шрифтов PDF.
StreamDecoderДекодировать данные PDF-потока, используя поддерживаемые фильтры.
StreamEncoderКодировать необработанные байты в данные PDF-потока, обратное к :class:StreamDecoder.
TagTreeДерево тегов B.10.2, используемое для включения и сигнализации нулевого битового плана.
TextFragmentAbsorber-simple_pdfПоглотитель, который извлекает текстовые фрагменты из экземпляра SimplePdf.
TextObjectA BT …
TiffPageОдно изображение в файле TIFF.
TimestampInfoРезультат проверки токена временной метки RFC 3161.
TrueTypeOutlinesДекодировать контуры глифов из встроенной TrueType (glyf) программы.
Type1OutlinesДекодировать контуры глифов из программы шрифта Type 1 (/FontFile).
XmpArrayУпорядоченное значение массива XMP.
XmpFieldОдно XMP-свойство.
XmpNamespaceProviderДвунаправленный разрешатель URI префикса пространства имён XMP.
XmpPacketПакет XMP в памяти: упорядоченная коллекция свойств.
XmpPropertyСвойство, несущие произвольные квалификаторы.
XmpStructСтруктурированное значение XMP (блок rdf:parseType="Resource").

Перечисления

ПеречислениеОписание:
EncodingTypeПеречисление с 5 элементами.
FilterTypeПеречисление FilterType содержит список поддерживаемых названий фильтров потоков, таких как FLATE_DECODE, LZW_DECODE и DCT_DECODE.

Generated

КлассОписание:
Document-generated_documentPythonic обёртка для жизненного цикла PDF-документа и основных операций.
PdfAValidateOptions-generated_pdfaПараметры для выполнения проверки PDF/A.
PdfAValidationResult-generated_pdfaРезультат выполнения проверки PDF/A.
UnsignedContent-generated_formsКонтейнер для неподписанного содержимого (страницы, поля форм, аннотации).
UnsignedContentAbsorber-generated_formsИзвлекает элементы неподписанного содержимого; включает информацию о полях форм/аннотациях).

Security

КлассОписание:
CompromiseCheckResultКласс с 4 свойствами.
SignaturesCompromiseDetectorОбнаружить возможные индикаторы компрометации в подписанных PDF-файлах.

 Русский