Add pre-commit with ruff (#140)

rcampos87 · web-flow · commit ecb85160fb2e · 2025-10-22T20:12:33.000+08:00
diff --git a/.flake8 b/.flake8
@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 88
+extend-ignore = E203,E501
diff --git a/.github/workflows/base-test.yml b/.github/workflows/base-test.yml
@@ -42,8 +42,6 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: pip install tox 'coveralls<3'
-      - name: Lint code
-        run: tox -e lint
       # - name: Login to Docker Hub
       #   uses: docker/login-action@v3
       #   with:
diff --git a/.github/workflows/test-before-pr.yml b/.github/workflows/test-before-pr.yml
@@ -5,7 +5,20 @@ on:
     branches: ["main"]
 
 jobs:
+  lint:
+    runs-on: ubuntu-22.04
+    name: Linting on Python
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v5
+      - name: Set up Python3
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - name: Lint with pre-commit
+        uses: pre-commit/action@v3.0.1
   test:
+    needs: lint
     uses: ./.github/workflows/base-test.yml
     # https://docs.github.com/en/actions/using-workflows/reusing-workflows#passing-inputs-and-secrets-to-a-reusable-workflow
     secrets: inherit
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,13 @@
+repos:
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.14.1
+  hooks:
+    -   id: ruff-check
+        args: [--fix, --exit-non-zero-on-fix]
+    -   id: ruff-format
+
+- repo: https://github.com/PyCQA/flake8
+  rev: 7.3.0
+  hooks:
+    -   id: flake8
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,5 @@
 ### 1.5.0
+- feat: #140: Adding pre-commit with ruff as linter and code formatter. 
 - fix: #139: Fix to replicas query when using default as cluster name
 - feat: #133: Fix simultaneous queries error when iteration is interrupted
 - feat: #130: Add `distributed_migrations` database setting to support distributed migration queries.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -21,40 +21,33 @@ How to Contribute Source Code
 
 1. Clone the forked repository and cd into it.
 
-2. Install [tox](https://tox.wiki/).
+2. Install [tox](https://tox.wiki/):
    ```shell
    pip install tox
    ```
 
-3. Start ClickHouse cluster.
+3. Install [pre-commit](https://pre-commit.com/):
+   ```shell
+   pip install pre-commit
+   pre-commit install --install-hooks
+   ```
+
+4. Start ClickHouse cluster.
    Docker and docker compose are required.
    ```shell
    docker compose up -d
    ```
 
-4. Install dependencies.
+5. Install dependencies.
    ```shell
    pip install -e .
    ```
 
 ### Code Style
 
-This project use:
-
-- [isort](https://github.com/PyCQA/isort#readme) to automate import sorting.
-- [black](https://black.readthedocs.io/en/stable/) to format code.
-- [flake8](https://pypi.org/project/flake8/) to lint code.
-
-If tox is installed, code formatting can be run as:
-
-```shell
-tox -e format
-```
-
-code linting can be run as:
-
+This project uses Ruff with pre-commit, and to run it manually:
 ```shell
-tox -e lint
+pre-commit run -a
 ```
 
 ### Code Conventions
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ Django ClickHouse Database Backend
 [![GitHub licence](https://img.shields.io/github/license/jayvynl/django-clickhouse-backend)](https://github.com/jayvynl/django-clickhouse-backend/blob/main/LICENSE)
 [![GitHub Action: Test](https://github.com/jayvynl/django-clickhouse-backend/actions/workflows/test-main.yml/badge.svg)](https://github.com/jayvynl/django-clickhouse-backend/actions/workflows/test-main.yml)
 [![Coverage Status](https://coveralls.io/repos/github/jayvynl/django-clickhouse-backend/badge.svg?branch=main)](https://coveralls.io/github/jayvynl/django-clickhouse-backend?branch=main)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Code style](https://camo.githubusercontent.com/051a04ae958f4a1a5d6444df4cdc520305eef93d5028e6d4c7cd16efa3136cd4/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f75726c3d68747470733a2f2f7261772e67697468756275736572636f6e74656e742e636f6d2f61737472616c2d73682f727566662f6d61696e2f6173736574732f62616467652f76322e6a736f6e)](https://github.com/astral-sh/ruff-pre-commit)
 
 Django clickhouse backend is a [django database backend](https://docs.djangoproject.com/en/5.1/ref/databases/) for
 [clickhouse](https://clickhouse.com/docs/en/home/) database. This project allows using django ORM to interact with
diff --git a/clickhouse_backend/models/engines.py b/clickhouse_backend/models/engines.py
@@ -130,9 +130,9 @@ def __init__(
         primary_key=None,
         **settings,
     ):
-        assert (
-            order_by is not None or primary_key is not None
-        ), "At least one of order_by or primary_key must be provided"
+        assert order_by is not None or primary_key is not None, (
+            "At least one of order_by or primary_key must be provided"
+        )
         self.order_by = order_by
         self.primary_key = primary_key
         self.partition_by = partition_by
diff --git a/clickhouse_backend/models/fields/__init__.py b/clickhouse_backend/models/fields/__init__.py
@@ -279,7 +279,7 @@ def _check_choices(self):
 
         invalid_errors = [
             checks.Error(
-                "'choices' must be an iterable containing " "(int, str) tuples.",
+                "'choices' must be an iterable containing (int, str) tuples.",
                 obj=self,
                 id="fields.E005",
             )
diff --git a/clickhouse_backend/models/indexes.py b/clickhouse_backend/models/indexes.py
@@ -35,7 +35,7 @@ def __init__(
             raise ValueError("Index.fields must be a list or tuple.")
         if not expressions and not fields:
             raise ValueError(
-                "At least one field or expression is required to define an " "index."
+                "At least one field or expression is required to define an index."
             )
         if expressions and fields:
             raise ValueError(
diff --git a/example/manage.py b/example/manage.py
@@ -1,5 +1,6 @@
 #!/usr/bin/env python
 """Django's command-line utility for administrative tasks."""
+
 import os
 import sys
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -46,5 +46,5 @@ dynamic = ["version", "readme"]
 version = {attr = "clickhouse_backend.__version__"}
 readme = {file = ["README.md"], content-type = "text/markdown"}
 
-[tool.isort]
-profile = "black"
+[tool.ruff]
+line-length = 88
diff --git a/tests/auth_tests/models/custom_permissions.py b/tests/auth_tests/models/custom_permissions.py
@@ -3,6 +3,7 @@
 Django permissions model. This allows us to check that the PermissionsMixin
 includes everything that is needed to interact with the ModelBackend.
 """
+
 from django.contrib.auth.models import AbstractBaseUser, PermissionsMixin
 from django.db import models
 
diff --git a/tests/backends/test_utils.py b/tests/backends/test_utils.py
@@ -1,4 +1,5 @@
 """Tests for django.db.backends.utils"""
+
 from decimal import Decimal, Rounded
 
 from django.db.backends.utils import format_number, split_identifier, truncate_name
diff --git a/tests/backends/tests.py b/tests/backends/tests.py
@@ -1,4 +1,5 @@
 """Tests related to django.db.backends that haven't been organized."""
+
 import datetime
 import importlib
 import threading
@@ -87,7 +88,7 @@ def test_debug_sql(self):
 
     def test_query_encoding(self):
         """last_executed_query() returns a string."""
-        data = RawData.objects.filter(raw_data=b"\x00\x46  \xFE").extra(
+        data = RawData.objects.filter(raw_data=b"\x00\x46  \xfe").extra(
             select={"föö": 1}
         )
         sql, params = data.query.sql_with_params()
diff --git a/tests/basic/models.py b/tests/basic/models.py
@@ -3,6 +3,7 @@
 
 This is a basic model with only two non-primary-key fields.
 """
+
 import uuid
 
 from django.db import models
diff --git a/tests/clickhouse_fields/tests.py b/tests/clickhouse_fields/tests.py
@@ -466,7 +466,7 @@ def test_blank_choices(self):
 
     def test_invalid_choices(self):
         for field_class in self.field_classes:
-            msg = "'choices' must be an iterable containing " "(int, str) tuples."
+            msg = "'choices' must be an iterable containing (int, str) tuples."
             field = field_class(choices=[(1, "a"), ("b", 2)], name="field")
             self.assertEqual(field.check()[0].msg, msg)
             field = field_class(choices=[(1, b"a\xff"), (2, 3.0)], name="field")
diff --git a/tests/clickhouse_functions/models.py b/tests/clickhouse_functions/models.py
@@ -1,6 +1,7 @@
 """
 Tests for Function expressions.
 """
+
 from clickhouse_backend import models
 
 
diff --git a/tests/expressions_window/tests.py b/tests/expressions_window/tests.py
@@ -549,9 +549,11 @@ def test_ntile(self):
         qs = Employee.objects.annotate(
             ntile=Window(
                 expression=Ntile(num_buckets=4),
-                order_by="-salary"
-                if compat.dj_ge41
-                else OrderBy(F("salary"), descending=True),
+                order_by=(
+                    "-salary"
+                    if compat.dj_ge41
+                    else OrderBy(F("salary"), descending=True)
+                ),
                 # https://github.com/ClickHouse/ClickHouse/issues/61391
                 # recent clickhouse version(24.5.3.5) ntile has a bug,
                 # older version(23.6) is OK without frame.
diff --git a/tests/migrations/test_base.py b/tests/migrations/test_base.py
@@ -266,16 +266,18 @@ def set_up_test_model(
         model_options = {
             "swappable": "TEST_SWAP_MODEL",
             # RemovedInDjango51Warning.
-            "indexes": [
-                Index(
-                    fields=("weight", "pink"),
-                    name="weight_pink_idx",
-                    type=Set(100),
-                    granularity=10,
-                )
-            ]
-            if index_together
-            else [],
+            "indexes": (
+                [
+                    Index(
+                        fields=("weight", "pink"),
+                        name="weight_pink_idx",
+                        type=Set(100),
+                        granularity=10,
+                    )
+                ]
+                if index_together
+                else []
+            ),
         }
         if options:
             model_options["permissions"] = [("can_groom", "Can groom")]
diff --git a/tests/migrations/test_executor.py b/tests/migrations/test_executor.py
@@ -407,9 +407,9 @@ def test_custom_user(self):
             migrations_apps = executor.loader.project_state(
                 ("migrations", "0001_initial"),
             ).apps
-            global_apps.get_app_config("migrations").models[
-                "author"
-            ] = migrations_apps.get_model("migrations", "author")
+            global_apps.get_app_config("migrations").models["author"] = (
+                migrations_apps.get_model("migrations", "author")
+            )
 
             connection.introspection.table_names = old_table_names
             del global_apps.get_app_config("migrations").models["author"]
diff --git a/tox.ini b/tox.ini
@@ -24,24 +24,4 @@ commands =
     pip install pandas
     # Use local clickhouse_backend package so that coverage works properly.
     pip install -e .
-    coverage run tests/runtests.py --debug-sql {posargs}
-
-[testenv:lint]
-description = lint code
-skip_install = true
-deps =
-    flake8
-    isort
-commands =
-    isort -c {[variables]code}
-    flake8 --max-line-length=88 --extend-ignore=E203,E501 {[variables]code}
-
-[testenv:format]
-description = format code
-skip_install = true
-deps =
-    black==23.7.0
-    isort
-commands =
-    isort {[variables]code}
-    black -t py37 -t py38 -t py39 -t py310 -t py311 -t py312 {[variables]code}
+    coverage run tests/runtests.py --debug-sql {posargs}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+[flake8]`
	`2`	`+max-line-length = 88`
	`3`	`+extend-ignore = E203,E501`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`### 1.5.0`
	`2`	`+- feat: #140: Adding pre-commit with ruff as linter and code formatter.`
`2`	`3`	`- fix: #139: Fix to replicas query when using default as cluster name`
`3`	`4`	`- feat: #133: Fix simultaneous queries error when iteration is interrupted`
`4`	`5`	- feat: #130: Add `distributed_migrations` database setting to support distributed migration queries.
Original file line number	Diff line number	Diff line change
`@@ -279,7 +279,7 @@ def _check_choices(self):`
`279`	`279`
`280`	`280`	`invalid_errors = [`
`281`	`281`	`checks.Error(`
`282`		`- "'choices' must be an iterable containing " "(int, str) tuples.",`
	`282`	`+ "'choices' must be an iterable containing (int, str) tuples.",`
`283`	`283`	`obj=self,`
`284`	`284`	`id="fields.E005",`
`285`	`285`	`)`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ def __init__(`
`35`	`35`	`raise ValueError("Index.fields must be a list or tuple.")`
`36`	`36`	`if not expressions and not fields:`
`37`	`37`	`raise ValueError(`
`38`		`- "At least one field or expression is required to define an " "index."`
	`38`	`+ "At least one field or expression is required to define an index."`
`39`	`39`	`)`
`40`	`40`	`if expressions and fields:`
`41`	`41`	`raise ValueError(`