python-docx-oss 0.0.9rc1__tar.gz → 0.0.11__tar.gz

python_docx_oss-0.0.11/HISTORY.md

@@ -0,0 +1,61 @@
+## Release History
+
+0.0.11 (2025-11-17)
+
+- round-float viewbox and enhance svg unit parsing #31
+
+**0.0.10 (2025-11-13)**
+
+- Fix modern bool representations in .docx files. #29
+- Fix \_dimensions_from_stream doesn't handle units properly from svg. #30
+
+**0.0.9 (2024-11-26)**
+
+- svg file support in add_picture. #27
+- update docs.
+
+**0.0.8 (2024-11-22)**
+
+- EastAsia font support fixes. #25
+- Update README.md. #26
+
+**0.0.7 (2022-10-29)**
+
+- add emf image file support. #24
+
+**0.0.6 (2022-10-21)**
+
+- change default custom xml file name to item1. #23
+
+**0.0.5 (2022-8-08)**
+
+- minor refactor custom-properties.
+- add add_float_picture in Document. #21
+
+**0.0.4 (2022-7-21)**
+
+- public python-docx-oss docs @ readthedocs.
+- add delete_item in CustomXmlPart. #17
+
+**0.0.3 (2022-7-01)**
+
+- Change method text to texts in CT_R. #14
+- Add external target_ref setter. #15
+- Blacken all Python files.
+
+**0.0.2 (2022-06-24)**
+
+- Add custom xml support. #10
+- Add Part **eq**.
+- Add Part element setter.
+- Add Relationships parts_with_reltype.
+
+**0.0.1 (2022-06-16)**
+
+- Only support Python3.8, 3.9 and 3.10.
+- Add custom properties support. #2
+- Add drop_rels in Package. #5
+- Add drop_rels in Part. #5
+- Add default NumberingPart. #4
+- Fix Python3.8+ **dict** TypeError. #6
+- Add some typehint.

{python_docx_oss-0.0.9rc1/python_docx_oss.egg-info → python_docx_oss-0.0.11}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: python-docx-oss
-Version: 0.0.9rc1
+Version: 0.0.11
 Summary: CRUD Microsoft Word .docx files.
 Home-page: https://github.com/lsaint/python-docx-oss
 Author: Ethan St. Lee
@@ -42,6 +42,17 @@ Classifier: Topic :: Software Development :: Libraries
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: lxml>=4.6.5
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
 
 <p align="center">
 <img src="https://raw.githubusercontent.com/lsaint/python-docx-oss/master/docs/_static/img/oss.png" width="400" alt="oss"/>
@@ -58,7 +69,7 @@ _As a Brazilian jiu-jitsu player, OSS means anything and everything. It's a term
     <a href="https://github.com/lsaint/python-docx-oss/blob/master/LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg"></a>
 </p>
 
----
+______________________________________________________________________
 
 ### FAQ
 
@@ -66,62 +77,75 @@ _As a Brazilian jiu-jitsu player, OSS means anything and everything. It's a term
 
 **A:** [HISTORY](https://github.com/lsaint/python-docx-oss/blob/master/HISTORY.md)
 
----
+______________________________________________________________________
 
 More information is available in the [python-docx-oss documentation](https://python-docx-oss.readthedocs.io/en/latest/)
 
 This project is based on the original work by [Steve Canny](https://github.com/scanny) and has been modified by [Ethan St. Lee](https://github.com/lsaint).
 
+### Donation
+
+[https://lsaint.github.io/donation/](https://lsaint.github.io/donation/)
+
 
 ## Release History
 
+0.0.11 (2025-11-17)
+
+- round-float viewbox and enhance svg unit parsing #31
+
+**0.0.10 (2025-11-13)**
+
+- Fix modern bool representations in .docx files. #29
+- Fix \_dimensions_from_stream doesn't handle units properly from svg. #30
+
 **0.0.9 (2024-11-26)**
 
--   svg file support in add_picture. #27
--   update docs.
+- svg file support in add_picture. #27
+- update docs.
 
 **0.0.8 (2024-11-22)**
 
--   EastAsia font support fixes. #25
--   Update README.md. #26
+- EastAsia font support fixes. #25
+- Update README.md. #26
 
 **0.0.7 (2022-10-29)**
 
--   add emf image file support. #24
+- add emf image file support. #24
 
 **0.0.6 (2022-10-21)**
 
--   change default custom xml file name to item1. #23
+- change default custom xml file name to item1. #23
 
 **0.0.5 (2022-8-08)**
 
--   minor refactor custom-properties.
--   add add_float_picture in Document. #21
+- minor refactor custom-properties.
+- add add_float_picture in Document. #21
 
 **0.0.4 (2022-7-21)**
 
--   public python-docx-oss docs @ readthedocs.
--   add delete_item in CustomXmlPart. #17
+- public python-docx-oss docs @ readthedocs.
+- add delete_item in CustomXmlPart. #17
 
 **0.0.3 (2022-7-01)**
 
--   Change method text to texts in CT_R. #14
--   Add external target_ref setter. #15
--   Blacken all Python files.
+- Change method text to texts in CT_R. #14
+- Add external target_ref setter. #15
+- Blacken all Python files.
 
 **0.0.2 (2022-06-24)**
 
--   Add custom xml support. #10
--   Add Part **eq**.
--   Add Part element setter.
--   Add Relationships parts_with_reltype.
+- Add custom xml support. #10
+- Add Part **eq**.
+- Add Part element setter.
+- Add Relationships parts_with_reltype.
 
 **0.0.1 (2022-06-16)**
 
--   Only support Python3.8, 3.9 and 3.10.
--   Add custom properties support. #2
--   Add drop_rels in Package. #5
--   Add drop_rels in Part. #5
--   Add default NumberingPart. #4
--   Fix Python3.8+ **dict** TypeError. #6
--   Add some typehint.
+- Only support Python3.8, 3.9 and 3.10.
+- Add custom properties support. #2
+- Add drop_rels in Package. #5
+- Add drop_rels in Part. #5
+- Add default NumberingPart. #4
+- Fix Python3.8+ **dict** TypeError. #6
+- Add some typehint.

{python_docx_oss-0.0.9rc1 → python_docx_oss-0.0.11}/README.md

@@ -13,7 +13,7 @@ _As a Brazilian jiu-jitsu player, OSS means anything and everything. It's a term
     <a href="https://github.com/lsaint/python-docx-oss/blob/master/LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg"></a>
 </p>
 
----
+______________________________________________________________________
 
 ### FAQ
 
@@ -21,8 +21,12 @@ _As a Brazilian jiu-jitsu player, OSS means anything and everything. It's a term
 
 **A:** [HISTORY](https://github.com/lsaint/python-docx-oss/blob/master/HISTORY.md)
 
----
+______________________________________________________________________
 
 More information is available in the [python-docx-oss documentation](https://python-docx-oss.readthedocs.io/en/latest/)
 
 This project is based on the original work by [Steve Canny](https://github.com/scanny) and has been modified by [Ethan St. Lee](https://github.com/lsaint).
+
+### Donation
+
+[https://lsaint.github.io/donation/](https://lsaint.github.io/donation/)

{python_docx_oss-0.0.9rc1 → python_docx_oss-0.0.11}/docs/index.rst

@@ -42,7 +42,7 @@ Here's an example of what |docx| can do:
         'first item in ordered list', style='List Number'
     )
 
-    document.add_picture('monty-truth.png', width=Inches(1.25))
+    document.add_picture('500miles.png', width=Inches(5.9))
 
     records = (
         (3, '101', 'Spam'),

{python_docx_oss-0.0.9rc1 → python_docx_oss-0.0.11}/docx/__init__.py

@@ -12,7 +12,7 @@ from docx.parts.numbering import NumberingPart
 from docx.parts.settings import SettingsPart
 from docx.parts.styles import StylesPart  # noqa
 
-__version__ = "0.0.9rc1"
+__version__ = "0.0.11"
 
 
 # register custom Part classes with opc package reader

python_docx_oss-0.0.11/docx/image/svg.py

@@ -0,0 +1,118 @@
+import re
+import xml.etree.ElementTree as ET
+
+from .constants import MIME_TYPE
+from .image import BaseImageHeader
+
+BASE_PX = 72
+
+
+class Svg(BaseImageHeader):
+    """
+    Image header parser for SVG images.
+    """
+
+    @classmethod
+    def from_stream(cls, stream):
+        """
+        Return |Svg| instance having header properties parsed from SVG image
+        in *stream*.
+        """
+        px_width, px_height = cls._dimensions_from_stream(stream)
+        return cls(px_width, px_height, BASE_PX, BASE_PX)
+
+    @property
+    def content_type(self):
+        """
+        MIME content type for this image, unconditionally `image/svg+xml` for
+        SVG images.
+        """
+        return MIME_TYPE.SVG
+
+    @property
+    def default_ext(self):
+        """
+        Default filename extension, always 'svg' for SVG images.
+        """
+        return "svg"
+
+    @classmethod
+    def _parse_svg_unit_value(cls, value_str: str) -> float:
+        """
+        Parse an SVG length value and return it in points (which are 1/72 of an inch).
+        Handles units like px, pt, cm, mm, in, pc.
+        """
+        if not value_str:
+            return 0.0
+
+        value_str = value_str.strip().lower()
+
+        # Regex to separate the numeric value from the unit, allowing for spaces
+        match = re.match(r"^(-?\d*\.?\d+)\s*([a-z%]*)$", value_str)
+        if not match:
+            # Handle case where there is no unit (treat as px, as per SVG spec)
+            try:
+                return float(value_str)
+            except ValueError:
+                return 0.0
+
+        value, unit = match.groups()
+        numeric_value = float(value)
+
+        # ---conversion factors to points (assuming 72 DPI, where 1pt = 1px)---
+        # This matches the existing behavior of the Svg class.
+        # 1 inch = BASE_PX points
+        # 1 cm = 1/2.54 inch = BASE_PX/2.54 points
+        # 1 mm = 1/25.4 inch = BASE_PX/25.4 points
+        # 1 pc = 12 points
+        # 1 px = 1 point (at BASE_PX DPI)
+
+        if unit in ("pt", "px", ""):
+            return numeric_value
+        elif unit == "in":
+            return numeric_value * float(BASE_PX)
+        elif unit == "pc":
+            return numeric_value * 12.0
+        elif unit == "cm":
+            return numeric_value * float(BASE_PX) / 2.54
+        elif unit == "mm":
+            return numeric_value * float(BASE_PX) / 25.4
+        # ---treat other units as px for now---
+        else:
+            return numeric_value
+
+    @classmethod
+    def _dimensions_from_stream(cls, stream):
+        stream.seek(0)
+        data = stream.read()
+        root = ET.fromstring(data)
+
+        width_str = root.attrib.get("width")
+        height_str = root.attrib.get("height")
+
+        if width_str and height_str:
+            width = round(cls._parse_svg_unit_value(width_str))
+            height = round(cls._parse_svg_unit_value(height_str))
+            return width, height
+
+        if root.attrib.get("viewBox"):
+            return cls._calculate_scaled_dimensions(root.attrib["viewBox"])
+
+        return 0, 0
+
+    @classmethod
+    def _calculate_scaled_dimensions(
+        cls, viewbox: str, base_px: int = BASE_PX
+    ) -> tuple[int, int]:
+        _, _, logical_width, logical_height = map(float, viewbox.split())
+
+        aspect_ratio = logical_width / logical_height
+
+        if aspect_ratio >= 1:
+            final_width = base_px
+            final_height = base_px / aspect_ratio
+        else:
+            final_height = base_px
+            final_width = base_px * aspect_ratio
+
+        return round(final_width), round(final_height)

{python_docx_oss-0.0.9rc1 → python_docx_oss-0.0.11}/docx/opc/customprops.py

@@ -24,7 +24,7 @@ class CustomProperties:
                 except ValueError:
                     return elm.text
             elif elm.tag == "{%s}bool" % NS_VT:
-                return elm.text == "1"
+                return elm.text.lower() in ["1", "true"]
             return elm.text
 
     def __setitem__(self, key, value):
@@ -33,7 +33,7 @@ class CustomProperties:
             elmType = "lpwstr"
             if isinstance(value, bool):
                 elmType = "bool"
-                value = str(1 if value else 0)
+                value = 'true' if value else 'false'
             elif isinstance(value, numbers.Number):
                 elmType = "i4"
                 value = str(int(value))
@@ -48,7 +48,7 @@ class CustomProperties:
             if elm.tag == "{%s}i4" % NS_VT:
                 elm.text = str(int(value))
             elif elm.tag == "{%s}bool" % NS_VT:
-                elm.text = str(1 if value else 0)
+                elm.text = 'true' if value else 'false'
             else:
                 elm.text = f"{str(value)}"
 

{python_docx_oss-0.0.9rc1 → python_docx_oss-0.0.11}/features/doc-customprops.feature

@@ -10,6 +10,12 @@ Feature: Read and write custom document properties
        And the custom property values match the known values
 
 
+  Scenario: read the custom properties of a document for legacy files
+     Given a document having known custom properties in legacy format
+      Then I can access the custom properties object
+       And the custom property values match the known values
+
+
   Scenario: change the custom properties of a document
      Given a document having known custom properties
       When I assign new values to the custom properties

{python_docx_oss-0.0.9rc1 → python_docx_oss-0.0.11}/features/steps/customprops.py

@@ -6,8 +6,6 @@ Gherkin step implementations for custom properties-related features.
 
 from __future__ import absolute_import, division, print_function, unicode_literals
 
-from datetime import datetime, timedelta
-
 from behave import given, then, when
 
 from docx import Document
@@ -24,6 +22,11 @@ def given_a_document_having_known_custom_properties(context):
     context.document = Document(test_docx("doc-customprops"))
 
 
+@given("a document having known custom properties in legacy format")
+def given_a_document_having_known_custom_properties_legacy(context):
+    context.document = Document(test_docx("doc-customprops-legacy"))
+
+
 @given("a document having no custom properties part")
 def given_a_document_having_no_custom_properties_part(context):
     context.document = Document(test_docx("doc-no-customprops"))

{python_docx_oss-0.0.9rc1 → python_docx_oss-0.0.11}/features/steps/font.py

@@ -195,8 +195,13 @@ def then_font_highlight_color_is_value(context, value):
 @then("font.name is {value}")
 def then_font_name_is_value(context, value):
     font = context.font
+    fontname = font.name
+    if isinstance(fontname, dict):
+        # word started differentiating typefaces for different regions of the world in 2025
+        # font.name is a dict of typeface names for different scripts
+        fontname = font.name['ascii']  # test against ascii name
     value = None if value == "None" else value
-    assert font.name == value
+    assert fontname == value, f"expected '{value}', got '{fontname}'"
 
 
 @then("font.size is {value}")

{python_docx_oss-0.0.9rc1 → python_docx_oss-0.0.11/python_docx_oss.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: python-docx-oss
-Version: 0.0.9rc1
+Version: 0.0.11
 Summary: CRUD Microsoft Word .docx files.
 Home-page: https://github.com/lsaint/python-docx-oss
 Author: Ethan St. Lee
@@ -42,6 +42,17 @@ Classifier: Topic :: Software Development :: Libraries
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: lxml>=4.6.5
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
 
 <p align="center">
 <img src="https://raw.githubusercontent.com/lsaint/python-docx-oss/master/docs/_static/img/oss.png" width="400" alt="oss"/>
@@ -58,7 +69,7 @@ _As a Brazilian jiu-jitsu player, OSS means anything and everything. It's a term
     <a href="https://github.com/lsaint/python-docx-oss/blob/master/LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg"></a>
 </p>
 
----
+______________________________________________________________________
 
 ### FAQ
 
@@ -66,62 +77,75 @@ _As a Brazilian jiu-jitsu player, OSS means anything and everything. It's a term
 
 **A:** [HISTORY](https://github.com/lsaint/python-docx-oss/blob/master/HISTORY.md)
 
----
+______________________________________________________________________
 
 More information is available in the [python-docx-oss documentation](https://python-docx-oss.readthedocs.io/en/latest/)
 
 This project is based on the original work by [Steve Canny](https://github.com/scanny) and has been modified by [Ethan St. Lee](https://github.com/lsaint).
 
+### Donation
+
+[https://lsaint.github.io/donation/](https://lsaint.github.io/donation/)
+
 
 ## Release History
 
+0.0.11 (2025-11-17)
+
+- round-float viewbox and enhance svg unit parsing #31
+
+**0.0.10 (2025-11-13)**
+
+- Fix modern bool representations in .docx files. #29
+- Fix \_dimensions_from_stream doesn't handle units properly from svg. #30
+
 **0.0.9 (2024-11-26)**
 
--   svg file support in add_picture. #27
--   update docs.
+- svg file support in add_picture. #27
+- update docs.
 
 **0.0.8 (2024-11-22)**
 
--   EastAsia font support fixes. #25
--   Update README.md. #26
+- EastAsia font support fixes. #25
+- Update README.md. #26
 
 **0.0.7 (2022-10-29)**
 
--   add emf image file support. #24
+- add emf image file support. #24
 
 **0.0.6 (2022-10-21)**
 
--   change default custom xml file name to item1. #23
+- change default custom xml file name to item1. #23
 
 **0.0.5 (2022-8-08)**
 
--   minor refactor custom-properties.
--   add add_float_picture in Document. #21
+- minor refactor custom-properties.
+- add add_float_picture in Document. #21
 
 **0.0.4 (2022-7-21)**
 
--   public python-docx-oss docs @ readthedocs.
--   add delete_item in CustomXmlPart. #17
+- public python-docx-oss docs @ readthedocs.
+- add delete_item in CustomXmlPart. #17
 
 **0.0.3 (2022-7-01)**
 
--   Change method text to texts in CT_R. #14
--   Add external target_ref setter. #15
--   Blacken all Python files.
+- Change method text to texts in CT_R. #14
+- Add external target_ref setter. #15
+- Blacken all Python files.
 
 **0.0.2 (2022-06-24)**
 
--   Add custom xml support. #10
--   Add Part **eq**.
--   Add Part element setter.
--   Add Relationships parts_with_reltype.
+- Add custom xml support. #10
+- Add Part **eq**.
+- Add Part element setter.
+- Add Relationships parts_with_reltype.
 
 **0.0.1 (2022-06-16)**
 
--   Only support Python3.8, 3.9 and 3.10.
--   Add custom properties support. #2
--   Add drop_rels in Package. #5
--   Add drop_rels in Part. #5
--   Add default NumberingPart. #4
--   Fix Python3.8+ **dict** TypeError. #6
--   Add some typehint.
+- Only support Python3.8, 3.9 and 3.10.
+- Add custom properties support. #2
+- Add drop_rels in Package. #5
+- Add drop_rels in Part. #5
+- Add default NumberingPart. #4
+- Fix Python3.8+ **dict** TypeError. #6
+- Add some typehint.

{python_docx_oss-0.0.9rc1 → python_docx_oss-0.0.11}/python_docx_oss.egg-info/SOURCES.txt

@@ -295,6 +295,7 @@ features/steps/test_files/court-exif.jpg
 features/steps/test_files/doc-access-sections.docx
 features/steps/test_files/doc-add-section.docx
 features/steps/test_files/doc-coreprops.docx
+features/steps/test_files/doc-customprops-legacy.docx
 features/steps/test_files/doc-customprops.docx
 features/steps/test_files/doc-default.docx
 features/steps/test_files/doc-no-coreprops.docx

{python_docx_oss-0.0.9rc1 → python_docx_oss-0.0.11}/tests/image/test_svg.py

@@ -25,6 +25,7 @@ def svg_with_viewbox():
         ("0 0 400 200", 72, 36, 72),  # Landscape
         ("0 0 200 400", 100, 200, 200),  # Portrait
         ("0 0 100 100", 50, 50, 50),  # Square
+        ("0 0 100.5 100.5", 50, 50, 50),  # Float
     ]
 )
 def viewbox_data(request):
@@ -35,13 +36,49 @@ def viewbox_data(request):
 @pytest.fixture(
     params=[
         (b'<svg width="200" height="100"/>', 200, 100),
+        (b'<svg width="200.5" height="100.5"/>', 200, 100),  # round-half-to-even
         (b'<svg viewBox="0 0 400 200"/>', BASE_PX, BASE_PX // 2),
+        (b'<svg viewBox="0 0 400.5 200.5"/>', BASE_PX, 36),
+        (b'<svg width="1in" height="0.5in"/>', 72, 36),
+        (b'<svg width="2.54cm" height="1.27cm"/>', 72, 36),
+        (b'<svg width="25.4mm" height="12.7mm"/>', 72, 36),
+        (b'<svg width="6pc" height="3pc"/>', 72, 36),
+        (b'<svg width="72pt" height="36pt"/>', 72, 36),
+        (b'<svg width="96px" height="48px"/>', 96, 48),
+        (b"<svg/>", 0, 0),
     ]
 )
 def svg_stream_data(request):
     return request.param
 
 
+@pytest.fixture(
+    params=[
+        ("100", 100.0),
+        ("150.5", 150.5),
+        ("100pt", 100.0),
+        ("100px", 100.0),
+        ("1in", 72.0),
+        ("1pc", 12.0),
+        ("2.54cm", 72.0),
+        ("25.4mm", 72.0),
+        (" 150.5 px ", 150.5),
+        ("-20.5", -20.5),
+        ("", 0.0),
+        ("invalid", 0.0),
+        ("12em", 12.0),  # fallback to px
+    ]
+)
+def unit_value_data(request):
+    """Fixture for different SVG unit value strings."""
+    return request.param
+
+
+def test_parse_svg_unit_value(unit_value_data):
+    value_str, expected_value = unit_value_data
+    assert Svg._parse_svg_unit_value(value_str) == pytest.approx(expected_value)
+
+
 def test_dimensions_from_stream(svg_stream_data):
     stream_data, expected_width, expected_height = svg_stream_data
     stream = io.BytesIO(stream_data)
@@ -55,3 +92,4 @@ def test_calculate_scaled_dimensions(viewbox_data):
     width, height = Svg._calculate_scaled_dimensions(viewbox, base_px)
     assert width == expected_width
     assert height == expected_height
+

{python_docx_oss-0.0.9rc1 → python_docx_oss-0.0.11}/tests/opc/test_customprops.py

@@ -38,7 +38,7 @@ class DescribeCustomProperties(object):
     @pytest.fixture(
         params=[
             ("CustomPropString", "lpwstr", "Hi there!", "Hi there!"),
-            ("CustomPropBool", "bool", "0", False),
+            ("CustomPropBool", "bool", "false", False),
             ("CustomPropInt", "i4", "5", 5),
         ]
     )