Migrate to python bootstrap conventions

src/zimscraperlib/download.py

@@ -42,7 +42,7 @@ def download(
         self,
         url: str,
         options: Optional[Dict],
-        wait: Optional[bool] = True,
+        wait: Optional[bool] = True,  # noqa: FBT002
     ) -> Union[bool, Future]:
         """Downloads video using initialized executor.
 
@@ -63,8 +63,8 @@ def download(
 
 
 class YoutubeConfig(dict):
-    options = {}
-    defaults = {
+    options = {}  # noqa: RUF012
+    defaults = {  # noqa: RUF012
         "writethumbnail": True,
         "write_all_thumbnails": True,
         "writesubtitles": True,
@@ -105,14 +105,14 @@ def get_options(
 
 
 class BestWebm(YoutubeConfig):
-    options = {
+    options = {  # noqa: RUF012
         "preferredcodec": "webm",
         "format": "best[ext=webm]/bestvideo[ext=webm]+bestaudio[ext=webm]/best",
     }
 
 
 class BestMp4(YoutubeConfig):
-    options = {
+    options = {  # noqa: RUF012
         "preferredcodec": "mp4",
         "format": "best[ext=mp4]/bestvideo[ext=mp4]+bestaudio[ext=m4a]/best",
     }
@@ -171,7 +171,7 @@ def stream_file(
     byte_stream: Optional[io.BytesIO] = None,
     block_size: Optional[int] = 1024,
     proxies: Optional[dict] = None,
-    only_first_block: Optional[bool] = False,
+    only_first_block: Optional[bool] = False,  # noqa: FBT002
     max_retries: Optional[int] = 5,
     headers: Optional[Dict[str, str]] = None,
     session: Optional[requests.Session] = None,

src/zimscraperlib/fix_ogvjs_dist.py

@@ -34,9 +34,9 @@ def fix_source_dir(source_vendors_path: Union[pathlib.Path, str]):
 
 
 def run():
-    if len(sys.argv) < 2:
-        print(f"Usage: {sys.argv[0]} <source_vendors_path>")
-        print(
+    if len(sys.argv) < 2:  # noqa: PLR2004
+        print(f"Usage: {sys.argv[0]} <source_vendors_path>")  # noqa: T201
+        print(  # noqa: T201
             "\t<source_vendors_path>\tpath to your folder containing "
             "ogvjs/videojs/videojs-ogvjs."
         )

src/zimscraperlib/i18n.py

@@ -13,7 +13,7 @@
 ISO_LEVELS = ["1", "2b", "2t", "3", "5"]
 
 
-class NotFound(ValueError):
+class NotFound(ValueError):  # noqa: N818
     pass
 
 
@@ -126,7 +126,9 @@ def update_with_macro(lang_data: Dict, macro_data: Dict):
     return lang_data
 
 
-def get_language_details(query: str, failsafe: Optional[bool] = False) -> Dict:
+def get_language_details(
+    query: str, failsafe: Optional[bool] = False  # noqa: FBT002
+) -> Dict:
     """language details dict from query.
 
     Raises NotFound or return `und` language details if failsafe
@@ -142,7 +144,7 @@ def get_language_details(query: str, failsafe: Optional[bool] = False) -> Dict:
 
     """
 
-    if query.isalpha() and (2 <= len(query) <= 3):
+    if query.isalpha() and (2 <= len(query) <= 3):  # noqa: PLR2004
         # possibility of iso-639 code
         adjusted_query = query
         native_query = query

src/zimscraperlib/image/convertion.py

@@ -30,7 +30,7 @@ def convert_image(
         fmt = format_for(dst)
     with PIL.Image.open(src) as image:
         if image.mode == "RGBA" and fmt in ALPHA_NOT_SUPPORTED or colorspace:
-            image = image.convert(colorspace or "RGB")
+            image = image.convert(colorspace or "RGB")  # noqa: PLW2901
         save_image(image, dst, fmt, **params)
 
 

src/zimscraperlib/image/optimization.py

@@ -53,12 +53,12 @@ def ensure_matches(
 def optimize_png(
     src: Union[pathlib.Path, io.BytesIO],
     dst: Optional[pathlib.Path] = None,
-    reduce_colors: Optional[bool] = False,
+    reduce_colors: Optional[bool] = False,  # noqa: FBT002
     max_colors: Optional[int] = 256,
-    fast_mode: Optional[bool] = True,
-    remove_transparency: Optional[bool] = False,
+    fast_mode: Optional[bool] = True,  # noqa: FBT002
+    remove_transparency: Optional[bool] = False,  # noqa: FBT002
     background_color: Optional[Tuple[int, int, int]] = (255, 255, 255),
-    **options,
+    **options,  # noqa: ARG001
 ) -> Union[pathlib.Path, io.BytesIO]:
     """method to optimize PNG files using a pure python external optimizer
 
@@ -101,9 +101,9 @@ def optimize_jpeg(
     src: Union[pathlib.Path, io.BytesIO],
     dst: Optional[pathlib.Path] = None,
     quality: Optional[int] = 85,
-    fast_mode: Optional[bool] = True,
-    keep_exif: Optional[bool] = True,
-    **options,
+    fast_mode: Optional[bool] = True,  # noqa: FBT002
+    keep_exif: Optional[bool] = True,  # noqa: FBT002
+    **options,  # noqa: ARG001
 ) -> Union[pathlib.Path, io.BytesIO]:
     """method to optimize JPEG files using a pure python external optimizer
     quality: JPEG quality (integer between 1 and 100)
@@ -130,7 +130,7 @@ def optimize_jpeg(
         had_exif = True
 
     # only use progressive if file size is bigger
-    use_progressive_jpg = orig_size > 10240  # 10KiB
+    use_progressive_jpg = orig_size > 10240  # 10KiB  # noqa: PLR2004
 
     if fast_mode:
         quality_setting = quality
@@ -168,10 +168,10 @@ def optimize_jpeg(
 def optimize_webp(
     src: Union[pathlib.Path, io.BytesIO],
     dst: Optional[pathlib.Path] = None,
-    lossless: Optional[bool] = False,
+    lossless: Optional[bool] = False,  # noqa: FBT002
     quality: Optional[int] = 60,
     method: Optional[int] = 6,
-    **options,
+    **options,  # noqa: ARG001
 ) -> Union[pathlib.Path, io.BytesIO]:
     """method to optimize WebP using Pillow options
     lossless: Whether to use lossless compression (boolean)
@@ -213,10 +213,10 @@ def optimize_gif(
     dst: pathlib.Path,
     optimize_level: Optional[int] = 1,
     lossiness: Optional[int] = None,
-    interlace: Optional[bool] = True,
-    no_extensions: Optional[bool] = True,
+    interlace: Optional[bool] = True,  # noqa: FBT002
+    no_extensions: Optional[bool] = True,  # noqa: FBT002
     max_colors: Optional[int] = None,
-    **options,
+    **options,  # noqa: ARG001
 ) -> pathlib.Path:
     """method to optimize GIFs using gifsicle >= 1.92
     optimize_level: Optimization level;
@@ -264,8 +264,8 @@ def optimize_gif(
 def optimize_image(
     src: pathlib.Path,
     dst: pathlib.Path,
-    delete_src: Optional[bool] = False,
-    convert: Optional[Union[bool, str]] = False,
+    delete_src: Optional[bool] = False,  # noqa: FBT002
+    convert: Optional[Union[bool, str]] = False,  # noqa: FBT002
     **options,
 ) -> bool:
     """Optimize image, automatically selecting correct optimizer

src/zimscraperlib/image/presets.py

@@ -18,7 +18,7 @@ class WebpLow:
     ext = "webp"
     mimetype = f"{preset_type}/webp"
 
-    options = {
+    options = {  # noqa: RUF012
         "lossless": False,
         "quality": 40,
         "method": 6,
@@ -37,7 +37,7 @@ class WebpMedium:
     ext = "webp"
     mimetype = f"{preset_type}/webp"
 
-    options = {
+    options = {  # noqa: RUF012
         "lossless": False,
         "quality": 50,
         "method": 6,
@@ -56,7 +56,7 @@ class WebpHigh:
     ext = "webp"
     mimetype = f"{preset_type}/webp"
 
-    options = {
+    options = {  # noqa: RUF012
         "lossless": False,
         "quality": 90,
         "method": 6,
@@ -77,7 +77,7 @@ class GifLow:
     ext = "gif"
     mimetype = f"{preset_type}/gif"
 
-    options = {
+    options = {  # noqa: RUF012
         "optimize_level": 3,
         "max_colors": 256,
         "lossiness": 80,
@@ -100,7 +100,7 @@ class GifMedium:
     ext = "gif"
     mimetype = f"{preset_type}/gif"
 
-    options = {
+    options = {  # noqa: RUF012
         "optimize_level": 3,
         "lossiness": 20,
         "no_extensions": True,
@@ -122,7 +122,7 @@ class GifHigh:
     ext = "gif"
     mimetype = f"{preset_type}/gif"
 
-    options = {
+    options = {  # noqa: RUF012
         "optimize_level": 2,
         "lossiness": None,
         "no_extensions": True,
@@ -141,7 +141,7 @@ class PngLow:
     ext = "png"
     mimetype = f"{preset_type}/png"
 
-    options = {
+    options = {  # noqa: RUF012
         "reduce_colors": True,
         "remove_transparency": False,
         "max_colors": 256,
@@ -160,7 +160,7 @@ class PngMedium:
     ext = "png"
     mimetype = f"{preset_type}/png"
 
-    options = {
+    options = {  # noqa: RUF012
         "reduce_colors": False,
         "remove_transparency": False,
         "fast_mode": False,
@@ -178,7 +178,7 @@ class PngHigh:
     ext = "png"
     mimetype = f"{preset_type}/png"
 
-    options = {
+    options = {  # noqa: RUF012
         "reduce_colors": False,
         "remove_transparency": False,
         "fast_mode": True,
@@ -197,7 +197,7 @@ class JpegLow:
     ext = "png"
     mimetype = f"{preset_type}/png"
 
-    options = {
+    options = {  # noqa: RUF012
         "quality": 45,
         "keep_exif": False,
         "fast_mode": True,
@@ -216,7 +216,7 @@ class JpegMedium:
     ext = "jpg"
     mimetype = f"{preset_type}/jpeg"
 
-    options = {
+    options = {  # noqa: RUF012
         "quality": 65,
         "keep_exif": False,
         "fast_mode": True,
@@ -235,7 +235,7 @@ class JpegHigh:
     ext = "jpg"
     mimetype = f"{preset_type}/jpeg"
 
-    options = {
+    options = {  # noqa: RUF012
         "quality": 80,
         "keep_exif": True,
         "fast_mode": True,

src/zimscraperlib/image/probing.py

@@ -12,7 +12,7 @@
 
 
 def get_colors(
-    src: pathlib.Path, use_palette: Optional[bool] = True
+    src: pathlib.Path, use_palette: Optional[bool] = True  # noqa: FBT002
 ) -> Tuple[str, str]:
     """(main, secondary) HTML color codes from an image path"""
 
@@ -22,7 +22,9 @@ 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)
+        h, l, s = colorsys.rgb_to_hls(  # noqa: E741
+            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))
         return r2, g2, b2
 
@@ -48,13 +50,16 @@ def is_hex_color(text: str) -> bool:
     return re.search(r"^#(?:[0-9a-fA-F]{3}){1,2}$", text)
 
 
-def format_for(src: Union[pathlib.Path, io.BytesIO], from_suffix: bool = True) -> str:
+def format_for(
+    src: Union[pathlib.Path, io.BytesIO],
+    from_suffix: bool = True,  # noqa: FBT001, FBT002
+) -> str:
     """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
 
-    from PIL.Image import EXTENSION as ext_fmt_map
+    from PIL.Image import EXTENSION as ext_fmt_map  # noqa: N811
     from PIL.Image import init as init_pil
 
     init_pil()

src/zimscraperlib/image/transformation.py

@@ -18,7 +18,7 @@ def resize_image(
     height: Optional[int] = None,
     dst: Optional[Union[pathlib.Path, io.BytesIO]] = None,
     method: Optional[str] = "width",
-    allow_upscaling: Optional[bool] = True,
+    allow_upscaling: Optional[bool] = True,  # noqa: FBT002
     **params: Optional[dict],
 ) -> None:
     """resize an image to requested dimensions
@@ -34,9 +34,13 @@ def resize_image(
         if allow_upscaling:
             height_width_ratio = float(image.size[1]) / float(image.size[0])
             if image.size[0] < width:
-                image = image.resize((width, int(width * height_width_ratio)))
+                image = image.resize(  # noqa: PLW2901
+                    (width, int(width * height_width_ratio))
+                )
             if height and image.size[1] < height:
-                image = image.resize((int(height / height_width_ratio), height))
+                image = image.resize(  # noqa: PLW2901
+                    (int(height / height_width_ratio), height)
+                )
 
         # resize using the requested method
         if method == "width":

src/zimscraperlib/inputs.py

@@ -20,7 +20,7 @@ def handle_user_provided_file(
     source: Optional[Union[pathlib.Path, str]] = None,
     dest: Optional[pathlib.Path] = None,
     in_dir: Optional[pathlib.Path] = None,
-    nocopy: bool = False,
+    nocopy: bool = False,  # noqa: FBT001, FBT002
 ) -> Union[pathlib.Path, None]:
     """path to downloaded or copied a user provided file (URL or path)
 

src/zimscraperlib/logging.py

@@ -14,17 +14,17 @@
 VERBOSE_DEPENDENCIES = ["urllib3", "PIL", "boto3", "botocore", "s3transfer"]
 
 
-def getLogger(
+def getLogger(  # noqa: N802
     name: str,
     level: Optional[int] = logging.INFO,
     console: Optional[io.TextIOBase] = sys.stdout,
     log_format: Optional[str] = DEFAULT_FORMAT,
-    file: Optional[pathlib.Path] = False,
+    file: Optional[pathlib.Path] = False,  # noqa: FBT002
     file_level: Optional[int] = None,
     file_format: Optional[str] = None,
     file_max: Optional[int] = 2**20,
     file_nb_backup: Optional[int] = 1,
-    deps_level: Optional[int] = logging.WARNING,
+    deps_level: Optional[int] = logging.WARNING,  # noqa: ARG001
     additional_deps: Optional[Iterable] = None,
 ):
     """configured logger for most usages