Fix linting and type checking recommendations

Author: benoit74

src/zimscraperlib/download.py

@@ -34,7 +34,9 @@ def shutdown(self) -> None:
         self.executor.shutdown(wait=True)
 
     def _run_youtube_dl(self, url: str, options: dict[str, Any]) -> None:
-        with youtube_dl.YoutubeDL(options) as ydl:
+        with youtube_dl.YoutubeDL(
+            options  # pyright: ignore[reportArgumentType]
+        ) as ydl:
             ydl.download([url])  # pyright: ignore[reportUnknownMemberType]
 
     def download(

src/zimscraperlib/i18n.py

@@ -164,6 +164,17 @@ def __eq__(self, value: object) -> bool:
             and self.native == getattr(value, "native", None)
         )
 
+    def __hash__(self):
+        return hash(
+            f"{getattr(self, "iso_639_1", None)}$"
+            f"{getattr(self, "iso_639_2b", None)}$"
+            f"{getattr(self, "iso_639_2t", None)}$"
+            f"{getattr(self, "iso_639_3", None)}$"
+            f"{getattr(self, "iso_639_5", None)}$"
+            f"{getattr(self, "english", None)}$"
+            f"{getattr(self, "native", None)}"
+        )
+
 
 def find_language_names(query: str) -> tuple[str, str]:
     """(native, english) language names for query"""

src/zimscraperlib/image/probing.py

@@ -5,9 +5,16 @@
 
 import colorthief  # pyright: ignore[reportMissingTypeStubs]
 import PIL.Image
+from PIL.Image import EXTENSION as PIL_FMT_EXTENSION
+from PIL.Image import init as init_pil
 
 from zimscraperlib.filesystem import get_content_mimetype, get_file_mimetype
 
+init_pil()  # populate the PIL_FMT_EXTENSION dictionary
+
+known_extensions = {".svg": "SVG"}
+known_extensions.update(PIL_FMT_EXTENSION)
+
 
 def get_colors(
     src: pathlib.Path, *, use_palette: bool | None = True
@@ -82,13 +89,6 @@ def format_for(
             "Cannot guess image format from file suffix when byte array is passed"
         )
 
-    from PIL.Image import EXTENSION as PIL_FMT_EXTENSION
-    from PIL.Image import init as init_pil
-
-    init_pil()  # populate the PIL_FMT_EXTENSION dictionary
-
-    known_extensions = {".svg": "SVG"}
-    known_extensions.update(PIL_FMT_EXTENSION)
     return known_extensions[src.suffix] if src.suffix in known_extensions else None
 
 

src/zimscraperlib/inputs.py

@@ -2,7 +2,6 @@
 import shutil
 import tempfile
 from collections.abc import Iterable
-from typing import TypeVar
 
 from zimscraperlib import logger
 from zimscraperlib.constants import DEFAULT_USER_AGENT
@@ -14,8 +13,6 @@
 )
 from zimscraperlib.download import stream_file
 
-T = TypeVar("T")
-
 
 def handle_user_provided_file(
     source: pathlib.Path | str | None = None,
@@ -136,6 +133,6 @@ def compute_tags(
     }
 
 
-def unique_values(items: list[T]) -> list[T]:
+def unique_values[T](items: list[T]) -> list[T]:
     """Return unique values in input list while preserving list order"""
     return list(dict.fromkeys(items))

src/zimscraperlib/zim/creator.py

@@ -381,6 +381,7 @@ def add_item_for(
     def add_item(  # pyright: ignore[reportIncompatibleMethodOverride]
         self,
         item: libzim.writer.Item,
+        *,
         duplicate_ok: bool | None = None,
         callbacks: list[Callback] | Callback | None = None,
     ):
@@ -417,6 +418,7 @@ def add_redirect(
         path: str,
         target_path: str,
         title: str | None = "",
+        *,
         is_front: bool | None = None,
         duplicate_ok: bool | None = None,
     ):

src/zimscraperlib/zim/items.py

@@ -235,6 +235,7 @@ def __init__(
         title: str | None = None,
         mimetype: str | None = None,
         hints: dict[libzim.writer.Hint, int] | None = None,
+        *,
         use_disk: bool | None = None,
         **kwargs: Any,
     ):

src/zimscraperlib/zim/metadata.py

@@ -163,11 +163,6 @@ def get_libzim_value(self) -> bytes: ...
 # Alias for convenience when function accept any metadata
 AnyMetadata = MetadataBase[Any]
 
-# TypeVar bounded to subclasses of GenericMetadata, used by class decorators so that
-# they properly accommodate to the class they are used on while still knowing they have
-# access to all attributes of the MetadataBase class
-U = TypeVar("U", bound=AnyMetadata)
-
 
 def clean_str(value: str) -> str:
     """Clean a string value for unwanted control characters and strip white chars"""
@@ -179,47 +174,47 @@ def nb_grapheme_for(value: str) -> int:
     return len(regex.findall(r"\X", value))
 
 
-def mandatory(cls: type[U]):
+def mandatory[U: AnyMetadata](cls: type[U]):
     """Marks a Metadata mandatory: must be set to please Creator and cannot be empty"""
     cls.is_required = True
     cls.empty_allowed = False
     return cls
 
 
-def allow_empty(cls: type[U]):
+def allow_empty[U: AnyMetadata](cls: type[U]):
     """Whether input can be blank"""
     cls.empty_allowed = True
     return cls
 
 
-def allow_duplicates(cls: type[U]):
+def allow_duplicates[U: AnyMetadata](cls: type[U]):
     """Whether list input can accept duplicate values"""
     cls.duplicates_allowed = True
     return cls
 
 
-def deduplicate(cls: type[U]):
+def deduplicate[U: AnyMetadata](cls: type[U]):
     """Whether duplicates in list inputs should be reduced"""
     cls.duplicates_allowed = True
     cls.require_deduplication = True
     return cls
 
 
-def only_lang_codes(cls: type[U]):
+def only_lang_codes[U: AnyMetadata](cls: type[U]):
     """Whether list input should be checked to only accept ISO-639-1 codes"""
     cls.oz_only_iso636_3_allowed = True
     return cls
 
 
-def x_protected(cls: type[U]):
+def x_protected[U: AnyMetadata](cls: type[U]):
     """Whether metadata name should be checked for collision with reserved names
 
     when applying recommendations"""
     cls.oz_x_protected = True
     return cls
 
 
-def x_prefixed(cls: type[U]):
+def x_prefixed[U: AnyMetadata](cls: type[U]):
     """Whether metadata names should be automatically X-Prefixed"""
     cls.oz_x_protected = False
     cls.oz_x_prefixed = True

tests/conftest.py

@@ -2,6 +2,8 @@
 
 import pytest
 
+from zimscraperlib.download import stream_file
+
 
 def pytest_addoption(parser: pytest.Parser):
     parser.addoption(
@@ -162,7 +164,6 @@ def valid_user_agent():
 
 @pytest.fixture(scope="session")
 def small_zim_file(tmpdir_factory: pytest.TempdirFactory) -> pathlib.Path:
-    from zimscraperlib.download import stream_file
 
     dst = pathlib.Path(tmpdir_factory.mktemp("data") / "small.zim")
     stream_file(
@@ -174,7 +175,6 @@ def small_zim_file(tmpdir_factory: pytest.TempdirFactory) -> pathlib.Path:
 
 @pytest.fixture(scope="session")
 def ns_zim_file(tmpdir_factory: pytest.TempdirFactory) -> pathlib.Path:
-    from zimscraperlib.download import stream_file
 
     dst = pathlib.Path(tmpdir_factory.mktemp("data") / "ns.zim")
     stream_file(
@@ -187,7 +187,6 @@ def ns_zim_file(tmpdir_factory: pytest.TempdirFactory) -> pathlib.Path:
 
 @pytest.fixture(scope="session")
 def real_zim_file(tmpdir_factory: pytest.TempdirFactory) -> pathlib.Path:
-    from zimscraperlib.download import stream_file
 
     dst = pathlib.Path(tmpdir_factory.mktemp("data") / "small.zim")
     stream_file(

tests/download/test_download.py

@@ -8,7 +8,7 @@
 import pytest
 import requests
 import requests.structures
-from yt_dlp import DownloadError  # pyright: ignore[reportMissingTypeStubs]
+from yt_dlp.utils import DownloadError
 
 from zimscraperlib.constants import DEFAULT_WEB_REQUESTS_TIMEOUT
 from zimscraperlib.download import (

tests/image/test_illustration.py

@@ -40,7 +40,7 @@ def test_get_zim_illustration(
 
 
 def test_get_missing_user_zim_illustration():
-    with pytest.raises(Exception, match="missing.png could not be found"):
+    with pytest.raises(Exception, match=r"missing\.png could not be found"):
         get_zim_illustration("./missing.png")