91 lines
2.3 KiB
Python
91 lines
2.3 KiB
Python
"""Helpers for working with PDF types."""
|
|
|
|
from abc import abstractmethod
|
|
from collections.abc import Sequence
|
|
from pathlib import Path
|
|
from typing import IO, Any, Literal, Optional, Protocol, Union
|
|
|
|
from ._utils import StrByteType, StreamType
|
|
|
|
|
|
class PdfObjectProtocol(Protocol):
|
|
indirect_reference: Any
|
|
|
|
def clone(
|
|
self,
|
|
pdf_dest: Any,
|
|
force_duplicate: bool = False,
|
|
ignore_fields: Union[tuple[str, ...], list[str], None] = (),
|
|
) -> Any:
|
|
... # pragma: no cover
|
|
|
|
def _reference_clone(self, clone: Any, pdf_dest: Any) -> Any:
|
|
... # pragma: no cover
|
|
|
|
def get_object(self) -> Optional["PdfObjectProtocol"]:
|
|
... # pragma: no cover
|
|
|
|
def hash_value(self) -> bytes:
|
|
... # pragma: no cover
|
|
|
|
def write_to_stream(
|
|
self, stream: StreamType, encryption_key: Union[str, bytes, None] = None
|
|
) -> None:
|
|
... # pragma: no cover
|
|
|
|
|
|
class XmpInformationProtocol(PdfObjectProtocol):
|
|
pass
|
|
|
|
|
|
class PdfCommonDocProtocol(Protocol):
|
|
@property
|
|
def pdf_header(self) -> str:
|
|
... # pragma: no cover
|
|
|
|
@property
|
|
def pages(self) -> Sequence[Any]:
|
|
... # pragma: no cover
|
|
|
|
@property
|
|
def root_object(self) -> PdfObjectProtocol:
|
|
... # pragma: no cover
|
|
|
|
def get_object(self, indirect_reference: Any) -> Optional[PdfObjectProtocol]:
|
|
... # pragma: no cover
|
|
|
|
@property
|
|
def strict(self) -> bool:
|
|
... # pragma: no cover
|
|
|
|
|
|
class PdfReaderProtocol(PdfCommonDocProtocol, Protocol):
|
|
@property
|
|
@abstractmethod
|
|
def xref(self) -> dict[int, dict[int, Any]]:
|
|
... # pragma: no cover
|
|
|
|
@property
|
|
@abstractmethod
|
|
def trailer(self) -> dict[str, Any]:
|
|
... # pragma: no cover
|
|
|
|
|
|
class PdfWriterProtocol(PdfCommonDocProtocol, Protocol):
|
|
_objects: list[Any]
|
|
# The "PreventGC" entry holds the source document, keeping it alive while
|
|
# the translation table is in use.
|
|
_id_translated: dict[int, dict[Union[int, Literal["PreventGC"]], Any]]
|
|
|
|
incremental: bool
|
|
# Only populated in incremental mode, None otherwise.
|
|
_reader: Optional[Any] # PdfReader
|
|
|
|
@abstractmethod
|
|
def write(self, stream: Union[Path, StrByteType]) -> tuple[bool, IO[Any]]:
|
|
... # pragma: no cover
|
|
|
|
@abstractmethod
|
|
def _add_object(self, obj: Any) -> Any:
|
|
... # pragma: no cover
|