Switch to Ruff

.github/workflows/test.yaml

@@ -45,11 +45,16 @@ jobs:
                   overrides = dict(package_name='${{ matrix.package-name }}')
                   cookiecutter('.', no_input=True, extra_context=overrides)
             # Check
+            - name: Set up pre-commit cache
+              uses: actions/cache@v3
+              with:
+                  path: ~/.cache/pre-commit
+                  key: pre-commit-3|${{ matrix.python }}|${{ hashFiles(format('{0}/.pre-commit-config.yaml', env.PROJECT_ROOT)) }}
             - name: Run pre-commit
               run: |
                   cd "$PROJECT_ROOT"
                   git add .
-                  pre-commit run --color=always --show-diff-on-failure --all-files
+                  pre-commit run --verbose --color=always --show-diff-on-failure --all-files
             - name: Install the package
               run: |
                   cd $PROJECT_ROOT

{{cookiecutter.project_name}}/.gitignore

@@ -1,9 +1,13 @@
 # Temp files
 .DS_Store
 *~
+buck-out/
 
 # Compiled files
+.venv/
 __pycache__/
+.mypy_cache/
+.ruff_cache/
 
 # Distribution / packaging
 /build/

{{cookiecutter.project_name}}/.pre-commit-config.yaml

@@ -7,9 +7,13 @@ default_stages:
 minimum_pre_commit_version: 2.16.0
 repos:
     - repo: https://github.com/psf/black
-      rev: 22.3.0
+      rev: "22.3.0"
       hooks:
           - id: black
+    - repo: https://github.com/asottile/blacken-docs
+      rev: v1.12.1
+      hooks:
+          - id: blacken-docs
     - repo: https://github.com/pre-commit/mirrors-prettier
       rev: v2.5.1
       hooks:
@@ -20,25 +24,11 @@ repos:
             # See https://github.com/scverse/cookiecutter-scverse/issues/143 and
             # https://github.com/jupyterlab/jupyterlab/issues/12675
             language_version: "17.9.1"
-    - repo: https://github.com/asottile/blacken-docs
-      rev: v1.12.1
+    - repo: https://github.com/charliermarsh/ruff-pre-commit
+      rev: v0.0.250
       hooks:
-          - id: blacken-docs
-    - repo: https://github.com/PyCQA/isort
-      rev: 5.10.1
-      hooks:
-          - id: isort
-    - repo: https://github.com/asottile/yesqa
-      rev: v1.3.0
-      hooks:
-          - id: yesqa
-            additional_dependencies:
-                - flake8-tidy-imports
-                - flake8-docstrings
-                - flake8-rst-docstrings
-                - flake8-comprehensions
-                - flake8-bugbear
-                - flake8-blind-except
+          - id: ruff
+            args: [--fix, --exit-non-zero-on-fix]
     - repo: https://github.com/pre-commit/pre-commit-hooks
       rev: v4.1.0
       hooks:
@@ -49,31 +39,6 @@ repos:
             args: [--fix=lf]
           - id: trailing-whitespace
           - id: check-case-conflict
-    - repo: https://github.com/myint/autoflake
-      rev: v1.4
-      hooks:
-          - id: autoflake
-            args:
-                - --in-place
-                - --remove-all-unused-imports
-                - --remove-unused-variable
-                - --ignore-init-module-imports
-    - repo: https://github.com/PyCQA/flake8
-      rev: 4.0.1
-      hooks:
-          - id: flake8
-            additional_dependencies:
-                - flake8-tidy-imports
-                - flake8-docstrings
-                - flake8-rst-docstrings
-                - flake8-comprehensions
-                - flake8-bugbear
-                - flake8-blind-except
-    - repo: https://github.com/asottile/pyupgrade
-      rev: v2.31.1
-      hooks:
-          - id: pyupgrade
-            args: [--py3-plus, --py38-plus, --keep-runtime-typing]
     - repo: local
       hooks:
           - id: forbid-to-commit

{{cookiecutter.project_name}}/docs/conf.py

@@ -65,7 +65,7 @@
 napoleon_include_init_with_doc = False
 napoleon_use_rtype = True  # having a separate entry generally helps readability
 napoleon_use_param = True
-myst_heading_anchors = 3  # create anchors for h1-h3
+myst_heading_anchors = 6  # create anchors for h1-h6
 myst_enable_extensions = [
     "amsmath",
     "colon_fence",

{{cookiecutter.project_name}}/docs/template_usage.md

@@ -142,78 +142,104 @@ Once authorized, pre-commit.ci should automatically be activated.
 
 #### Overview of pre-commit hooks used by the template
 
-The following pre-commit checks are for code style and format:
-
--   [black](https://black.readthedocs.io/en/stable/): standard code
-    formatter in Python.
--   [isort](https://pycqa.github.io/isort/): sort module imports into
-    sections and types.
--   [prettier](https://prettier.io/docs/en/index.html): standard code
-    formatter for non-Python files (e.g. YAML).
--   [blacken-docs](https://github.com/asottile/blacken-docs): black on
-    python code in docs.
-
-The following pre-commit checks are for errors and inconsistencies:
-
--   [flake8](https://flake8.pycqa.org/en/latest/): standard check for errors in Python files.
-    -   [flake8-tidy-imports](https://github.com/adamchainz/flake8-tidy-imports):
-        tidy module imports.
-    -   [flake8-docstrings](https://github.com/PyCQA/flake8-docstrings):
-        pydocstyle extension of flake8.
-    -   [flake8-rst-docstrings](https://github.com/peterjc/e8-rst-docstrings):
-        extension of `flake8-docstrings` for `rst` docs.
-    -   [flake8-comprehensions](https://github.com/adamchainz/e8-comprehensions):
-        write better list/set/dict comprehensions.
-    -   [flake8-bugbear](https://github.com/PyCQA/flake8-bugbear):
-        find possible bugs and design issues in program.
-    -   [flake8-blind-except](https://github.com/elijahandrews/flake8-blind-except):
-        checks for blind, catch-all `except` statements.
--   [yesqa](https://github.com/asottile/yesqa):
-    remove unneccesary `# noqa` comments, follows additional dependencies listed above.
--   [autoflake](https://github.com/PyCQA/autoflake):
-    remove unused imports and variables.
--   [pre-commit-hooks](https://github.com/pre-commit/pre-commit-hooks): generic pre-commit hooks.
+The following pre-commit hooks are for code style and format:
+
+-   [black](https://black.readthedocs.io/en/stable/):
+    standard code formatter in Python.
+-   [blacken-docs](https://github.com/asottile/blacken-docs):
+    black on Python code in docs.
+-   [prettier](https://prettier.io/docs/en/index.html):
+    standard code formatter for non-Python files (e.g. YAML).
+
+The following pre-commit hooks are for errors and inconsistencies:
+
+-   [ruff][]: Many configurable checks for Python code, see [Overview of Ruff checks](#overview-of-ruff-checks).
+-   [pre-commit-hooks](https://github.com/pre-commit/pre-commit-hooks): generic pre-commit hooks for text files.
     -   **detect-private-key**: checks for the existence of private keys.
     -   **check-ast**: check whether files parse as valid python.
-    -   **end-of-file-fixer**:check files end in a newline and only a newline.
+    -   **end-of-file-fixer**: check files end in a newline and only a newline.
     -   **mixed-line-ending**: checks mixed line ending.
     -   **trailing-whitespace**: trims trailing whitespace.
     -   **check-case-conflict**: check files that would conflict with case-insensitive file systems.
--   [pyupgrade](https://github.com/asottile/pyupgrade):
+-   **forbid-to-commit**: Make sure that `*.rej` files cannot be commited.
+    These files are created by the [automated template sync](#automated-template-sync)
+    if there's a merge conflict and need to be addressed manually.
+
+[ruff]: https://beta.ruff.rs/docs/
+
+#### Overview of Ruff checks
+
+[Ruff][] implements several checks for Python code and docstrings.
+Therefore each check below mentions a the rule prefix that enables it when added to `pyproject.toml`.
+E.g. `isort` is enabled with:
+
+```toml
+[tool.ruff]
+select = [ ..., "I", ... ]
+```
+
+The following checks are for code style and format:
+
+-   [isort](https://beta.ruff.rs/docs/rules/#isort-i) (`I`):
+    sort module imports into sections and types.
+-   [pydocstyle](https://beta.ruff.rs/docs/rules/#pydocstyle-d) (`D`):
+    pydocstyle extension of flake8.
+-   [flake8-tidy-imports](https://beta.ruff.rs/docs/rules/#flake8-tidy-imports-tid) (`TID`):
+    tidy module imports.
+-   [flake8-comprehensions](https://beta.ruff.rs/docs/rules/#flake8-comprehensions-c4) (`C4`):
+    write better list/set/dict comprehensions.
+-   [pyupgrade](https://beta.ruff.rs/docs/rules/#pyupgrade-up) (`UP`):
     upgrade syntax for newer versions of the language.
--   **forbid-to-commit**: Make sure that `*.rej` files cannot be commited. These files are created by the
-    [automated template sync](#automated-template-sync) if there's a merge conflict and need to be addressed manually.
+
+The following checks are for errors and inconsistencies:
+
+-   [pyflakes](https://beta.ruff.rs/docs/rules/#pyflakes-f) (`F`):
+    various checks for errors.
+-   [pycodestyle](https://beta.ruff.rs/docs/rules/#pycodestyle-e-w) (`E`, `W`):
+    various checks for errors.
+-   [flake8-bugbear](https://beta.ruff.rs/docs/rules/#flake8-bugbear-b) (`B`):
+    find possible bugs and design issues in program.
+-   [flake8-blind-except](https://beta.ruff.rs/docs/rules/#flake8-blind-except-ble) (`BLE`):
+    checks for blind, catch-all `except` statements.
+-   [Ruff-specific rules](https://beta.ruff.rs/docs/rules/#ruff-specific-rules-ruf) (`RUF`):
+    -   `RUF100`: remove unneccesary `# noqa` comments.
+        See [How to ignore certain lint warnings](#how-to-ignore-certain-lint-warnings) for details.
 
 ### How to disable or add pre-commit checks
 
--   To ignore lint warnigs from **flake8**, see [Ignore certain lint warnings](#how-to-ignore-certain-lint-warnings).
+-   To ignore lint warnigs from [Ruff][], see [How to ignore certain lint warnings](#how-to-ignore-certain-lint-warnings).
 -   You can add or remove pre-commit checks by simply deleting relevant lines in the `.pre-commit-config.yaml` file.
     Some pre-commit checks have additional options that can be specified either in the `pyproject.toml` or tool-specific
     config files, such as `.prettierrc.yml` for **prettier** and `.flake8` for **flake8**.
 
 ### How to ignore certain lint warnings
 
-The [pre-commit checks](#pre-commit-checks) include [flake8](https://flake8.pycqa.org/en/latest/) which checks
+The [pre-commit checks](#pre-commit-checks) include [Ruff][] which checks
 for errors in Python files, including stylistic errors.
 
 In some cases it might overshoot and you may have good reasons to ignore certain warnings.
 
-To ignore an specific error on a per-case basis, you can add a comment `# noqa` to the offending line. You can also
-specify the error ID to ignore, with e.g. `# noqa: E731`. Check the [flake8 guide][] for reference.
+To ignore an specific error on a per-case basis, you can add a `# noqa: <rule>[, <rule>, …]` comment to the offending line.
+Specify the rule ID(s) to ignore, with e.g. `# noqa: E731`. Check the [Ruff guide][] for reference.
 
-Alternatively, you can disable certain error messages for the entire project. To do so, edit the `.flake8`
-file in the root of the repository. Add one line per linting code you wish to ignore and don't forget to add a comment.
+The `RUF100` check will remove `noqa` IDs that are no longer necessary.
+If you want to add an ID that comes from a tool other than Ruff,
+add it to Ruff’s [`external = [...]`](https://beta.ruff.rs/docs/settings/#external) setting to prevent `RUF100` from removing it.
+
+You can also disable certain error messages for the entire project.
+To do so, edit the `[tool.ruff]` section in `pyproject.toml` in the root of the repository.
+Add the rule ID(s) you want to ignore and don't forget to add a comment explaining why.
 
 ```toml
-...
-# line break before a binary operator -> black does not adhere to PEP8
-W503
-# line break occured after a binary operator -> black does not adhere to PEP8
-W504
-...
+ignore = [
+    ...
+    # __magic__ methods are are often self-explanatory, allow missing docstrings
+    "D105",
+    ...
+]
 ```
 
-[flake8 guide]: https://flake8.pycqa.org/en/3.1.1/user/ignoring-errors.html
+[ruff guide]: https://beta.ruff.rs/docs/configuration/#suppressing-errors
 
 ### API design