Aspose.PDF FOSS pour Python

API reference pour Aspose.Pdf FOSS pour Python. 265 types publics organisés par module.

API principale

ClasseDescription
ActionClasse de base pour une action interactive.
AsposePdfExceptionClasse de base pour toutes les aspose_pdf exceptions.
ByteArrayDataSourceUne source de données reposant sur des octets en mémoire.
CdrLoadOptionsOptions de chargement des fichiers CDR.
CgmLoadOptionsOptions de chargement des fichiers CGM.
ColorPrimitivePrimitive de couleur très petite avec prise en charge de la transparence.
DataSourceClasse de base pour les entrées et sorties du plugin.
DeprecatedFeatureExceptionLevée lorsqu’une fonctionnalité PDF obsolète est utilisée et n’est pas autorisée dans les versions PDF plus récentes.
DestinationClasse de base pour une destination de vue sur une page de document.
Document-documentWrapper pythonique pour le cycle de vie d’un document PDF et les opérations de base.
FieldUn champ d’un formulaire interactif.
FileDataSourceUne source de données supportée par un fichier sur le disque.
FileFontSourceDécouvrez la ou les polices contenues dans un seul fichier.
FileSpecificationUn fichier intégré au niveau du document (/Filespec) avec des métadonnées typées.
FillModeÉnumération du mode de remplissage pour les opérations de chemin.
FitBDestinationAjuster la boîte englobante de la page dans la fenêtre.
FitBHDestinationAjuster la largeur de la boîte englobante avec top en haut de la fenêtre.
FitBVDestinationAjuster la hauteur de la boîte englobante avec left à gauche de la fenêtre.
FitDestinationFaire tenir toute la page dans la fenêtre.
FitHDestinationAdapter la largeur de la page avec top en haut de la fenêtre.
FitRDestinationFaire tenir le rectangle (left, bottom, right, top) dans la fenêtre.
FitVDestinationAdapter la hauteur de la page avec left à gauche de la fenêtre.
FolderFontSourceCollecter les polices depuis un répertoire (en parcourant éventuellement les sous-dossiers).
FontDescriptorReprésente une police découvrable.
FontEmbeddingExceptionLevée lorsqu’une erreur survient lors de l’intégration des polices dans le PDF.
FontRegistryRegistre singleton pour résoudre les noms de polices bien connus.
FontRepositoryAgrège les sources de polices et résout les polices par leur nom.
FontSourceClasse de base pour les fournisseurs de polices externes.
FontSubstitutionOptionsSources de polices que le moteur de rendu peut substituer.
FormReprésente un formulaire interactif (AcroForm) dans un document PDF.
GoToActionAller à une destination dans ce document.
GoToRActionAller à une destination dans un autre fichier PDF (à distance).
GradientAxialShadingReprésente un dégradé axial (linéaire).
GraphicElementUn tracé peint ou une image placée, lu depuis le flux de contenu d’une page.
GraphicElementCollectionUne liste en mémoire d’objets :class:GraphicElement.
GraphicsAbsorberAbsorbe les éléments graphiques des pages PDF.
HtmlLoadOptionsOptions de chargement des documents HTML.
HtmlSaveOptionsOptions d’enregistrement des documents PDF au format HTML.
ImagePlacement-imagesReprésente une image placée sur une page PDF.
ImagePlacementAbsorber-imagesAbsorbeur pour collecter les emplacements d’images depuis les pages PDF.
IncorrectCMapUsageExceptionLevée lorsqu’il y a une utilisation incorrecte de CMap.
InvalidFormTypeOperationExceptionException levée lorsqu’une opération de type de formulaire invalide est tentée.
InvalidOperationExceptionLevée lorsqu’un élément graphique est attaché au mauvais parent.
InvalidPasswordExceptionLevée lorsqu’un mot de passe incorrect est fourni pour un document chiffré.
InvalidPdfFileFormatExceptionLevée lorsque le format de fichier PDF est invalide ou corrompu.
InvalidValueFormatExceptionLevée lorsqu’une valeur invalide est rencontrée lors de l’analyse ou de la conversion.
JavaScriptActionExécuter un script JavaScript (sérialisé mot pour mot, non validé).
LatexFragmentPetit objet valeur qui stocke le texte source LaTeX.
LaunchActionLancer une application ou ouvrir un fichier (sérialisé mot pour mot).
LayerUn groupe de contenu optionnel, et s’il est actuellement affiché.
LayerCollectionLes calques du document, indexables par position ou par nom.
LicenseClasse de gestion de licences pour Aspose.PDF.
MarginMargin fournit un conteneur simple pour les valeurs de marge de page (top, left, bottom, right) qui peuvent être transmises aux API liées à la mise en page.
MarkdownSaveOptionsMarkdownSaveOptions permet aux développeurs de configurer l’export Markdown, y compris la cible resources_directory_name, markdown_format, si extract_images, et le image_directory; les paramètres peuvent être sérialisés avec to_dict.
Matrix3DReprésente une matrice de transformation 3D.
MemoryFontSourceExposez un programme de police fourni sous forme d’octets en mémoire.
MergeOptionsOptions pour :class:Merger : concaténer toutes les entrées dans l’ordre.
MergerConcaténer chaque PDF d’entrée en un seul document.
NamedActionUne action nommée prédéfinie, par ex.
NamespaceProviderRésoudre les préfixes d’espace de noms XMP et les URI.
OfdLoadOptionsOptions de chargement des fichiers OFD.
OperationResultUn résultat unique produit par un plugin.
OptimizationOptionsOptimizationOptions.to_dict sérialise tous les drapeaux d’optimisation dans un dictionnaire pour inspection ou sortie JSON.
OptimizeOptionsOptions pour :class:Optimizer.
OptimizerOptimiser chaque PDF d’entrée (compression + nettoyage des objets inutilisés).
OutlineCollectionCollection de niveau supérieur des signets :class:OutlineItem.
OutlineItemUne entrée de signet unique dans l’arborescence du plan PDF.
PageUne page d’un document PDF.
PageCollectionUne collection pour gérer les pages PDF au sein d’un Document.
PageInfoClasse avec 1 propriété.
PdfAConversionResultRésultat d’une opération de conversion PDF/A.
PdfAValidateOptions-pdfaConteneur pour les paramètres de validation PDF/A.
PdfAValidationResult-pdfaRésultat détaillé d’une exécution de validation PDF/A.
PdfAValidatorPlugin qui exécute la validation PDF/A sur une ou plusieurs entrées.
PdfConstsClasse avec 2 méthodes.
PdfExceptionClasse de base pour les exceptions liées aux PDF.
PdfExtractorExtracteur simple de texte et d’images PDF.
PdfFileEditorFaçade pour les opérations d’édition de fichiers PDF.
PdfIOExceptionLevée lorsqu’une erreur d’I/O survient lors du traitement du PDF.
PdfLoadLimitsLimites de sécurité immuables pour les entrées PDF non fiables et les actifs créés.
PdfParseExceptionLevée lorsqu’une erreur se produit lors de l’analyse d’un document PDF.
PdfPluginClasse de base pour les plugins low-code.
PdfResourceLimitExceptionLevée lorsque le traitement d’un PDF dépasserait une limite de ressources configurée.
PdfSecurityExceptionLevée lorsqu’il y a une erreur de chiffrement, de signature ou de permissions.
PdfSignatureReprésente une signature numérique PDF.
PdfUaValidateOptionsConteneur pour les paramètres de validation par lots PDF/UA.
PdfUaValidationResultRésultat détaillé d’une vérification de la structure PDF/UA (heuristique).
PdfUaValidatorPlugin qui exécute une validation heuristique PDF/UA sur une ou plusieurs entrées.
PdfValidationExceptionDéclenchée lorsqu’un document PDF ne réussit pas les contrôles de validation ou de conformité.
PerformanceLoggerPerformanceLogger.log_line(line) enregistre une ligne de diagnostic dans la propriété log du logger pour le suivi de performance personnalisé.
PluginOptionsConserver les sources de données d’entrée/sortie et leur politique de limite de ressources PDF.
PointReprésente un point dans l’espace 2D.
Point3DReprésente un point 3D.
PrinterSettingsClasse avec 11 propriétés.
RecipientUn certificat qui peut ouvrir le document, et ce qu’il peut ensuite faire.
RectangleRectangle représentant les limites de placement de l’image sur une page PDF.
RegexResultEnveloppe une correspondance unique d’expression régulière trouvée sur une page PDF.
ResetFormActionRéinitialise les champs du formulaire à leurs valeurs par défaut.
ResultContainerContient les résultats ordonnés d’une opération de plug-in.
SplitOptionsOptions pour :class:Splitter: fractionner la première entrée en pages individuelles.
SplitterDivisez le premier PDF d’entrée en un document par page.
StatisticsEntryEntrée pour le suivi des statistiques et des informations de temporisation.
StreamDataSourceUne source de données alimentée par un flux binaire (par ex.
StructureElementUn élément de structure logique mutable dans un PDF balisé.
SubmitFormActionEnvoyez les valeurs des champs du formulaire à url.
SvgLoadOptions-load_optionsOptions de chargement des fichiers SVG.
SvgLoadOptions-svgClasse avec 1 méthode et 2 propriétés.
SystemFontSourceCollectez les polices à partir des répertoires de polices système courants.
TaggedContentVue modifiable de l’arborescence de la structure logique d’un document.
TaggedContextClasse avec 4 propriétés.
TextAbsorberAbsorbe le texte des pages PDF (classe héritée, alias de TextFragmentAbsorber).
TextExtractionOptionsOptions pour l’extraction de texte des pages PDF.
TextExtractorExtraire le texte brut de chaque PDF d’entrée.
TextExtractorOptionsOptions pour :class:TextExtractor: extraire le texte de chaque entrée.
TextFormattingModeMode de formatage du texte pour l’extraction du texte.
TextFragmentUn fragment de texte trouvé à l’intérieur d’une page PDF.
TextFragmentAbsorber-textAbsorbe des fragments de texte d’une page PDF ou d’un document.
TextFragmentCollectionUne collection ordonnée mutable d’objets :class:TextFragment.
TextLayoutOptionsConfigure le modelage de texte complexe et la disposition des lignes pour Page.add_text.
TextSearchOptionsOptions contrôlant la façon dont la recherche de texte est effectuée.
URIActionRésoudre un identifiant de ressource uniforme (généralement un lien web).
UnsignedContent-formsReprésente une collection d’éléments de contenu non signés dans un document PDF.
UnsignedContentAbsorber-formsExtraire les champs de formulaire et les annotations non signés d’un document PDF.
UnsupportedFeatureExceptionLevée lorsqu’une interface de compatibilité mentionne une fonctionnalité que ce paquet ne possède pas.
ValidationOptionsConfiguration de la validation de la signature.
ValidationResultRésultat structuré renvoyé par la validation de signature.
VirtualizationPerformanceClasse avec 5 méthodes.
WarichuWPElementType d’élément balisé minimal pour la compatibilité API.
XYZDestinationPositionnez (left, top) en haut à gauche avec un zoom facultatif.

Énumérations

ÉnumérationDescription
CertificationLevelDocMDP niveau de certification d’une signature.
DocFormatFormat cible pour une opération d’enregistrement.
DuplexÉnumération avec 4 membres.
FieldTypeType de champ de formulaire.
FormTypeType de formulaire PDF.
PadesLevelNiveau de conformité de base PAdES atteint par une signature.
PluginIdentifiants pour les plugins low-code disponibles.
PrintRangeÉnumération avec 4 membres.
RevocationStatusRésultat de la révocation du certificat (OCSP/CRL).
SaveFormatFormat d’enregistrement des documents PDF.
StructureTypeStandardEnum avec 15 membres.
TrustStatusRésultat de la construction/validation de la chaîne de certificats du signataire.
ValidationMethodSélectionne le format de signature / l’algorithme de validation.
ValidationModeContrôle si la révocation de certificat est vérifiée via le réseau.
ValidationStatusRésultat d’un :class:ValidationResult.

Annotations

ClasseDescription
AnnotationVue en direct d’une annotation unique sur une page.
AnnotationCollectionEnveloppe mutable de type séquence pour les annotations de page.
LinkAnnotationType d’annotation concret conservé pour la compatibilité avec tests/API.
MarkupAnnotationClasse de base pour les annotations de balisage.
PDF3DAnnotationEnveloppe d’annotation minimale pour les importations en préversion.
PDF3DArtworkConteneur pour le contenu 3D et les vues nommées.
PDF3DContentRéférence au contenu 3D stocké sur le disque.
PDF3DViewDescription légère d’une vue 3D enregistrée.

Énumérations

ÉnumérationDescription
AnnotationFlagsDrapeaux qui définissent le comportement de l’annotation.
AnnotationTypeNoms de sous-types d’annotation connus (PDF 32000-1:2008, tableau 169).
PDF3DLightingSchemeÉnumération avec 5 membres.
PDF3DRenderModeLes énumérations PDF3DRenderMode et PDF3DLightingScheme permettent aux développeurs de choisir le style de rendu (SOLID, WIREFRAME, TRANSPARENT) et l’éclairage (HEADLAMP, WHITE, etc.) pour les annotations 3D.

Clustering

ClasseDescription
ClusterReprésente un groupe de points de données.
ClusterCollectionUne collection de clusters.
DataPointReprésente un point de données dans les opérations de regroupement.

Engine

ClasseDescription
AbsorbedElementUn chemin peint ou une image placée, dans l’espace de page (utilisateur).
AnnotationNameUne sous-classe str qui marque une valeur à sérialiser en tant que nom PDF.
AuthoredFontUne police intégrée normalisée et le mappage CID mutable pour le texte rédigé.
AuthoredImageDonnées d’image préparées et métadonnées du XObject d’image PDF.
BitStreamTampon minimal orienté bits utilisé par le code de compatibilité.
BlockUn élément de la structure exportée.
CffOutlinesDécoder les tracés de glyphes à partir d’un programme de police CFF (charstring de type 2).
ChainResultRésultat de la construction et de la validation d’un chemin de certificat.
CharacterCollectionUn registre CIDSystemInfo, un ordre et un triple de supplément.
CidTextCodecCodec de code pour les chaînes d’affichage d’une police composite (Type0).
CodestreamClasse avec 2 méthodes et 8 propriétés.
ColorReprésente une couleur dans les documents PDF.
CompositeFontMetricMétriques d’avance pour une police composite (Type0).
ContentStreamParserAnalyser un flux de contenu PDF et extraire le texte brut.
CosExtractorExtraire les pages, les flux, les images et les métadonnées d’un PdfDocument.
DecodedImageUne image JPEG 2000 décodée sous forme d’échantillons entrelacés de 8 bits.
DecodedJpegUne image JPEG décodée.
Decoder-ccittClasse avec 2 méthodes.
Decoder-jbig2Décodeur JBIG2 qui analyse la structure des segments et extrait les données bitmap.
Decoder-jpxDécodeur de flux JPEG 2000 (JPX).
DssMaterialMatériel de validation destiné à (ou prélevé sur) un /DSS.
EncodingClasse avec 1 méthode et 4 membres.
EncryptionUtilsClasse utilitaire pour AES-CBC conforme au PDF, le chiffrement RC4 et la dérivation de clé.
FontResolverIndexer les sources de polices externes et résoudre les noms de polices PDF par rapport à celles-ci.
GeneratedAppearanceUne apparence synthétisée : octets de contenu plus toutes les entrées ExtGState nécessaires.
GlyphPlacementUn glyphe en forme à une position relative à l’em dans une ligne mise en page.
ImagePlacement-simple_pdfReprésente un placement d’image sur une page.
ImagePlacementAbsorber-simple_pdfAbsorbeur qui trouve les emplacements d’images dans un PDF.
IncrementalUpdateGénérer une section de mise à jour incrémentielle pour un PDF existant.
IncrementalWriterUtilitaire qui ajoute des mises à jour incrémentielles à un PDF existant.
Jpeg2000ErrorUn flux de code JPEG 2000 qui ne peut pas être décodé.
LayoutElementUn élément de contenu de page positionné (un objet texte ou un rendu d’image).
LayoutLineUne ligne visuelle avec du texte de remplacement logique et des glyphes façonnés.
LayoutResultDisposition complète de la ligne ; les coordonnées et les largeurs des glyphes sont exprimées en unités em.
LazyImageDictDictionnaire qui décode les flux d’images à la demande pour économiser de la mémoire.
LazyPdfObjectStoreCorrespondance numéro-objet → objet COS qui s’analyse à partir d’un :class:PdfCosParser à la demande.
MQDecoderLe décodeur arithmétique MQ de l’annexe C.
MatrixMatrix.translate(x, y) décale un système de coordonnées, tandis que Matrix.multiply(other) compose deux transformations, exposant les composants a‑f sous-jacents.
OptionalContentLes groupes de contenu optionnel du document et leur visibilité par défaut.
OptionalContentGroupUn groupe de contenu optionnel (/OCG) du document.
ParseWarningsCollecte les avertissements pendant l’analyse.
PdfArrayPdfArray fournit une collection d’items et une méthode append pour créer des objets tableau PDF.
PdfBooleanPdfBoolean représente une valeur booléenne PDF via sa propriété ‘value’.
PdfCorruptedErrorCorruption PDF irrécupérable.
PdfCosParserAnalyser un fichier PDF (octets) en un :class:PdfDocument.
PdfCosWriterSérialiser un :class:PdfDocument en une séquence d’octets PDF.
PdfDictionaryPdfDictionary se comporte comme un mapping avec les méthodes get et pop pour accéder aux entrées.
PdfDocumentConteneur du graphe d’objets COS d’un PDF.
PdfEncodingErrorErreur d’encodage de police ou de flux de contenu.
PdfIndirectReferencePdfIndirectReference expose le numéro d’objet et le numéro de génération d’un objet PDF indirect.
PdfMalformedErrorStructure PDF malformée récupérable.
PdfNameClasse avec 1 méthode et 1 propriété.
PdfNullReprésente l’objet null PDF.
PdfNumberClasse avec 1 méthode et 1 propriété.
PdfObjectClasse de base pour tous les objets PDF COS.
PdfObjectIDPdfObjectID expose les object_number et generation_number d’un objet PDF indirect, permettant une identification précise dans la table des références croisées.
PdfObjectRegistryPdfObjectRegistry vous permet d’enregistrer n’importe quel PdfObject et de le récupérer plus tard par son PdfObjectID via les méthodes register() et get().
PdfParseErrorException de base pour les erreurs d’analyse PDF.
PdfParseWarningProblème d’analyse non fatal dont la récupération a été effectuée.
PdfSecurityErrorErreur liée au chiffrement ou aux autorisations.
PdfStreamPdfStream se comporte comme un mapping mutable ; vous pouvez récupérer les valeurs avec get(key, default) et supprimer les entrées avec pop(key, default).
PdfStringClasse avec 1 méthode et 1 propriété.
PdfTrailerableClasse avec 1 méthode.
PdfValidationErrorPDF/A ou erreur de validation structurelle générale.
PdfWriterV0Écrit SimplePdf au format PDF 1.7.
PredefinedCMapUn CMap prédéfini résolu et son mappage Unicode sémantique.
PredefinedCMapEncodingVue compacte code-vers-CID d’un CMap prédéfini.
RasterizedPageUne page PDF rendue au format RGB empaqueté.
RecipientPayloadCe que porte une enveloppe ouverte.
ReshaperPolitique de mise en forme des remplacements de scripts complexes lors d’une modification de texte.
ResolvedFaceUn programme de police choisi pour une police PDF non incorporée.
RevocationResultClasse avec 3 propriétés.
RichRunClasse avec 2 propriétés.
RichStyleLe style résolu d’un run de texte.
SfntFaceMétadonnées récupérées à partir d’une seule face SFNT.
ShadingClasse de base pour l’échantillonnage RVB limité dans l’espace cible d’un shading.
SignedDataInfoTout ce dont nous avons besoin à partir d’un CMS analysé SignedData.
SignerVerificationRésultat de la vérification d’un seul signataire.
SigningUtilsClasse utilitaire pour générer des certificats et des signatures PKCS#7.
SimpleFontMetricMétriques avancées pour une police simple à octet unique, dans un espace de glyphes de 1000 unités.
SimplePdfReprésentation native du document PDF Python.
StandardFontsClasse utilitaire pour les 14 polices standard du PDF.
StreamDecoderDécoder les données du flux PDF en utilisant les filtres pris en charge.
StreamEncoderEncoder les octets bruts en données de flux PDF, l’inverse de :class:StreamDecoder.
TagTreeL’arbre d’étiquettes de B.10.2, utilisé pour l’inclusion et le signalement à zéro plan de bits.
TextFragmentAbsorber-simple_pdfAbsorbeur qui extrait des fragments de texte d’une instance SimplePdf.
TextObjectA BT …
TiffPageUne image dans un fichier TIFF.
TimestampInfoRésultat de la vérification d’un jeton d’horodatage RFC 3161.
TrueTypeOutlinesDécoder les contours des glyphes à partir d’un programme TrueType (glyf) intégré.
Type1OutlinesDécoder les contours des glyphes à partir d’un programme de police Type 1 (/FontFile).
XmpArrayUne valeur de tableau XMP ordonnée.
XmpFieldUne seule propriété XMP.
XmpNamespaceProviderRésolveur d’URI de préfixe d’espace de noms XMP bidirectionnel.
XmpPacketUn paquet XMP en mémoire : une collection ordonnée de propriétés.
XmpPropertyUne propriété portant des qualificateurs arbitraires.
XmpStructUne valeur XMP structurée (un bloc rdf:parseType="Resource").

Énumérations

ÉnumérationDescription
EncodingTypeEnum avec 5 membres.
FilterTypeL’énum FilterType répertorie les noms de filtres de flux pris en charge tels que FLATE_DECODE, LZW_DECODE et DCT_DECODE.

Generated

ClasseDescription
Document-generated_documentWrapper Pythonic pour le cycle de vie des documents PDF et les opérations principales.
PdfAValidateOptions-generated_pdfaOptions pour une exécution de validation PDF/A.
PdfAValidationResult-generated_pdfaRésultat d’une exécution de validation PDF/A.
UnsignedContent-generated_formsConteneur pour le contenu non signé (pages, champs de formulaire, annotations).
UnsignedContentAbsorber-generated_formsExtrait les éléments de contenu non signé ; inclut les informations de champ de formulaire/annotation.

Security

ClasseDescription
CompromiseCheckResultClasse avec 4 propriétés.
SignaturesCompromiseDetectorDétecter les éventuels indicateurs de compromission autour des PDF signés.

 Français