Rework following review

Author: benoit74

CHANGELOG.md

@@ -13,7 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Add utility to fetch and prepare ZIM illustration ; make this utility directly accessible from illustration metadata (#254)
+- Add utility to fetch and prepare ZIM illustration (#254)
 
 ## [5.1.1] - 2025-02-17
 

src/zimscraperlib/zim/metadata.py

@@ -1,7 +1,6 @@
 import base64
 import datetime
 import io
-import pathlib
 from abc import ABC, abstractmethod
 from collections.abc import Iterable
 from dataclasses import asdict, dataclass, fields
@@ -19,7 +18,6 @@
     RECOMMENDED_MAX_TITLE_LENGTH,
 )
 from zimscraperlib.i18n import is_valid_iso_639_3
-from zimscraperlib.image.illustration import get_zim_illustration
 from zimscraperlib.image.probing import is_valid_image
 from zimscraperlib.inputs import unique_values
 from zimscraperlib.typing import SupportsRead, SupportsSeekableRead
@@ -356,20 +354,12 @@ class IllustrationBasedMetadata(Metadata):
     meta_mimetype = "image/png"
 
     def __init__(
-        self,
-        value: bytes | io.IOBase | io.BytesIO | str | pathlib.Path,
-        name: str | None = None,
+        self, value: bytes | io.IOBase | io.BytesIO, name: str | None = None
     ) -> None:
         super().__init__(value=value, name=name)
 
     # native type is PNG image buffer
-    def get_cleaned_value(
-        self, value: bytes | io.IOBase | io.BytesIO | str | pathlib.Path
-    ) -> bytes:
-        if isinstance(value, str | pathlib.Path):
-            value = get_zim_illustration(
-                value, self.illustration_size, self.illustration_size
-            )
+    def get_cleaned_value(self, value: bytes | io.IOBase | io.BytesIO) -> bytes:
         value = self.get_binary_from(value)
         if not is_valid_image(
             image=value,
@@ -425,10 +415,7 @@ class IllustrationMetadata(IllustrationBasedMetadata):
     illustration_scale: int = 1
 
     def __init__(
-        self,
-        value: bytes | io.IOBase | io.BytesIO | str | pathlib.Path,
-        size: int,
-        scale: int = 1,
+        self, value: bytes | io.IOBase | io.BytesIO, size: int, scale: int = 1
     ) -> None:
         self.illustration_scale = scale
         self.illustration_size = size

tests/zim/test_metadata.py

@@ -10,7 +10,6 @@
 
 import pytest
 from beartype.roar import BeartypeCallHintParamViolation as InvalidType
-from PIL.Image import open as pilopen
 
 from zimscraperlib.zim import metadata
 
@@ -214,11 +213,6 @@ def test_validate_illustration_invalid_image():
         metadata.IllustrationMetadata(b"PN", size=48)
 
 
-def test_validate_illustration_invalid_image_location():
-    with pytest.raises(OSError, match="missing.png could not be found"):
-        metadata.IllustrationMetadata("missing.png", size=48)
-
-
 def test_validate_illustration_wrong_sizes(png_image2: pathlib.Path):
     with open(png_image2, "rb") as fh:
         png_data = fh.read()
@@ -228,22 +222,6 @@ def test_validate_illustration_wrong_sizes(png_image2: pathlib.Path):
         metadata.IllustrationMetadata(png_data, size=48)
 
 
-def test_validate_illustration_path_resized(png_image2: pathlib.Path):
-    with pilopen(
-        io.BytesIO(metadata.IllustrationMetadata(png_image2, size=32).libzim_value)
-    ) as image:
-        assert image.size == (32, 32)
-
-
-def test_validate_illustration_str_resized(png_image2: pathlib.Path):
-    with pilopen(
-        io.BytesIO(
-            metadata.IllustrationMetadata(png_image2.resolve(), size=48).libzim_value
-        )
-    ) as image:
-        assert image.size == (48, 48)
-
-
 def test_blank_metadata():
     with pytest.raises(ValueError, match=r"Missing value \(empty not allowed\)"):
         metadata.Metadata(name="Blank", value=b"")

tests/zim/test_zim_creator.py

@@ -14,7 +14,6 @@
 
 import pytest
 from libzim.writer import Compression  # pyright: ignore[reportMissingModuleSource]
-from PIL.Image import open as pilopen
 
 from zimscraperlib.constants import UTF8
 from zimscraperlib.download import save_large_file, stream_file
@@ -757,9 +756,11 @@ def test_relax_metadata(
     ],
 )
 def test_config_metadata(
-    tmp_path: pathlib.Path, png_image2: pathlib.Path, tags: str | list[str]
+    tmp_path: pathlib.Path, png_image: pathlib.Path, tags: str | list[str]
 ):
     fpath = tmp_path / "test_config.zim"
+    with open(png_image, "rb") as fh:
+        png_data = fh.read()
     creator = Creator(fpath, "").config_metadata(
         StandardMetadataList(
             Name=NameMetadata("wikipedia_fr_football"),
@@ -780,7 +781,7 @@ def test_config_metadata(
             Flavour=FlavourMetadata("nopic"),
             Source=SourceMetadata("https://en.wikipedia.org/"),
             Scraper=ScraperMetadata("mwoffliner 1.2.3"),
-            Illustration_48x48_at_1=DefaultIllustrationMetadata(png_image2),
+            Illustration_48x48_at_1=DefaultIllustrationMetadata(png_data),
         ),
         [CustomTextMetadata("X-TestMetadata", "Test Metadata")],
     )
@@ -816,11 +817,7 @@ def test_config_metadata(
     assert reader.get_text_metadata("Flavour") == "nopic"
     assert reader.get_text_metadata("Source") == "https://en.wikipedia.org/"
     assert reader.get_text_metadata("Scraper") == "mwoffliner 1.2.3"
-    with pilopen(
-        io.BytesIO(reader.get_metadata("Illustration_48x48@1"))
-    ) as illustration:
-        assert illustration.size == (48, 48)
-        assert illustration.format == "PNG"
+    assert reader.get_metadata("Illustration_48x48@1") == png_data
     assert reader.get_text_metadata("X-TestMetadata") == "Test Metadata"