chore: introduce ruff to replace flake8 (#53)

Flake8 was recently removed, this MR introduces ruff to perform the same
checks.

Author: david-pershouse

.github/workflows/checks.yml

@@ -58,6 +58,9 @@ jobs:
       - name: Run pylint
         run: poetry run task pylint
 
+      - name: Run ruff
+        run: poetry run task ruff
+
       - name: Run pytest
         run: poetry run task test
         env:

lib/binarylane/types.py

@@ -1,4 +1,5 @@
 """ Contains some shared types for properties """
+
 from __future__ import annotations
 
 from http import HTTPStatus

poetry.lock

@@ -25,7 +25,8 @@ types-python-dateutil = "^2.8.19"
 pytest = "^7.2.0"
 absolufy-imports = "^0.3.1"
 binarylane-python-client = "^0.13.2a0"
-safety = "*"
+safety = "<3.0.0"
+ruff = "^0.9.6"
 
 [tool.poetry.group.pylint.dependencies]
 pylint = { version = "^3.3.4", python = ">=3.9" }
@@ -38,10 +39,11 @@ generate = "python scripts/generate.py"
 black = "black ."
 isort = "isort ."
 mypy = "mypy ."
+ruff = "ruff check src"
 pylint = "pylint src"
 safety = "poetry export -f requirements.txt | safety check --bare --stdin"
 test = "pytest tests"
-check = "task isort && task black && task mypy && task pylint && task test && task safety"
+check = "task isort && task black && task mypy && task ruff && task pylint && task test && task safety"
 
 [tool.isort]
 py_version = 37
@@ -58,6 +60,17 @@ add_imports=["from __future__ import annotations"]
 line-length = 120
 target_version = ["py37"]
 
+[tool.ruff]
+# Always generate Python 3.8-compatible code.
+target-version = "py38"
+line-length = 120
+exclude = [
+    "api",  # generated command classes
+]
+
+[tool.ruff.lint]
+select = ["E4", "E7", "E9", "F", "TC"]
+
 [tool.pylint.format]
 max-line-length = 120
 ignore-paths = ['src/binarylane/console/commands/*/']

pyproject.toml

@@ -1,4 +1,5 @@
 """Generate updated API bindings and CLI commands from OpenAPI specification document"""
+
 from __future__ import annotations
 
 import re

scripts/generate.py

@@ -22,16 +22,13 @@ class OptionAttributes(ABC):
     UNCONFIGURED_TOKEN: ClassVar[str] = "unconfigured"
 
     @abstractmethod
-    def get_option(self, name: OptionName) -> Optional[str]:
-        ...
+    def get_option(self, name: OptionName) -> Optional[str]: ...
 
     @abstractmethod
-    def required_option(self, name: OptionName) -> str:
-        ...
+    def required_option(self, name: OptionName) -> str: ...
 
     @abstractmethod
-    def add_option(self, name: OptionName, value: str) -> None:
-        ...
+    def add_option(self, name: OptionName, value: str) -> None: ...
 
     @staticmethod
     def to_bool(name: str) -> bool:

src/binarylane/config/options.py

@@ -10,8 +10,7 @@
 
 
 class Source(Protocol):
-    def get(self, name: str) -> Optional[str]:
-        ...
+    def get(self, name: str) -> Optional[str]: ...
 
 
 T = TypeVar("T", bound=Source)

src/binarylane/config/repository.py

@@ -1,12 +1,14 @@
 from __future__ import annotations
 
-import argparse
 import configparser
 import os
 import sys
 from abc import ABC
 from pathlib import Path
-from typing import ClassVar, Dict, Optional
+from typing import TYPE_CHECKING, ClassVar, Dict, Optional
+
+if TYPE_CHECKING:
+    import argparse
 
 
 class _SourceBase(ABC):

src/binarylane/config/sources.py

@@ -1,4 +1,5 @@
 """ Contains methods for accessing the API """
+
 from __future__ import annotations
 
 import re

src/binarylane/console/commands/api/__init__.py

@@ -1,13 +1,14 @@
 from __future__ import annotations
 
-import argparse
 import logging
 from abc import ABC, abstractmethod
 from typing import TYPE_CHECKING, ClassVar, List, Optional
 
 logger = logging.getLogger(__name__)
 
 if TYPE_CHECKING:
+    import argparse
+
     from binarylane.console.parser.object_attribute import ObjectAttribute
     from binarylane.console.parser.parser import Parser
 
@@ -62,12 +63,10 @@ def group_name(self) -> Optional[str]:
         return self.parent.group_name if self.parent else None
 
     @abstractmethod
-    def configure(self, parser: Parser) -> None:
-        ...
+    def configure(self, parser: Parser) -> None: ...
 
     @abstractmethod
-    def construct(self, parser: Parser, parsed: argparse.Namespace) -> object:
-        ...
+    def construct(self, parser: Parser, parsed: argparse.Namespace) -> object: ...
 
     def _unsupported(self, message: str, error: bool = True) -> None:
         """Report that command parsing is not likely to work correctly"""