refactor: improve codebase using ruff (#305)

Author: bryanforbes

pep517backend/backend.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from typing import Any
+from typing import TYPE_CHECKING
 
 import itertools
 import logging
@@ -10,6 +11,9 @@
 
 import setuptools.build_meta as _orig
 
+if TYPE_CHECKING:
+    from _typeshed import StrPath
+
 logging.basicConfig(level="INFO", format="%(levelname)s: %(message)s")
 log = logging.getLogger()
 
@@ -93,12 +97,14 @@ def _install_stubs(stub_config: list[LibVersion]) -> None:
         new_stub_path.write_text(f"from ._{lib} import *")
 
 
-def get_requires_for_build_editable(config_settings: Any | None = None) -> list[str]:
+def get_requires_for_build_editable(
+    config_settings: _orig._ConfigSettings | None = None,
+) -> list[str]:
     return _orig.get_requires_for_build_editable(config_settings)
 
 
 def prepare_metadata_for_build_editable(
-    metadata_directory: Any, config_settings: Any | None = None
+    metadata_directory: StrPath, config_settings: _orig._ConfigSettings | None = None
 ) -> str:
     return _orig.prepare_metadata_for_build_editable(
         metadata_directory, config_settings
@@ -113,19 +119,19 @@ def build_editable(
     return _orig.build_editable(wheel_directory, config_settings, metadata_directory)
 
 
-def get_requires_for_build_sdist(*args: Any, **kwargs: Any) -> str:
+def get_requires_for_build_sdist(*args: Any, **kwargs: Any) -> str:  # noqa: ANN401
     return _orig.get_requires_for_build_sdist(*args, **kwargs)
 
 
-def build_sdist(*args: Any, **kwargs: Any) -> str:
+def build_sdist(*args: Any, **kwargs: Any) -> str:  # noqa: ANN401
     return _orig.build_sdist(*args, **kwargs)
 
 
-def get_requires_for_build_wheel(*args: Any, **kwargs: Any) -> str:
+def get_requires_for_build_wheel(*args: Any, **kwargs: Any) -> str:  # noqa: ANN401
     return _orig.get_requires_for_build_wheel(*args, **kwargs)
 
 
-def prepare_metadata_for_build_wheel(*args: Any, **kwargs: Any) -> str:
+def prepare_metadata_for_build_wheel(*args: Any, **kwargs: Any) -> str:  # noqa: ANN401
     return _orig.prepare_metadata_for_build_wheel(*args, **kwargs)
 
 
@@ -141,10 +147,8 @@ def build_wheel(
     _check_config(stub_config)
     _install_stubs(stub_config)
 
-    basename = _orig.build_wheel(
+    return _orig.build_wheel(
         wheel_directory,
         config_settings=config_settings,
         metadata_directory=metadata_directory,
     )
-
-    return basename

pyproject.toml

@@ -61,10 +61,27 @@ exclude = [
 
 [tool.ruff.lint]
 select = [
-    "PYI",   # flake8-pyi
-    "UP",
-    "I001",  # isort
-    "F401",  # unused imports
+    "ANN",  # flake8-annotations
+	"B",    # flake8-bugbear
+	"C4",   # flake8-comprehensions
+	"E",    # pycodestyle errors
+	"EXE",  # flake8-executable
+	"F",    # pyflakes
+    "I",    # isort
+	"INP",  # flake8-no-pep420
+	"ISC",  # flake8-implicit-str-concat
+	"PIE",  # flake8-pie
+	"PTH",  # flake8-use-pathlib
+    "PYI",  # flake8-pyi
+	"Q",    # flake8-quotes
+	"RET",  # flake8-return
+	"RSE",  # flake8-raise
+	"SIM",  # flake8-simplify
+    "T10",  # flake8-debugger
+    "TC",   # flake8-type-checking
+    "UP",   # pyupgrade
+	"W",    # pycodestyle warnings
+    "RUF",  # ruff-specific rules
 ]
 ignore = [
   "PYI001",  # Name of private `TypeVar` must start with `_`
@@ -78,13 +95,15 @@ ignore = [
 ]
 
 [tool.ruff.lint.per-file-ignores]
-"src/pygobject_stub_generator/**/*.py" = ["PYI"]
+"src/gi-stubs/*.pyi" = ["ANN", "E501", "E701", "E741", "F403", "F405", "F811", "F821", "I002", "PTH", "TC", "T10", "RUF002"]
+"src/pygobject_stub_generator/*.py" = ["PYI"]
 
 [tool.ruff.lint.isort]
 case-sensitive = false
 order-by-type = false
 force-single-line = true
 section-order = ["future", "typing", "standard-library", "third-party", "first-party", "local-folder"]
+required-imports = ["from __future__ import annotations"]
 
 [tool.ruff.lint.isort.sections]
 typing = ["_typeshed", "typing", "typing_extensions"]

src/pygobject_stub_generator/class_info.py

@@ -51,7 +51,7 @@ def _find_attributes(obj: type[Any]) -> list[str]:
             if "__info__" in base.__dict__:
                 obj_attrs.update(base.__dict__.keys())
 
-    return sorted(list(obj_attrs))
+    return sorted(obj_attrs)
 
 
 @dataclass(slots=True)
@@ -144,17 +144,26 @@ def __get_bases_and_gi_info(
         object_info: GI.RegisteredTypeInfo | None = self.cls.__dict__.get("__info__")
         bases = list(get_original_bases(self.cls))
 
-        # Because we're generating types for gi.repository, we have to generate stubs for
-        # override classes that come from gi.repository and inherit from gi.repository classes.
-        # Effectively, we want to write the stubs as if the override class and repository class
-        # are one class in the MRO. What this means is that the following transformations need to
-        # happen:
+        # Because we're generating types for gi.repository, we have to generate stubs
+        # for override classes that come from gi.repository and inherit from
+        # gi.repository classes. Effectively, we want to write the stubs as if the
+        # override class and repository class are one class in the MRO. What this means
+        # is that the following transformations need to happen:
         # 1. For the following:
         #    gi.repository.X.One(<One repository bases>)
-        #    gi.overrides.X.One(<One prefix override bases>, gi.repository.X.One, <One suffix override bases>) ->
-        #        gi.repository.X.One(<One prefix override bases>, <One repository bases>, <One override bases>)
+        #    gi.overrides.X.One(
+        #        <One prefix override bases>,
+        #        gi.repository.X.One,
+        #        <One suffix override bases>
+        #    ) -> gi.repository.X.One(
+        #        <One prefix override bases>,
+        #        <One repository bases>,
+        #        <One override bases>
+        #    )
         # 2. gi.overrides.X.Two(float) -> gi.repository.X.Two(float)
-        # 3. gi.overrides.X.Three(gi.overrides.X.Four, ...) -> gi.repository.X.Three(gi.repository.X.Four, ...)
+        # 3. gi.overrides.X.Three(gi.overrides.X.Four, ...) -> gi.repository.X.Three(
+        #        gi.repository.X.Four, ...
+        #    )
         if full_module_name.startswith("gi.overrides.") and any(
             base.__module__.startswith("gi.repository.") for base in bases
         ):
@@ -290,8 +299,7 @@ def __build_docstring(self) -> str | None:
         ).strip()
 
         if docs:
-            docs = '"""\n' + docs.strip() + '\n"""'
-            return docs
+            return '"""\n' + docs.strip() + '\n"""'
 
         return None
 
@@ -324,7 +332,9 @@ def __build_props_class(self) -> str | None:
             parent := self.gi_info.get_parent()
         ):
             parent_name = f"{parent.get_name()}"
-            parents_string = f"({self.stub.get_namespace_member(parent.get_namespace(), parent_name)}.Props)"
+            parents_string = f"({
+                self.stub.get_namespace_member(parent.get_namespace(), parent_name)
+            }.Props)"
 
         return f"""@{self.stub.get_import("typing", "type_check_only")}
 class Props{parents_string}:
@@ -353,7 +363,7 @@ def __build_props(self) -> str | None:
     def __build_fields(self) -> str:
         lines: list[str] = []
 
-        for field in self.fields:
+        for field in self.fields:  # noqa: F402
             name = f"{field.get_name()}"
 
             if override := self.stub.check_override(self.full_name, name):

src/pygobject_stub_generator/main.py

@@ -84,7 +84,9 @@ def main() -> None:
     parser.add_argument(
         "--init",
         type=str,
-        help='Initialization code that must be evaluated first e.g. \'gi.require_version("Gst", "1.0"); from gi.repository import Gst; Gst.init(None)\'',
+        help="Initialization code that must be evaluated first e.g. "
+        '\'gi.require_version("Gst", "1.0"); from gi.repository import Gst; '
+        "Gst.init(None)'",
     )
     parser.add_argument(
         "--format",

src/pygobject_stub_generator/parse.py

@@ -64,7 +64,9 @@ def _search_overridden_symbols(input: str) -> list[str]:
                 ) / INDENTATION_SPACES
                 if indentation_level != int(indentation_level):
                     raise ParseError(
-                        f"Wrong indentation at line: {i}, {indentation_level} != {int(indentation_level)}"
+                        f"Wrong indentation at line: {i}, {indentation_level} != {
+                            int(indentation_level)
+                        }"
                     )
                 indentation_level = int(indentation_level)
 
@@ -75,12 +77,10 @@ def _search_overridden_symbols(input: str) -> list[str]:
                     else:
                         if index != CONSTANT_INDEX:
                             raise ParseError(f"Wrong indentation at line: {i}")
-                        else:
-                            # Regex for constant trigger also on functions arguments
-                            print(
-                                f"Wrong indentation for constant at line {i}, skipping"
-                            )
-                            continue
+
+                        # Regex for constant trigger also on functions arguments
+                        print(f"Wrong indentation for constant at line {i}, skipping")
+                        continue
                 elif indentation_level < last_indentation_level:
                     while indentation_level < last_indentation_level:
                         parents.pop()
@@ -93,7 +93,8 @@ def _search_overridden_symbols(input: str) -> list[str]:
                     symbols.append(".".join(full_list))
 
                 break
-            elif res:
+
+            if res:
                 raise ParseError(f"Unable to parse line {i}: '{line}'")
 
         class_res = re.match(CLASS_PATTERN, line)
@@ -166,15 +167,16 @@ def _generate_result_node(
             return
 
     if isinstance(node, ast.Assign):
-        if typevars is not None:
-            if isinstance(node.value, ast.Call) and isinstance(
-                node.value.func, ast.Name
-            ):
-                if node.value.func.id == "TypeVar":
-                    typevars.append(TypeVarInfo.from_call(node.value))
-
-                if node.value.func.id == "TypeVarTuple":
-                    typevars.append(TypeVarTupleInfo.from_call(node.value))
+        if (
+            typevars is not None
+            and isinstance(node.value, ast.Call)
+            and isinstance(node.value.func, ast.Name)
+        ):
+            if node.value.func.id == "TypeVar":
+                typevars.append(TypeVarInfo.from_call(node.value))
+
+            if node.value.func.id == "TypeVarTuple":
+                typevars.append(TypeVarTupleInfo.from_call(node.value))
 
         if not hasattr(node.targets[0], "id"):
             print(f"Skipping {'.'.join(parents)} {node} no id attribute")