Add all needed pyright:ignore statements - to be removed in the future, one by one

Author: benoit74

Diff for: src/zimscraperlib/download.py

@@ -52,14 +52,16 @@ def download(
 
         Returns download result of future (wait=False)"""
 
-        future = self.executor.submit(self._run_youtube_dl, url, options)
+        future = self.executor.submit(
+            self._run_youtube_dl, url, options  # pyright: ignore
+        )
         if not wait:
             return future
         if not future.exception():
             # return the result
-            return future.result()
+            return future.result()  # pyright: ignore
         # raise the exception
-        raise future.exception()
+        raise future.exception()  # pyright: ignore
 
 
 class YoutubeConfig(dict):
@@ -137,8 +139,10 @@ def save_large_file(url: str, fpath: pathlib.Path) -> None:
     )
 
 
-def _get_retry_adapter(max_retries: Optional[int] = 5) -> requests.adapters.BaseAdapter:
-    retries = requests.packages.urllib3.util.retry.Retry(
+def _get_retry_adapter(
+    max_retries: Optional[int] = 5,
+) -> requests.adapters.BaseAdapter:  # pyright: ignore
+    retries = requests.packages.urllib3.util.retry.Retry(  # pyright: ignore
         total=max_retries,  # total number of retries
         connect=max_retries,  # connection errors
         read=max_retries,  # read errors
@@ -155,7 +159,7 @@ def _get_retry_adapter(max_retries: Optional[int] = 5) -> requests.adapters.Base
         ],  # force retry on the following codes
     )
 
-    return requests.adapters.HTTPAdapter(max_retries=retries)
+    return requests.adapters.HTTPAdapter(max_retries=retries)  # pyright: ignore
 
 
 def get_session(max_retries: Optional[int] = 5) -> requests.Session:
@@ -175,7 +179,7 @@ def stream_file(
     max_retries: Optional[int] = 5,
     headers: Optional[Dict[str, str]] = None,
     session: Optional[requests.Session] = None,
-) -> tuple[int, requests.structures.CaseInsensitiveDict]:
+) -> tuple[int, requests.structures.CaseInsensitiveDict]:  # pyright: ignore
     """Stream data from a URL to either a BytesIO object or a file
     Arguments -
         fpath - Path of the file where data is sent
@@ -211,7 +215,7 @@ def stream_file(
 
     for data in resp.iter_content(block_size):
         total_downloaded += len(data)
-        fp.write(data)
+        fp.write(data)  # pyright: ignore
 
         # stop downloading/reading if we're just testing first block
         if only_first_block:
@@ -220,7 +224,7 @@ def stream_file(
     logger.debug(f"Downloaded {total_downloaded} bytes from {url}")
 
     if fpath:
-        fp.close()
+        fp.close()  # pyright: ignore
     else:
-        fp.seek(0)
+        fp.seek(0)  # pyright: ignore
     return total_downloaded, resp.headers

Diff for: src/zimscraperlib/html.py

@@ -18,7 +18,7 @@ def find_title_in(content: Union[str, BinaryIO, TextIO], mime_type: str) -> str:
     if mime_type != ARTICLE_MIME:
         return ""
     try:
-        return BeautifulSoup(content, "lxml").find("title").text
+        return BeautifulSoup(content, "lxml").find("title").text  # pyright: ignore
     except Exception:
         return ""
 
@@ -44,15 +44,15 @@ def find_language_in(content: Union[str, BinaryIO, TextIO], mime_type: str) -> s
         for key in keylist:
             node = soup.find(nodename)
             if node:
-                if not node.has_attr(key):
+                if not node.has_attr(key):  # pyright: ignore
                     continue
                 if (
                     nodename == "meta"
-                    and not node.attrs.get("http-equiv", "").lower()
+                    and not node.attrs.get("http-equiv", "").lower()  # pyright: ignore
                     == "content-language"
                 ):
                     continue
-                return node.attrs[key]
+                return node.attrs[key]  # pyright: ignore
     return ""
 
 

Diff for: src/zimscraperlib/i18n.py

@@ -102,15 +102,19 @@ def find_language_names(
         lang_data = get_language_details(query, failsafe=True) or {}
     try:
         query_locale = babel.Locale.parse(query)
-        return query_locale.get_display_name(), query_locale.get_display_name("en")
+        return query_locale.get_display_name(), query_locale.get_display_name(
+            "en"
+        )  # pyright: ignore
     except (babel.UnknownLocaleError, TypeError, ValueError, AttributeError):
         pass
 
     # ISO code lookup order matters (most qualified first)!
     for iso_level in [f"iso-639-{lang_}" for lang_ in reversed(ISO_LEVELS)]:
         try:
             query_locale = babel.Locale.parse(lang_data.get(iso_level))
-            return query_locale.get_display_name(), query_locale.get_display_name("en")
+            return query_locale.get_display_name(), query_locale.get_display_name(
+                "en"
+            )  # pyright: ignore
         except (babel.UnknownLocaleError, TypeError, ValueError, AttributeError):
             pass
     default = lang_data.get("english", query)
@@ -166,10 +170,10 @@ def get_language_details(
         lang_data, macro_data = get_iso_lang_data(adjusted_query)
     except NotFound as exc:
         if failsafe:
-            return None
+            return None  # pyright: ignore
         raise exc
 
-    iso_data = update_with_macro(lang_data, macro_data)
+    iso_data = update_with_macro(lang_data, macro_data)  # pyright: ignore
     native_name, english_name = find_language_names(native_query, iso_data)
     iso_data.update(
         {

Diff for: src/zimscraperlib/image/convertion.py

@@ -25,10 +25,12 @@ def convert_image(
      to RGB. ex: RGB, ARGB, CMYK (and other PIL colorspaces)"""
 
     colorspace = params.get("colorspace")  # requested colorspace
-    fmt = params.pop("fmt").upper() if "fmt" in params else None  # requested format
+    fmt = (
+        params.pop("fmt").upper() if "fmt" in params else None  # pyright: ignore
+    )  # requested format
     if not fmt:
         fmt = format_for(dst)
-    with PIL.Image.open(src) as image:
+    with PIL.Image.open(src) as image:  # pyright: ignore
         if image.mode == "RGBA" and fmt in ALPHA_NOT_SUPPORTED or colorspace:
             image = image.convert(colorspace or "RGB")  # noqa: PLW2901
         save_image(image, dst, fmt, **params)
@@ -39,13 +41,13 @@ def create_favicon(src: pathlib.Path, dst: pathlib.Path) -> None:
     if dst.suffix != ".ico":
         raise ValueError("favicon extension must be ICO")
 
-    img = PIL.Image.open(src)
+    img = PIL.Image.open(src)  # pyright: ignore
     w, h = img.size
     # resize image to square first
     if w != h:
         size = min([w, h])
         resized = dst.parent.joinpath(f"{src.stem}.tmp.{src.suffix}")
         resize_image(src, size, size, resized, "contain")
-        img = PIL.Image.open(resized)
+        img = PIL.Image.open(resized)  # pyright: ignore
     # now convert to ICO
     save_image(img, dst, "ICO")

Diff for: src/zimscraperlib/image/optimization.py

@@ -76,25 +76,25 @@ def optimize_png(
         if remove_transparency is True (tuple containing RGB values)
             values: (255, 255, 255) | (221, 121, 108) | (XX, YY, ZZ)"""
 
-    ensure_matches(src, "PNG")
+    ensure_matches(src, "PNG")  # pyright: ignore
 
     img = Image.open(src)
 
     if remove_transparency:
-        img = remove_alpha(img, background_color)
+        img = remove_alpha(img, background_color)  # pyright: ignore
 
     if reduce_colors:
-        img, _, _ = do_reduce_colors(img, max_colors)
+        img, _, _ = do_reduce_colors(img, max_colors)  # pyright: ignore
 
     if not fast_mode and img.mode == "P":
         img, _ = rebuild_palette(img)
 
     if dst is None:
-        dst = io.BytesIO()
-    img.save(dst, optimize=True, format="PNG")
+        dst = io.BytesIO()  # pyright: ignore
+    img.save(dst, optimize=True, format="PNG")  # pyright: ignore
     if isinstance(dst, io.BytesIO):
         dst.seek(0)
-    return dst
+    return dst  # pyright: ignore
 
 
 def optimize_jpeg(
@@ -114,7 +114,7 @@ def optimize_jpeg(
                get dynamic quality value to ensure better compression
         values: True | False"""
 
-    ensure_matches(src, "JPEG")
+    ensure_matches(src, "JPEG")  # pyright: ignore
 
     img = Image.open(src)
     orig_size = (
@@ -138,10 +138,10 @@ def optimize_jpeg(
         quality_setting, _ = jpeg_dynamic_quality(img)
 
     if dst is None:
-        dst = io.BytesIO()
+        dst = io.BytesIO()  # pyright: ignore
 
     img.save(
-        dst,
+        dst,  # pyright: ignore
         quality=quality_setting,
         optimize=True,
         progressive=use_progressive_jpg,
@@ -157,12 +157,14 @@ def optimize_jpeg(
                 str(src.resolve()) if isinstance(src, pathlib.Path) else src.getvalue()
             ),
             image=(
-                str(dst.resolve()) if isinstance(dst, pathlib.Path) else dst.getvalue()
+                str(dst.resolve())
+                if isinstance(dst, pathlib.Path)
+                else dst.getvalue()  # pyright: ignore
             ),
             new_file=dst,
         )
 
-    return dst
+    return dst  # pyright: ignore
 
 
 def optimize_webp(
@@ -186,7 +188,7 @@ def optimize_webp(
     refer to the link for more details
     https://pillow.readthedocs.io/en/stable/handbook/image-file-formats.html#webp"""
 
-    ensure_matches(src, "WEBP")
+    ensure_matches(src, "WEBP")  # pyright: ignore
     params = {
         "lossless": lossless,
         "quality": quality,
@@ -195,17 +197,17 @@ def optimize_webp(
 
     webp_image = Image.open(src)
     if dst is None:
-        dst = io.BytesIO()
-        webp_image.save(dst, format="WEBP", **params)
-        dst.seek(0)
+        dst = io.BytesIO()  # pyright: ignore
+        webp_image.save(dst, format="WEBP", **params)  # pyright: ignore
+        dst.seek(0)  # pyright: ignore
     else:
         try:
-            save_image(webp_image, dst, fmt="WEBP", **params)
+            save_image(webp_image, dst, fmt="WEBP", **params)  # pyright: ignore
         except Exception as exc:
-            if src.resolve() != dst.resolve() and dst.exists():
+            if src.resolve() != dst.resolve() and dst.exists():  # pyright: ignore
                 dst.unlink()  # pragma: nocover
             raise exc
-    return dst
+    return dst  # pyright: ignore
 
 
 def optimize_gif(
@@ -267,7 +269,7 @@ def optimize_image(
     delete_src: Optional[bool] = False,  # noqa: FBT002
     convert: Optional[Union[bool, str]] = False,  # noqa: FBT002
     **options,
-) -> bool:
+) -> bool:  # pyright: ignore
     """Optimize image, automatically selecting correct optimizer
 
     delete_src: whether to remove src file upon success (boolean)
@@ -281,12 +283,12 @@ def optimize_image(
     # if requested, convert src to requested format into dst path
     if convert and src_format != dst_format:
         src_format = dst_format = convert if isinstance(convert, str) else dst_format
-        convert_image(src, dst, fmt=src_format)
+        convert_image(src, dst, fmt=src_format)  # pyright: ignore
         src_img = pathlib.Path(dst)
     else:
         src_img = pathlib.Path(src)
 
-    {
+    {  # pyright: ignore
         "JPEG": optimize_jpeg,
         "PNG": optimize_png,
         "GIF": optimize_gif,

Diff for: src/zimscraperlib/image/probing.py

@@ -47,7 +47,7 @@ def solarize(r: int, g: int, b: int) -> Tuple[int, int, int]:
 
 def is_hex_color(text: str) -> bool:
     """whether supplied text is a valid hex-formated color code"""
-    return re.search(r"^#(?:[0-9a-fA-F]{3}){1,2}$", text)
+    return re.search(r"^#(?:[0-9a-fA-F]{3}){1,2}$", text)  # pyright: ignore
 
 
 def format_for(
@@ -57,13 +57,15 @@ def format_for(
     """Pillow format of a given filename, either Pillow-detected or from suffix"""
     if not from_suffix:
         with PIL.Image.open(src) as img:
-            return img.format
+            return img.format  # pyright: ignore
 
     from PIL.Image import EXTENSION as ext_fmt_map  # noqa: N811
     from PIL.Image import init as init_pil
 
     init_pil()
-    return ext_fmt_map[src.suffix]  # might raise KeyError on unknown extension
+    return ext_fmt_map[
+        src.suffix  # pyright: ignore
+    ]  # might raise KeyError on unknown extension
 
 
 def is_valid_image(

Diff for: src/zimscraperlib/image/transformation.py

@@ -25,7 +25,7 @@ def resize_image(
 
     methods: width, height, cover, thumbnail
     allow upscaling: upscale image first, preserving aspect ratio if required"""
-    with PIL.Image.open(src) as image:
+    with PIL.Image.open(src) as image:  # pyright: ignore
         # preserve image format as resize() does not transmit it into new object
         image_format = image.format
         image_mode = image.mode
@@ -58,4 +58,9 @@ def resize_image(
     if dst is None and isinstance(src, io.BytesIO):
         src.seek(0)
 
-    save_image(resized, dst if dst is not None else src, image_format, **params)
+    save_image(
+        resized,
+        dst if dst is not None else src,  # pyright: ignore
+        image_format,
+        **params,
+    )

Diff for: src/zimscraperlib/image/utils.py

@@ -8,9 +8,12 @@
 
 
 def save_image(
-    src: Image, dst: pathlib.Path, fmt: Optional[str] = None, **params: Optional[dict]
+    src: Image,  # pyright: ignore
+    dst: pathlib.Path,
+    fmt: Optional[str] = None,
+    **params: Optional[dict],
 ) -> None:
     """PIL.Image.save() wrapper setting default parameters"""
-    args = {"JPEG": {"quality": 100}, "PNG": {}}.get(fmt, {})
+    args = {"JPEG": {"quality": 100}, "PNG": {}}.get(fmt, {})  # pyright: ignore
     args.update(params or {})
-    src.save(dst, fmt, **args)
+    src.save(dst, fmt, **args)  # pyright: ignore