Method load

docling_parse/pdf_parser.py:1439–1490

Load a document for parallel processing. Parameters: path_or_stream: File path or BytesIO object. password: Optional password for protected files. page_numbers: Optional 1-indexed physical pages to schedule. Returns: str: The document

(
        self,
        path_or_stream: Union[str, Path, BytesIO],
        password: str | None = None,
        page_numbers: Sequence[int] | None = None,
    )

            )

    def load(
        self,
        path_or_stream: Union[str, Path, BytesIO],
        password: str | None = None,
        page_numbers: Sequence[int] | None = None,
    ) -> str:
        """Load a document for parallel processing.

        Parameters:
            path_or_stream: File path or BytesIO object.
            password: Optional password for protected files.
            page_numbers: Optional 1-indexed physical pages to schedule.

        Returns:
            str: The document key.
        """
        if isinstance(path_or_stream, str):
            path_or_stream = Path(path_or_stream)

        if isinstance(path_or_stream, Path):
            key = f"key={path_or_stream!s}"
            success = self._parser.load_document(
                key=key,
                filename=str(path_or_stream).encode("utf8"),
                password=password,
                page_numbers=list(page_numbers) if page_numbers is not None else None,
            )
        elif isinstance(path_or_stream, BytesIO):
            hasher = hashlib.sha256(usedforsecurity=False)
            while chunk := path_or_stream.read(8192):
                hasher.update(chunk)
            path_or_stream.seek(0)
            hash_val = hasher.hexdigest()

            key = f"key={hash_val}"
            success = self._parser.load_document_from_bytesio(
                key=key,
                bytes_io=path_or_stream,
                password=password,
                page_numbers=list(page_numbers) if page_numbers is not None else None,
            )
        else:
            raise TypeError(
                f"Expected str, Path, or BytesIO, got {type(path_or_stream)}"
            )

        if not success:
            raise RuntimeError(f"Failed to load document with key {key}")

        self._page_counts[key] = self._parser.number_of_pages(key)
        self._scheduled_page_counts[key] = self._parser.scheduled_number_of_pages(key)
        return key

    def page_count(self, doc_key: str) -> int:
        """Return the total page count for a loaded document."""