update workflows and pre-commit to use Python 3.12

Author: Eugene Shershen

.flake8

@@ -55,8 +55,8 @@ jobs:
         file: ./coverage.xml
         token: ${{ secrets.CODECOV_TOKEN }}
 
-  lint:
-    name: lint
+  ruff:
+    name: ruff
     runs-on: ubuntu-latest
     steps:
     - name: Checkout repository
@@ -68,30 +68,10 @@ jobs:
         python-version: 3.12
 
     - name: Install dependencies
-      run: pip install flake8
+      run: pip install ruff
 
-    - name: Run flake8
-      run: flake8 --count .
+    - name: Run ruff linter
+      run: ruff check .
 
-  format:
-    name: format
-    runs-on: ubuntu-latest
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v4
-
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: 3.12
-
-    - name: Install dependencies
-      # isort needs all of the packages to be installed so it can
-      # tell which are third party and which are first party
-      run: pip install -r requirements.txt
-
-    - name: Check formatting of imports
-      run: isort --check-only --diff --verbose
-
-    - name: Check formatting of code
-      run: black . --check --diff
+    - name: Run ruff formatter
+      run: ruff format --check .

.github/workflows/ci.yml

@@ -5,43 +5,20 @@ default_language_version:
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v5.0.0
     hooks:
       - id: end-of-file-fixer
       - id: trailing-whitespace
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v2.28.0
-    hooks:
-      - id: pyupgrade
-        args:
-          - --py37-plus
-  - repo: https://github.com/myint/autoflake
-    rev: v1.4
-    hooks:
-      - id: autoflake
-        args:
-          - --in-place
-          - --remove-all-unused-imports
-          - --expand-star-imports
-          - --remove-duplicate-keys
-          - --remove-unused-variables
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.12.0
-    hooks:
-      - id: isort
-  - repo: https://github.com/psf/black
-    rev: 22.3.0
-    hooks:
-      - id: black
-  - repo: https://github.com/PyCQA/flake8
-    rev: 5.0.4
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.4
     hooks:
-      - id: flake8
-        args:
-          - --max-line-length=100
-          - --ignore=E203, E501, W503
+      - id: ruff
+        args: [--fix, --unsafe-fixes]
+      - id: ruff-format
+
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.982
+    rev: v1.17.0
     hooks:
       - id: mypy
         additional_dependencies:

.pre-commit-config.yaml

@@ -1,33 +1,35 @@
 import asyncio
 from contextvars import ContextVar
-from typing import Dict, Optional, Union
+from typing import Dict, Optional, Type, Union
 
-from sqlalchemy.engine import Engine
 from sqlalchemy.engine.url import URL
-from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
+from sqlalchemy.ext.asyncio import AsyncEngine, AsyncSession, create_async_engine
 from starlette.middleware.base import BaseHTTPMiddleware, RequestResponseEndpoint
 from starlette.requests import Request
 from starlette.types import ASGIApp
 
-from fastapi_async_sqlalchemy.exceptions import MissingSessionError, SessionNotInitialisedError
+from fastapi_async_sqlalchemy.exceptions import (
+    MissingSessionError,
+    SessionNotInitialisedError,
+)
 
 try:
-    from sqlalchemy.ext.asyncio import async_sessionmaker  # noqa: F811
+    from sqlalchemy.ext.asyncio import async_sessionmaker
 except ImportError:
-    from sqlalchemy.orm import sessionmaker as async_sessionmaker
+    from sqlalchemy.orm import sessionmaker as async_sessionmaker  # type: ignore
 
 # Try to import SQLModel's AsyncSession which has the .exec() method
 try:
     from sqlmodel.ext.asyncio.session import AsyncSession as SQLModelAsyncSession
 
-    DefaultAsyncSession = SQLModelAsyncSession
+    DefaultAsyncSession: Type[AsyncSession] = SQLModelAsyncSession  # type: ignore
 except ImportError:
-    DefaultAsyncSession = AsyncSession
+    DefaultAsyncSession: Type[AsyncSession] = AsyncSession  # type: ignore
 
 
-def create_middleware_and_session_proxy():
+def create_middleware_and_session_proxy() -> tuple:
     _Session: Optional[async_sessionmaker] = None
-    _session: ContextVar[Optional[DefaultAsyncSession]] = ContextVar("_session", default=None)
+    _session: ContextVar[Optional[AsyncSession]] = ContextVar("_session", default=None)
     _multi_sessions_ctx: ContextVar[bool] = ContextVar("_multi_sessions_context", default=False)
     _commit_on_exit_ctx: ContextVar[bool] = ContextVar("_commit_on_exit_ctx", default=False)
     # Usage of context vars inside closures is not recommended, since they are not properly
@@ -39,9 +41,9 @@ def __init__(
             self,
             app: ASGIApp,
             db_url: Optional[Union[str, URL]] = None,
-            custom_engine: Optional[Engine] = None,
-            engine_args: Dict = None,
-            session_args: Dict = None,
+            custom_engine: Optional[AsyncEngine] = None,
+            engine_args: Optional[Dict] = None,
+            session_args: Optional[Dict] = None,
             commit_on_exit: bool = False,
         ):
             super().__init__(app)
@@ -52,13 +54,18 @@ def __init__(
             if not custom_engine and not db_url:
                 raise ValueError("You need to pass a db_url or a custom_engine parameter.")
             if not custom_engine:
+                if db_url is None:
+                    raise ValueError("db_url cannot be None when custom_engine is not provided")
                 engine = create_async_engine(db_url, **engine_args)
             else:
                 engine = custom_engine
 
             nonlocal _Session
             _Session = async_sessionmaker(
-                engine, class_=DefaultAsyncSession, expire_on_commit=False, **session_args
+                engine,
+                class_=DefaultAsyncSession,
+                expire_on_commit=False,
+                **session_args,
             )
 
         async def dispatch(self, request: Request, call_next: RequestResponseEndpoint):
@@ -67,7 +74,7 @@ async def dispatch(self, request: Request, call_next: RequestResponseEndpoint):
 
     class DBSessionMeta(type):
         @property
-        def session(self) -> DefaultAsyncSession:
+        def session(self) -> AsyncSession:
             """Return an instance of Session local to the current async context."""
             if _Session is None:
                 raise SessionNotInitialisedError
@@ -123,7 +130,7 @@ async def cleanup():
     class DBSession(metaclass=DBSessionMeta):
         def __init__(
             self,
-            session_args: Dict = None,
+            session_args: Optional[Dict] = None,
             commit_on_exit: bool = False,
             multi_sessions: bool = False,
         ):

fastapi_async_sqlalchemy/middleware.py

@@ -1,19 +1,33 @@
-[tool.black]
+[tool.ruff]
 line-length = 100
-target-version = ['py37']
-include = '\.pyi?$'
-exclude = '''
-(
-    | .git
-    | .venv
-    | build
-    | dist
-)
-'''
+target-version = "py37"
+exclude = [
+    ".git",
+    ".venv",
+    "build",
+    "dist",
+]
 
-[tool.isort]
-multi_line_output = 3
-include_trailing_comma = true
-force_grid_wrap = 0
-use_parentheses = true
-line_length = 100
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "I",  # isort
+    "B",  # flake8-bugbear
+    "C4", # flake8-comprehensions
+    "UP", # pyupgrade
+]
+ignore = [
+    "E203", # whitespace before ':'
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+split-on-trailing-comma = true

pyproject.toml

@@ -6,7 +6,10 @@
 from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
 from starlette.middleware.base import BaseHTTPMiddleware
 
-from fastapi_async_sqlalchemy.exceptions import MissingSessionError, SessionNotInitialisedError
+from fastapi_async_sqlalchemy.exceptions import (
+    MissingSessionError,
+    SessionNotInitialisedError,
+)
 
 db_url = "sqlite+aiosqlite://"
 
@@ -72,7 +75,7 @@ async def test_inside_route_without_middleware_fails(app, client, db):
     @app.get("/")
     def test_get():
         with pytest.raises(SessionNotInitialisedError):
-            db.session
+            _ = db.session
 
     client.get("/")
 
@@ -88,7 +91,7 @@ async def test_outside_of_route(app, db, SQLAlchemyMiddleware):
 @pytest.mark.asyncio
 async def test_outside_of_route_without_middleware_fails(db):
     with pytest.raises(SessionNotInitialisedError):
-        db.session
+        _ = db.session
 
     with pytest.raises(SessionNotInitialisedError):
         async with db():
@@ -100,7 +103,7 @@ async def test_outside_of_route_without_context_fails(app, db, SQLAlchemyMiddlew
     app.add_middleware(SQLAlchemyMiddleware, db_url=db_url)
 
     with pytest.raises(MissingSessionError):
-        db.session
+        _ = db.session
 
 
 @pytest.mark.asyncio
@@ -131,9 +134,9 @@ async def test_rollback(app, db, SQLAlchemyMiddleware):
     #  if we could demonstrate somehow that db.session.rollback() was called e.g. once
     app.add_middleware(SQLAlchemyMiddleware, db_url=db_url)
 
-    with pytest.raises(Exception):
+    with pytest.raises(RuntimeError):
         async with db():
-            raise Exception
+            raise RuntimeError("Test exception")
 
         db.session.rollback.assert_called_once()
 
@@ -150,7 +153,7 @@ async def test_db_context_session_args(app, db, SQLAlchemyMiddleware, commit_on_
 
     session_args = {"expire_on_commit": False}
     async with db(session_args=session_args):
-        db.session
+        _ = db.session
 
 
 @pytest.mark.asyncio

tests/test_session.py

@@ -53,7 +53,7 @@ async def test_sqlmodel_exec_method_exists(app, db, SQLAlchemyMiddleware):
     async with db():
         # Test that exec method exists
         assert hasattr(db.session, "exec")
-        assert callable(getattr(db.session, "exec"))
+        assert callable(db.session.exec)
 
 
 @pytest.mark.skipif(not SQLMODEL_AVAILABLE, reason="SQLModel not available")
@@ -272,8 +272,8 @@ async def test_sqlmodel_session_has_both_exec_and_execute(app, db, SQLAlchemyMid
         # Should have both methods
         assert hasattr(db.session, "exec")
         assert hasattr(db.session, "execute")
-        assert callable(getattr(db.session, "exec"))
-        assert callable(getattr(db.session, "execute"))
+        assert callable(db.session.exec)
+        assert callable(db.session.execute)
 
         # Both should work
         result1 = await db.session.execute(text("SELECT 42 as answer"))