Merge pull request #50 from pharmaverse/ruff-check

Add ruff linter rules and fix linting issues

Author: nanxstats

pyproject.toml

@@ -69,3 +69,19 @@ dev = [
 minversion = "6.0"
 testpaths = ["tests"]
 addopts = "-v --cov=pkglite --cov-report html"
+
+[tool.ruff.lint]
+select = [
+    # pycodestyle
+    "E",
+    # Pyflakes
+    "F",
+    # pyupgrade
+    "UP",
+    # flake8-bugbear
+    "B",
+    # flake8-simplify
+    "SIM",
+    # isort
+    "I",
+]

src/pkglite/__init__.py

@@ -2,3 +2,11 @@
 from .pack import pack
 from .unpack import unpack
 from .use import use_pkglite
+
+__all__ = [
+    "classify_file",
+    "is_text_file",
+    "pack",
+    "unpack",
+    "use_pkglite",
+]

src/pkglite/classify.py

@@ -1,5 +1,4 @@
 import os
-from typing import FrozenSet
 
 
 def is_text_file(path: str, n: int | None = None) -> bool:
@@ -16,8 +15,8 @@ def is_text_file(path: str, n: int | None = None) -> bool:
     Returns:
         True if the file is text, False if binary.
     """
-    ALLOW: FrozenSet[int] = frozenset([9, 10, 13] + list(range(32, 256)))
-    BLOCK: FrozenSet[int] = frozenset(list(range(0, 7)) + list(range(14, 32)))
+    ALLOW: frozenset[int] = frozenset([9, 10, 13] + list(range(32, 256)))
+    BLOCK: frozenset[int] = frozenset(list(range(0, 7)) + list(range(14, 32)))
 
     with open(path, "rb") as file:
         bytecode = bytes(file.read(n or os.path.getsize(path)))

src/pkglite/main.py

@@ -13,7 +13,8 @@
 @app.callback()
 def callback():
     """
-    pkglite - Plain text representations for packages written in any programming language
+    pkglite - Plain text representations for packages written in any
+    programming language.
     """
 
 

src/pkglite/pack.py

@@ -35,7 +35,7 @@ def load_ignore_matcher(directory: str) -> PathMatcher:
     if not os.path.exists(ignore_path):
         return lambda path: False
 
-    with open(ignore_path, "r", encoding="utf-8") as f:
+    with open(ignore_path, encoding="utf-8") as f:
         patterns = f.readlines()
 
     spec = PathSpec.from_lines("gitwildmatch", patterns)
@@ -102,7 +102,7 @@ def read_text_content(file_path: str) -> str:
     Returns:
         Formatted text content.
     """
-    with open(file_path, "r", encoding="utf-8") as f:
+    with open(file_path, encoding="utf-8") as f:
         return "".join("  " + line for line in f)
 
 
@@ -212,29 +212,31 @@ def pack(
             package_name = get_package_name(directory)
 
             all_files = [
-                (os.path.join(root, file), root, file)
+                os.path.join(root, file)
                 for root, _, files in os.walk(directory)
                 for file in files
                 if not ignore_matcher(os.path.join(root, file))
             ]
 
             if not quiet:
                 print_action("Packing", package_name)
-                for file_path, root, file in all_files:
+                for file_path in all_files:
                     rel_path = os.path.relpath(file_path, directory)
                     print_sub_action("Reading", rel_path, path_type="source")
                     if content := process_single_file(
                         file_path, directory, package_name, ignore_matcher
                     ):
                         out.write(content)
             else:
-                for file_path, _, _ in all_files:
+                for file_path in all_files:
                     if content := process_single_file(
                         file_path, directory, package_name, ignore_matcher
                     ):
                         out.write(content)
 
     if not quiet:
         print_success(
-            f"Packed {format_count(len(abs_dirs))} packages into {format_path(abs_output, path_type='target')}"
+            "Packed "
+            f"{format_count(len(abs_dirs))} packages into "
+            f"{format_path(abs_output, path_type='target')}"
         )

src/pkglite/unpack.py

@@ -149,15 +149,16 @@ def finalize_current_entry(
     content_lines: list[str] = []
     state = ParserState.EXPECTING_PACKAGE
 
-    with open(input_file, "r", encoding="utf-8") as f:
+    with open(input_file, encoding="utf-8") as f:
         for line in f:
             line = line.rstrip()
 
             if state == ParserState.EXPECTING_PACKAGE:
                 # Handle transition from current package to new package
-                if current_file:
-                    if file_data := finalize_current_entry(current_file, content_lines):
-                        files.append(file_data)
+                if current_file and (
+                    file_data := finalize_current_entry(current_file, content_lines)
+                ):
+                    files.append(file_data)
 
                 new_state, new_file = handle_package_state(line)
                 if new_file:
@@ -217,8 +218,10 @@ def write_binary_file(file_path: Path, content: str) -> None:
         binary_content = binascii.unhexlify(content)
         file_path.parent.mkdir(parents=True, exist_ok=True)
         file_path.write_bytes(binary_content)
-    except binascii.Error:
-        raise ValueError(f"Invalid hexadecimal content for binary file: {file_path}")
+    except binascii.Error as err:
+        raise ValueError(
+            f"Invalid hexadecimal content for binary file: {file_path}"
+        ) from err
 
 
 def write_file(file_data: FileData, output_directory: Path) -> None:
@@ -274,6 +277,8 @@ def unpack(
 
     if not quiet:
         print_success(
-            f"Unpacked {format_count(len(packages))} packages from "
-            f"{format_path(str(input_path), path_type='source')} into {format_path(str(output_path), path_type='target')}"
+            "Unpacked "
+            f"{format_count(len(packages))} packages from "
+            f"{format_path(str(input_path), path_type='source')} into "
+            f"{format_path(str(output_path), path_type='target')}"
         )

src/pkglite/use.py

@@ -3,7 +3,6 @@
 import shutil
 from collections.abc import Sequence
 from pathlib import Path
-from typing import Tuple
 
 import pkglite.templates
 
@@ -12,7 +11,7 @@
 
 def process_directory(
     template: Path, directory: str | Path, force: bool, quiet: bool
-) -> Tuple[str, bool]:
+) -> tuple[str, bool]:
     """
     Process a single directory and create/overwrite `.pkgliteignore` file.
 
@@ -23,15 +22,18 @@ def process_directory(
         quiet: If True, suppress output messages.
 
     Returns:
-        A tuple containing the path to the `.pkgliteignore` file and whether it was created/overwritten.
+        A tuple containing the `.pkgliteignore` path and whether it was
+        created or overwritten.
     """
     dir_path = Path(os.path.abspath(os.path.expanduser(str(directory))))
     ignore_path = str(dir_path / ".pkgliteignore")
 
     if os.path.exists(ignore_path) and not force:
         if not quiet:
             print_warning(
-                f"Skipping: {format_path('.pkgliteignore', path_type='target')} already exists in {format_path(str(dir_path), path_type='target')}"
+                "Skipping: "
+                f"{format_path('.pkgliteignore', path_type='target')} already exists "
+                f"in {format_path(str(dir_path), path_type='target')}"
             )
         return ignore_path, False
 
@@ -41,7 +43,9 @@ def process_directory(
     if not quiet:
         action = "Overwrote" if os.path.exists(ignore_path) and force else "Created"
         print_success(
-            f"{action} {format_path('.pkgliteignore', path_type='target')} in {format_path(str(dir_path), path_type='target')}"
+            f"{action} "
+            f"{format_path('.pkgliteignore', path_type='target')} in "
+            f"{format_path(str(dir_path), path_type='target')}"
         )
     return ignore_path, True