python-docx-oss 0.0.10__tar.gz → 0.0.12__tar.gz

{python_docx_oss-0.0.10 → python_docx_oss-0.0.12}/HISTORY.md

@@ -1,5 +1,13 @@
 ## Release History
 
+0.0.12 (2025-12-03)
+
+- default dpi for jpeg #33
+
+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

{python_docx_oss-0.0.10/python_docx_oss.egg-info → python_docx_oss-0.0.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-docx-oss
-Version: 0.0.10
+Version: 0.0.12
 Summary: CRUD Microsoft Word .docx files.
 Home-page: https://github.com/lsaint/python-docx-oss
 Author: Ethan St. Lee
@@ -69,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
 
@@ -77,15 +77,27 @@ _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.12 (2025-12-03)
+
+- default dpi for jpeg #33
+
+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

{python_docx_oss-0.0.10 → python_docx_oss-0.0.12}/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.10 → python_docx_oss-0.0.12}/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.10"
+__version__ = "0.0.12"
 
 
 # register custom Part classes with opc package reader

{python_docx_oss-0.0.10 → python_docx_oss-0.0.12}/docx/image/__init__.py

@@ -10,7 +10,7 @@ from __future__ import absolute_import, division, print_function, unicode_litera
 from docx.image.bmp import Bmp
 from docx.image.emf import Emf
 from docx.image.gif import Gif
-from docx.image.jpeg import Exif, Jfif
+from docx.image.jpeg import Exif, Jfif, Jpeg
 from docx.image.png import Png
 from docx.image.svg import Svg
 from docx.image.tiff import Tiff
@@ -21,6 +21,7 @@ SIGNATURES = (
     (Png, 0, b"\x89PNG\x0D\x0A\x1A\x0A"),
     (Jfif, 6, b"JFIF"),
     (Exif, 6, b"Exif"),
+    (Jpeg, 0, b"\xff\xd8"),
     (Gif, 0, b"GIF87a"),
     (Gif, 0, b"GIF89a"),
     (Tiff, 0, b"MM\x00*"),  # big-endian (Motorola) TIFF

{python_docx_oss-0.0.10 → python_docx_oss-0.0.12}/docx/image/jpeg.py

@@ -29,6 +29,51 @@ class Jpeg(BaseImageHeader):
         """
         return "jpg"
 
+    DEFAULT_DPI = 72
+
+    @classmethod
+    def from_stream(cls, stream):
+        """
+        If APP0 or APP1 is missing, the DPI values will be set to the default value of |DEFAULT_DPI|(72).
+        """
+        markers = _JfifMarkers.from_stream(stream)
+        px_width = markers.sof.px_width
+        px_height = markers.sof.px_height
+        horz_dpi, vert_dpi = cls._get_horz_dpi_and_vert_dpi(markers)
+        return cls(px_width, px_height, horz_dpi, vert_dpi)
+
+    @classmethod
+    def _get_horz_dpi_and_vert_dpi(cls, markers):
+        horz_dpi, vert_dpi = cls._try_get_dpi_from_app0(markers)
+        if horz_dpi is None or vert_dpi is None:
+            horz_dpi, vert_dpi = cls._try_get_dpi_from_app1(markers)
+        if horz_dpi is None or vert_dpi is None:
+            horz_dpi = vert_dpi = cls.DEFAULT_DPI
+        # DPI values in APP0 or APP1 may be 0, which is invalid. should use default value.
+        if horz_dpi == 0:
+            horz_dpi = cls.DEFAULT_DPI
+        if vert_dpi == 0:
+            vert_dpi = cls.DEFAULT_DPI
+        return horz_dpi, vert_dpi
+
+    @staticmethod
+    def _try_get_dpi_from_app0(markers):
+        try:
+            horz_dpi = markers.app0.horz_dpi
+            vert_dpi = markers.app0.vert_dpi
+            return horz_dpi, vert_dpi
+        except KeyError:
+            return None, None
+
+    @staticmethod
+    def _try_get_dpi_from_app1(markers):
+        try:
+            horz_dpi = markers.app1.horz_dpi
+            vert_dpi = markers.app1.vert_dpi
+            return horz_dpi, vert_dpi
+        except KeyError:
+            return None, None
+
 
 class Exif(Jpeg):
     """

python_docx_oss-0.0.12/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.10 → python_docx_oss-0.0.12/python_docx_oss.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-docx-oss
-Version: 0.0.10
+Version: 0.0.12
 Summary: CRUD Microsoft Word .docx files.
 Home-page: https://github.com/lsaint/python-docx-oss
 Author: Ethan St. Lee
@@ -69,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
 
@@ -77,15 +77,27 @@ _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.12 (2025-12-03)
+
+- default dpi for jpeg #33
+
+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

{python_docx_oss-0.0.10 → python_docx_oss-0.0.12}/python_docx_oss.egg-info/SOURCES.txt

@@ -428,6 +428,7 @@ tests/test_files/CVS_LOGO.WMF
 tests/test_files/exif-420-dpi.jpg
 tests/test_files/having-images.docx
 tests/test_files/jfif-iguana.jpg
+tests/test_files/jpeg_without_app0_and_app1.jpg
 tests/test_files/little-endian.tif
 tests/test_files/monty-truth.png
 tests/test_files/python-icon.jpeg

{python_docx_oss-0.0.10 → python_docx_oss-0.0.12}/tests/image/test_jpeg.py

@@ -31,6 +31,8 @@ from ..unitutil.mock import (
     initializer_mock,
     instance_mock,
     method_mock,
+    MagicMock,
+    PropertyMock
 )
 
 
@@ -43,6 +45,14 @@ class DescribeJpeg(object):
         jpeg = Jpeg(None, None, None, None)
         assert jpeg.default_ext == "jpg"
 
+    def it_not_contains_app0_or_app1(self):
+        with open("tests/test_files/jpeg_without_app0_and_app1.jpg", "rb") as f:
+            jpeg = Jpeg.from_stream(f)
+            assert jpeg.horz_dpi == 72
+            assert jpeg.vert_dpi == 72
+            assert jpeg.px_width == 1190
+            assert jpeg.px_height == 1190
+
     class DescribeExif(object):
         def it_can_construct_from_an_exif_stream(self, from_exif_fixture):
             # fixture ----------------------
@@ -637,3 +647,74 @@ class Describe_MarkerParser(object):
     @pytest.fixture
     def stream_reader_(self, request):
         return instance_mock(request, StreamReader)
+
+
+class TestJpegMethods:
+    def test_get_horz_dpi_and_vert_dpi_from_app0(self, mocker):
+        markers = MagicMock()
+        mocker.patch.object(Jpeg, "_try_get_dpi_from_app0", return_value=(96, 96))
+        horz_dpi,vert_dpi = Jpeg._get_horz_dpi_and_vert_dpi(markers)
+        assert horz_dpi == 96
+        assert vert_dpi == 96
+
+    def test_get_horz_dpi_and_vert_dpi_from_app0_but_return_zero(self, mocker):
+        markers = MagicMock()
+        mocker.patch.object(Jpeg, "_try_get_dpi_from_app0", return_value=(0, 0))
+        horz_dpi,vert_dpi = Jpeg._get_horz_dpi_and_vert_dpi(markers)
+        assert horz_dpi == 72
+        assert vert_dpi == 72
+
+
+    def test_get_horz_dpi_and_vert_dpi_from_app1(self, mocker):
+        markers = MagicMock()
+        mocker.patch.object(Jpeg, "_try_get_dpi_from_app0", return_value=(None, None))
+        mocker.patch.object(Jpeg, "_try_get_dpi_from_app1", return_value=(96, 96))
+        horz_dpi,vert_dpi = Jpeg._get_horz_dpi_and_vert_dpi(markers)
+        assert horz_dpi == 96
+        assert vert_dpi == 96
+
+    def test_get_horz_dpi_and_vert_dpi_from_app1_but_return_zero(self, mocker):
+        markers = MagicMock()
+        mocker.patch.object(Jpeg, "_try_get_dpi_from_app0", return_value=(None, None))
+        mocker.patch.object(Jpeg, "_try_get_dpi_from_app1", return_value=(0, 0))
+        horz_dpi,vert_dpi = Jpeg._get_horz_dpi_and_vert_dpi(markers)
+        assert horz_dpi == 72
+        assert vert_dpi == 72
+
+    def test_get_horz_dpi_and_vert_dpi_from_DEFAULT_DPI(self, mocker):
+        markers = MagicMock()
+        mocker.patch.object(Jpeg, "_try_get_dpi_from_app0", return_value=(None, None))
+        mocker.patch.object(Jpeg, "_try_get_dpi_from_app1", return_value=(None, None))
+        horz_dpi,vert_dpi = Jpeg._get_horz_dpi_and_vert_dpi(markers)
+        assert horz_dpi == 72
+        assert vert_dpi == 72
+
+    def test__try_get_dpi_from_app0_returns_None(self, mocker):
+        markers = MagicMock()
+        type(markers).app0 = PropertyMock(side_effect=KeyError("APP0 not found"))
+        horz_dpi,vert_dpi = Jpeg._try_get_dpi_from_app0(markers)
+        assert horz_dpi is None
+        assert vert_dpi is None
+
+    def test__try_get_dpi_from_app0(self, mocker):
+        markers = MagicMock()
+        markers.app0.horz_dpi = 96
+        markers.app0.vert_dpi = 96
+        horz_dpi,vert_dpi = Jpeg._try_get_dpi_from_app0(markers)
+        assert horz_dpi == 96
+        assert vert_dpi == 96
+
+    def test__try_get_dpi_from_app1_returns_None(self, mocker):
+        markers = MagicMock()
+        type(markers).app1 = PropertyMock(side_effect=KeyError("APP1 not found"))
+        horz_dpi,vert_dpi = Jpeg._try_get_dpi_from_app1(markers)
+        assert horz_dpi is None
+        assert vert_dpi is None
+
+    def test__try_get_dpi_from_app1(self, mocker):
+        markers = MagicMock()
+        markers.app1.horz_dpi = 96
+        markers.app1.vert_dpi = 96
+        horz_dpi,vert_dpi = Jpeg._try_get_dpi_from_app1(markers)
+        assert horz_dpi == 96
+        assert vert_dpi == 96

{python_docx_oss-0.0.10 → python_docx_oss-0.0.12}/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.10/docx/image/svg.py

@@ -1,65 +0,0 @@
-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, 72, 72)
-
-    @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 _dimensions_from_stream(cls, stream):
-        stream.seek(0)
-        data = stream.read()
-        root = ET.fromstring(data)
-        if root.attrib.get("width") is None:
-            return cls._calculate_scaled_dimensions(root.attrib["viewBox"])
-
-        width = int(float(root.attrib["width"].replace("pt", "")))
-        height = int(float(root.attrib["height"].replace("pt", "")))
-        return width, height
-
-    @classmethod
-    def _calculate_scaled_dimensions(
-        cls, viewbox: str, base_px: int = BASE_PX
-    ) -> tuple[int, int]:
-        _, _, logical_width, logical_height = map(int, 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 int(final_width), int(final_height)