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`	Pythonic-обгортка для життєвого циклу 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`	Представляє точку у 2D просторі.
`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`	Визначити Uniform Resource Identifier (зазвичай веб-посилання).
`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, Table 169).
`PDF3DLightingScheme`	Перелічення з 5 елементами.
`PDF3DRenderMode`	PDF3DRenderMode та PDF3DLightingScheme — це перечислення, які дозволяють розробникам вибирати стиль рендерингу (SOLID, WIREFRAME, TRANSPARENT) та тип освітлення (HEADLAMP, WHITE тощо) для 3D-аннотацій.

Clustering

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

Engine

Клас	Опис
`AbsorbedElement`	Один намальований шлях або розміщене зображення у просторі сторінки (користувача).
`AnnotationName`	Підклас `str`, який позначає значення для серіалізації як PDF-ім’я.
`AuthoredFont`	Нормалізований вбудований шрифт і змінюване CID mapping для створеного тексту.
`AuthoredImage`	Підготовлені дані зображення та метадані PDF image XObject.
`BitStream`	Мінімальний біт-орієнтований буфер, що використовується кодом сумісності.
`Block`	Один елемент експортованої структури.
`CffOutlines`	Декодувати контури гліфів з програми шрифту CFF (Type 2 charstring).
`ChainResult`	Результат побудови та валідації ланцюжка сертифікатів.
`CharacterCollection`	Реєстр CIDSystemInfo, порядок і додаткове трійне значення.
`CidTextCodec`	Кодек для show strings складного (Type0) шрифту.
`Codestream`	Клас з 2 методами та 8 властивостями.
`Color`	Представляє колір у PDF-документах.
`CompositeFontMetric`	Advance metrics для composite (Type0) шрифту.
`ContentStreamParser`	Проаналізуйте потік вмісту PDF і витягніть простий текст.
`CosExtractor`	Витягніть сторінки, потоки, зображення та метадані з PdfDocument.
`DecodedImage`	Декодоване зображення JPEG 2000 у вигляді перемішаних 8-бітових зразків.
`DecodedJpeg`	Декодоване зображення JPEG.
`Decoder-ccitt`	Клас з 2 методами.
`Decoder-jbig2`	Декодер JBIG2, який розбирає структуру сегмента та витягує дані bitmap.
`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`	Розташований елемент вмісту сторінки (текстовий об’єкт або малюнок зображення).
`LayoutLine`	Один візуальний рядок із логічним замінним текстом та сформованими гліфами.
`LayoutResult`	Повний макет рядка; координати гліфів і їх ширини вказані в одиницях em.
`LazyImageDict`	Словник, який декодує потоки зображень за вимогою, щоб заощадити пам’ять.
`LazyPdfObjectStore`	Відображення номеру об’єкта → 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 null-об’єкт.
`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.
`Shading`	Базовий клас для обмеженого RGB-семплінгу у цільовому просторі затінення.
`SignedDataInfo`	Все, що нам потрібно від розпарсеного CMS `SignedData`.
`SignerVerification`	Результат перевірки одного підписанта.
`SigningUtils`	Клас-утиліта для створення сертифікатів та підписів PKCS#7.
`SimpleFontMetric`	Розширені метрики для простого однобайтового шрифту у гліфовому просторі 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`	Enum з 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-файлів.