arkindex-base-worker 0.5.1rc3__py3-none-any.whl → 0.5.2a1__py3-none-any.whl

{arkindex_base_worker-0.5.1rc3.dist-info → arkindex_base_worker-0.5.2a1.dist-info}/METADATA

@@ -1,31 +1,9 @@
 Metadata-Version: 2.4
 Name: arkindex-base-worker
-Version: 0.5.1rc3
+Version: 0.5.2a1
 Summary: Base Worker to easily build Arkindex ML workflows
 Author-email: Teklia <contact@teklia.com>
 Maintainer-email: Teklia <contact@teklia.com>
-License: MIT License
-        
-        Copyright (c) 2023 Teklia
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-        
 Project-URL: Homepage, https://workers.arkindex.org
 Project-URL: Documentation, https://workers.arkindex.org
 Project-URL: Repository, https://gitlab.teklia.com/workers/base-worker
@@ -41,12 +19,12 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: humanize==4.14.0
+Requires-Dist: humanize==4.15.0
 Requires-Dist: peewee~=3.17
 Requires-Dist: Pillow==11.3.0
-Requires-Dist: python-gnupg==0.5.5
+Requires-Dist: python-gnupg==0.5.6
 Requires-Dist: shapely==2.0.6
-Requires-Dist: teklia-toolbox==0.1.11
+Requires-Dist: teklia-toolbox==0.1.12
 Requires-Dist: zstandard==0.25.0
 Provides-Extra: tests
 Requires-Dist: pytest-mock==3.15.1; extra == "tests"

{arkindex_base_worker-0.5.1rc3.dist-info → arkindex_base_worker-0.5.2a1.dist-info}/RECORD

@@ -1,9 +1,9 @@
-arkindex_base_worker-0.5.1rc3.dist-info/licenses/LICENSE,sha256=NVshRi1efwVezMfW7xXYLrdDr2Li1AfwfGOd5WuH1kQ,1063
+arkindex_base_worker-0.5.2a1.dist-info/licenses/LICENSE,sha256=NVshRi1efwVezMfW7xXYLrdDr2Li1AfwfGOd5WuH1kQ,1063
 arkindex_worker/__init__.py,sha256=Sdt5KXn8EgURb2MurYVrUWaHbH3iFA1XLRo0Lc5AJ44,250
 arkindex_worker/cache.py,sha256=XpEXMSnbhYCvrJquwA9XXqZo-ajMLpaCxKG5wH3Gp6Y,10959
 arkindex_worker/image.py,sha256=sGE8to5iykXv25bpkftOEWzlh5NzBZSKy4lSRoHYHPU,20929
-arkindex_worker/models.py,sha256=7GnKqpWPOSxyR_eKlDNVBe_r3TcE4ofK-1GzaonJEdM,10132
-arkindex_worker/utils.py,sha256=yq_LmRlqfWOzB09Aiz2XYx4xPZnoEXR3As48h2HxOVc,10974
+arkindex_worker/models.py,sha256=DgKvAB_2e1cPcuUavZkyTkV10jBK8y083oVklB9idSk,10855
+arkindex_worker/utils.py,sha256=Eqg5pGAuOmuwMT3EhKTQDMek7wHC1KzZL7XXqYVVfHY,10977
 arkindex_worker/worker/__init__.py,sha256=SzD0s1_m6gMV02EUF-NeciqZdVPA4dpXI84tSj-g494,17869
 arkindex_worker/worker/base.py,sha256=-R_aLMJHbR6X1uM-U0zExsF_KLy5Wl3WJ_YMGO9We0I,22153
 arkindex_worker/worker/classification.py,sha256=qvykymkgd4nGywHCxL8obo4egstoGsmWNS4Ztc1qNWQ,11024
@@ -55,7 +55,7 @@ worker-demo/tests/conftest.py,sha256=XzNMNeg6pmABUAH8jN6eZTlZSFGLYjS3-DTXjiRN6Yc
 worker-demo/tests/test_worker.py,sha256=3DLd4NRK4bfyatG5P_PK4k9P9tJHx9XQq5_ryFEEFVg,304
 worker-demo/worker_demo/__init__.py,sha256=2BPomV8ZMNf3YXJgloatKeHQCE6QOkwmsHGkO6MkQuM,125
 worker-demo/worker_demo/worker.py,sha256=Rt-DjWa5iBP08k58NDZMfeyPuFbtNcbX6nc5jFX7GNo,440
-arkindex_base_worker-0.5.1rc3.dist-info/METADATA,sha256=EhM_vIe59B-G10-l3mQUdEWXDIe4HmoSp8vbstcJ2Cs,3091
-arkindex_base_worker-0.5.1rc3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-arkindex_base_worker-0.5.1rc3.dist-info/top_level.txt,sha256=-vNjP2VfROx0j83mdi9aIqRZ88eoJjxeWz-R_gPgyXU,49
-arkindex_base_worker-0.5.1rc3.dist-info/RECORD,,
+arkindex_base_worker-0.5.2a1.dist-info/METADATA,sha256=AwYp_xJZzu6zAtvnvZjeK_W29tzqvRuwYnxwMYcKSIc,1849
+arkindex_base_worker-0.5.2a1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+arkindex_base_worker-0.5.2a1.dist-info/top_level.txt,sha256=-vNjP2VfROx0j83mdi9aIqRZ88eoJjxeWz-R_gPgyXU,49
+arkindex_base_worker-0.5.2a1.dist-info/RECORD,,

arkindex_worker/models.py

@@ -9,6 +9,8 @@ from contextlib import contextmanager
 from PIL import Image
 from requests import HTTPError
 
+IMAGE_EXTENSION = "jpg"
+
 
 class MagicDict(dict):
     """
@@ -62,28 +64,38 @@ class Element(MagicDict):
     Describes an Arkindex element.
     """
 
-    def resize_zone_url(self, size: str = "full") -> str:
+    def resize_zone_url(
+        self, size: str = "full", extension: str = IMAGE_EXTENSION
+    ) -> str:
         """
         Compute the URL of the image corresponding to the size
         :param size: Requested size
+        :param extension: IIIF extension to download the image
         :return: The URL corresponding to the size
         """
+        # Removing the `jpg` default extension at the end of the URL to use the provided one
+        url = self.zone.url[:-3] + extension
+
         if size == "full":
-            return self.zone.url
+            return url
         else:
-            parts = self.zone.url.split("/")
+            parts = url.split("/")
             parts[-3] = size
             return "/".join(parts)
 
-    def image_url(self, size: str = "full") -> str | None:
+    def image_url(
+        self, size: str = "full", extension: str = IMAGE_EXTENSION
+    ) -> str | None:
         """
         Build a URL to access the image.
         When possible, will return the S3 URL for images, so an ML worker can bypass IIIF servers.
         :param size: Subresolution of the image, following the syntax of the IIIF resize parameter.
+        :param extension: IIIF extension to download the image.
         :returns: A URL to the image, or None if the element does not have an image.
         """
         if not self.get("zone"):
             return
+
         url = self.zone.image.get("s3_url")
         if url:
             return url
@@ -95,7 +107,7 @@ class Element(MagicDict):
         url = self.zone.image.url
         if not url.endswith("/"):
             url += "/"
-        return f"{url}full/{size}/0/default.jpg"
+        return f"{url}full/{size}/0/default.{extension}"
 
     @property
     def polygon(self) -> list[float]:
@@ -131,6 +143,7 @@ class Element(MagicDict):
         max_width: int | None = None,
         max_height: int | None = None,
         use_full_image: bool | None = False,
+        extension: str | None = IMAGE_EXTENSION,
         **kwargs,
     ) -> Image.Image:
         """
@@ -163,6 +176,7 @@ class Element(MagicDict):
         :param max_height: The maximum height of the image.
         :param use_full_image: Ignore the ``zone.polygon`` and always
            retrieve the image without cropping.
+        :param extension: The extension to download the image.
         :param *args: Positional arguments passed to [arkindex_worker.image.open_image][].
         :param **kwargs: Keyword arguments passed to [arkindex_worker.image.open_image][].
         :raises ValueError: When the element does not have an image.
@@ -200,7 +214,11 @@ class Element(MagicDict):
             else:
                 resize = f"{max_width or ''},{max_height or ''}"
 
-        url = self.image_url(resize) if use_full_image else self.resize_zone_url(resize)
+        url = (
+            self.image_url(resize, extension)
+            if use_full_image
+            else self.resize_zone_url(resize, extension)
+        )
 
         try:
             return open_image(
@@ -224,7 +242,7 @@ class Element(MagicDict):
 
     @contextmanager
     def open_image_tempfile(
-        self, format: str | None = "jpeg", *args, **kwargs
+        self, extension: str | None = IMAGE_EXTENSION, *args, **kwargs
     ) -> Generator[tempfile.NamedTemporaryFile, None, None]:
         """
         Get the element's image as a temporary file stored on the disk.
@@ -243,8 +261,12 @@ class Element(MagicDict):
         :param **kwargs: Keyword arguments passed to [arkindex_worker.image.open_image][].
 
         """
-        with tempfile.NamedTemporaryFile() as f:
-            self.open_image(*args, **kwargs).save(f, format=format)
+        PIL_format = "jpeg" if extension == IMAGE_EXTENSION else extension
+
+        with tempfile.NamedTemporaryFile(suffix=f".{extension}") as f:
+            self.open_image(*args, extension=extension, **kwargs).save(
+                f, format=PIL_format
+            )
             yield f
 
     def __str__(self):

arkindex_worker/utils.py

@@ -243,7 +243,7 @@ def create_zip_archive(source: Path, destination: Path | None = None) -> Path:
     logger.debug(f"Compressing file to {destination}")
 
     with zipfile.ZipFile(
-        destination, mode="w", compression=zipfile.ZIP_BZIP2
+        destination, mode="w", compression=zipfile.ZIP_DEFLATED
     ) as archive:
         for p in source.rglob("*"):
             relpath = p.relative_to(source)