Add ruff and ty

Author: tarsil

.github/workflows/test-suite.yml

@@ -85,12 +85,12 @@ jobs:
       - name: Install build dependencies
         if: steps.cache.outputs.cache-hit != 'true'
         run: pip install hatch
-      - name: "Run linting"
+      - name: "Run linting checks"
         if: steps.filters.outputs.src == 'true'
-        run: "hatch fmt --check"
-      # - name: "Run mypy"
-      #   if: steps.filters.outputs.src == 'true'
-      #   run: "hatch run test:check_types"
+        run: "hatch run ruff"
+      - name: "Run typing checks"
+        if: steps.filters.outputs.src == 'true'
+        run: "hatch run test:check_types"
       - name: "Run tests"
         if: steps.filters.outputs.src == 'true' || steps.filters.outputs.workflows == 'true' || github.event.schedule != ''
         # test with xdist as still segfaults occur

Taskfile.yaml

@@ -1,6 +1,26 @@
 version: 3
 
 tasks:
+  ruff:
+    desc: Runs ruff linting checks
+    cmds:
+      - hatch run ruff
+
+  lint:
+    desc: Runs linting checks (ruff + ty)
+    cmds:
+      - hatch run lint
+
+  format:
+    desc: Formats the codebase and re-runs checks
+    cmds:
+      - hatch run format
+
+  ty:
+    desc: Runs type checking with ty
+    cmds:
+      - hatch run test:check_types
+
   docs_prepare:
     desc: Prepares documentation sources for Zensical
     cmds:

databasez/interfaces.py

@@ -293,8 +293,7 @@ async def batched_iterate(
         Yields:
             Sequence[Record]: A batch of result rows.
         """
-        # mypy needs async iterators to contain a `yield`
-        # https://github.com/python/mypy/issues/5385#issuecomment-407281656
+        # Type checkers need async iterators to contain a `yield`.
         yield True  # type: ignore
 
     async def iterate(

docs/contributing.md

@@ -57,8 +57,24 @@ $ hatch test -- tests/test_database_url.py -q
 ## Linting and formatting
 
 ```shell
-$ hatch fmt --check
-$ hatch fmt
+$ hatch run ruff
+$ hatch run lint
+$ hatch run format
+```
+
+## Type checking
+
+```shell
+$ hatch run test:check_types
+```
+
+Taskfile shortcut:
+
+```shell
+$ task ruff
+$ task ty
+$ task lint
+$ task format
 ```
 
 ## Documentation workflow (Zensical)

docs_src/transactions/async_context_connection.py

@@ -2,7 +2,10 @@
 
 
 async def main() -> None:
-    async with Database("sqlite+aiosqlite:///example.db") as database, database.connection() as connection:
+    async with (
+        Database("sqlite+aiosqlite:///example.db") as database,
+        database.connection() as connection,
+    ):
         await connection.execute(
             "CREATE TABLE IF NOT EXISTS notes (id INTEGER PRIMARY KEY, text VARCHAR(100))"
         )
@@ -13,4 +16,6 @@ async def main() -> None:
             )
 
         async with connection.transaction(force_rollback=True):
-            await connection.execute("INSERT INTO notes(text) VALUES (:text)", {"text": "rolled back"})
+            await connection.execute(
+                "INSERT INTO notes(text) VALUES (:text)", {"text": "rolled back"}
+            )

docs_src/transactions/async_context_database.py

@@ -13,4 +13,6 @@ async def main() -> None:
             )
 
         async with database.transaction(force_rollback=True):
-            await database.execute("INSERT INTO notes(text) VALUES (:text)", {"text": "rolled back"})
+            await database.execute(
+                "INSERT INTO notes(text) VALUES (:text)", {"text": "rolled back"}
+            )

docs_src/transactions/force_rollback_transaction.py

@@ -14,7 +14,9 @@ async def test_foo() -> None:
             await database.execute("INSERT INTO notes(text) VALUES (:text)", {"text": "saved"})
 
             async with database.transaction(force_rollback=True):
-                await database.execute("INSERT INTO notes(text) VALUES (:text)", {"text": "rolled"})
+                await database.execute(
+                    "INSERT INTO notes(text) VALUES (:text)", {"text": "rolled"}
+                )
 
         rows = await database.fetch_all("SELECT text FROM notes ORDER BY id")
         assert [row.text for row in rows] == ["saved"]

pyproject.toml

@@ -75,16 +75,31 @@ all = ["databasez[jdbc,mysql,aiomysql,odbc,postgresql,sqlite]"]
 path = "databasez/__init__.py"
 
 
-[tool.mypy]
-strict = true
-disallow_any_generics = false
-disallow_untyped_decorators = true
-implicit_reexport = true
-disallow_incomplete_defs = true
-disable_error_code = "attr-defined"
-disallow_untyped_defs = true
-ignore_missing_imports = true
-no_implicit_optional = true
+[tool.ty]
+
+[tool.ty.src]
+exclude = ["docs_src/"]
+
+[tool.ty.terminal]
+error-on-warning = true
+
+[tool.ty.rules]
+unresolved-import = "ignore"
+redundant-cast = "ignore"
+unused-type-ignore-comment = "ignore"
+possibly-missing-attribute = "ignore"
+unresolved-attribute = "ignore"
+call-top-callable = "ignore"
+call-non-callable = "ignore"
+invalid-type-form = "ignore"
+invalid-parameter-default = "ignore"
+invalid-method-override = "ignore"
+invalid-assignment = "ignore"
+invalid-argument-type = "ignore"
+conflicting-declarations = "ignore"
+unknown-argument = "ignore"
+unsupported-operator = "ignore"
+invalid-await = "ignore"
 
 [tool.ruff]
 extend-exclude = ["docs"]
@@ -123,20 +138,6 @@ known-third-party = ["ravyn", "starlette", "lilya"]
 max-line-length = 120
 max-doc-length = 120
 
-[[tool.mypy.overrides]]
-module = "databasez.tests.*"
-ignore_missing_imports = true
-check_untyped_defs = true
-
-[[tool.mypy.overrides]]
-module = ["sqlalchemy.*", "asyncpg", "alembic", "sqlalchemy_utils.*"]
-ignore_missing_imports = true
-ignore_errors = true
-
-[[tool.mypy.overrides]]
-module = "docs_src.*"
-ignore_errors = true
-
 [tool.pytest.ini_options]
 addopts = [
     "--strict-config",
@@ -159,6 +160,8 @@ include = ["/databasez"]
 [tool.hatch.envs.default]
 features = ["all"]
 extra-dependencies = [
+    "ty",
+    "ruff>=0.3.0,<5.0.0",
     # for debugging
     "sqlalchemy_utils",
     "ipdb>=0.13.13",
@@ -168,6 +171,10 @@ extra-dependencies = [
 [tool.hatch.envs.default.scripts]
 clean_pyc = "find . -type f -name \"*.pyc\" -delete"
 clean_pycache = "find . -type d -name \"*__pycache__*\" -delete"
+check_types = "ty check --error-on-warning databasez"
+ruff = "hatch fmt --check"
+lint = "hatch fmt --check && ty check --error-on-warning databasez"
+format = "hatch fmt && hatch fmt --check && ty check --error-on-warning databasez"
 
 [tool.hatch.envs.docs]
 dependencies = [
@@ -185,10 +192,10 @@ dev = "python scripts/docs.py serve"
 [tool.hatch.envs.test]
 # type-checking
 features = ["all"]
-extra-dependencies = ["mypy>=1.1.0,<2.0.0"]
+extra-dependencies = ["ty"]
 
 [tool.hatch.envs.test.scripts]
-check_types = "mypy -p databasez"
+check_types = "ty check --error-on-warning databasez"
 
 [tool.hatch.envs.hatch-static-analysis]
 # disables custom ruff rules, required to align with pre-commit
@@ -204,7 +211,7 @@ extra-dependencies = [
     "sqlalchemy_utils",
     "ipdb>=0.13.13",
     "ravyn>=0.3.8",
-    "mypy>=1.1.0,<2.0.0",
+    "ty",
     "starlette>=0.26.1",
     "httpx",
     "psycopg[binary]",

scripts/clean

@@ -15,9 +15,6 @@ fi
 if [ -d 'databasez.egg-info' ] ; then
     rm -r databasez.egg-info
 fi
-if [ -d '.mypy_cache' ] ; then
-    rm -r .mypy_cache
-fi
 if [ -d '.pytest_cache' ] ; then
     rm -r .pytest_cache
 fi