Aspose.PDF FOSS para Python

para API reference Aspose.Pdf FOSS para Python. 265 tipos públicos organizados por módulo.

API de núcleo

ClasseDescrição
ActionClasse base para uma ação interativa.
AsposePdfExceptionClasse base para todas as exceções aspose_pdf.
ByteArrayDataSourceUma fonte de dados suportada por bytes em memória.
CdrLoadOptionsOpções para carregar arquivos CDR.
CgmLoadOptionsOpções para carregar arquivos CGM.
ColorPrimitivePrimitiva de cor muito pequena com suporte a transparência.
DataSourceClasse base para entradas e saídas de plugins.
DeprecatedFeatureExceptionLançada quando um recurso PDF obsoleto é usado e não é permitido em versões mais recentes do PDF.
DestinationClasse base para um destino de visualização em uma página de documento.
Document-documentWrapper pythonic para o ciclo de vida do documento PDF e operações principais.
FieldUm campo de um formulário interativo.
FileDataSourceUma fonte de dados suportada por um arquivo no disco.
FileFontSourceDescubra a(s) font(s) contida(s) em um único arquivo.
FileSpecificationUm arquivo incorporado ao nível de documento (/Filespec) com metadados tipados.
FillModeEnumeração de modo de preenchimento para operações de caminho.
FitBDestinationAjuste a caixa delimitadora da página na janela.
FitBHDestinationAjuste a largura da caixa delimitadora com top na parte superior da janela.
FitBVDestinationAjuste a altura da caixa delimitadora com left à esquerda da janela.
FitDestinationAjuste a página inteira na janela.
FitHDestinationAjuste a largura da página com top na parte superior da janela.
FitRDestinationAjuste o retângulo (left, bottom, right, top) na janela.
FitVDestinationAjuste a altura da página com left à esquerda da janela.
FolderFontSourceColetar fontes de um diretório (opcionalmente percorrendo subpastas).
FontDescriptorRepresenta uma fonte descobrível.
FontEmbeddingExceptionGerada quando há um erro ao incorporar fontes no PDF.
FontRegistryRegistro singleton para resolver nomes de fontes bem conhecidos.
FontRepositoryAgrega fontes de origem e resolve fontes por nome.
FontSourceClasse base para provedores externos de fontes.
FontSubstitutionOptionsFontes de fontes que o renderizador pode substituir.
FormRepresenta um formulário interativo (AcroForm) dentro de um documento PDF.
GoToActionIr para um destino dentro deste documento.
GoToRActionIr para um destino em outro arquivo PDF (remoto).
GradientAxialShadingRepresenta sombreamento gradiente axial (linear).
GraphicElementUm caminho pintado ou uma imagem posicionada, lido a partir do fluxo de conteúdo de uma página.
GraphicElementCollectionUma lista em memória de objetos :class:GraphicElement.
GraphicsAbsorberAbsorve elementos gráficos das páginas PDF.
HtmlLoadOptionsOpções para carregar documentos HTML.
HtmlSaveOptionsOpções para salvar documentos PDF como HTML.
ImagePlacement-imagesRepresenta uma imagem colocada em uma página PDF.
ImagePlacementAbsorber-imagesAbsorvedor para coletar posicionamentos de imagens das páginas PDF.
IncorrectCMapUsageExceptionLançada quando há um uso incorreto do CMap.
InvalidFormTypeOperationExceptionExceção lançada quando uma operação de tipo de formulário inválida é tentada.
InvalidOperationExceptionLançada quando um elemento gráfico é anexado ao pai incorreto.
InvalidPasswordExceptionLançada quando uma senha incorreta é fornecida para um documento criptografado.
InvalidPdfFileFormatExceptionLançada quando o formato de arquivo PDF é inválido ou corrompido.
InvalidValueFormatExceptionLançada quando um valor inválido é encontrado durante a análise ou conversão.
JavaScriptActionExecute um script JavaScript (serializado literalmente, sem validação).
LatexFragmentPequeno objeto de valor que armazena o texto fonte LaTeX.
LaunchActionInicie um aplicativo ou abra um arquivo (serializado literalmente).
LayerUm grupo de conteúdo opcional e se ele está atualmente exibido.
LayerCollectionAs camadas do documento, indexáveis por posição ou por nome.
LicenseClasse de gerenciamento de licença para Aspose.PDF.
MarginMargin fornece um contêiner simples para valores de margem de página (top, left, bottom, right) que pode ser passado para APIs relacionadas ao layout.
MarkdownSaveOptionsMarkdownSaveOptions permite que os desenvolvedores configurem a exportação Markdown, incluindo o destino resources_directory_name, markdown_format, se extract_images, e o image_directory; as configurações podem ser serializadas com to_dict.
Matrix3DRepresenta uma matriz de transformação 3D.
MemoryFontSourceExponha um programa de fonte fornecido como bytes em memória.
MergeOptionsOpções para :class:Merger: concatenar todas as entradas em ordem.
MergerConcatenar cada PDF de entrada em um único documento.
NamedActionUma ação nomeada predefinida, por exemplo.
NamespaceProviderResolve prefixos e URIs de namespace XMP.
OfdLoadOptionsOpções para carregar arquivos OFD.
OperationResultUm único resultado produzido por um plugin.
OptimizationOptionsOptimizationOptions.to_dict serializa todos os sinalizadores de otimização em um dicionário para inspeção ou saída JSON.
OptimizeOptionsOpções para :class:Optimizer.
OptimizerOtimize cada PDF de entrada (compactação + limpeza de objetos não utilizados).
OutlineCollectionColeção de nível superior de marcadores :class:OutlineItem.
OutlineItemUma única entrada de marcador em uma árvore de contorno de PDF.
PageUma página de um documento PDF.
PageCollectionUma coleção para gerenciar páginas PDF dentro de um Documento.
PageInfoClasse com 1 propriedade.
PdfAConversionResultResultado de uma operação de conversão PDF/A.
PdfAValidateOptions-pdfaContêiner para configurações de validação PDF/A.
PdfAValidationResult-pdfaResultado detalhado de uma execução de validação de PDF/A.
PdfAValidatorPlugin que executa a validação de PDF/A em uma ou mais entradas.
PdfConstsClasse com 2 métodos.
PdfExceptionClasse base para exceções relacionadas a PDF.
PdfExtractorExtrator simples de texto e imagem PDF.
PdfFileEditorFacade para operações de edição de arquivos PDF.
PdfIOExceptionLançado quando ocorre um erro de E/S durante o processamento de PDF.
PdfLoadLimitsLimites de segurança imutáveis para entrada de PDF não confiável e assets criados.
PdfParseExceptionLançada quando há um erro ao analisar um documento PDF.
PdfPluginClasse base para plugins low-code.
PdfResourceLimitExceptionLançado quando o processamento de um PDF exceder um limite de recurso configurado.
PdfSecurityExceptionLançado quando ocorre um erro de criptografia, assinatura ou permissões.
PdfSignatureRepresenta uma assinatura digital PDF.
PdfUaValidateOptionsContêiner para configurações de validação em lote PDF/UA.
PdfUaValidationResultResultado detalhado de uma verificação de estrutura PDF/UA (heurística).
PdfUaValidatorPlugin que executa validação heurística de PDF/UA em uma ou mais entradas.
PdfValidationExceptionLançada quando um documento PDF falha na validação ou nas verificações de conformidade.
PerformanceLoggerPerformanceLogger.log_line(line) registra uma linha de diagnóstico na propriedade log do logger para rastreamento de desempenho personalizado.
PluginOptionsMantém fontes de dados de entrada/saída e sua política de limite de recursos de PDF.
PointRepresenta um ponto no espaço 2D.
Point3DRepresenta um ponto 3D.
PrinterSettingsClasse com 11 propriedades.
RecipientUm certificado que pode abrir o documento e o que ele pode fazer depois.
RectangleRetângulo que representa os limites de posicionamento da imagem em uma página PDF.
RegexResultEnvolve uma única correspondência de expressão regular encontrada em uma página PDF.
ResetFormActionRedefina os campos do formulário para seus valores padrão.
ResultContainerMantém os resultados ordenados de uma operação de plugin.
SplitOptionsOpções para :class:Splitter: dividir a primeira entrada em páginas individuais.
SplitterDivida o primeiro PDF de entrada em um documento por página.
StatisticsEntryEntrada para rastrear estatísticas e informações de tempo.
StreamDataSourceUma fonte de dados suportada por um fluxo binário (por exemplo,
StructureElementUm elemento de estrutura lógica mutável em um PDF marcado.
SubmitFormActionEnvie os valores dos campos do formulário para url.
SvgLoadOptions-load_optionsOpções para carregar arquivos SVG.
SvgLoadOptions-svgClasse com 1 método e 2 propriedades.
SystemFontSourceColetar fontes dos diretórios de fontes do sistema comuns.
TaggedContentVisualização editável da árvore de estrutura lógica de um documento.
TaggedContextClasse com 4 propriedades.
TextAbsorberAbsorve texto de páginas PDF (classe legada, alias para TextFragmentAbsorber).
TextExtractionOptionsOpções para extração de texto de páginas PDF.
TextExtractorExtrair texto simples de cada PDF de entrada.
TextExtractorOptionsOpções para :class:TextExtractor: extrair texto de cada entrada.
TextFormattingModeModo de formatação de texto para a extração de texto.
TextFragmentUm fragmento de texto encontrado dentro de uma página PDF.
TextFragmentAbsorber-textAbsorve fragmentos de texto de uma página ou documento PDF.
TextFragmentCollectionUma coleção ordenada mutável de objetos :class:TextFragment.
TextLayoutOptionsConfigure a modelagem de texto complexo e o layout de linhas para Page.add_text.
TextSearchOptionsOpções que controlam como a pesquisa de texto é realizada.
URIActionResolver um identificador uniforme de recurso (geralmente um link da web).
UnsignedContent-formsRepresenta uma coleção de elementos de conteúdo não assinados em um documento PDF.
UnsignedContentAbsorber-formsExtrair campos de formulário e anotações não assinados de um documento PDF.
UnsupportedFeatureExceptionGerado quando uma camada de compatibilidade menciona um recurso que este pacote não possui.
ValidationOptionsConfiguração para validação de assinatura.
ValidationResultResultado estruturado retornado pela validação de assinatura.
VirtualizationPerformanceClasse com 5 métodos.
WarichuWPElementTipo de elemento marcado mínimo para compatibilidade com API.
XYZDestinationPosicione (left, top) no canto superior esquerdo com um zoom opcional.

Enumerações

EnumeraçãoDescrição
CertificationLevelNível de certificação DocMDP de uma assinatura.
DocFormatFormato de destino para uma operação de salvamento.
DuplexEnum com 4 membros.
FieldTypeTipo de campo de formulário.
FormTypeTipo de formulário PDF.
PadesLevelNível de conformidade de baseline PAdES alcançado por uma assinatura.
PluginIdentificadores dos plugins low-code disponíveis.
PrintRangeEnum com 4 membros.
RevocationStatusResultado da revogação do certificado (OCSP/CRL).
SaveFormatFormato para salvar documentos PDF.
StructureTypeStandardEnum com 15 membros.
TrustStatusResultado da construção/validação da cadeia de certificados do assinante.
ValidationMethodSeleciona o formato da assinatura / algoritmo de validação.
ValidationModeControla se a revogação de certificados é verificada via rede.
ValidationStatusResultado de um :class:ValidationResult.

Anotações

ClasseDescrição
AnnotationVisualização ao vivo de uma única anotação em uma página.
AnnotationCollectionWrapper mutável semelhante a uma sequência sobre anotações de página.
LinkAnnotationTipo de anotação concreto mantido para compatibilidade com tests/API.
MarkupAnnotationClasse base para anotações de marcação.
PDF3DAnnotationInvólucro de anotação mínima para importações pré-lançamento.
PDF3DArtworkContêiner para conteúdo 3D e visualizações nomeadas.
PDF3DContentReferência a conteúdo 3D armazenado em disco.
PDF3DViewDescrição leve de uma visualização 3D salva.

Enumerações

EnumeraçãoDescrição
AnnotationFlagsFlags que definem o comportamento da anotação.
AnnotationTypeNomes de subtipo de anotação conhecidos (PDF 32000-1:2008, Tabela 169).
PDF3DLightingSchemeEnum com 5 membros.
PDF3DRenderModeOs enums PDF3DRenderMode e PDF3DLightingScheme permitem que os desenvolvedores escolham o estilo de renderização (SOLID, WIREFRAME, TRANSPARENT) e a iluminação (HEADLAMP, WHITE, etc.) para anotações 3D.

Clustering

ClasseDescrição
ClusterRepresenta um cluster de pontos de dados.
ClusterCollectionUma coleção de clusters.
DataPointRepresenta um ponto de dados em operações de clustering.

Engine

ClasseDescrição
AbsorbedElementUm caminho pintado ou imagem colocada, no espaço da página (do usuário).
AnnotationNameUma subclasse str que marca um valor para ser serializado como um nome PDF.
AuthoredFontUma fonte incorporada normalizada e o mapeamento CID mutável para texto criado.
AuthoredImageDados de imagem preparados e metadados do XObject de imagem PDF.
BitStreamBuffer mínimo orientado a bits usado por código de compatibilidade.
BlockUm elemento da estrutura exportada.
CffOutlinesDecodificar contornos de glifos a partir de um programa de fonte CFF (charstring Tipo 2).
ChainResultResultado da construção e validação de um caminho de certificado.
CharacterCollectionUm registro CIDSystemInfo, ordenação e suplemento triplo.
CidTextCodecCodec de código para as strings de exibição de uma fonte composta (Type0).
CodestreamClasse com 2 métodos e 8 propriedades.
ColorRepresenta uma cor em documentos PDF.
CompositeFontMetricMétricas avançadas para uma fonte composta (Type0).
ContentStreamParserAnalise um fluxo de conteúdo PDF e extraia texto simples.
CosExtractorExtrair páginas, fluxos, imagens e metadados de um PdfDocument.
DecodedImageUma imagem JPEG 2000 decodificada como amostras intercaladas de 8 bits.
DecodedJpegUma imagem JPEG decodificada.
Decoder-ccittClasse com 2 métodos.
Decoder-jbig2Decodificador JBIG2 que analisa a estrutura do segmento e extrai dados de bitmap.
Decoder-jpxDecodificador de Fluxo JPEG 2000 (JPX).
DssMaterialMaterial de validação destinado a (ou coletado de) um /DSS.
EncodingClasse com 1 método e 4 membros.
EncryptionUtilsClasse utilitária para AES-CBC compatível com PDF, criptografia RC4 e derivação de chave.
FontResolverIndexar fontes externas e resolver nomes de fontes PDF contra elas.
GeneratedAppearanceUma aparência sintetizada: bytes de conteúdo mais quaisquer entradas ExtGState necessárias.
GlyphPlacementUm glifo moldado em posição relativa ao em dentro de uma linha formatada.
ImagePlacement-simple_pdfRepresenta uma colocação de imagem na página.
ImagePlacementAbsorber-simple_pdfAbsorvedor que encontra posicionamentos de imagens em um PDF.
IncrementalUpdateGere uma seção de atualização incremental para um PDF existente.
IncrementalWriterUtilitário que adiciona atualizações incrementais a um PDF existente.
Jpeg2000ErrorUm codestream JPEG 2000 que não pode ser decodificado.
LayoutElementUm trecho posicionado de conteúdo da página (um objeto de texto ou uma pintura de imagem).
LayoutLineUma linha visual com texto de substituição lógico e glifos modelados.
LayoutResultLayout completo de linha; coordenadas e larguras dos glifos estão em unidades em.
LazyImageDictDicionário que decodifica fluxos de imagem sob demanda para economizar memória.
LazyPdfObjectStoreMapa de número-objeto → objeto COS que analisa a partir de um :class:PdfCosParser sob demanda.
MQDecoderO decodificador aritmético MQ do Anexo C.
MatrixMatrix.translate(x, y) desloca um sistema de coordenadas, enquanto Matrix.multiply(other) compõe duas transformações, expondo os componentes subjacentes a‑f.
OptionalContentOs grupos de conteúdo opcional do documento e sua visibilidade padrão.
OptionalContentGroupUm grupo de conteúdo opcional (/OCG) do documento.
ParseWarningsColeta avisos durante a análise.
PdfArrayPdfArray fornece uma coleção de itens e um método append para construir objetos de array PDF.
PdfBooleanPdfBoolean representa um valor booleano PDF através da sua propriedade ‘value’.
PdfCorruptedErrorCorrupção de PDF irrecuperável.
PdfCosParserAnalisar um arquivo PDF (bytes) em um :class:PdfDocument.
PdfCosWriterSerializar um :class:PdfDocument para uma sequência de bytes PDF.
PdfDictionaryPdfDictionary comporta-se como um mapeamento com os métodos get e pop para acessar entradas.
PdfDocumentContêiner para o grafo de objetos COS de um PDF.
PdfEncodingErrorErro de codificação de fonte ou fluxo de conteúdo.
PdfIndirectReferencePdfIndirectReference expõe o número do objeto e o número de geração de um objeto PDF indireto.
PdfMalformedErrorEstrutura de PDF malformada recuperável.
PdfNameClasse com 1 método e 1 propriedade.
PdfNullRepresenta o objeto nulo PDF.
PdfNumberClasse com 1 método e 1 propriedade.
PdfObjectClasse base para todos os objetos PDF COS.
PdfObjectIDPdfObjectID expõe o object_number e o generation_number de um objeto PDF indireto, permitindo identificação precisa dentro da tabela de referência cruzada.
PdfObjectRegistryPdfObjectRegistry permite registrar qualquer PdfObject e recuperá-lo posteriormente pelo seu PdfObjectID via os métodos register() e get().
PdfParseErrorExceção base para erros de análise de PDF.
PdfParseWarningProblema de análise não fatal que foi recuperado.
PdfSecurityErrorErro relacionado a criptografia ou permissão.
PdfStreamPdfStream comporta-se como um mapeamento mutável; você pode recuperar valores com get(key, default) e remover entradas com pop(key, default).
PdfStringClasse com 1 método e 1 propriedade.
PdfTrailerableClasse com 1 método.
PdfValidationErrorPDF/A ou erro de validação estrutural geral.
PdfWriterV0Grava SimplePdf no formato PDF 1.7.
PredefinedCMapUm CMap pré-definido resolvido e seu mapeamento semântico Unicode.
PredefinedCMapEncodingVisão compacta de código-para-CID de um CMap pré-definido.
RasterizedPageUma página PDF renderizada em formato RGB compactado.
RecipientPayloadO que um envelope aberto contém.
ReshaperPolítica para modelagem de substituições de script complexo durante uma edição de texto.
ResolvedFaceUm programa de fonte escolhido para uma fonte PDF não incorporada.
RevocationResultClasse com 3 propriedades.
RichRunClasse com 2 propriedades.
RichStyleO estilo resolvido de uma sequência de texto.
SfntFaceMetadados recuperados de uma única face SFNT.
ShadingClasse base para amostragem RGB limitada no espaço-alvo de sombreamento.
SignedDataInfoTudo que precisamos de um CMS analisado SignedData.
SignerVerificationResultado da verificação de um único assinante.
SigningUtilsClasse utilitária para gerar certificados e assinaturas PKCS#7.
SimpleFontMetricMétricas de avanço para uma fonte simples de byte único, no espaço de glifos de 1000 unidades.
SimplePdfRepresentação nativa de documento PDF Python.
StandardFontsClasse utilitária para as 14 fontes padrão do PDF.
StreamDecoderDecodifique os dados de fluxo PDF usando filtros suportados.
StreamEncoderCodifique bytes brutos em dados de fluxo PDF, o inverso de :class:StreamDecoder.
TagTreeA árvore de tags de B.10.2, usada para inclusão e sinalização de plano de bits zero.
TextFragmentAbsorber-simple_pdfAbsorvedor que extrai fragmentos de texto de uma instância SimplePdf.
TextObjectA BT …
TiffPageUma imagem em um arquivo TIFF.
TimestampInfoResultado da verificação de um token de timestamp RFC 3161.
TrueTypeOutlinesDecodificar contornos de glifos de um programa TrueType (glyf) incorporado.
Type1OutlinesDecodifique contornos de glifos de um programa de fonte Type 1 (/FontFile).
XmpArrayUm valor de array XMP ordenado.
XmpFieldUma única propriedade XMP.
XmpNamespaceProviderResolvedor bidirecional de URI de prefixo de namespace XMP.
XmpPacketUm pacote XMP em memória: uma coleção ordenada de propriedades.
XmpPropertyUma propriedade que transporta qualificadores arbitrários.
XmpStructUm valor XMP estruturado (um bloco rdf:parseType="Resource").

Enumerações

EnumeraçãoDescrição
EncodingTypeEnum com 5 membros.
FilterTypeO enum FilterType lista os nomes de filtros de fluxo suportados, como FLATE_DECODE, LZW_DECODE e DCT_DECODE.

Generated

ClasseDescrição
Document-generated_documentWrapper pythonic para o ciclo de vida de documentos PDF e operações essenciais.
PdfAValidateOptions-generated_pdfaOpções para uma execução de validação de PDF/A.
PdfAValidationResult-generated_pdfaResultado de uma execução de validação de PDF/A.
UnsignedContent-generated_formsContêiner para conteúdo não assinado (páginas, campos de formulário, anotações).
UnsignedContentAbsorber-generated_formsExtrai elementos de conteúdo não assinado; inclui informações de campo de formulário/anotação.

Security

ClasseDescrição
CompromiseCheckResultClasse com 4 propriedades.
SignaturesCompromiseDetectorDetectar possíveis indicadores de comprometimento em PDFs assinados.

 Português