refactor: move remaining config into pyproject.toml

Translate German comments to English. Enable ruff rules for the retired

tools (E/W/F/I/D/UP/C901/TRY), move isort and pylint settings into

pyproject.toml, and delete setup.cfg and .pylintrc. Makefile, pre-commit

and CI now rely on ruff instead of flake8/pycodestyle/pydocstyle.

Author: AlexanderWillner

.github/workflows/tests.yml

@@ -35,6 +35,6 @@ jobs:
           token: ${{ secrets.CODECOV_TOKEN }}
       - name: Run lint
         run: |
-          pip install black pycodestyle pylint flake8 mypy pydocstyle vulture pytest ruff setuptools
+          pip install black pylint mypy vulture pytest ruff setuptools
           sudo npm install -g pyright
           make lint

.pre-commit-config.yaml

@@ -16,10 +16,18 @@ repos:
     rev: 23.3.0
     hooks:
     -   id: black
--   repo: https://github.com/PyCQA/flake8
-    rev: 6.0.0
+-   repo: local
     hooks:
-    - id: flake8
+    -   id: ruff-check
+        name: ruff check
+        entry: ruff check --force-exclude
+        language: system
+        'types': [python]
+    -   id: ruff-format
+        name: ruff format
+        entry: ruff format --force-exclude
+        language: system
+        'types': [python]
 -   repo: local
     hooks:
     - id: unittest

.pylintrc

@@ -71,12 +71,9 @@ auto-style: ## Style the code
 	 else echo "SKIPPED. Run '$(PIP) install black' first." >&2 ; fi
 
 code-style: ## Test the code style
-	@echo Pycodestyle...
-	@if type pycodestyle >/dev/null 2>&1 ; then pycodestyle *.py $(SRC_CORE)/*.py $(SRC_TEST)/*.py ; \
-	 else echo "SKIPPED. Run '$(PIP) install pycodestyle' first." >&2 ; fi
-	@echo Pydocstyle...
-	@if type pydocstyle >/dev/null 2>&1 ; then pydocstyle $(SRC_CORE)/*.py $(SRC_TEST)/*.py ; \
-	 else echo "SKIPPED. Run '$(PIP) install pydocstyle' first." >&2 ; fi
+	@echo Ruff format...
+	@if type ruff >/dev/null 2>&1 ; then ruff format --check . ; \
+	 else echo "SKIPPED. Run '$(PIP) install ruff' first." >&2 ; fi
 
 code-count: ## Count the code
 	@if type cloc >/dev/null 2>&1 ; then cloc $(SRC_CORE) ; \
@@ -89,9 +86,6 @@ code-lint: code-style ## Lint the code
 	@echo Ruff...
 	@if type ruff >/dev/null 2>&1 ; then ruff check . ; \
 	 else echo "SKIPPED. Run '$(PIP) install ruff' first." >&2 ; fi
-	@echo Flake...
-	@if type flake8 >/dev/null 2>&1 ; then flake8 . ; \
-	 else echo "SKIPPED. Run '$(PIP) install flake8' first." >&2 ; fi
 
 code-check-types: ## Check the code types
 	@echo Pyright...

Makefile

@@ -22,19 +22,40 @@ dynamic = ["version"]
 [tool.setuptools.dynamic]
 version = { attr = "things.__version__" }
 
-# Ruff-Konfiguration: Ziel ist die älteste unterstützte Version
-# (pyproject.toml: requires-python >= 3.11, CI testet 3.11+).
-# Damit sind moderne Annotations-Syntaxen (PEP 585/604) ok.
+# Ruff configuration: target the oldest supported version
+# (pyproject.toml: requires-python >= 3.11, CI tests 3.11+).
+# This allows modern annotation syntax (PEP 585/604).
 [tool.ruff]
 target-version = "py311"
+line-length = 88
 
 [tool.ruff.lint]
-# TRY004 will TypeError statt ValueError bei falschem Typ. ValueError ist
-# hier API-Vertrag: things/api.get() fängt ValueError, Tests erwarten ihn.
-ignore = ["TRY004"]
-# C901 kennt nur flake8 (max-complexity = 10 in setup.cfg). Die noqa dafür
-# in things/api.py muss bleiben; Ruff soll sie als verwendet werten.
-external = ["C901"]
+# E/W mirror the old flake8/pycodestyle setup (E501 and friends stay ignored:
+# layout is owned by `ruff format`). I/D take over isort/pydocstyle, C901
+# takes over flake8 max-complexity, UP keeps the annotations modern.
+select = ["E", "W", "F", "I", "D", "UP", "C901", "TRY"]
+# TRY004 wants TypeError instead of ValueError for wrong types. ValueError
+# is part of the API contract here: things/api.get() catches ValueError
+# and the tests expect it.
+# The D-ignores mirror the old pydocstyle section from setup.cfg. D417 and
+# TRY003 are new: ruff is stricter than the tools it replaces here, and both
+# touch the public API shape (docstring/kwargs style, exception classes),
+# so they stay off instead of churning user-visible code.
+ignore = ["TRY004", "TRY003", "E501", "E203", "E231", "E241", "E202", "D102", "D212", "D213", "D413", "D203", "D409", "D405", "D406", "D407", "D417"]
+
+[tool.ruff.lint.isort]
+force-sort-within-sections = true
+lines-after-imports = 2
+
+[tool.ruff.lint.mccabe]
+max-complexity = 10
+
+[tool.isort]
+force_sort_within_sections = true
+lines_after_imports = 2
+
+[tool.pylint."MESSAGES CONTROL"]
+disable = ["missing-function-docstring", "C0412"]
 
 [tool.pytest.ini_options]
 doctest_optionflags = ["NORMALIZE_WHITESPACE", "ELLIPSIS"]

pyproject.toml

@@ -2,7 +2,7 @@
 
 import os
 
-from setuptools import find_packages, setup  # type: ignore # pylint: disable=import-error
+import setuptools  # type: ignore # pylint: disable=import-error
 
 
 def package_files(directory):
@@ -15,13 +15,13 @@ def package_files(directory):
     return paths
 
 
-setup(
+setuptools.setup(
     # name stays here (not only in pyproject.toml): py2app's finalize hook
     # reads it before pyproject metadata is merged; without it every
     # setup.py invocation fails with "no script, modules or dest_base specified".
     name="things.py",
     app=[""],
-    packages=find_packages(),
+    packages=setuptools.find_packages(),
     data_files=package_files(""),
     options={"py2app": {"argv_emulation": False}},  # pyright: ignore[reportArgumentType]
     setup_requires=["py2app"],

setup.cfg

@@ -6,13 +6,14 @@
 import sqlite3
 import time
 import tracemalloc
+from typing import cast
 import unittest
 import unittest.mock
-from typing import cast
 
 import things
 import things.database
 
+
 tracemalloc.start()
 
 TEST_DATABASE_FILEPATH = "tests/main.sqlite"

setup.py

@@ -8,11 +8,12 @@
 """
 
 import os  # pylint: disable=C0412
-import urllib.parse
 from shlex import quote
+import urllib.parse
 
 from things.database import Database
 
+
 # --------------------------------------------------
 # Core functions
 # --------------------------------------------------

tests/test_things.py

@@ -8,8 +8,9 @@
 import plistlib
 import re
 import sqlite3
-import weakref
 from textwrap import dedent
+import weakref
+
 
 # --------------------------------------------------
 # Core constants