U cqe@sdZddlmZddlmZmZddlmZddl m Z ddl m Z ddl mZddlmZdd lmZGd d d ZGd d d ZdS)z8Objects that implement reading and writing OPC packages.)RELATIONSHIP_TYPE) PACKAGE_URIPackURI) PartFactory)CorePropertiesPart) PackageReader) PackageWriter) Relationships) lazypropertycseZdZdZfddZddZeddZdd Zd d Z d!d dZ eddZ ddZ e ddZddZeddZddZeddZddZedd ZZS)" OpcPackagezMain API class for |python-opc|. A new instance is constructed by calling the :meth:`open` class method with a path to a package file or file-like object containing one. cstt|dSN)superr __init__self __class__4/tmp/pip-unpacked-wheel-gx5hpqp3/docx/opc/package.pyrszOpcPackage.__init__cCsdS)zEntry point for any post-unmarshaling processing. May be overridden by subclasses without forwarding call to super. Nrrrrrafter_unmarshalszOpcPackage.after_unmarshalcCs|jjS)zl|CoreProperties| object providing read/write access to the Dublin Core properties for this document.)_core_properties_partcore_propertiesrrrrr szOpcPackage.core_propertiesc#s&dfdd |D] }|VqdS)zGenerate exactly one reference to each relationship in the package by performing a depth-first traversal of the rels graph.Nc3sf|dkr gn|}|jD]F}|V|jr,q|j}||kr.walk_rels)Nr)rr rr"r iter_rels&s zOpcPackage.iter_relsc#s(gffdd |D] }|VqdS)zGenerate exactly one reference to each of the parts in the package by performing a depth-first traversal of the rels graph.c3sV|jD]F}|jrq |j}||kr&q |||V|}||D] }|VqDq dSr rr walk_partsrrr&?s z)OpcPackage.iter_parts..walk_partsNr)rr!rr%r iter_parts;s zOpcPackage.iter_partsFcCs|j||||S)a}Return newly added |_Relationship| instance of `reltype` between this part and `target` with key `rId`. Target mode is set to ``RTM.EXTERNAL`` if `is_external` is |True|. Intended for use during load from a serialized package, where the rId is well known. Other methods exist for adding a new relationship to the package during processing. )rZadd_relationship)rreltypetargetrIdrrrrload_relOszOpcPackage.load_relcCs |tjS)aReturn a reference to the main document part for this package. Examples include a document part for a WordprocessingML package, a presentation part for a PresentationML package, or a workbook part for a SpreadsheetML package. )part_related_byRTZOFFICE_DOCUMENTrrrrmain_document_partYszOpcPackage.main_document_partcCsJdd|D}tdt|dD] }||}||kr$t|Sq$dS)aReturn a |PackURI| instance representing partname matching `template`. The returned part-name has the next available numeric suffix to distinguish it from other parts of its type. `template` is a printf (%)-style template string containing a single replacement item, a '%d' to be used to insert the integer portion of the partname. Example: "/word/header%d.xml" cSsh|] }|jqSr)partname).0r!rrr ksz+OpcPackage.next_partname..N)r'rangelenr)rtemplateZ partnamesnZcandidate_partnamerrr next_partnamecs zOpcPackage.next_partnamecCs"t|}|}t||t|S)zGReturn an |OpcPackage| instance loaded with the contents of `pkg_file`.)r from_file Unmarshaller unmarshalr)clspkg_file pkg_readerpackagerrropenqs zOpcPackage.opencCs |j|S)zReturn part to which this package has a relationship of `reltype`. Raises |KeyError| if no such relationship is found and |ValueError| if more than one such relationship is found. )rZpart_with_reltype)rr(rrrr,yszOpcPackage.part_related_bycCs t|S)zJReturn a list containing a reference to each of the parts in this package.)listr'rrrrpartsszOpcPackage.partscCs|j||}|jS)zReturn rId key of relationship to `part`, from the existing relationship if there is one, otherwise a newly created one.)rZ get_or_addr*)rr!r(r rrr relate_toszOpcPackage.relate_tocCs ttjS)ztReturn a reference to the |Relationships| instance holding the collection of relationships for this package.)r rZbaseURIrrrrrszOpcPackage.relscCs*|jD] }|qt||j|jdS)zvSave this package to `pkg_file`, where `file` can be either a path to a file (a string) or a file-like object.N)rBZbefore_marshalrwriter)rr=r!rrrsaves  zOpcPackage.savecCsDz|tjWStk r>t|}||tj|YSXdS)z|CorePropertiesPart| object related to this package. Creates a default core properties part if one is not present (not common). N)r,r-ZCORE_PROPERTIESKeyErrorrdefaultrC)rZcore_properties_partrrrrs  z OpcPackage._core_properties_part)F)__name__ __module__ __qualname____doc__rrpropertyrr$r'r+r.r8 classmethodr@r,rBrCr rrEr __classcell__rrrrr s,        r c@s4eZdZdZeddZeddZeddZdS) r:zHHosts static methods for unmarshalling a package from a |PackageReader|.cCs>t|||}t||||D] }|q$|dS)zConstruct graph of parts and realized relationships based on the contents of `pkg_reader`, delegating construction of each part to `part_factory`. Package relationships are added to `pkg`. N)r:_unmarshal_parts_unmarshal_relationshipsrr)r>r? part_factoryrBr!rrrr;s   zUnmarshaller.unmarshalcCs2i}|D] \}}}}||||||||<q |S)zReturn a dictionary of |Part| instances unmarshalled from `pkg_reader`, keyed by partname. Side-effect is that each part in `pkg_reader` is constructed using `part_factory`. )Z iter_sparts)r>r?rQrBr/ content_typer(ZblobrrrrOs zUnmarshaller._unmarshal_partscCsV|D]H\}}|dkr|n||}|jr0|jn||j}||j||j|jqdS)zAdd a relationship to the source object corresponding to each of the relationships in `pkg_reader` with its target_part set to the actual target part in `parts`./N)Z iter_srelsrZ target_refZtarget_partnamer+r(r*)r>r?rBZ source_uriZsrelrr)rrrrPs z%Unmarshaller._unmarshal_relationshipsN)rHrIrJrK staticmethodr;rOrPrrrrr:s  r:N)rKZdocx.opc.constantsrr-Zdocx.opc.packurirrZ docx.opc.partrZdocx.opc.parts.corepropsrZdocx.opc.pkgreaderrZdocx.opc.pkgwriterrZ docx.opc.relr Zdocx.opc.sharedr r r:rrrrs