python-docx-oss 0.1.1__py3-none-any.whl → 0.2.0__py3-none-any.whl

docx/__init__.py

@@ -13,7 +13,7 @@ from docx.api import Document
 if TYPE_CHECKING:
     from docx.opc.part import Part
 
-__version__ = "0.1.1"
+__version__ = "0.2.0"
 
 
 __all__ = ["Document"]

docx/api.py

@@ -5,6 +5,7 @@ Provides a syntactically more convenient API for interacting with the OpcPackage
 
 from __future__ import annotations
 
+import io
 import os
 from typing import IO, TYPE_CHECKING, cast
 
@@ -16,18 +17,20 @@ if TYPE_CHECKING:
     from docx.parts.document import DocumentPart
 
 
-def Document(docx: str | IO[bytes] | None = None) -> DocumentObject:
+def Document(docx: str | bytes | IO[bytes] | None = None) -> DocumentObject:
     """Return a |Document| object loaded from `docx`, where `docx` can be either a path
-    to a ``.docx`` file (a string) or a file-like object.
+    to a ``.docx`` file, raw DOCX bytes, or a binary file-like object.
 
     If `docx` is missing or ``None``, the built-in default document "template" is
     loaded.
     """
     docx = _default_docx_path() if docx is None else docx
+    source_name = "<bytes>" if isinstance(docx, bytes) else docx
+    docx = io.BytesIO(docx) if isinstance(docx, bytes) else docx
     document_part = cast("DocumentPart", Package.open(docx).main_document_part)
     if document_part.content_type != CT.WML_DOCUMENT_MAIN:
         tmpl = "file '%s' is not a Word file, content type is '%s'"
-        raise ValueError(tmpl % (docx, document_part.content_type))
+        raise ValueError(tmpl % (source_name, document_part.content_type))
     return document_part.document
 
 

docx/document.py

@@ -5,8 +5,10 @@
 
 from __future__ import annotations
 
+import io
 from typing import IO, TYPE_CHECKING, Iterator, List, Sequence
 
+from docx.api import Document as open_document
 from docx.blkcntnr import BlockItemContainer
 from docx.enum.section import WD_SECTION
 from docx.enum.text import WD_BREAK
@@ -182,6 +184,10 @@ class Document(ElementProxy):
         """A |CoreProperties| object providing Dublin Core properties of document."""
         return self._part.core_properties
 
+    def copy(self) -> Document:
+        """Return an independent in-memory snapshot of this document."""
+        return open_document(io.BytesIO(self.to_bytes()))
+
     @property
     def custom_properties(self) -> CustomProperties:
         """A |CustomProperties| object providing custom properties of document."""
@@ -249,6 +255,12 @@ class Document(ElementProxy):
         """
         return self._body.tables
 
+    def to_bytes(self) -> bytes:
+        """Serialize this document as a complete in-memory DOCX package."""
+        with io.BytesIO() as stream:
+            self.save(stream)
+            return stream.getvalue()
+
     @property
     def _block_width(self) -> Length:
         """A |Length| object specifying the space between margins in last section."""

docx/image/constants.py

@@ -101,6 +101,7 @@ class MIME_TYPE:
     """Image content types."""
 
     BMP = "image/bmp"
+    EMF = "image/x-emf"
     GIF = "image/gif"
     JPEG = "image/jpeg"
     PNG = "image/png"

docx/image/emf.py

@@ -13,7 +13,7 @@ class Emf(BaseImageHeader):
     @property
     def content_type(self):
         """
-        MIME content type for this image, unconditionally `image/emf` for
+        MIME content type for this image, unconditionally `image/x-emf` for
         EMF images.
         """
         return MIME_TYPE.EMF
@@ -38,7 +38,6 @@ class Emf(BaseImageHeader):
         y1 = stream_rdr.read_long(20)
 
         frame = tuple(map(stream_rdr.read_long, (24, 28, 32, 36)))
-        size = x1 - x0, y1 - y0
 
         xdpi = 2540.0 * (x1 - x0) / (frame[2] - frame[0])
         ydpi = 2540.0 * (y1 - y0) / (frame[3] - frame[1])

docx/opc/rel.py

@@ -28,6 +28,11 @@ class Relationships(Dict[str, "_Relationship"]):
             self._target_parts_by_rId[rId] = target
         return rel
 
+    def __delitem__(self, rId: str) -> None:
+        """Remove the relationship and its cached target-part reference."""
+        super().__delitem__(rId)
+        self._target_parts_by_rId.pop(rId, None)
+
     def get_or_add(self, reltype: str, target_part: Part) -> _Relationship:
         """Return relationship of `reltype` to `target_part`, newly added if not already
         present in collection."""

docx/parts/customxml.py

@@ -59,7 +59,7 @@ class CustomXmlPart(XmlPart):
         """
         return self.element.getchildren()
 
-    def add_item(self, tag: str, text: str = "", **attrib):
+    def add_item(self, tag: str, text: str = "", **attrib: str) -> None:
         """
         Add a child element to root.
         """

docx/parts/document.py

@@ -54,6 +54,24 @@ class DocumentPart(StoryPart):
         rId = self.relate_to(header_part, RT.HEADER)
         return header_part, rId
 
+    def delete_custom_xml_part(self, part: CustomXmlPart) -> None:
+        """Delete a Custom XML part related to this document.
+
+        Related Custom XML property parts are detached with the part and omitted from
+        the package when it is next saved.
+        """
+        matching_rIds = [
+            rId
+            for rId, rel in self.rels.items()
+            if rel.reltype == RT.CUSTOM_XML and not rel.is_external and rel.target_part is part
+        ]
+        if not matching_rIds:
+            raise ValueError(f"part '{part.partname}' is not related to this document")
+
+        part.drop_rels(lambda rel: rel.reltype == RT.CUSTOM_XML_PROPS)
+        for rId in matching_rIds:
+            del self.rels[rId]
+
     @property
     def comments(self) -> Comments:
         """|Comments| object providing access to the comments added to this document."""

{python_docx_oss-0.1.1.dist-info → python_docx_oss-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-docx-oss
-Version: 0.1.1
+Version: 0.2.0
 Summary: Create, read, and update Microsoft Word .docx files.
 Author: Ethan St Lee
 License-Expression: MIT
@@ -53,18 +53,19 @@ Use it when an application needs more than basic paragraphs and tables: custom d
 metadata, application-owned XML, vector images, floating pictures, East Asian fonts,
 or low-level package and relationship access.
 
-## Features
+## Capability Matrix
 
-| Capability | Support |
-| --- | --- |
-| Documents, paragraphs, runs, tables, styles, sections, headers, and footers | ✓ |
-| Custom document properties | ✓ |
-| Custom XML parts | ✓ |
-| SVG and EMF images | ✓ |
-| Inline and floating pictures | ✓ |
-| Independent ASCII, High ANSI, and East Asian font controls | ✓ |
-| Low-level OPC parts and relationships | ✓ |
-| File-path and in-memory stream processing | ✓ |
+| Capability | Status | Primary API |
+| --- | --- | --- |
+| Documents, paragraphs, tables, styles, sections, headers, and footers | Stable | `Document()` and document object APIs |
+| Custom document properties | Stable | `document.custom_properties` |
+| Custom XML lifecycle | Stable | `add_custom_xml_part()`, `delete_custom_xml_part()` |
+| SVG and EMF images | Stable | `add_picture()` |
+| Inline and floating pictures | Stable | `add_picture()`, `add_float_picture()` |
+| Latin and East Asian font controls | Stable | `run.font.name`, `run.font.hAnsi`, `run.font.eastAsia` |
+| Low-level OPC parts and relationships | Stable | `document.part.package`, `part.rels` |
+| In-memory read, export, and independent copies | Stable | `Document()`, `to_bytes()`, `copy()` |
+| Package inspection, diff, and sanitization | Planned | — |
 
 ## Installation
 
@@ -170,6 +171,8 @@ available through `Document.add_float_picture()` and `Run.add_float_picture()`.
 - [API reference](docs/index.rst#api-documentation)
 - [Custom properties](docs/user/custom-properties.rst)
 - [Custom XML](docs/user/custom-xml.rst)
+- [python-docx compatibility](docs/user/compatibility.rst)
+- [Upstream maintenance](docs/dev/upstream-maintenance.rst)
 - [Release history](HISTORY.md)
 
 ## Quality and Testing

{python_docx_oss-0.1.1.dist-info → python_docx_oss-0.2.0.dist-info}/RECORD

@@ -1,8 +1,8 @@
-docx/__init__.py,sha256=lzMxui-aFJFpJ33Mg8ra9T6A4KSd24ZH5sEHgXwgmcU,2102
-docx/api.py,sha256=13U56iPSM2tMRDEb03OmSZQkDAPmwGjfxosYkWS2tcc,1350
+docx/__init__.py,sha256=aw9boQn8MrzqJFVCGmYy41YRdhhw3Ym0bIhqE643gCA,2102
+docx/api.py,sha256=jIojXW4IRDEXQqaqvmOZbzBvNeyRXv9ntHByxd-Kb0M,1518
 docx/blkcntnr.py,sha256=_xe7Uz3RBCz4TPKXpIzRxtGg-1YPb3gAG9YvsSUyoLU,3525
 docx/comments.py,sha256=MmaP7U9mZOUFsRhaZNIbXatqOOA8-pOC6UlqWAuTHsc,6385
-docx/document.py,sha256=MbIMThSh8tEVExx72aKI4SMGQBcsScQdGLzNv2Asa9o,11941
+docx/document.py,sha256=s9oolRg9W37W_8RG8v-rHVZtU9iBevV-NgnJ9JW2z00,12376
 docx/exceptions.py,sha256=WWiMy3ZtsfKRS31Wv09egLZnpPkX0H66B8JkOPCC3FM,454
 docx/package.py,sha256=Eob2q7R6jXQ3iPD0cAGHzu2RVYgU2te4zfG3oVN_-lM,4288
 docx/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -25,8 +25,8 @@ docx/enum/table.py,sha256=7PuQ--PGnSaNiE0Bu4VJ9t6LOgM-hNNmKEcl-3S2eUk,3943
 docx/enum/text.py,sha256=o6bdpJot2iY40UnnBQ1uGfdE8oHFm3dtXUrmt9eMlvE,10276
 docx/image/__init__.py,sha256=OvnRg5_DTmmrJObUBWLVcPFMRPb-u63e0EKfF_eIQlk,924
 docx/image/bmp.py,sha256=w_Jhu6hByAckJNyKhI3zHOKsHyibHgxDIjiPI9ev704,1347
-docx/image/constants.py,sha256=Y-ME9Z2KDLsjFQDun8XxhXrL6HNXhkUZqGHuCHXEMf4,3466
-docx/image/emf.py,sha256=BnPe6n9f4H9GZvB3Rb8zY-aaHr61WFLcQkryAqx4V4c,1210
+docx/image/constants.py,sha256=c6Mtsy38b0nilCcRp9vvXkV7hyLDb0sDHfJoPqH-lPk,3490
+docx/image/emf.py,sha256=C22sBpDu6vxLqAQmycPCb6xBc8ezVpr1C8x-C8SL2GE,1180
 docx/image/exceptions.py,sha256=_6rkjXXcbFxb_H-J0kK4Q1J9RaLx3TVQ5hoOVENvQaI,383
 docx/image/gif.py,sha256=0R7L0r7kjf844pdpN6UKEISsEQzOPAyA3cghXXdJW2s,1118
 docx/image/helpers.py,sha256=jy0fQBqIfstp9ExfKw3dGNKozn74RnmSA_YwmolsDqM,3089
@@ -47,7 +47,7 @@ docx/opc/part.py,sha256=15TjdwOs137LDdr-EVNeLb4iQdRyIfDZg6Vjx6_8Zdc,9606
 docx/opc/phys_pkg.py,sha256=-eNZDBbLShHo3W1iglf1CwN_nkK8qnmTWp6ABg77cjA,4005
 docx/opc/pkgreader.py,sha256=iUPZ7Ba4kNXjPB-q1mQEO44eVmbnP08po4WFH-HD2IE,9588
 docx/opc/pkgwriter.py,sha256=shDeuBtW2BbFOTHrXx8R97PWFaH_fE37JYBfbw6QWRs,4524
-docx/opc/rel.py,sha256=9BAZ59Cr5-BKs_5R8aifPDnPpXw-75GdfYYY6_a8Ays,6219
+docx/opc/rel.py,sha256=ziqjJ_zQZ1Ow1sNM46se8F6YZRVST-Z8Z4NYvnnOt8o,6423
 docx/opc/shared.py,sha256=Zn2avg2g0J2fkG5YgFfCbl138gXex8stR-QwVJcuSIY,996
 docx/opc/spec.py,sha256=GP8YEb7bSmZQ0i338M3lQCVZm6yUnkUhm3PFKVgW8bQ,638
 docx/opc/parts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -81,8 +81,8 @@ docx/oxml/text/parfmt.py,sha256=5TYCf-QfcwlECXUkrLSYFfewFA1JieKGTtm3X01fu64,1222
 docx/oxml/text/run.py,sha256=W8vwOomvk1oGzAq2BqDgyVftKsSi5LK9_vlADVcMgpg,11238
 docx/parts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 docx/parts/comments.py,sha256=Dmxh_i8ADRo-wLfO9LV0Lyho5XC_76oU1NJN8itw8lc,1760
-docx/parts/customxml.py,sha256=7GNGmzJf6-jBZ7ltciXp_3nfGDJGKI7y5jDCarbjVuI,1907
-docx/parts/document.py,sha256=lQSAco_MB0Y5hv7zDQGypR9JcYNi6HcF5Qsfn5c3ahg,7450
+docx/parts/customxml.py,sha256=hbwDmPwR-1RRLOOFhmiPd0B-dNwpfZFrOxIaGU4UlG4,1920
+docx/parts/document.py,sha256=hox7yRnsZRTF1C4ersAQUHNP58YhHxHMJnnztyp-2wM,8171
 docx/parts/hdrftr.py,sha256=_U0PCjVkK6EWwkyZb9oTunlNb6x55rECD1xFDzwUlPM,1709
 docx/parts/image.py,sha256=c-DF5YFvp1qVTx7Zon-xOXw0qPc_3LoeX9qMSFPs6mo,2739
 docx/parts/numbering.py,sha256=rrVIiRoBQIy6j8eWGhWyhcJvNx6RRaItWVDhorwrVyo,1715
@@ -125,8 +125,8 @@ docx/text/paragraph.py,sha256=N3F62_JRQZYaumuoaJXKCDnRSw2DIiOwzyMPV2Jd7GI,6828
 docx/text/parfmt.py,sha256=70M75HFo7ydpqmIdZjkV711muyrsBGdr4WZscF3YVJY,10339
 docx/text/run.py,sha256=tsW8dXOE4VnqEM7cJz_uU2Vq3qgdnrMGzyDq9x5jvE4,10800
 docx/text/tabstops.py,sha256=bJN98GWW22f4Sqg0dQbyUcnuOn65fHsNZuCGswI03_c,3896
-python_docx_oss-0.1.1.dist-info/licenses/LICENSE,sha256=lf2yZv-riPwFeah3IMDeG0zqI6fXcV9T9YOToeG54NM,1164
-python_docx_oss-0.1.1.dist-info/METADATA,sha256=vsUjUJmj42pvIO-LKhVnsuAxjpmU415JVPKJzSRfR4Q,7319
-python_docx_oss-0.1.1.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
-python_docx_oss-0.1.1.dist-info/top_level.txt,sha256=zkbrD3gmyqHpD_XhHe7lCbr2M5vT229nJ4UFqF5VjIs,5
-python_docx_oss-0.1.1.dist-info/RECORD,,
+python_docx_oss-0.2.0.dist-info/licenses/LICENSE,sha256=lf2yZv-riPwFeah3IMDeG0zqI6fXcV9T9YOToeG54NM,1164
+python_docx_oss-0.2.0.dist-info/METADATA,sha256=xgmccioh4zptF-ExSr52_7IrSCIsMQXeiovBXzT7DRk,7851
+python_docx_oss-0.2.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+python_docx_oss-0.2.0.dist-info/top_level.txt,sha256=zkbrD3gmyqHpD_XhHe7lCbr2M5vT229nJ4UFqF5VjIs,5
+python_docx_oss-0.2.0.dist-info/RECORD,,