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-document | Python-обёртка для жизненного цикла 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. |
Margin | Margin предоставляет простой контейнер для значений полей страницы (top, left, bottom, right) который может быть передан в API, связанные с разметкой. |
MarkdownSaveOptions | MarkdownSaveOptions позволяет разработчикам настраивать экспорт 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 | Один результат, генерируемый плагином. |
OptimizationOptions | OptimizationOptions.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-документ не проходит проверку или проверку соответствия. |
PerformanceLogger | PerformanceLogger.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 | Целевой формат для операции сохранения. |
Duplex | Enum с 4 членами. |
FieldType | Тип поля формы. |
FormType | Тип PDF-формы. |
PadesLevel | Уровень базового соответствия PAdES, достигнутый подписью. |
Plugin | Идентификаторы доступных low-code плагинов. |
PrintRange | Enum с 4 элементами. |
RevocationStatus | Результат отзыва сертификата (OCSP/CRL). |
SaveFormat | Формат для сохранения PDF-документов. |
StructureTypeStandard | Enum с 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 по запросу для экономии памяти. |
LazyPdfObjectStore | Object-number → карта COS-объектов, которая разбирает из :class:PdfCosParser по запросу. |
MQDecoder | MQ-арифметический декодер Приложения C. |
Matrix | Matrix.translate(x, y) сдвигает систему координат, тогда как Matrix.multiply(other) композирует два преобразования, раскрывая базовые компоненты a‑f. |
OptionalContent | Опциональные группы содержимого документа и их видимость по умолчанию. |
OptionalContentGroup | Одна необязательная группа содержимого (/OCG) документа. |
ParseWarnings | Собирает предупреждения во время парсинга. |
PdfArray | PdfArray предоставляет коллекцию элементов и метод append для построения объектов массивов PDF. |
PdfBoolean | PdfBoolean представляет логическое значение PDF через его свойство ‘value’. |
PdfCorruptedError | Неисправимое повреждение PDF. |
PdfCosParser | Разобрать PDF-файл (байты) в :class:PdfDocument. |
PdfCosWriter | Сериализовать :class:PdfDocument в последовательность байтов PDF. |
PdfDictionary | PdfDictionary ведёт себя как отображение с методами get и pop для доступа к записям. |
PdfDocument | Контейнер для графа COS-объектов PDF. |
PdfEncodingError | Ошибка кодировки шрифта или потока содержимого. |
PdfIndirectReference | PdfIndirectReference раскрывает номер объекта и номер поколения косвенного PDF-объекта. |
PdfMalformedError | Восстанавливаемая некорректная структура PDF. |
PdfName | Класс с 1 методом и 1 свойством. |
PdfNull | Представляет нулевой объект PDF. |
PdfNumber | Класс с 1 методом и 1 свойством. |
PdfObject | Базовый класс для всех объектов PDF COS. |
PdfObjectID | PdfObjectID раскрывает object_number и generation_number косвенного PDF‑объекта, позволяя точно идентифицировать его в таблице перекрёстных ссылок. |
PdfObjectRegistry | PdfObjectRegistry позволяет регистрировать любой PdfObject и позже получать его по его PdfObjectID с помощью методов register() и get(). |
PdfParseError | Базовое исключение для ошибок разбора PDF. |
PdfParseWarning | Некритичная проблема разбора, от которой удалось восстановиться. |
PdfSecurityError | Ошибка, связанная с шифрованием или разрешениями. |
PdfStream | PdfStream ведёт себя как изменяемое отображение; вы можете получать значения с помощью get(key, default) и удалять элементы с помощью pop(key, default). |
PdfString | Класс с 1 методом и 1 свойством. |
PdfTrailerable | Класс с 1 методом. |
PdfValidationError | PDF/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. |
TextObject | A 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_document | Pythonic обёртка для жизненного цикла PDF-документа и основных операций. |
PdfAValidateOptions-generated_pdfa | Параметры для выполнения проверки PDF/A. |
PdfAValidationResult-generated_pdfa | Результат выполнения проверки PDF/A. |
UnsignedContent-generated_forms | Контейнер для неподписанного содержимого (страницы, поля форм, аннотации). |
UnsignedContentAbsorber-generated_forms | Извлекает элементы неподписанного содержимого; включает информацию о полях форм/аннотациях). |
Security
| Класс | Описание: |
|---|---|
CompromiseCheckResult | Класс с 4 свойствами. |
SignaturesCompromiseDetector | Обнаружить возможные индикаторы компрометации в подписанных PDF-файлах. |