Method load

src/bcf/bcf/v3/document.py:25–51

Loads the documents from the given zip file directory. Args: zip_path: The directory path inside the zip file. xml_handler: The xml parser/serializer to use. Returns: The documents handler.

(
        cls,
        zip_file: zipfile.ZipFile,
        xml_handler: Optional[AbstractXmlParserSerializer] = None,
    )

    @classmethod
    def load(
        cls,
        zip_file: zipfile.ZipFile,
        xml_handler: Optional[AbstractXmlParserSerializer] = None,
    ) -> Optional["DocumentsHandler"]:
        """
        Loads the documents from the given zip file directory.

        Args:
            zip_path: The directory path inside the zip file.
            xml_handler: The xml parser/serializer to use.

        Returns:
            The documents handler.
        """
        xml_handler = xml_handler or XmlParserSerializer()
        file_to_open = zipfile.Path(zip_file, "documents.xml")
        if not file_to_open.exists():
            return None
        definition = xml_handler.parse(file_to_open.read_bytes(), mdl.DocumentInfo)
        documents = {}
        if def_docs := definition.documents:
            for document in def_docs.document:
                document_path = zipfile.Path(zip_file, f"documents/{document.guid}")
                if document_path.exists():
                    documents[document.filename] = document_path.read_bytes()
        return cls(definition, documents=documents)

    def save(self, bcf_zip: ZipFileInterface) -> None:
        """Save the documents to the zip file."""