chore(lint): enable flake8-logging-format ruff rules

- G004: Logging statement uses f-string
- G010: Logging statement uses `warn` instead of `warning`

https://beta.ruff.rs/docs/rules/#flake8-logging-format-g

Author: László Vaskó

pyproject.toml

@@ -69,6 +69,7 @@ select = [
   "E",      # pycodestyle (errors)
   "F",      # pyflakes
   "FBT",    # flake8-boolean-trap
+  "G",      # flake8-logging-format
   "I",      # isort
   "ISC",    # flake8-implicit-str-concats
   "N",      # pep8-naming

unblob/extractor.py

@@ -53,7 +53,7 @@ def fix_symlink(path: Path, outdir: Path, task_result: TaskResult) -> Path:
     value).
     """
     if is_recursive_link(path):
-        logger.error(f"Symlink loop identified, removing {path}.")
+        logger.error("Symlink loop identified, removing", path=path)
         error_report = MaliciousSymlinkRemoved(
             link=path.as_posix(), target=os.readlink(path)
         )
@@ -71,7 +71,7 @@ def fix_symlink(path: Path, outdir: Path, task_result: TaskResult) -> Path:
     safe = is_safe_path(outdir, target)
 
     if not safe:
-        logger.error(f"Path traversal attempt through symlink, removing {target}.")
+        logger.error("Path traversal attempt through symlink, removing", target=target)
         error_report = MaliciousSymlinkRemoved(
             link=path.as_posix(), target=target.as_posix()
         )

unblob/handlers/archive/_safe_tarfile.py

@@ -19,13 +19,13 @@ def extract(
         member_name_path = Path(str(member.name))
 
         if not RUNNING_AS_ROOT and (member.ischr() or member.isblk()):
-            logger.warn(
+            logger.warning(
                 "missing elevated permissions, skipping block and character device creation",
                 path=member_name_path,
             )
             return
         if not is_safe_path(path_as_path, member_name_path):
-            logger.warn("traversal attempt", path=member_name_path)
+            logger.warning("traversal attempt", path=member_name_path)
             return
 
         super().extract(member, path, set_attrs, numeric_owner=numeric_owner)

unblob/handlers/archive/xiaomi/hdr.py

@@ -98,7 +98,7 @@ def extract(self, inpath: Path, outdir: Path):
         with File.from_path(inpath) as file:
             for output_path, chunk in self.parse(file):
                 if not is_safe_path(outdir, output_path):
-                    logger.warn(
+                    logger.warning(
                         "Path traversal attempt, discarding.", output_path=output_path
                     )
                     return

unblob/handlers/filesystem/romfs.py

@@ -251,7 +251,7 @@ def create_symlink(self, extract_root: Path, output_path: Path, inode: FileHeade
             target_path = extract_root.joinpath(target).resolve()
 
         if not is_safe_path(extract_root, target_path):
-            logger.warn(
+            logger.warning(
                 "Path traversal attempt through symlink.", target_path=target_path
             )
             return
@@ -268,24 +268,26 @@ def create_hardlink(self, extract_root: Path, link_path: Path, inode: FileHeader
             try:
                 os.link(target_path, link_path)
             except FileNotFoundError:
-                logger.warn(
+                logger.warning(
                     "Hard link target does not exist, discarding.",
                     target_path=target_path,
                     link_path=link_path,
                 )
             except PermissionError:
-                logger.warn(
+                logger.warning(
                     "Not enough privileges to create hardlink to block/char device, discarding.",
                     target_path=target_path,
                     link_path=link_path,
                 )
         else:
-            logger.warn("Invalid hard link target", inode_key=inode.spec_info)
+            logger.warning("Invalid hard link target", inode_key=inode.spec_info)
 
     def create_inode(self, extract_root: Path, inode: FileHeader):
         output_path = extract_root.joinpath(inode.path).resolve()
         if not is_safe_path(extract_root, inode.path):
-            logger.warn("Path traversal attempt, discarding.", output_path=output_path)
+            logger.warning(
+                "Path traversal attempt, discarding.", output_path=output_path
+            )
             return
         logger.info("dumping inode", inode=inode, output_path=str(output_path))
 
@@ -314,7 +316,7 @@ def dump_fs(self):
             self.create_inode(self.extract_root, inode)
 
         if os.geteuid() != 0:
-            logger.warn(
+            logger.warning(
                 "root privileges are required to create block and char devices, skipping."
             )
         else:

unblob/models.py

@@ -192,7 +192,7 @@ def default(self, obj):
             except UnicodeDecodeError:
                 return str(obj)
 
-        logger.error(f"JSONEncoder met a non-JSON encodable value: {obj}")
+        logger.error("JSONEncoder met a non-JSON encodable value", obj=obj)
         # the usual fail path of custom JSONEncoders is to call the parent and let it fail
         #     return json.JSONEncoder.default(self, obj)
         # instead of failing, just return something usable

unblob/processing.py

@@ -243,7 +243,7 @@ def _process_task(self, result: TaskResult, task: Task):
             return
 
         if not valid_path(task.path):
-            log.warn("Path contains invalid characters, it won't be processed")
+            log.warning("Path contains invalid characters, it won't be processed")
             return
 
         stat_report = StatReport.from_path(task.path)