[chore] Replace Black 24.1 with Ruff 0.6

Quite a few automated reformatting as a result, but all in all it's not too bad - Ruff's formatting rules don't differ too much from Black's ones :-)
--> https://docs.astral.sh/ruff/formatter/black/

Author: olivierphi

.github/workflows/test-suite.yml

@@ -29,9 +29,9 @@ jobs:
         run: uv python install
       - name: "Install dependencies via uv"
         run: uv sync --all-extras
-      - name: "Run linting checks: Black"
-        run: uv run black src/
-      - name: "Run linting checks: Ruff"
+      - name: "Run linting checks: Ruff checker"
+        run: uv run ruff format --check --quiet src/
+      - name: "Run linting checks: Ruff linter"
         run: uv run ruff check --quiet src/
       - name: "Run linting checks: Mypy"
         run: uv run mypy src/

.pre-commit-config.yaml

@@ -1,23 +1,22 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
-  - repo: https://github.com/psf/black
-    rev: 24.1.1
-    hooks:
-      - id: black
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.8.0
+    rev: v1.11.2
     hooks:
       - id: mypy
         additional_dependencies: [types-requests==2.31.0.2]
         exclude: "^scripts/load_testing/.*\\.py$"
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.1.14
+    rev: v0.6.3
     hooks:
+      # Run the formatter.
+      - id: ruff-format
+      # Run the linter.
       - id: ruff
         args: ["--fix"] 
         exclude: "^src/project/settings/.*\\.py$"
   - repo: https://github.com/abravalheri/validate-pyproject
-    rev: v0.16
+    rev: v0.19
     hooks:
       - id: validate-pyproject

Makefile

@@ -13,6 +13,7 @@ help:
 install: bin/uv .venv ./node_modules ## Install the Python and frontend dependencies
 	bin/uv sync --all-extras
 	${PYTHON_BINS}/pre-commit install
+	${SUB_MAKE} .venv/bin/black
 
 .PHONY: dev
 dev: .env.local db.sqlite3
@@ -60,18 +61,18 @@ test: ## Launch the pytest tests suite
 		${PYTHON_BINS}/pytest ${pytest_opts}
 
 .PHONY: code-quality/all
-code-quality/all: code-quality/black code-quality/ruff code-quality/mypy  ## Run all our code quality tools
-
-.PHONY: code-quality/black
-code-quality/black: black_opts ?=
-code-quality/black: ## Automated 'a la Prettier' code formatting
-# @link https://black.readthedocs.io/en/stable/
-	@${PYTHON_BINS}/black ${black_opts} src/
-
-.PHONY: code-quality/ruff
-code-quality/ruff: ruff_opts ?= --fix
-code-quality/ruff: ## Fast linting
-# @link https://docs.astral.sh/ruff/
+code-quality/all: code-quality/ruff_check code-quality/ruff_lint code-quality/mypy  ## Run all our code quality tools
+
+.PHONY: code-quality/ruff_check
+code-quality/ruff_check: ruff_opts ?=
+code-quality/ruff_check: ## Automated 'a la Prettier' code formatting
+# @link https://docs.astral.sh/ruff/formatter/
+	@${PYTHON_BINS}/ruff format ${ruff_opts} src/
+
+.PHONY: code-quality/ruff_lint
+code-quality/ruff_lint: ruff_opts ?= --fix
+code-quality/ruff_lint: ## Fast linting
+# @link https://docs.astral.sh/ruff/linter/
 	@${PYTHON_BINS}/ruff check src/ ${ruff_opts}
 
 .PHONY: code-quality/mypy
@@ -154,6 +155,10 @@ bin/uv: # Install `uv` and `uvx` locally in the "bin/" folder
 .env.local:
 	cp .env.dist .env.local
 
+.venv/bin/black: .venv ## A simple and stupid shim to use the IDE's Black integration with Ruff
+	@echo '#!/usr/bin/env sh\n$$(dirname "$$0")/ruff format $$@' > ${PYTHON_BINS}/black
+	@chmod +x ${PYTHON_BINS}/black
+
 db.sqlite3: dotenv_file ?= .env.local
 db.sqlite3: ## Initialises the SQLite database
 	touch db.sqlite3

manage.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python
 """Django's command-line utility for administrative tasks."""
+
 import os
 import sys
 

pyproject.toml

@@ -31,16 +31,15 @@ dependencies= [
 [project.optional-dependencies]
 dev = [
     "python-dotenv==1.*",
-    "black==24.1.*",
     "ruff==0.6.*",
     "mypy==1.*",
     "pre-commit==3.*",
     "ipython==8.*",
     "types-requests==2.*",
     "django-extensions==3.*",
-    "httpx==0.26.*",   # only used in "scripts/download_assets.py" for parallel downloads
+    # (httpx is only used in "scripts/download_assets.py" for parallel downloads)
+    "httpx==0.26.*",
     "sqlite-utils==3.*",
-    
 ]
 test = [
     "pytest==7.*",
@@ -59,13 +58,9 @@ Repository = "https://github.com/olivierphi/zakuchess"
 
 
 [tool.uv]
-package = true
+package = true # symlinks the project's "src/" root folder to the venv
 
 
-[tool.black]
-# @link https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html
-target-version = ['py311']
-
 [tool.ruff]
 # @link https://docs.astral.sh/ruff/configuration/
 target-version = "py311"

scripts/download_assets.py

@@ -41,8 +41,8 @@
     )
 )
 
+# fmt: off
 ASSETS_MAP: dict[URL, Path] = {
-    # fmt: off
     # Fonts:
     ASSETS_PATTERNS["GOOGLE_FONTS"].format(font_name="opensans", file_id="mem8YaGs126MiZpBA-UFVZ0b", v="v35"): WEBUI_STATIC / "fonts" / "OpenSans.woff2",
     # Stockfish:
@@ -81,8 +81,8 @@
     ASSETS_PATTERNS["WIKIMEDIA_CHESS_SVG_DARK"].format(folder="f/ff", piece="r"): CHESS_STATIC / "symbols" / "b-rook.svg",
     ASSETS_PATTERNS["WIKIMEDIA_CHESS_SVG_DARK"].format(folder="4/47", piece="q"): CHESS_STATIC / "symbols" / "b-queen.svg",
     ASSETS_PATTERNS["WIKIMEDIA_CHESS_SVG_DARK"].format(folder="f/f0", piece="k"): CHESS_STATIC / "symbols" / "b-king.svg",
-    # fmt: on
 }
+# fmt: on
 
 
 async def download_assets(*, even_if_exists: bool) -> None:

src/apps/authentication/migrations/0001_initial.py

@@ -7,7 +7,6 @@
 
 
 class Migration(migrations.Migration):
-
     initial = True
 
     dependencies = [

src/apps/chess/business_logic/_do_chess_move.py

@@ -24,9 +24,7 @@
     False: "b",
 }
 
-_CHESS_OUTCOME_TO_GAME_END_REASON_MAPPING: (
-    "Mapping[chess.Termination, GameEndReason]"
-) = {
+_CHESS_OUTCOME_TO_GAME_END_REASON_MAPPING: "Mapping[chess.Termination, GameEndReason]" = {
     chess.Termination.CHECKMATE: "checkmate",
     chess.Termination.STALEMATE: "stalemate",
     chess.Termination.INSUFFICIENT_MATERIAL: "insufficient_material",

src/apps/chess/components/chess_board.py

@@ -40,12 +40,10 @@
 )
 _PIECE_GROUND_MARKER_COLOR_TAILWIND_CLASSES: dict[tuple["PlayerSide", bool], str] = {
     # the boolean says if the piece can move
-    # fmt: off
     ("w", False): "bg-emerald-800/40 border-2 border-emerald-800",
     ("b", False): "bg-indigo-800/40 border-2 border-indigo-800",
     ("w", True): "bg-emerald-600/40 border-2 border-emerald-800",
     ("b", True): "bg-indigo-600/40 border-2 border-indigo-800",
-    # fmt: on
 }
 _CHESS_PIECE_Z_INDEXES: dict[str, str] = {
     # N.B. z-indexes must be multiples of 10 in Tailwind.
@@ -672,7 +670,6 @@ def chess_last_move(
 def chess_last_move_marker(
     *, square: "Square", move_part: Literal["from", "to"]
 ) -> "dom_tag":
-
     match move_part:
         case "from":
             start_class = "!w-full"

src/apps/chess/consts.py

@@ -23,9 +23,9 @@
     "q": 9,
 }
 
+# fmt: off
 SQUARES: Final[tuple["Square", ...]] = (
     # The order matters here, as we use that for the board visual representation.
-    # fmt: off
     "a1", "a2", "a3", "a4", "a5", "a6", "a7", "a8",
     "b1", "b2", "b3", "b4", "b5", "b6", "b7", "b8",
     "c1", "c2", "c3", "c4", "c5", "c6", "c7", "c8",
@@ -34,8 +34,8 @@
     "f1", "f2", "f3", "f4", "f5", "f6", "f7", "f8",
     "g1", "g2", "g3", "g4", "g5", "g6", "g7", "g8",
     "h1", "h2", "h3", "h4", "h5", "h6", "h7", "h8",
-    # fmt: on
 )
+# fmt: on
 FILES: Final[tuple["File", ...]] = ("a", "b", "c", "d", "e", "f", "g", "h")
 RANKS: Final[tuple["Rank", ...]] = ("1", "2", "3", "4", "5", "6", "7", "8")