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

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

@@ -1,5 +1,9 @@
 ## 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

{python_docx_oss-0.0.11/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.11
+Version: 0.0.12
 Summary: CRUD Microsoft Word .docx files.
 Home-page: https://github.com/lsaint/python-docx-oss
 Author: Ethan St. Lee
@@ -90,6 +90,10 @@ This project is based on the original work by [Steve Canny](https://github.com/s
 
 ## 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

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

{python_docx_oss-0.0.11 → 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.11 → 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.11 → 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.11
+Version: 0.0.12
 Summary: CRUD Microsoft Word .docx files.
 Home-page: https://github.com/lsaint/python-docx-oss
 Author: Ethan St. Lee
@@ -90,6 +90,10 @@ This project is based on the original work by [Steve Canny](https://github.com/s
 
 ## 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

{python_docx_oss-0.0.11 → 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.11 → 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