refactor!: Simplify Session API

fastapi_sqla.Session is used as a dependency directly.

BREAKING CHANGE: * Removed `fastapi_sqla.with_session`. Use `fastapi_sqla.Session` instead.

Author: hadrien

README.md

@@ -47,17 +47,17 @@ class Entity(Base):
     __tablename__ = "table-name-in-db"
 ```
 
-### Getting an sqla orm session
+### Getting an sqla session
 
 ```python
 from fastapi import APIRouter, Depends
-from fastapi_sqla import Session, with_session
+from fastapi_sqla import Session
 
 router = APIRouter()
 
 
 @router.get("/example")
-def example(session: Session = Depends(with_session)):
+def example(session: Session = Depends()):
     return session.execute("SELECT now()").scalar()
 ```
 
@@ -71,7 +71,6 @@ from fastapi_sqla import (
     PaginatedResult,
     Session,
     with_pagination,
-    with_session,
 )
 from pydantic import BaseModel
 
@@ -89,7 +88,7 @@ class User(BaseModel):
 
 @router.get("/users", response_model=Paginated[User])
 def all_users(
-    session: Session = Depends(with_session),
+    session: Session = Depends(),
     paginated_result: PaginatedResult = Depends(with_pagination),
 ):
     query = session.query(UserEntity)
@@ -116,7 +115,6 @@ from fastapi_sqla import (
     PaginatedResult,
     Pagination,
     Session,
-    with_session,
 )
 from pydantic import BaseModel
 from sqlalchemy import func
@@ -147,7 +145,7 @@ with_custom_pagination = Pagination(
 
 @router.get("/users", response_model=Paginated[User])
 def all_users(
-    session: Session = Depends(with_session),
+    session: Session = Depends(),
     paginated_result: PaginatedResult = Depends(with_custom_pagination),
 ):
     query = session.query(UserEntity)

fastapi_sqla/__init__.py

@@ -12,9 +12,9 @@
 from sqlalchemy import engine_from_config
 from sqlalchemy.ext.declarative import DeferredReflection, declarative_base
 from sqlalchemy.orm import Query as DbQuery
-from sqlalchemy.orm.session import Session, sessionmaker
+from sqlalchemy.orm.session import Session as SqlaSession, sessionmaker
 
-__all__ = ["Base", "setup", "with_session"]
+__all__ = ["Base", "Session", "setup"]
 
 logger = structlog.get_logger(__name__)
 
@@ -40,6 +40,29 @@ class Base(declarative_base(cls=DeferredReflection)):  # type: ignore
     __abstract__ = True
 
 
+class Session(SqlaSession):
+    def __new__(cls, request: Request) -> SqlaSession:
+        """Yield the sqlalchmey session for that request.
+
+        It is meant to be used as a FastAPI dependency::
+
+            from fastapi import APIRouter, Depends
+            from fastapi_sqla import Session
+
+            router = APIRouter()
+
+            @router.get("/users")
+            def get_users(session: Session = Depends()):
+                pass
+        """
+        try:
+            return request.scope[_SESSION_KEY]
+        except KeyError:  # pragma: no cover
+            raise Exception(
+                "No session found in request, please ensure you've setup fastapi_sqla."
+            )
+
+
 @contextmanager
 def open_session() -> Session:
     """Context manager that opens a session and properly closes session when exiting.
@@ -63,28 +86,6 @@ def open_session() -> Session:
         session.close()
 
 
-def with_session(request: Request) -> Session:
-    """Yield the sqlalchmey session for that request.
-
-    It is meant to be used as a FastAPI® dependency::
-
-        from er import sqla
-        from fastapi import APIRouter, Depends
-
-        router = APIRouter()
-
-        @router.get("/users")
-        def get_users(db: sqla.Session = Depends(sqla.with_session)):
-            pass
-    """
-    try:
-        yield request.scope[_SESSION_KEY]
-    except KeyError:  # pragma: no cover
-        raise Exception(
-            "No session found in request, please ensure you've setup fastapi_sqla."
-        )
-
-
 async def add_session_to_request(request: Request, call_next):
     """Middleware which injects a new sqla session into every request.
 
@@ -165,7 +166,7 @@ def Pagination(
     query_count: Callable[[Session, DbQuery], int] = _query_count,
 ) -> Callable[[Session, int, int], PaginatedResult]:
     def dependency(
-        session: Session = Depends(with_session),
+        session: Session = Depends(),
         offset: int = Query(0, ge=0),
         limit: int = Query(min_page_size, ge=1, le=max_page_size),
     ) -> PaginatedResult:

tests/test_middleware.py

@@ -37,7 +37,7 @@ class User(Base):
 
 @fixture
 def app(User):
-    from fastapi_sqla import setup, with_session
+    from fastapi_sqla import Session, setup
 
     app = FastAPI()
     setup(app)
@@ -48,7 +48,7 @@ class UserIn(BaseModel):
         last_name: str
 
     @app.post("/users")
-    def create_user(user: UserIn, session=Depends(with_session)):
+    def create_user(user: UserIn, session: Session = Depends()):
         session.add(User(**user.dict()))
         return {}
 

tests/test_pagination.py

@@ -113,7 +113,7 @@ def test_Pagination_with_custom_count(
 def app(user_cls, note_cls):
     from sqlalchemy.orm import joinedload
 
-    from fastapi_sqla import Paginated, Session, setup, with_pagination, with_session
+    from fastapi_sqla import Paginated, Session, setup, with_pagination
 
     app = FastAPI()
     setup(app)
@@ -129,7 +129,7 @@ class User(BaseModel):
 
     @app.get("/users")
     def all_users(
-        session: Session = Depends(with_session),
+        session: Session = Depends(),
         paginated_result=Depends(with_pagination),
         reponse_model=Paginated[User],
     ):