Praca z wygenerowaną kompatybilnością API

Praca z wygenerowaną kompatybilnością API

Aspose.PDF FOSS dla Python dostarcza drugą, mniejszą powierzchnię API w podpakiecie aspose_pdf.generated: generated.document.Document, generated.forms.UnsignedContent i UnsignedContentAbsorber, oraz generated.pdfa.PdfAValidateOptions i PdfAValidationResult. Każda z tych klas ma taką samą nazwę jak klasa w głównym API biblioteki (aspose_pdf.Document, aspose_pdf.UnsignedContent i tak dalej), ale są to oddzielne, niezależnie zdefiniowane klasy o ograniczonym zestawie metod. Istnieją jako samodzielna warstwa kompatybilności — zawsze importuj je przy użyciu pełnej ścieżki aspose_pdf.generated.*, aby wiedzieć, którą wywołujesz.

Cykl życia dokumentu za pośrednictwem wygenerowanego Document

generated.document.Document obsługuje podstawowy cykl życia dokumentu: ładowanie, zapisywanie, podstawową optymalizację, szyfrowanie i walidację. Większość jego właściwości jest typowana jako Any, a nie jako bogatsze typy udostępniane w głównej klasie Document.

from aspose_pdf.generated.document import Document

doc = Document()
doc.load_from("input.pdf")

doc.optimize(compress_images=True)
doc.optimize_resources(remove_unused=True)

if doc.validate():
    doc.save("output.pdf")

doc.dispose()

Szyfrowanie i zmiany hasła używają formularza jednego hasła, zamiast oddzielnych haseł użytkownika/właściciela w głównym Document.encrypt:

from aspose_pdf.generated.document import Document

doc = Document()
doc.load_from("input.pdf")

doc.encrypt("secret")
doc.change_passwords("secret", "new-secret")
doc.save("protected.pdf")

Wyodrębnianie niepodpisanej treści

generated.forms.UnsignedContentAbsorber wyodrębnia strony, pola formularzy i adnotacje dokumentu, które nie zostały jeszcze podpisane, do kontenera UnsignedContent. Wywołaj extract(), aby uruchomić wyodrębnianie, a następnie get_extracted() lub has_extracted(), aby sprawdzić wynik bez ponownego uruchamiania.

from aspose_pdf.generated.document import Document
from aspose_pdf.generated.forms import UnsignedContentAbsorber

doc = Document()
doc.load_from("input.pdf")

absorber = UnsignedContentAbsorber()
extracted = absorber.extract()

print(len(extracted.pages), len(extracted.form_fields), extracted.annotations)

if absorber.has_extracted():
    same_result = absorber.get_extracted()

absorber.reset()

UnsignedContent może być także budowany i wypełniany bezpośrednio, niezależnie od absorbentu:

from aspose_pdf.generated.forms import UnsignedContent

bundle = UnsignedContent()
bundle.add_page(some_page)
bundle.add_form_field(some_field)
bundle.add_annotation(some_annotation)

bundle.remove_page(some_page)
bundle.reset()

PDF/A opcje walidacji i wyniki

generated.pdfa.PdfAValidateOptions i PdfAValidationResult są samodzielną parą opcji/rezultatu dla przepływów walidacji w stylu PDF/A. Nie są to klasy zwracane przez główny API’s Document.validate_pdfa() ani konsumowane przez PdfAValidator.process() — te używają własnych, osobno zdefiniowanych klas PdfAValidateOptions i PdfAValidationResult o bogatszym interfejsie (level, warnings, is_heuristic oraz font_lookup_directory).

from aspose_pdf.generated.pdfa import PdfAValidateOptions, PdfAValidationResult

options = PdfAValidateOptions()
options.add_input()
options.set_option("level", "1b")

stored_options = options.get_options()

result = PdfAValidationResult()
result.add_error("Font not embedded: Arial")

summary = result.to_dict()
is_valid = result.is_valid

Wskazówki i najlepsze praktyki

• Importuj każdą klasę generated przez pełną ścieżkę podmodułu (from aspose_pdf.generated.document import Document, oraz analogicznie dla generated.forms i generated.pdfa) — nigdy nie zakładaj, że import samego Document lub UnsignedContent rozwiązuje się do wersji kompatybilnej.
• Nadaj importowanej klasie wyróżniającą nazwę lokalną za każdym razem, gdy plik używa także głównego API w tym samym module, aby dwie powierzchnie pozostały widocznie oddzielone w każdym miejscu wywołania.
• Traktuj generated.pdfa.PdfAValidateOptions/PdfAValidationResult jako samodzielną parę: zbuduj opcje, uruchom własną logikę walidacji i samodzielnie zapisz wyniki przy użyciu add_error() — nie są one automatycznie wypełniane przez Document.validate_pdfa().
• Sprawdź UnsignedContentAbsorber.has_extracted() przed wywołaniem get_extracted(), jeśli nie masz pewności, że extract() już się wykonało.
• Preferuj główny aspose_pdf.Document API dla nowego kodu, chyba że konkretnie potrzebujesz zredukowanego, generowanego interfejsu kompatybilności.

Typowe problemy

FAQ

Czy aspose_pdf.generated jest szkieletem lub placeholderem?

Nie. To prawdziwy, importowalny podpakiet z działającymi klasami — Document, UnsignedContent, UnsignedContentAbsorber, PdfAValidateOptions i PdfAValidationResult — jest po prostu mniejszym, samodzielnym interfejsem niż główny API biblioteki.

Dlaczego generated.document.Document ma taką samą nazwę jak aspose_pdf.Document?

To dwie niezależnie zdefiniowane klasy, które przypadkowo mają tę samą nazwę. Importowanie z aspose_pdf.generated.document zapewnia wersję kompatybilności; importowanie aspose_pdf.Document (lub from aspose_pdf import Document) daje wersję główną.

Czy mogę przekazać generated.pdfa.PdfAValidateOptions do PdfAValidator.process()?

Nie. PdfAValidator.process() jest częścią głównego API i oczekuje własnej klasy PdfAValidateOptions głównego API, która ma inny podpis metody (add_input(source) zamiast metody bezargumentowej add_input()).

Czy UnsignedContentAbsorber.extract() potrzebuje argumentu Document?

Nie. extract() nie przyjmuje żadnych argumentów w wygenerowanej powierzchni zgodności; skonstruuj absorber i wywołaj extract() bezpośrednio.

API Reference Podsumowanie

Zobacz także

• Aspose.PDF for Python — Enterprise Documentation