chore: enable more linting rules

Author: mtth

pyproject.toml

@@ -94,8 +94,33 @@ log_level = "DEBUG"
 line-length = 79
 
 [tool.ruff.lint]
-select = ["D", "E", "F", "I", "N", "PL", "RUF", "SIM"]
-ignore = ["D102", "D103", "D105", "D107", "D415", "PLR2004"]
+select = [
+  "A",
+  "ANN",
+  "ARG",
+  "D",
+  "E",
+  "ERA",
+  "F",
+  "I",
+  "INP",
+  "LOG",
+  "N",
+  "PL",
+  "RUF",
+  "SIM",
+  "SLF",
+  "T20",
+  "TD",
+  "UP",
+  "W"
+]
+ignore = [
+  "ANN003", "ANN401",
+  "D102", "D103", "D105", "D107", "D415",
+  "PLR2004",
+  "TD002", "TD003",
+]
 
 [tool.ruff.lint.isort]
 force-sort-within-sections = true
@@ -105,4 +130,4 @@ lines-after-imports = 2
 convention = "google"
 
 [tool.ruff.lint.per-file-ignores]
-"tests/**" = ["D"]
+"tests/**" = ["ANN", "D", "SLF"]

src/git_draft/__main__.py

@@ -2,12 +2,12 @@
 
 from __future__ import annotations
 
+from collections.abc import Sequence
 import importlib.metadata
 import logging
 import optparse
 from pathlib import Path, PurePosixPath
 import sys
-from typing import Sequence
 
 from .bots import load_bot
 from .common import PROGRAM, Config, UnreachableError, ensure_state_home
@@ -41,7 +41,12 @@ def new_parser() -> optparse.OptionParser:
     )
 
     def add_command(name: str, short: str | None = None, **kwargs) -> None:
-        def callback(_option, _opt, _value, parser) -> None:
+        def callback(
+            _option: object,
+            _opt: object,
+            _value: object,
+            parser: optparse.OptionParser,
+        ) -> None:
             parser.values.command = name
 
         parser.add_option(
@@ -128,20 +133,20 @@ class ToolPrinter(ToolVisitor):
     def on_list_files(
         self, _paths: Sequence[PurePosixPath], _reason: str | None
     ) -> None:
-        print("Listing available files...")
+        pass
 
     def on_read_file(
         self, path: PurePosixPath, _contents: str | None, _reason: str | None
     ) -> None:
-        print(f"Reading {path!r}...")
+        pass
 
     def on_write_file(
         self, path: PurePosixPath, _contents: str, _reason: str | None
     ) -> None:
-        print(f"Updated {path!r}.")
+        pass
 
     def on_delete_file(self, path: PurePosixPath, _reason: str | None) -> None:
-        print(f"Deleted {path!r}.")
+        pass
 
 
 def edit(*, path: Path | None = None, text: str | None = None) -> str:
@@ -153,26 +158,23 @@ def edit(*, path: Path | None = None, text: str | None = None) -> str:
     # https://unix.stackexchange.com/q/604260
     elif path is None:
         assert text, "Empty path and text"
-        print(text)
         sys.exit(198)
     else:
         if text is not None:
             with open(path, "w") as f:
                 f.write(text)
-        print(path)
         sys.exit(199)
 
 
 _PROMPT_PLACEHOLDER = "Enter your prompt here..."
 
 
-def main() -> None:  # noqa: PLR0912 PLR0915
+def main() -> None:  # noqa: PLR0912
     config = Config.load()
     (opts, args) = new_parser().parse_args()
 
     log_path = ensure_state_home() / "log"
     if opts.log:
-        print(log_path)
         return
     logging.basicConfig(level=config.log_level, filename=str(log_path))
 
@@ -210,19 +212,16 @@ def main() -> None:  # noqa: PLR0912 PLR0915
             reset=config.auto_reset if opts.reset is None else opts.reset,
             sync=opts.sync,
         )
-        print(f"Refined {name}.")
     elif command == "finalize":
         name = drafter.exit_draft(
             revert=opts.revert, clean=opts.clean, delete=opts.delete
         )
-        verb = "Reverted" if opts.revert else "Finalized"
-        print(f"{verb} {name}.")
     elif command == "show-drafts":
         table = drafter.history_table(args[0] if args else None)
         if table:
-            print(table.to_json() if opts.json else table)
+            pass
     elif command == "show-prompts":
-        raise NotImplementedError()  # TODO
+        raise NotImplementedError()  # TODO: Implement
     elif command == "show-templates":
         if args:
             name = args[0]
@@ -232,21 +231,17 @@ def main() -> None:  # noqa: PLR0912 PLR0915
                     edit(path=tpl.local_path(), text=tpl.source)
                 else:
                     edit(path=Template.local_path_for(name))
-            else:
-                if not tpl:
-                    raise ValueError(f"No template named {name!r}")
-                print(tpl.source)
+            elif not tpl:
+                raise ValueError(f"No template named {name!r}")
         else:
             table = templates_table()
-            print(table.to_json() if opts.json else table)
     else:
         raise UnreachableError()
 
 
 if __name__ == "__main__":
     try:
         main()
-    except Exception as err:
+    except Exception:
         _logger.exception("Program failed.")
-        print(f"Error: {err}", file=sys.stderr)
         sys.exit(1)

src/git_draft/bots/common.py

@@ -29,10 +29,10 @@ class Action:
     request_count: int | None = None
     token_count: int | None = None
 
-    def increment_request_count(self, n=1, init=False) -> None:
+    def increment_request_count(self, n: int = 1, init: bool = False) -> None:
         self._increment("request_count", n, init)
 
-    def increment_token_count(self, n, init=False) -> None:
+    def increment_token_count(self, n: int, init: bool = False) -> None:
         self._increment("token_count", n, init)
 
     def _increment(self, attr: str, count: int, init: bool) -> None:
@@ -48,7 +48,7 @@ class Bot:
     """Code assistant bot"""
 
     @classmethod
-    def state_folder_path(cls, ensure_exists=False) -> Path:
+    def state_folder_path(cls, ensure_exists: bool = False) -> Path:
         """Returns a path unique to this bot class
 
         The path can be used to store data specific to this bot implementation.

src/git_draft/bots/openai.py

@@ -12,11 +12,12 @@
 * https://github.com/openai/openai-python/blob/main/src/openai/resources/beta/threads/runs/runs.py
 """
 
+from collections.abc import Mapping, Sequence
 import json
 import logging
 import os
 from pathlib import PurePosixPath
-from typing import Any, Mapping, Self, Sequence, TypedDict, override
+from typing import Any, Self, TypedDict, override
 
 import openai
 
@@ -61,7 +62,7 @@ def _param(
         name: str,
         description: str,
         inputs: Mapping[str, Any] | None = None,
-        required_inputs: Sequence[str] | None = None,
+        _required_inputs: Sequence[str] | None = None,
     ) -> openai.types.beta.FunctionToolParam:
         param: openai.types.beta.FunctionToolParam = {
             "type": "function",
@@ -225,10 +226,10 @@ def _on_read_file(self, path: PurePosixPath, contents: str | None) -> str:
             return f"`{path}` does not exist."
         return f"The contents of `{path}` are:\n\n```\n{contents}\n```\n"
 
-    def _on_write_file(self, path: PurePosixPath) -> None:
+    def _on_write_file(self, _path: PurePosixPath) -> None:
         return None
 
-    def _on_delete_file(self, path: PurePosixPath) -> None:
+    def _on_delete_file(self, _path: PurePosixPath) -> None:
         return None
 
     def _on_list_files(self, paths: Sequence[PurePosixPath]) -> str:
@@ -316,7 +317,7 @@ def on_run_step_done(
         else:
             _logger.warning("Missing usage in threads run step")
 
-    def _handle_action(self, run_id: str, data: Any) -> None:
+    def _handle_action(self, _run_id: str, data: Any) -> None:
         tool_outputs = list[Any]()
         for tool in data.required_action.submit_tool_outputs.tool_calls:
             handler = _ThreadToolHandler(self._toolbox, tool.id)
@@ -347,15 +348,15 @@ def _wrap(self, output: str) -> _ToolOutput:
         return _ToolOutput(tool_call_id=self._call_id, output=output)
 
     def _on_read_file(
-        self, path: PurePosixPath, contents: str | None
+        self, _path: PurePosixPath, contents: str | None
     ) -> _ToolOutput:
         return self._wrap(contents or "")
 
-    def _on_write_file(self, path: PurePosixPath) -> _ToolOutput:
+    def _on_write_file(self, _path: PurePosixPath) -> _ToolOutput:
         return self._wrap("OK")
 
-    def _on_delete_file(self, path: PurePosixPath) -> _ToolOutput:
+    def _on_delete_file(self, _path: PurePosixPath) -> _ToolOutput:
         return self._wrap("OK")
 
     def _on_list_files(self, paths: Sequence[PurePosixPath]) -> _ToolOutput:
-        return self._wrap("\n".join((str(p) for p in paths)))
+        return self._wrap("\n".join(str(p) for p in paths))

src/git_draft/common.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from collections.abc import Mapping, Sequence
 import dataclasses
 import itertools
 import logging
@@ -11,7 +12,7 @@
 import string
 import textwrap
 import tomllib
-from typing import Any, ClassVar, Mapping, Self, Sequence, Type
+from typing import Any, ClassVar, Self
 
 import prettytable
 import xdg_base_dirs
@@ -84,7 +85,7 @@ class UnreachableError(RuntimeError):
     """Indicates unreachable code was unexpectedly executed"""
 
 
-def reindent(s: str, width=0) -> str:
+def reindent(s: str, width: int = 0) -> str:
     """Reindents text by dedenting and optionally wrapping paragraphs"""
     paragraphs = (
         " ".join(textwrap.dedent("\n".join(g)).splitlines())
@@ -96,7 +97,7 @@ def reindent(s: str, width=0) -> str:
     )
 
 
-def qualified_class_name(cls: Type) -> str:
+def qualified_class_name(cls: type) -> str:
     name = cls.__qualname__
     return f"{cls.__module__}.{name}" if cls.__module__ else name
 

src/git_draft/drafter.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from collections.abc import Callable, Sequence
 import dataclasses
 from datetime import datetime
 import json
@@ -10,9 +11,9 @@
 import os.path as osp
 from pathlib import PurePosixPath
 import re
+from re import Match
 import textwrap
 import time
-from typing import Callable, Match, Sequence
 
 import git
 
@@ -53,7 +54,7 @@ def active(cls, repo: git.Repo, name: str | None = None) -> _Branch | None:
         return _Branch(match[1])
 
     @staticmethod
-    def new_suffix():
+    def new_suffix() -> str:
         return random_id(9)
 
 
@@ -85,7 +86,7 @@ def generate_draft(  # noqa: PLR0913
         timeout: float | None = None,
     ) -> str:
         if timeout is not None:
-            raise NotImplementedError()  # TODO
+            raise NotImplementedError()  # TODO: Implement
 
         if self._repo.is_dirty(working_tree=False):
             if not reset:
@@ -174,7 +175,9 @@ def generate_draft(  # noqa: PLR0913
         _logger.info("Completed generation for %s.", branch)
         return str(branch)
 
-    def exit_draft(self, *, revert: bool, clean=False, delete=False) -> str:
+    def exit_draft(
+        self, *, revert: bool, clean: bool = False, delete: bool = False
+    ) -> str:
         branch = _Branch.active(self._repo)
         if not branch:
             raise RuntimeError("Not currently on a draft branch")
@@ -312,7 +315,7 @@ def _untracked(self) -> frozenset[str]:
         text = self._repo.git.ls_files(exclude_standard=True, others=True)
         return frozenset(text.splitlines())
 
-    def _delta(self, spec) -> _Delta:
+    def _delta(self, spec: str) -> _Delta:
         changed = list[str]()
         deleted = list[str]()
         for line in self._repo.git.diff(spec, name_status=True).splitlines():

src/git_draft/editor.py

@@ -22,11 +22,16 @@ def _guess_editor_binpath() -> str:
     return ""
 
 
-def _get_tty_filename():
+def _get_tty_filename() -> str:
     return "CON:" if sys.platform == "win32" else "/dev/tty"
 
 
-def open_editor(text="", path: Path | None = None, *, _open_tty=open) -> str:
+def open_editor(
+    text: str = "",
+    path: Path | None = None,
+    *,
+    _open_tty=open,  # noqa
+) -> str:
     """Open an editor to edit a file and return its contents
 
     The method returns once the editor is closed. It respects the `$EDITOR`
@@ -46,7 +51,7 @@ def edit(path: str) -> str:
         proc = subprocess.Popen([binpath, path], close_fds=True, stdout=stdout)
         proc.communicate()
 
-        with open(path, mode="r") as reader:
+        with open(path) as reader:
             return reader.read()
 
     if path: