Merge pull request #170 from Dev-iL/2605/prek

Replace `pre-commit` with `prek`

Author: chandr-andr

.github/workflows/prek.yaml

@@ -0,0 +1,9 @@
+name: Prek checks
+on: [push, pull_request]
+
+jobs:
+  prek:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: j178/prek-action@v2

.pre-commit-config.yaml

@@ -3,30 +3,25 @@ ci:
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
       - id: trailing-whitespace
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.5.1
+    rev: v2.1.0
     hooks:
       - id: mypy
         name: python mypy
         always_run: true
         pass_filenames: false
         args: ["python"]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.8.1
+    rev: v0.15.13
     hooks:
-      - id: ruff
-        name: ruff
-        pass_filenames: false
-        always_run: true
-        args: ["python", "--fix"]
+      # Run the linter.
+      - id: ruff-check
+        args: [ --fix ]
+      # Run the formatter.
       - id: ruff-format
-        name: ruff
-        pass_filenames: false
-        always_run: true
-        args: ["python"]
   - repo: local
     hooks:
       - id: fmt

docs/contribute.md

@@ -22,7 +22,7 @@ One of the best ways is follow [maturin offical documentation](https://www.matur
 ```bash
 > python3 -m venv .venv
 > source .venv/bin/activate
-> pip install -U pip maturin pre-commit pytest pytest-anyio pydantic pgpq
+> pip install -U pip maturin prek pytest pytest-anyio pydantic pgpq
 ```
 
 Then you need to build `PSQLPy` project.
@@ -33,12 +33,12 @@ maturin develop
 After this step project is built and installed in your python environment you created in previous step.
 
 ## Linting and type checking
-We have pre-commit configured with all our settings. We highly recommend you to install it as a git hook using pre-commit install command.
+We have prek configured with all our settings. We highly recommend you to install it as a git hook using prek install command.
 
 But even without installation, you can run all lints manually:
 
 ```bash
-pre-commit run -a
+prek run -a
 ```
 
 ## Testing

psqlpy-stress/.pre-commit-config.yaml

@@ -1,29 +1,34 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
+orphan: true
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.4.0
+    rev: v6.0.0
     hooks:
       - id: check-ast
       - id: trailing-whitespace
       - id: check-toml
       - id: end-of-file-fixer
 
   - repo: https://github.com/asottile/add-trailing-comma
-    rev: v2.1.0
+    rev: v4.0.0
     hooks:
       - id: add-trailing-comma
 
-  - repo: local
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v2.1.0
     hooks:
-      - id: ruff
-        name: Check with ruff
-        entry: poetry run ruff check --force-exclude
-        language: system
-        types: [python]
-
       - id: mypy
-        name: Validate types with MyPy
-        entry: poetry run mypy
-        language: system
-        types: [python]
+        name: python mypy
+        always_run: true
+        pass_filenames: false
+        args: ["psqlpy_stress"]
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.13
+    hooks:
+      # Run the linter.
+      - id: ruff-check
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format

psqlpy-stress/psqlpy_stress/migrations/env.py

@@ -1,4 +1,16 @@
 # noqa: INP001
+"""Alembic migration environment.
+
+To enable autogenerate support, point ``target_metadata`` at your models::
+
+    from myapp import mymodel
+    target_metadata = mymodel.Base.metadata
+
+Additional values from alembic.ini can be read via ``config.get_main_option``::
+
+    my_important_option = config.get_main_option("my_important_option")
+"""
+
 from logging.config import fileConfig
 
 from alembic import context
@@ -17,20 +29,11 @@
 if config.config_file_name is not None:
     fileConfig(config.config_file_name)
 
-# add your model's MetaData object here
-# for 'autogenerate' support
-# from myapp import mymodel
-# target_metadata = mymodel.Base.metadata
 target_metadata = Base.metadata
 
 database_url = settings.database_url
 config.set_main_option("sqlalchemy.url", database_url)
 
-# other values from the config, defined by the needs of env.py,
-# can be acquired:
-# my_important_option = config.get_main_option("my_important_option")
-# ... etc.
-
 
 def run_migrations_offline() -> None:
     """Run migrations in 'offline' mode.

psqlpy-stress/psqlpy_stress/migrations/versions/06d989926550_basic_user_table.py

@@ -1,3 +1,4 @@
+# ruff: noqa: INP001
 """basic user table
 
 Revision ID: 06d989926550
@@ -7,17 +8,16 @@
 """
 
 from collections.abc import Sequence
-from typing import Union
 
 import sqlalchemy as sa
 from alembic import op
 
 
 # revision identifiers, used by Alembic.
 revision: str = "06d989926550"
-down_revision: Union[str, None] = None
-branch_labels: Union[str, Sequence[str], None] = None
-depends_on: Union[str, Sequence[str], None] = None
+down_revision: str | None = None
+branch_labels: str | Sequence[str] | None = None
+depends_on: str | Sequence[str] | None = None
 
 
 def upgrade() -> None:

psqlpy-stress/psqlpy_stress/migrations/versions/d162c084f522_big_af_table.py

@@ -1,3 +1,4 @@
+# ruff: noqa: INP001
 """big af table
 
 Revision ID: d162c084f522
@@ -7,7 +8,6 @@
 """
 
 from collections.abc import Sequence
-from typing import Union
 
 import sqlalchemy as sa
 from alembic import op
@@ -16,9 +16,9 @@
 
 # revision identifiers, used by Alembic.
 revision: str = "d162c084f522"
-down_revision: Union[str, None] = "06d989926550"
-branch_labels: Union[str, Sequence[str], None] = None
-depends_on: Union[str, Sequence[str], None] = None
+down_revision: str | None = "06d989926550"
+branch_labels: str | Sequence[str] | None = None
+depends_on: str | Sequence[str] | None = None
 
 
 def upgrade() -> None:

psqlpy-stress/psqlpy_stress/mocker.py

@@ -25,12 +25,12 @@ async def fill_users() -> None:
         )
 
 
-def generate_random_array() -> list[str]:
-    return [random.randint(50, 500) for _ in range(random.randint(50, 500))]
+def generate_random_array() -> list[int]:
+    return [random.randint(50, 500) for _ in range(random.randint(50, 500))]  # noqa: S311
 
 
 def generate_random_dict() -> dict[str, str]:
-    return {str(uuid.uuid4()): str(uuid.uuid4()) for _ in range(random.randint(50, 500))}
+    return {str(uuid.uuid4()): str(uuid.uuid4()) for _ in range(random.randint(50, 500))}  # noqa: S311
 
 
 async def fill_big_table() -> None:
@@ -39,10 +39,12 @@ async def fill_big_table() -> None:
     connection = await pool.connection()
     for _ in range(big_table_amount):
         await connection.execute(
-            "INSERT INTO big_table (string_field, integer_field, json_field, array_field) VALUES($1, $2, $3, $4)",
+            "INSERT INTO big_table"
+            " (string_field, integer_field, json_field, array_field)"
+            " VALUES($1, $2, $3, $4)",
             parameters=[
                 str(uuid.uuid4()),
-                random.randint(1, 99999999),
+                random.randint(1, 99999999),  # noqa: S311
                 generate_random_dict(),
                 generate_random_array(),
             ],

psqlpy-stress/psqlpy_stress/models/piccolo.py

@@ -2,12 +2,12 @@
 from piccolo.table import Table
 
 
-class User(Table, tablename="users"):
+class User(Table, tablename="users"):  # type: ignore[call-arg]
     user_id = Serial(primary_key=True)
     username = Varchar(null=False)
 
 
-class SomeBigTable(Table, tablename="big_table"):
+class SomeBigTable(Table, tablename="big_table"):  # type: ignore[call-arg]
     big_table_id = Integer(primary_key=True)
     string_field = Varchar(null=False)
     integer_field = Integer(null=False)

psqlpy-stress/psqlpy_stress/models/sqlalchemy.py

@@ -6,14 +6,14 @@
 Base = declarative_base()
 
 
-class User(Base):
+class User(Base):  # type: ignore[misc, valid-type]
     __tablename__ = "users"
 
     user_id = Column(Integer, primary_key=True, autoincrement=True)
     username = Column(String, unique=True, nullable=False)
 
 
-class SomeBigTable(Base):
+class SomeBigTable(Base):  # type: ignore[misc, valid-type]
     __tablename__ = "big_table"
     big_table_id = Column(Integer, primary_key=True, autoincrement=True)
     string_field = Column(String, unique=False, nullable=False)