Automatic fixes by ruff and black

benoit74 · benoit74 · commit 2a18db4b4475 · 2024-02-06T16:38:12.000+01:00
diff --git a/src/zimscraperlib/__about__.py b/src/zimscraperlib/__about__.py
@@ -1 +1 @@
-__version__ = "3.2.1-dev0"
+__version__ = "3.2.1-dev0"
diff --git a/src/zimscraperlib/__init__.py b/src/zimscraperlib/__init__.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 import logging as stdlogging
diff --git a/src/zimscraperlib/constants.py b/src/zimscraperlib/constants.py
@@ -1,10 +1,10 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 import base64
 import pathlib
 import re
+
 from zimscraperlib.__about__ import __version__
 
 ROOT_DIR = pathlib.Path(__file__).parent
diff --git a/src/zimscraperlib/download.py b/src/zimscraperlib/download.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 from __future__ import annotations
diff --git a/src/zimscraperlib/filesystem.py b/src/zimscraperlib/filesystem.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 """ Files manipulation tools
@@ -41,7 +40,7 @@ def get_content_mimetype(content: bytes) -> str:
 def delete_callback(
     fpath: Union[str, pathlib.Path],
     callback: Optional[Callable] = None,
-    *callback_args: Any
+    *callback_args: Any,
 ):
     """helper deleting passed filepath, optionnaly calling an additional callback"""
 
diff --git a/src/zimscraperlib/fix_ogvjs_dist.py b/src/zimscraperlib/fix_ogvjs_dist.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 
@@ -19,7 +18,7 @@ def fix_source_dir(source_vendors_path: Union[pathlib.Path, str]):
     root = pathlib.Path(source_vendors_path)
     logger.info("fixing videosjs-ogvjs.js")
     plugin_path = root.joinpath("videojs-ogvjs.js")
-    with open(plugin_path, "r") as fp:
+    with open(plugin_path) as fp:
         content = fp.read()
 
     content = content.replace(
diff --git a/src/zimscraperlib/html.py b/src/zimscraperlib/html.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 """ Tools to work with HTML contents """
@@ -27,7 +26,7 @@ def find_title_in(content: Union[str, BinaryIO, TextIO], mime_type: str) -> str:
 def find_title_in_file(fpath: pathlib.Path, mime_type: str) -> str:
     """Extracted title from an HTML file"""
     try:
-        with open(fpath, "r") as fh:
+        with open(fpath) as fh:
             return find_title_in(fh, mime_type)
     except Exception:
         return ""
@@ -60,7 +59,7 @@ def find_language_in(content: Union[str, BinaryIO, TextIO], mime_type: str) -> s
 def find_language_in_file(fpath: pathlib.Path, mime_type: str) -> str:
     """Extracted language from an HTML file"""
     try:
-        with open(fpath, "r") as fh:
+        with open(fpath) as fh:
             return find_language_in(fh, mime_type)
     except Exception:
         return ""
diff --git a/src/zimscraperlib/i18n.py b/src/zimscraperlib/i18n.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 import gettext
diff --git a/src/zimscraperlib/image/convertion.py b/src/zimscraperlib/image/convertion.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 import pathlib
diff --git a/src/zimscraperlib/image/optimization.py b/src/zimscraperlib/image/optimization.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 
@@ -154,12 +153,12 @@ def optimize_jpeg(
 
     if keep_exif and had_exif:
         piexif.transplant(
-            exif_src=str(src.resolve())
-            if isinstance(src, pathlib.Path)
-            else src.getvalue(),
-            image=str(dst.resolve())
-            if isinstance(dst, pathlib.Path)
-            else dst.getvalue(),
+            exif_src=(
+                str(src.resolve()) if isinstance(src, pathlib.Path) else src.getvalue()
+            ),
+            image=(
+                str(dst.resolve()) if isinstance(dst, pathlib.Path) else dst.getvalue()
+            ),
             new_file=dst,
         )
 
@@ -251,7 +250,7 @@ def optimize_gif(
         args += ["--interlace"]
     args += [str(src)]
     with open(dst, "w") as out_file:
-        gifsicle = subprocess.run(args, stdout=out_file)
+        gifsicle = subprocess.run(args, stdout=out_file, check=False)
 
     # remove dst if gifsicle failed and src is different from dst
     if gifsicle.returncode != 0 and src.resolve() != dst.resolve() and dst.exists():
diff --git a/src/zimscraperlib/image/presets.py b/src/zimscraperlib/image/presets.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 """ presets for ImageOptimizer in zimscraperlib.image.optimization module """
diff --git a/src/zimscraperlib/image/probing.py b/src/zimscraperlib/image/probing.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 import colorsys
@@ -24,7 +23,7 @@ def rgb_to_hex(r: int, g: int, b: int) -> str:
     def solarize(r: int, g: int, b: int) -> Tuple[int, int, int]:
         # calculate solarized color for main
         h, l, s = colorsys.rgb_to_hls(float(r) / 256, float(g) / 256, float(b) / 256)
-        r2, g2, b2 = [int(x * 256) for x in colorsys.hls_to_rgb(h, 0.95, s)]
+        r2, g2, b2 = (int(x * 256) for x in colorsys.hls_to_rgb(h, 0.95, s))
         return r2, g2, b2
 
     ct = colorthief.ColorThief(src)
diff --git a/src/zimscraperlib/image/transformation.py b/src/zimscraperlib/image/transformation.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 import io
diff --git a/src/zimscraperlib/image/utils.py b/src/zimscraperlib/image/utils.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 import pathlib
diff --git a/src/zimscraperlib/inputs.py b/src/zimscraperlib/inputs.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 import pathlib
@@ -43,7 +42,7 @@ def handle_user_provided_file(
     else:
         source = pathlib.Path(source).expanduser().resolve()
         if not source.exists():
-            raise IOError(f"{source} could not be found.")
+            raise OSError(f"{source} could not be found.")
         if nocopy:
             return source
 
diff --git a/src/zimscraperlib/logging.py b/src/zimscraperlib/logging.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 import io
@@ -76,5 +75,5 @@ def nicer_args_join(args: Iterable) -> str:
     """slightly better concateated list of subprocess args for display"""
     nargs = args[0:1]
     for arg in args[1:]:
-        nargs.append(arg if arg.startswith("-") else '"{}"'.format(arg))
+        nargs.append(arg if arg.startswith("-") else f'"{arg}"')
     return " ".join(nargs)
diff --git a/src/zimscraperlib/types.py b/src/zimscraperlib/types.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 """ File extensions to MIME-Type  mapping
diff --git a/src/zimscraperlib/video/config.py b/src/zimscraperlib/video/config.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 
diff --git a/src/zimscraperlib/video/encoding.py b/src/zimscraperlib/video/encoding.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 
@@ -34,14 +33,15 @@ def reencode(
             + [f"file:{tmp_path}"]
         )
         logger.debug(
-            f"Encode {src_path} -> {dst_path} " f"video format = {dst_path.suffix}"
+            f"Encode {src_path} -> {dst_path} video format = {dst_path.suffix}"
         )
         logger.debug(nicer_args_join(args))
         ffmpeg = subprocess.run(
             args,
             stderr=subprocess.STDOUT,
             stdout=subprocess.PIPE,
-            universal_newlines=True,
+            text=True,
+            check=False,
         )
         if not failsafe:
             ffmpeg.check_returncode()
diff --git a/src/zimscraperlib/video/presets.py b/src/zimscraperlib/video/presets.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 from .config import Config
diff --git a/src/zimscraperlib/video/probing.py b/src/zimscraperlib/video/probing.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 
@@ -30,7 +29,7 @@ def get_media_info(src_path):
         args,
         stdout=subprocess.PIPE,
         stderr=subprocess.PIPE,
-        universal_newlines=True,
+        text=True,
         check=False,
     )
     result = ffprobe.stdout.strip().split("\n")
diff --git a/src/zimscraperlib/zim/__init__.py b/src/zimscraperlib/zim/__init__.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 """ ZIM file creation tools
diff --git a/src/zimscraperlib/zim/archive.py b/src/zimscraperlib/zim/archive.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 """ ZIM Archive helper
diff --git a/src/zimscraperlib/zim/creator.py b/src/zimscraperlib/zim/creator.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 """ ZIM Creator helper
@@ -78,7 +77,6 @@ def mimetype_for(
 
 
 class Creator(libzim.writer.Creator):
-
     """libzim.writer.Creator subclass
 
     Note: due to the lack of a cancel() method in the libzim itself, it is not possible
diff --git a/src/zimscraperlib/zim/filesystem.py b/src/zimscraperlib/zim/filesystem.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 """ zimwriterfs-like tools to convert a build folder into a ZIM
@@ -99,7 +98,7 @@ def add_redirects_to_zim(
         zim_file.add_redirect(source_url, target_url, title)
 
     if redirects_file:
-        with open(redirects_file, "r") as fh:
+        with open(redirects_file) as fh:
             for line in fh.readlines():
                 namespace, path, title, target_url = re.match(
                     r"^(.)\t(.+)\t(.*)\t(.+)$", line
@@ -144,11 +143,11 @@ def make_zim_file(
 
     # sanity checks
     if not build_dir.exists() or not build_dir.is_dir():
-        raise IOError(f"Incorrect build_dir: {build_dir}")
+        raise OSError(f"Incorrect build_dir: {build_dir}")
 
     illustration_path = build_dir / illustration
     if not illustration_path.exists() or not illustration_path.is_file():
-        raise IOError(f"Incorrect illustration: {illustration} ({illustration_path})")
+        raise OSError(f"Incorrect illustration: {illustration} ({illustration_path})")
 
     with open(illustration_path, "rb") as fh:
         illustration_data = fh.read()
diff --git a/src/zimscraperlib/zim/items.py b/src/zimscraperlib/zim/items.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 
@@ -113,7 +112,7 @@ def __init__(self, url: str, **kwargs):
                 url, byte_stream=io.BytesIO(), only_first_block=True
             )
         except Exception as exc:
-            raise IOError(f"Unable to access URL at {url}: {exc}")
+            raise OSError(f"Unable to access URL at {url}: {exc}")
 
         # HTML content will be indexed.
         # we proxy the content in the Item to prevent double-download of the resource
diff --git a/src/zimscraperlib/zim/providers.py b/src/zimscraperlib/zim/providers.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 """ libzim Providers accepting a `ref` arg to keep it away from garbage collection
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 import pathlib
@@ -139,7 +138,7 @@ def small_zim_file(tmpdir_factory):
 
     dst = tmpdir_factory.mktemp("data").join("small.zim")
     stream_file(
-        "https://github.com/openzim/zim-testing-suite/raw/v0.3/data/nons/" "small.zim",
+        "https://github.com/openzim/zim-testing-suite/raw/v0.3/data/nons/small.zim",
         dst,
     )
     return dst
diff --git a/tests/download/test_download.py b/tests/download/test_download.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 import concurrent.futures
diff --git a/tests/filesystem/test_filesystem.py b/tests/filesystem/test_filesystem.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 import magic
diff --git a/tests/html/conftest.py b/tests/html/conftest.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 import pytest
diff --git a/tests/html/test_html.py b/tests/html/test_html.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 import pytest
diff --git a/tests/i18n/test_i18n.py b/tests/i18n/test_i18n.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 import locale
diff --git a/tests/image/test_image.py b/tests/image/test_image.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 import inspect
diff --git a/tests/inputs/test_inputs.py b/tests/inputs/test_inputs.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 import pathlib
diff --git a/tests/logging/conftest.py b/tests/logging/conftest.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 import io
diff --git a/tests/logging/test_logging.py b/tests/logging/test_logging.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # vim: ai ts=4 sts=4 et sw=4 nu
 
 import logging
@@ -19,7 +18,7 @@ def assert_message_console(logger, console, level, expected):
 def assert_message_file(logger, fpath, level, expected):
     msg = f"a {level} message"
     getattr(logger, level)(msg)
-    with open(fpath, "r") as file:
+    with open(fpath) as file:
         file.seek(0)
         if expected:
             assert msg in file.read()
diff --git a/tests/ogvjs/conftest.py b/tests/ogvjs/conftest.py
diff --git a/tests/ogvjs/test_ogvjs.py b/tests/ogvjs/test_ogvjs.py
diff --git a/tests/types/test_types.py b/tests/types/test_types.py
diff --git a/tests/video/conftest.py b/tests/video/conftest.py
diff --git a/tests/video/test_video.py b/tests/video/test_video.py
diff --git a/tests/zim/conftest.py b/tests/zim/conftest.py
diff --git a/tests/zim/test_archive.py b/tests/zim/test_archive.py
diff --git a/tests/zim/test_fs.py b/tests/zim/test_fs.py
diff --git a/tests/zim/test_libkiwix.py b/tests/zim/test_libkiwix.py
diff --git a/tests/zim/test_zim_creator.py b/tests/zim/test_zim_creator.py

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = "3.2.1-dev0"`
	`1`	`+__version__ = "3.2.1-dev0"`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`#!/usr/bin/env python`
`2`		`-# -- coding: utf-8 --`
`3`	`2`	`# vim: ai ts=4 sts=4 et sw=4 nu`
`4`	`3`
`5`	`4`	`import logging as stdlogging`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`#!/usr/bin/env python3`
`2`		`-# -- coding: utf-8 --`
`3`	`2`	`# vim: ai ts=4 sts=4 et sw=4 nu`
`4`	`3`
`5`	`4`	`from __future__ import annotations`