arkindex-base-worker 0.4.0rc6__py3-none-any.whl → 0.5.0a2__py3-none-any.whl

tests/test_image.py

@@ -9,6 +9,7 @@ import pytest
 from PIL import Image, ImageChops, ImageOps
 from requests import HTTPError
 
+import arkindex_worker.image
 from arkindex_worker.cache import CachedElement, create_tables, init_cache_db
 from arkindex_worker.image import (
     IIIF_FULL,
@@ -35,9 +36,18 @@ ROTATED_MIRRORED_IMAGE = FIXTURES_DIR / "rotated_mirrored_image.jpg"
 TEST_IMAGE = {"width": 800, "height": 300}
 
 
-@pytest.fixture()
+@pytest.fixture
 def mock_page():
     class Page(Element):
+        @property
+        def crop(self):
+            # Image from Socface (https://socface.site.ined.fr/) project (AD026)
+            image = Image.open(FIXTURES_DIR / "AD026_6M_00505_0001_0373.jpg")
+            x, y, element_width, element_height = polygon_bounding_box(
+                self.zone.polygon
+            )
+            return image.crop(box=(x, y, x + element_width, y + element_height))
+
         def open_image(
             self,
             *args,
@@ -46,18 +56,21 @@ def mock_page():
             use_full_image: bool | None = False,
             **kwargs,
         ) -> Image.Image:
-            # Image from Socface (https://socface.site.ined.fr/) project (AD026)
-            image = Image.open(FIXTURES_DIR / "AD026_6M_00505_0001_0373.jpg")
-            image.thumbnail(size=(max_width or image.width, max_height or image.height))
-
-            return image
+            crop = self.crop.copy()
+            crop.thumbnail(
+                size=(
+                    max_width or self.zone.image.width,
+                    max_height or self.zone.image.height,
+                )
+            )
+            return crop
 
     return Page(
         id="page_id",
         name="1",
         zone={
-            "polygon": [[0, 0], [1000, 0], [1000, 3000], [0, 3000], [0, 0]],
-            "image": {"width": 1000, "height": 3000},
+            "polygon": [[0, 0], [2000, 0], [2000, 3000], [0, 3000], [0, 0]],
+            "image": {"width": 2000, "height": 3000},
         },
         rotation_angle=0,
         mirrored=False,
@@ -624,186 +637,283 @@ def test_upload_image(responses):
 
 
 @pytest.mark.parametrize(
-    ("max_pixels", "max_bytes", "expected_sizes", "expected_logs"),
+    (
+        "max_pixels_short",
+        "max_pixels_long",
+        "max_bytes",
+        "expected_sizes",
+        "expected_logs",
+    ),
     [
-        # No limits
+        # No limits provided
         (
             None,
             None,
+            None,
+            [(2000, 3000), (1000, 1500), (200, 300)],
             [
-                (1992, 3000),
-                (1793, 2700),
-                (1694, 2550),
-                (1594, 2400),
-                (1494, 2250),
-                (1395, 2100),
-                (1195, 1800),
-                (996, 1500),
-                (797, 1200),
-                (598, 900),
-            ],
-            [
-                (logging.WARNING, "The image was resized to (1992 x 3000)."),
-                (logging.WARNING, "The image was resized to (1793 x 2700)."),
-                (logging.WARNING, "The image was resized to (1694 x 2550)."),
-                (logging.WARNING, "The image was resized to (1594 x 2400)."),
-                (logging.WARNING, "The image was resized to (1494 x 2250)."),
-                (logging.WARNING, "The image was resized to (1395 x 2100)."),
-                (logging.WARNING, "The image was resized to (1195 x 1800)."),
-                (logging.WARNING, "The image was resized to (996 x 1500)."),
-                (logging.WARNING, "The image was resized to (797 x 1200)."),
-                (logging.WARNING, "The image was resized to (598 x 900)."),
+                (logging.INFO, "This element's image dimensions are (2000 x 3000)."),
+                (logging.WARNING, "The image was resized to (1000 x 1500)."),
+                (logging.WARNING, "The image was resized to (200 x 300)."),
             ],
         ),
-        # Image already under the limits
+        # Image already under all three limits
         (
+            10000,
             10000,
             4000000,  # 4MB
+            [(2000, 3000), (1000, 1500), (200, 300)],
             [
-                (1992, 3000),
-                (1793, 2700),
-                (1694, 2550),
-                (1594, 2400),
-                (1494, 2250),
-                (1395, 2100),
-                (1195, 1800),
-                (996, 1500),
-                (797, 1200),
-                (598, 900),
+                (logging.INFO, "This element's image dimensions are (2000 x 3000)."),
+                (logging.WARNING, "The image was resized to (1000 x 1500)."),
+                (logging.WARNING, "The image was resized to (200 x 300)."),
             ],
+        ),
+        # Image above the "short side in pixels" limit
+        (
+            1000,
+            None,
+            None,
+            [(1000, 1500), (500, 750), (100, 150)],
             [
-                (logging.WARNING, "The image was resized to (1992 x 3000)."),
-                (logging.WARNING, "The image was resized to (1793 x 2700)."),
-                (logging.WARNING, "The image was resized to (1694 x 2550)."),
-                (logging.WARNING, "The image was resized to (1594 x 2400)."),
-                (logging.WARNING, "The image was resized to (1494 x 2250)."),
-                (logging.WARNING, "The image was resized to (1395 x 2100)."),
-                (logging.WARNING, "The image was resized to (1195 x 1800)."),
-                (logging.WARNING, "The image was resized to (996 x 1500)."),
-                (logging.WARNING, "The image was resized to (797 x 1200)."),
-                (logging.WARNING, "The image was resized to (598 x 900)."),
+                (logging.INFO, "This element's image dimensions are (2000 x 3000)."),
+                (
+                    logging.WARNING,
+                    "Maximum image dimensions supported are (1000 x 3000).",
+                ),
+                (logging.WARNING, "The image will be resized."),
+                (logging.WARNING, "The image was resized to (1000 x 1500)."),
+                (logging.WARNING, "The image was resized to (500 x 750)."),
+                (logging.WARNING, "The image was resized to (100 x 150)."),
             ],
         ),
-        # Image above the limits
+        # Image above the "long side in pixels" limit
         (
             None,
-            100000,  # 100kB
-            [(598, 900)],
+            2000,
+            None,
+            [(1333, 2000), (667, 1000), (133, 200)],
             [
-                (logging.WARNING, "The image was resized to (1992 x 3000)."),
-                (logging.WARNING, "The image size is 773.4 kB."),
-                (logging.WARNING, "Maximum image input size supported is 100.0 kB."),
+                (logging.INFO, "This element's image dimensions are (2000 x 3000)."),
+                (
+                    logging.WARNING,
+                    "Maximum image dimensions supported are (2000 x 2000).",
+                ),
                 (logging.WARNING, "The image will be resized."),
-                (logging.WARNING, "The image was resized to (1793 x 2700)."),
-                (logging.WARNING, "The image size is 616.0 kB."),
+                (logging.WARNING, "The image was resized to (1333 x 2000)."),
+                (logging.WARNING, "The image was resized to (667 x 1000)."),
+                (logging.WARNING, "The image was resized to (133 x 200)."),
+            ],
+        ),
+        # Image above the "size in bytes" limit
+        (
+            None,
+            None,
+            100000,  # 100kB
+            [(200, 300)],
+            [
+                (logging.INFO, "This element's image dimensions are (2000 x 3000)."),
+                (logging.WARNING, "The image size is 1.3 MB."),
                 (logging.WARNING, "Maximum image input size supported is 100.0 kB."),
                 (logging.WARNING, "The image will be resized."),
-                (logging.WARNING, "The image was resized to (1694 x 2550)."),
-                (logging.WARNING, "The image size is 546.4 kB."),
+                (logging.WARNING, "The image was resized to (1000 x 1500)."),
+                (logging.WARNING, "The image size is 214.2 kB."),
                 (logging.WARNING, "Maximum image input size supported is 100.0 kB."),
                 (logging.WARNING, "The image will be resized."),
-                (logging.WARNING, "The image was resized to (1594 x 2400)."),
-                (logging.WARNING, "The image size is 479.4 kB."),
-                (logging.WARNING, "Maximum image input size supported is 100.0 kB."),
+                (logging.WARNING, "The image was resized to (200 x 300)."),
+            ],
+        ),
+        # Image above all three limits
+        (
+            1000,
+            2000,
+            100000,  # 100kB
+            [(500, 750), (100, 150)],
+            [
+                (logging.INFO, "This element's image dimensions are (2000 x 3000)."),
+                (
+                    logging.WARNING,
+                    "Maximum image dimensions supported are (1000 x 2000).",
+                ),
                 (logging.WARNING, "The image will be resized."),
-                (logging.WARNING, "The image was resized to (1494 x 2250)."),
-                (logging.WARNING, "The image size is 416.1 kB."),
+                (logging.WARNING, "The image was resized to (1000 x 1500)."),
+                (logging.WARNING, "The image size is 214.2 kB."),
                 (logging.WARNING, "Maximum image input size supported is 100.0 kB."),
                 (logging.WARNING, "The image will be resized."),
-                (logging.WARNING, "The image was resized to (1395 x 2100)."),
-                (logging.WARNING, "The image size is 360.5 kB."),
-                (logging.WARNING, "Maximum image input size supported is 100.0 kB."),
+                (logging.WARNING, "The image was resized to (500 x 750)."),
+                (logging.WARNING, "The image was resized to (100 x 150)."),
+            ],
+        ),
+        # Image always above all three limits
+        (
+            50,
+            50,
+            50,  # 50B
+            [],
+            [
+                (logging.INFO, "This element's image dimensions are (2000 x 3000)."),
+                (logging.WARNING, "Maximum image dimensions supported are (50 x 50)."),
                 (logging.WARNING, "The image will be resized."),
-                (logging.WARNING, "The image was resized to (1195 x 1800)."),
-                (logging.WARNING, "The image size is 258.6 kB."),
-                (logging.WARNING, "Maximum image input size supported is 100.0 kB."),
+                (logging.WARNING, "The image was resized to (33 x 50)."),
+                (logging.WARNING, "The image size is 1.0 kB."),
+                (logging.WARNING, "Maximum image input size supported is 50 Bytes."),
                 (logging.WARNING, "The image will be resized."),
-                (logging.WARNING, "The image was resized to (996 x 1500)."),
-                (logging.WARNING, "The image size is 179.0 kB."),
-                (logging.WARNING, "Maximum image input size supported is 100.0 kB."),
+                (logging.WARNING, "The image was resized to (17 x 25)."),
+                (logging.WARNING, "The image size is 785 Bytes."),
+                (logging.WARNING, "Maximum image input size supported is 50 Bytes."),
                 (logging.WARNING, "The image will be resized."),
-                (logging.WARNING, "The image was resized to (797 x 1200)."),
-                (logging.WARNING, "The image size is 115.7 kB."),
-                (logging.WARNING, "Maximum image input size supported is 100.0 kB."),
+                (logging.WARNING, "The image was resized to (3 x 5)."),
+                (logging.WARNING, "The image size is 689 Bytes."),
+                (logging.WARNING, "Maximum image input size supported is 50 Bytes."),
                 (logging.WARNING, "The image will be resized."),
-                (logging.WARNING, "The image was resized to (598 x 900)."),
             ],
         ),
-        # Image above the limits
+    ],
+)
+def test_resized_images_portrait_format(
+    monkeypatch,
+    max_pixels_short,
+    max_pixels_long,
+    max_bytes,
+    expected_sizes,
+    expected_logs,
+    mock_page,
+    caplog,
+):
+    monkeypatch.setattr(arkindex_worker.image, "IMAGE_RATIOS", [1.0, 0.5, 0.1])
+
+    # Short side is the width, long side is the height
+    assert mock_page.zone.image.width < mock_page.zone.image.height
+
+    assert [
+        Image.open(image).size
+        for image in resized_images(
+            element=mock_page,
+            max_pixels_short=max_pixels_short,
+            max_pixels_long=max_pixels_long,
+            max_bytes=max_bytes,
+        )
+    ] == expected_sizes
+
+    assert [
+        (record.levelno, record.message) for record in caplog.records
+    ] == expected_logs
+
+
+@pytest.mark.parametrize(
+    ("max_pixels_short", "max_pixels_long", "expected_sizes", "expected_logs"),
+    [
+        # Image above the "short side in pixels" limit
         (
-            2000,
+            1000,
             None,
-            [(1328, 2000), (1195, 1800), (996, 1500), (797, 1200), (598, 900)],
+            [(1500, 1000), (750, 500), (150, 100)],
             [
+                (logging.INFO, "This element's image dimensions are (3000 x 2000)."),
                 (
                     logging.WARNING,
-                    "Maximum image input size supported is (2000 x 2000).",
+                    "Maximum image dimensions supported are (3000 x 1000).",
                 ),
                 (logging.WARNING, "The image will be resized."),
-                (logging.WARNING, "The image was resized to (1328 x 2000)."),
-                (logging.WARNING, "The image was resized to (1195 x 1800)."),
-                (logging.WARNING, "The image was resized to (996 x 1500)."),
-                (logging.WARNING, "The image was resized to (797 x 1200)."),
-                (logging.WARNING, "The image was resized to (598 x 900)."),
+                (logging.WARNING, "The image was resized to (1500 x 1000)."),
+                (logging.WARNING, "The image was resized to (750 x 500)."),
+                (logging.WARNING, "The image was resized to (150 x 100)."),
             ],
         ),
-        # Image above the limits
+        # Image above the "long side in pixels" limit
         (
+            None,
             2000,
-            100000,  # 100kB
-            [(598, 900)],
+            [(2000, 1333), (1000, 667), (200, 133)],
             [
+                (logging.INFO, "This element's image dimensions are (3000 x 2000)."),
                 (
                     logging.WARNING,
-                    "Maximum image input size supported is (2000 x 2000).",
+                    "Maximum image dimensions supported are (2000 x 2000).",
                 ),
                 (logging.WARNING, "The image will be resized."),
-                (logging.WARNING, "The image was resized to (1328 x 2000)."),
-                (logging.WARNING, "The image size is 325.5 kB."),
-                (logging.WARNING, "Maximum image input size supported is 100.0 kB."),
-                (logging.WARNING, "The image will be resized."),
-                (logging.WARNING, "The image was resized to (1195 x 1800)."),
-                (logging.WARNING, "The image size is 258.6 kB."),
-                (logging.WARNING, "Maximum image input size supported is 100.0 kB."),
-                (logging.WARNING, "The image will be resized."),
-                (logging.WARNING, "The image was resized to (996 x 1500)."),
-                (logging.WARNING, "The image size is 179.0 kB."),
-                (logging.WARNING, "Maximum image input size supported is 100.0 kB."),
-                (logging.WARNING, "The image will be resized."),
-                (logging.WARNING, "The image was resized to (797 x 1200)."),
-                (logging.WARNING, "The image size is 115.7 kB."),
-                (logging.WARNING, "Maximum image input size supported is 100.0 kB."),
-                (logging.WARNING, "The image will be resized."),
-                (logging.WARNING, "The image was resized to (598 x 900)."),
+                (logging.WARNING, "The image was resized to (2000 x 1333)."),
+                (logging.WARNING, "The image was resized to (1000 x 667)."),
+                (logging.WARNING, "The image was resized to (200 x 133)."),
             ],
         ),
-        # Image always above the limits
+        # Image above the two pixels limits
         (
-            50,
-            50,  # 50B
-            [],
+            1000,
+            2000,
+            [(1500, 1000), (750, 500), (150, 100)],
             [
-                (logging.WARNING, "Maximum image input size supported is (50 x 50)."),
-                (logging.WARNING, "The image will be resized."),
-                (logging.WARNING, "The image was resized to (33 x 50)."),
-                (logging.WARNING, "The image size is 1.0 kB."),
-                (logging.WARNING, "Maximum image input size supported is 50 Bytes."),
+                (logging.INFO, "This element's image dimensions are (3000 x 2000)."),
+                (
+                    logging.WARNING,
+                    "Maximum image dimensions supported are (2000 x 1000).",
+                ),
                 (logging.WARNING, "The image will be resized."),
+                (logging.WARNING, "The image was resized to (1500 x 1000)."),
+                (logging.WARNING, "The image was resized to (750 x 500)."),
+                (logging.WARNING, "The image was resized to (150 x 100)."),
             ],
         ),
     ],
 )
-def test_resized_images(
-    max_pixels, max_bytes, expected_sizes, expected_logs, mock_page, caplog
+def test_resized_images_landscape_format(
+    monkeypatch,
+    max_pixels_short,
+    max_pixels_long,
+    expected_sizes,
+    expected_logs,
+    mock_page,
+    caplog,
 ):
-    caplog.set_level(logging.WARNING)
+    monkeypatch.setattr(arkindex_worker.image, "IMAGE_RATIOS", [1.0, 0.5, 0.1])
+
+    # Short side is the height, long side is the width
+    mock_page.zone = {
+        "polygon": [[0, 0], [3000, 0], [3000, 2000], [0, 2000], [0, 0]],
+        "image": {"width": 3000, "height": 2000},
+    }
+    assert mock_page.zone.image.height < mock_page.zone.image.width
 
     assert [
         Image.open(image).size
         for image in resized_images(
-            element=mock_page, max_pixels=max_pixels, max_bytes=max_bytes
+            element=mock_page,
+            max_pixels_short=max_pixels_short,
+            max_pixels_long=max_pixels_long,
+            max_bytes=None,
         )
     ] == expected_sizes
+
     assert [
         (record.levelno, record.message) for record in caplog.records
     ] == expected_logs
+
+
+def test_resized_images_use_base64(monkeypatch, mock_page, caplog):
+    monkeypatch.setattr(arkindex_worker.image, "IMAGE_RATIOS", [1.0, 0.5, 0.25, 0.1])
+
+    assert list(
+        map(
+            len,
+            resized_images(
+                element=mock_page,
+                max_pixels_short=None,
+                max_pixels_long=None,
+                max_bytes=100000,
+                use_base64=True,
+            ),
+        )
+    ) == [65280, 11892]
+
+    assert [(record.levelno, record.message) for record in caplog.records] == [
+        (logging.INFO, "This element's image dimensions are (2000 x 3000)."),
+        (logging.WARNING, "The image size is 1.7 MB."),
+        (logging.WARNING, "Maximum image input size supported is 100.0 kB."),
+        (logging.WARNING, "The image will be resized."),
+        (logging.WARNING, "The image was resized to (1000 x 1500)."),
+        (logging.WARNING, "The image size is 285.6 kB."),
+        (logging.WARNING, "Maximum image input size supported is 100.0 kB."),
+        (logging.WARNING, "The image will be resized."),
+        (logging.WARNING, "The image was resized to (500 x 750)."),
+        (logging.WARNING, "The image was resized to (200 x 300)."),
+    ]

tests/test_utils.py

@@ -1,5 +1,8 @@
+import logging
+
 import pytest
 
+from arkindex_worker.cache import unsupported_cache
 from arkindex_worker.utils import (
     DEFAULT_BATCH_SIZE,
     batch_publication,
@@ -58,10 +61,24 @@ def test_close_delete_file(tmp_path):
 
 
 class TestMixin:
+    def __init__(self, use_cache: bool = False):
+        """
+        Args:
+            use_cache (bool, optional): To mock BaseWorker.use_cache attribute. Defaults to False.
+        """
+        self.use_cache = use_cache
+
     @batch_publication
     def custom_publication_in_batches(self, batch_size: int = DEFAULT_BATCH_SIZE):
         return batch_size
 
+    @unsupported_cache
+    @batch_publication
+    def custom_publication_in_batches_without_cache(
+        self, batch_size: int = DEFAULT_BATCH_SIZE
+    ):
+        return batch_size
+
 
 def test_batch_publication_decorator_no_parameter():
     assert TestMixin().custom_publication_in_batches() == DEFAULT_BATCH_SIZE
@@ -81,3 +98,23 @@ def test_batch_publication_decorator_right_parameter(batch_size):
     assert (
         TestMixin().custom_publication_in_batches(batch_size=batch_size) == batch_size
     )
+
+
+def test_batch_publication_decorator_alongside_unsupported_cache(caplog):
+    # Capture log messages
+    caplog.clear()
+    with caplog.at_level(logging.WARNING):
+        # Call the helper
+        assert (
+            TestMixin(use_cache=True).custom_publication_in_batches_without_cache()
+            == DEFAULT_BATCH_SIZE
+        )
+
+    # Check logs
+    assert caplog.record_tuples == [
+        (
+            "arkindex_worker",
+            logging.WARNING,
+            "This API helper `custom_publication_in_batches_without_cache` did not update the cache database",
+        ),
+    ]