Update to ruff (instead of pylint (and isort))

.github/utils/run_hooks.py

@@ -59,5 +59,5 @@ def main(hook: str, options: list[str]) -> None:
             hook=sys.argv[1],
             options=sys.argv[2:] if len(sys.argv) > 2 else [],
         )
-    except Exception as exc:  # pylint: disable=broad-except
+    except Exception as exc:
         sys.exit(str(exc))

.github/workflows/_local_ci_tests.yml

@@ -15,13 +15,9 @@ jobs:
       # general
       install_extras: "[dev,docs,testing]"
 
-      # pre-commit
-      skip_pre-commit_hooks: pylint,pylint-tests
-
-      # pylint
-      pylint_runs: |
-        --rcfile=pyproject.toml ci_cd
-        --rcfile=pyproject.toml --disable=import-outside-toplevel,redefined-outer-name tests
+      # pylint & safety
+      run_pylint: false
+      run_safety: true
 
       # build dist
       build_libs: flit

.github/workflows/_local_ci_update_dependencies.yml

@@ -20,6 +20,5 @@ jobs:
       extra_to_dos: "- [ ] Make sure the PR is **squash** merged, with a sensible commit message."
       update_pre-commit: true
       install_extras: "[dev]"
-      skip_pre-commit_hooks: "pylint,pylint-tests"
     secrets:
       PAT: ${{ secrets.RELEASE_PAT }}

.pre-commit-config.yaml

@@ -19,27 +19,16 @@ repos:
     - id: trailing-whitespace
       args: [--markdown-linebreak-ext=md]
 
-  # isort is a tool to sort and group import statements in Python files
-  # It works on files in-place
-  - repo: https://github.com/timothycrosley/isort
-    rev: 5.12.0
-    hooks:
-    - id: isort
-      args:
-      - "--profile=black"
-      - "--filter-files"
-      - "--skip-gitignore"
-      - "--add-import=from __future__ import annotations"
-
-  # pyupgrade is a tool to automatically upgrade Python syntax for newer versions
+  # pyupgrade is a tool for automatically upgrading Python syntax for newer versions of
+  # the language
   # It works on files in-place
   - repo: https://github.com/asottile/pyupgrade
     # Latest version for Python 3.7: 3.3.2
     # Latest version for Python 3.8: 3.8.0
     rev: v3.15.0
     hooks:
     - id: pyupgrade
-      args: ["--py37-plus"]
+      args: [--py37-plus]
 
   # Black is a code style and formatter
   # It works on files in-place
@@ -48,6 +37,22 @@ repos:
     hooks:
     - id: black
 
+  # ruff is a Python linter, incl. import sorter and formatter
+  # It works partly on files in-place
+  # More information can be found in its documentation:
+  # https://docs.astral.sh/ruff/
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.7
+    hooks:
+    - id: ruff
+      # Fix what can be fixed in-place and exit with non-zero status if files were
+      # changed and/or there are rules violations.
+      args:
+      - "--fix"
+      - "--exit-non-zero-on-fix"
+      - "--show-fixes"
+      - "--no-unsafe-fixes"
+
   # Bandit is a security linter
   # More information can be found in its documentation:
   # https://bandit.readthedocs.io/en/latest/
@@ -74,34 +79,3 @@ repos:
     - id: docs-api-reference
       args:
       - "--package-dir=ci_cd"
-
-  - repo: local
-    hooks:
-    # pylint is a Python linter
-    # It is run through the local environment to ensure external packages can be
-    # imported without issue.
-    # For more information about pylint see its documentation at:
-    # https://pylint.pycqa.org/en/latest/
-    - id: pylint
-      name: pylint
-      entry: pylint
-      args: ["--rcfile=pyproject.toml"]
-      language: python
-      types: [python]
-      require_serial: true
-      exclude: ^tests/.*$
-    # pylint is a Python linter
-    # It is run through the local environment to ensure external packages can be
-    # imported without issue.
-    # For more information about pylint see its documentation at:
-    # https://pylint.pycqa.org/en/latest/
-    - id: pylint-tests
-      name: pylint - tests
-      entry: pylint
-      args:
-      - "--rcfile=pyproject.toml"
-      - "--disable=import-outside-toplevel,redefined-outer-name"
-      language: python
-      types: [python]
-      require_serial: true
-      files: ^tests/.*$

ci_cd/tasks/api_reference_docs.py

@@ -5,7 +5,6 @@
 """
 from __future__ import annotations
 
-# pylint: disable=duplicate-code
 import logging
 import os
 import re
@@ -97,7 +96,7 @@
         "special_option",
     ],
 )
-def create_api_reference_docs(  # pylint: disable=too-many-locals,too-many-branches,too-many-statements,line-too-long
+def create_api_reference_docs(
     context,
     package_dir,
     pre_clean=False,
@@ -312,7 +311,11 @@ def write_file(full_path: Path, content: str) -> None:
                     f"{py_path_root}/{filename.stem}"
                     if str(relpath) == "."
                     or (str(relpath) == package.name and not single_package)
-                    else f"{py_path_root}/{relpath if single_package else relpath.relative_to(package.name)}/{filename.stem}"
+                    else (
+                        f"{py_path_root}/"
+                        f"{relpath if single_package else relpath.relative_to(package.name)}/"  # noqa: E501
+                        f"{filename.stem}"
+                    )
                 )
 
                 # Replace OS specific path separators with forward slashes before

ci_cd/tasks/docs_index.py

@@ -40,7 +40,7 @@
     },
     iterable=["replacement"],
 )
-def create_docs_index(  # pylint: disable=too-many-locals
+def create_docs_index(
     context,
     pre_commit=False,
     root_repo_path=".",

ci_cd/tasks/setver.py

@@ -50,7 +50,7 @@
     },
     iterable=["code_base_update"],
 )
-def setver(  # pylint: disable=too-many-locals
+def setver(
     _,
     package_dir,
     version,
@@ -66,7 +66,7 @@ def setver(  # pylint: disable=too-many-locals
         version: str = version  # type: ignore[no-redef]
         root_repo_path: str = root_repo_path  # type: ignore[no-redef]
         code_base_update: list[str] = code_base_update  # type: ignore[no-redef]
-        code_base_update_separator: str = code_base_update_separator  # type: ignore[no-redef]  # pylint: disable=line-too-long
+        code_base_update_separator: str = code_base_update_separator  # type: ignore[no-redef]
         test: bool = test  # type: ignore[no-redef]
         fail_fast: bool = fail_fast  # type: ignore[no-redef]
 
@@ -120,9 +120,7 @@ def setver(  # pylint: disable=too-many-locals
                 )
 
             filepath = Path(
-                filepath.format(
-                    **{"package_dir": package_dir, "version": semantic_version}
-                )
+                filepath.format(package_dir=package_dir, version=semantic_version)
             ).resolve()
             if not filepath.exists():
                 error_msg = (
@@ -143,9 +141,7 @@ def setver(  # pylint: disable=too-many-locals
                 filepath,
                 pattern,
                 replacement,
-                replacement.format(
-                    **{"package_dir": package_dir, "version": semantic_version}
-                ),
+                replacement.format(package_dir=package_dir, version=semantic_version),
             )
             if test:
                 print(
@@ -154,7 +150,7 @@ def setver(  # pylint: disable=too-many-locals
                 )
                 print(
                     "replacement (handled): "
-                    f"{replacement.format(**{'package_dir': package_dir, 'version': semantic_version})}"  # pylint: disable=line-too-long
+                    f"{replacement.format(package_dir=package_dir, version=semantic_version)}"  # noqa: E501
                 )
 
             try:
@@ -163,7 +159,7 @@ def setver(  # pylint: disable=too-many-locals
                     (
                         pattern,
                         replacement.format(
-                            **{"package_dir": package_dir, "version": semantic_version}
+                            package_dir=package_dir, version=semantic_version
                         ),
                     ),
                 )
@@ -176,7 +172,7 @@ def setver(  # pylint: disable=too-many-locals
                     f"{Emoji.CROSS_MARK.value} Error: Could not update file {filepath}"
                     f" according to the given input:\n\n  pattern: {pattern}\n  "
                     "replacement: "
-                    f"{replacement.format(**{'package_dir': package_dir, 'version': semantic_version})}"  # pylint: disable=line-too-long
+                    f"{replacement.format(package_dir=package_dir, version=semantic_version)}"  # noqa: E501
                 )
 
     print(

ci_cd/tasks/update_deps.py

@@ -2,7 +2,6 @@
 
 Update dependencies in a `pyproject.toml` file.
 """
-# pylint: disable=duplicate-code
 from __future__ import annotations
 
 import logging
@@ -36,8 +35,6 @@
 )
 
 if TYPE_CHECKING:  # pragma: no cover
-    from typing import Union
-
     from invoke import Context, Result
 
     from ci_cd.utils.versions import IgnoreUpdateTypes, IgnoreVersions
@@ -114,7 +111,7 @@ def _format_and_update_dependency(
     },
     iterable=["ignore"],
 )
-def update_deps(  # pylint: disable=too-many-branches,too-many-locals,too-many-statements
+def update_deps(
     context,
     root_repo_path=".",
     fail_fast=False,

ci_cd/utils/console_printing.py

@@ -3,12 +3,16 @@
 
 import platform
 from enum import Enum
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:  # pragma: no cover
+    from typing_extensions import Self
 
 
 class Emoji(str, Enum):
     """Unicode strings for certain emojis."""
 
-    def __new__(cls, value: str) -> Emoji:
+    def __new__(cls, value: str) -> Self:
         obj = str.__new__(cls, value)
         if platform.system() == "Windows":
             # Windows does not support unicode emojis, so we replace them with
@@ -27,7 +31,7 @@ def __new__(cls, value: str) -> Emoji:
 class Color(str, Enum):
     """ANSI escape sequences for colors."""
 
-    def __new__(cls, value: str) -> Color:
+    def __new__(cls, value: str) -> Self:
         obj = str.__new__(cls, value)
         obj._value_ = value
         return obj
@@ -49,7 +53,7 @@ def write(self, text: str) -> str:
 class Formatting(str, Enum):
     """ANSI escape sequences for formatting."""
 
-    def __new__(cls, value: str) -> Formatting:
+    def __new__(cls, value: str) -> Self:
         obj = str.__new__(cls, value)
         obj._value_ = value
         return obj