Add ruff and refurb to pre-commit and fix the CI banner. (#17)

Author: pre-commit-ci[bot]

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.2.0
+    rev: v4.4.0
     hooks:
     -   id: check-added-large-files
         args: ['--maxkb=100']
@@ -26,46 +26,34 @@ repos:
     -   id: python-use-type-annotations
     -   id: text-unicode-replacement-char
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v2.32.0
+    rev: v3.3.1
     hooks:
     -   id: pyupgrade
         args: [--py37-plus]
 -   repo: https://github.com/asottile/reorder_python_imports
-    rev: v3.0.1
+    rev: v3.9.0
     hooks:
     -   id: reorder-python-imports
         args: [--py37-plus, --add-import, 'from __future__ import annotations']
 -   repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 22.12.0
     hooks:
     -   id: black
--   repo: https://github.com/PyCQA/flake8
-    rev: 4.0.1
+-   repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.0.205
     hooks:
-    -   id: flake8
-        types: [python]
-        additional_dependencies: [
-            flake8-alfred,
-            flake8-bugbear,
-            flake8-builtins,
-            flake8-comprehensions,
-            flake8-docstrings,
-            flake8-eradicate,
-            flake8-print,
-            flake8-pytest-style,
-            flake8-todo,
-            flake8-typing-imports,
-            flake8-unused-arguments,
-            pep8-naming,
-            pydocstyle,
-            Pygments,
-        ]
+      - id: ruff
+-   repo: https://github.com/dosisod/refurb
+    rev: v1.9.1
+    hooks:
+    -   id: refurb
+        args: [--ignore, FURB126]
 -   repo: https://github.com/asottile/setup-cfg-fmt
-    rev: v1.20.1
+    rev: v2.2.0
     hooks:
     -   id: setup-cfg-fmt
--   repo: https://github.com/myint/docformatter
-    rev: v1.3.1
+-   repo: https://github.com/PyCQA/docformatter
+    rev: v1.5.1
     hooks:
     -   id: docformatter
         args: [--in-place, --wrap-summaries, "88", --wrap-descriptions, "88", --blank]
@@ -75,7 +63,7 @@ repos:
     -   id: interrogate
         args: [-v, --fail-under=40, src, tests]
 -   repo: https://github.com/executablebooks/mdformat
-    rev: 0.7.14
+    rev: 0.7.16
     hooks:
     -   id: mdformat
         additional_dependencies: [
@@ -84,12 +72,13 @@ repos:
         ]
         args: [--wrap, "88"]
 - repo: https://github.com/codespell-project/codespell
-  rev: v2.1.0
+  rev: v2.2.2
   hooks:
     -   id: codespell
         args: [-L als, -L unparseable]
+        additional_dependencies: ["tomli"]
 -   repo: https://github.com/mgedmin/check-manifest
-    rev: "0.48"
+    rev: "0.49"
     hooks:
     -   id: check-manifest
         args: [--no-build-isolation]

CHANGES.md

@@ -5,6 +5,10 @@ reverse chronological order. Releases follow [semantic versioning](https://semve
 and all releases are available on
 [Anaconda.org](https://anaconda.org/conda-forge/pytask-environment).
 
+## 0.2.x - 2023-xx-xx
+
+- {pull}`17` adds ruff and refurb to pre-commits and fixes the banner.
+
 ## 0.2.0 - 2022-16-04
 
 - {pull}`15` aligns pytask-environment with pytask v0.2.0.

README.md

@@ -5,7 +5,7 @@
 [![image](https://img.shields.io/conda/vn/conda-forge/pytask-environment.svg)](https://anaconda.org/conda-forge/pytask-environment)
 [![image](https://img.shields.io/conda/pn/conda-forge/pytask-environment.svg)](https://anaconda.org/conda-forge/pytask-environment)
 [![PyPI - License](https://img.shields.io/pypi/l/pytask-environment)](https://pypi.org/project/pytask-environment)
-[![image](https://img.shields.io/github/workflow/status/pytask-dev/pytask-environment/Continuous%20Integration%20Workflow/main)](https://github.com/pytask-dev/pytask-environment/actions?query=branch%3Amain)
+[![image](https://img.shields.io/github/actions/workflow/status/pytask-dev/pytask-environment/main.yml?branch=main)](https://github.com/pytask-dev/pytask-environment/actions?query=branch%3Amain)
 [![image](https://codecov.io/gh/pytask-dev/pytask-environment/branch/main/graph/badge.svg)](https://codecov.io/gh/pytask-dev/pytask-environment)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/pytask-dev/pytask-environment/main.svg)](https://results.pre-commit.ci/latest/github/pytask-dev/pytask-environment/main)
 [![image](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

environment.yml

@@ -5,7 +5,7 @@ channels:
   - nodefaults
 
 dependencies:
-  - python >=3.6
+  - python >=3.7
   - pip
   - setuptools_scm
   - toml

pyproject.toml

@@ -5,3 +5,41 @@ build-backend = "setuptools.build_meta"
 
 [tool.setuptools_scm]
 write_to = "src/pytask_environment/_version.py"
+
+
+[tool.codespell]
+ignore-words-list = "falsy"
+
+
+[tool.ruff]
+select = ["ALL"]
+fix = true
+extend-ignore = [
+    # Numpy docstyle
+    "D107",
+    "D203",
+    "D212",
+    "D213",
+    "D402",
+    "D404",
+    "D413",
+    "D415",
+    "D416",
+    "D417",
+    # Others.
+    "RET504",  # unnecessary variable assignment before return.
+    "S101",  # raise errors for asserts.
+    "B905",  # strict parameter for zip that was implemented in py310.
+    "I",  # ignore isort
+    "ANN101",  # type annotating self
+    "ANN102",  # type annotating cls
+    "FBT",  # flake8-boolean-trap
+    "EM",  # flake8-errmsg
+    "ANN401",  # flake8-annotate typing.Any
+    "PD",  # pandas-vet
+    "UP",  # pyupgrade is too aggressive for py<3.10
+]
+
+
+[tool.ruff.per-file-ignores]
+"tests/*" = ["D", "ANN"]

setup.cfg

@@ -15,10 +15,6 @@ classifiers =
     Operating System :: OS Independent
     Programming Language :: Python :: 3
     Programming Language :: Python :: 3 :: Only
-    Programming Language :: Python :: 3.7
-    Programming Language :: Python :: 3.8
-    Programming Language :: Python :: 3.9
-    Programming Language :: Python :: 3.10
 project_urls =
     Changelog = https://github.com/pytask-dev/pytask-environment/blob/main/CHANGES.md
     Documentation = https://github.com/pytask-dev/pytask-environment

src/pytask_environment/config.py

@@ -1,3 +1,4 @@
+"""This module contains everything related to the configuration."""
 from __future__ import annotations
 
 from typing import Any
@@ -61,18 +62,18 @@ def _get_first_non_none_value(
     the order of the inputs while also providing a default.
 
     """
-    callback = (lambda x: x) if callback is None else callback  # noqa: E731
+    callback = (lambda x: x) if callback is None else callback
     processed_values = (callback(config.get(key)) for config in configs)
     return next((value for value in processed_values if value is not None), default)
 
 
 def _convert_truthy_or_falsy_to_bool(x: bool | str | None) -> bool:
     """Convert truthy or falsy value in .ini to Python boolean."""
-    if x in [True, "True", "true", "1"]:
+    if x in (True, "True", "true", "1"):
         out = True
-    elif x in [False, "False", "false", "0"]:
+    elif x in (False, "False", "false", "0"):
         out = False
-    elif x in [None, "None", "none"]:
+    elif x in (None, "None", "none"):
         out = None
     else:
         raise ValueError(

src/pytask_environment/database.py

@@ -1,3 +1,4 @@
+"""This module contains everything related to the database."""
 from __future__ import annotations
 
 from pony import orm

src/pytask_environment/logging.py

@@ -1,3 +1,4 @@
+"""This module contains everything related to logging."""
 from __future__ import annotations
 
 import sys
@@ -34,7 +35,7 @@ def pytask_log_session_header(session: Session) -> None:
         not session.config["check_python_version"]
         and not session.config["check_environment"]
     ):
-        return None
+        return
 
     package = retrieve_package("python")
 
@@ -43,7 +44,7 @@ def pytask_log_session_header(session: Session) -> None:
 
     # Bail out if everything is fine.
     if same_version and same_path:
-        return None
+        return
 
     msg = ""
     if not same_version and session.config["check_python_version"]:

src/pytask_environment/plugin.py

@@ -1,14 +1,15 @@
 """Entry-point for the plugin."""
 from __future__ import annotations
 
+from pluggy import PluginManager
 from pytask import hookimpl
 from pytask_environment import config
 from pytask_environment import database
 from pytask_environment import logging
 
 
 @hookimpl
-def pytask_add_hooks(pm):
+def pytask_add_hooks(pm: PluginManager) -> None:
     """Register some plugins."""
     pm.register(logging)
     pm.register(config)