fastapi-sqla 3.0.2__py3-none-any.whl → 3.1.2__py3-none-any.whl

fastapi_sqla/__init__.py

@@ -1,7 +1,13 @@
 from fastapi_sqla.base import setup
-from fastapi_sqla.models import Base, Collection, Item, Page
+from fastapi_sqla.models import Collection, Item, Page
 from fastapi_sqla.pagination import Paginate, PaginateSignature, Pagination
-from fastapi_sqla.sqla import Session, SessionDependency, SqlaSession, open_session
+from fastapi_sqla.sqla import (
+    Base,
+    Session,
+    SessionDependency,
+    SqlaSession,
+    open_session,
+)
 
 __all__ = [
     "Base",

fastapi_sqla/async_pagination.py

@@ -6,7 +6,7 @@ from fastapi import Depends, Query
 from sqlalchemy.sql import Select, func, select
 
 from fastapi_sqla.async_sqla import AsyncSessionDependency, SqlaAsyncSession
-from fastapi_sqla.models import Page
+from fastapi_sqla.models import Meta, Page
 from fastapi_sqla.sqla import _DEFAULT_SESSION_KEY
 
 QueryCountDependency = Callable[..., Awaitable[int]]
@@ -33,20 +33,20 @@ async def paginate_query(
     scalars: bool = True,
 ) -> Page:
     total_pages = math.ceil(total_items / limit)
-    page_number = offset / limit + 1
+    page_number = math.floor(offset / limit + 1)
     query = query.offset(offset).limit(limit)
     result = await session.execute(query)
     data = iter(
         cast(Iterator, result.unique().scalars() if scalars else result.mappings())
     )
     return Page(
-        data=data,
-        meta={
-            "offset": offset,
-            "total_items": total_items,
-            "total_pages": total_pages,
-            "page_number": page_number,
-        },
+        data=data,  # type: ignore # Expected to be a list
+        meta=Meta(
+            offset=offset,
+            total_items=total_items,
+            total_pages=total_pages,
+            page_number=page_number,
+        ),
     )
 
 

fastapi_sqla/async_sqla.py

@@ -11,8 +11,7 @@ from sqlalchemy.ext.asyncio import AsyncSession as SqlaAsyncSession
 from sqlalchemy.orm.session import sessionmaker
 
 from fastapi_sqla import aws_aurora_support, aws_rds_iam_support
-from fastapi_sqla.models import Base
-from fastapi_sqla.sqla import _DEFAULT_SESSION_KEY, new_engine
+from fastapi_sqla.sqla import _DEFAULT_SESSION_KEY, Base, new_engine
 
 logger = structlog.get_logger(__name__)
 

fastapi_sqla/models.py

@@ -2,14 +2,6 @@ from typing import Generic, TypeVar
 
 from pydantic import BaseModel, Field
 from pydantic import __version__ as pydantic_version
-from sqlalchemy.ext.declarative import DeferredReflection
-
-try:
-    from sqlalchemy.orm import DeclarativeBase
-except ImportError:
-    from sqlalchemy.ext.declarative import declarative_base
-
-    DeclarativeBase = declarative_base()  # type: ignore
 
 major, _, _ = [int(v) for v in pydantic_version.split(".")]
 is_pydantic2 = major == 2
@@ -19,10 +11,6 @@ else:
     from pydantic.generics import GenericModel  # type:ignore
 
 
-class Base(DeclarativeBase, DeferredReflection):
-    __abstract__ = True
-
-
 ItemT = TypeVar("ItemT")
 
 

fastapi_sqla/pagination.py

@@ -7,7 +7,7 @@ from fastapi import Depends, Query
 from sqlalchemy.orm import Query as LegacyQuery
 from sqlalchemy.sql import Select, func, select
 
-from fastapi_sqla.models import Page
+from fastapi_sqla.models import Meta, Page
 from fastapi_sqla.sqla import _DEFAULT_SESSION_KEY, SessionDependency, SqlaSession
 
 DbQuery = Union[LegacyQuery, Select]
@@ -66,15 +66,15 @@ def _paginate_legacy(
     scalars: bool = True,
 ) -> Page:
     total_pages = math.ceil(total_items / limit)
-    page_number = offset / limit + 1
+    page_number = math.floor(offset / limit + 1)
     return Page(
         data=query.offset(offset).limit(limit).all(),
-        meta={
-            "offset": offset,
-            "total_items": total_items,
-            "total_pages": total_pages,
-            "page_number": page_number,
-        },
+        meta=Meta(
+            offset=offset,
+            total_items=total_items,
+            total_pages=total_pages,
+            page_number=page_number,
+        ),
     )
 
 
@@ -89,20 +89,20 @@ def _paginate(
     scalars: bool = True,
 ) -> Page:
     total_pages = math.ceil(total_items / limit)
-    page_number = offset / limit + 1
+    page_number = math.floor(offset / limit + 1)
     query = query.offset(offset).limit(limit)
     result = session.execute(query)
     data = iter(
         cast(Iterator, result.unique().scalars() if scalars else result.mappings())
     )
     return Page(
-        data=data,
-        meta={
-            "offset": offset,
-            "total_items": total_items,
-            "total_pages": total_pages,
-            "page_number": page_number,
-        },
+        data=data,  # type: ignore # Expected to be a list
+        meta=Meta(
+            offset=offset,
+            total_items=total_items,
+            total_pages=total_pages,
+            page_number=page_number,
+        ),
     )
 
 

fastapi_sqla/sqla.py

@@ -10,11 +10,25 @@ from fastapi.concurrency import contextmanager_in_threadpool
 from fastapi.responses import PlainTextResponse
 from sqlalchemy import engine_from_config, text
 from sqlalchemy.engine import Engine
+from sqlalchemy.ext.declarative import DeferredReflection
 from sqlalchemy.orm.session import Session as SqlaSession
 from sqlalchemy.orm.session import sessionmaker
 
 from fastapi_sqla import aws_aurora_support, aws_rds_iam_support
-from fastapi_sqla.models import Base
+
+try:
+    from sqlalchemy.orm import DeclarativeBase
+except ImportError:
+    from sqlalchemy.ext.declarative import declarative_base
+
+    DeclarativeBase = declarative_base()  # type: ignore
+
+try:
+    from sqlmodel import Session as SqlaSession  # type: ignore  # noqa
+
+except ImportError:
+    pass
+
 
 logger = structlog.get_logger(__name__)
 
@@ -23,6 +37,10 @@ _REQUEST_SESSION_KEY = "fastapi_sqla_session"
 _session_factories: dict[str, sessionmaker] = {}
 
 
+class Base(DeclarativeBase, DeferredReflection):
+    __abstract__ = True
+
+
 def new_engine(key: str = _DEFAULT_SESSION_KEY) -> Engine:
     envvar_prefix = "sqlalchemy_"
     if key != _DEFAULT_SESSION_KEY:
@@ -50,7 +68,8 @@ def startup(key: str = _DEFAULT_SESSION_KEY):
         raise
 
     Base.prepare(engine)
-    _session_factories[key] = sessionmaker(bind=engine)
+
+    _session_factories[key] = sessionmaker(bind=engine, class_=SqlaSession)
 
     logger.info("engine startup", engine_key=key, engine=engine)
 

{fastapi_sqla-3.0.2.dist-info → fastapi_sqla-3.1.2.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: fastapi-sqla
-Version: 3.0.2
-Summary: SQLAlchemy extension for FastAPI with support for pagination, asyncio, and pytest, ready for production.
+Version: 3.1.2
+Summary: SQLAlchemy extension for FastAPI with support for pagination, asyncio, SQLModel, and pytest, ready for production.
 Home-page: https://github.com/dialoguemd/fastapi-sqla
 License: MIT
 Keywords: FastAPI,SQLAlchemy,asyncio,pytest,alembic
@@ -34,6 +34,7 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
 Provides-Extra: asyncpg
 Provides-Extra: aws-rds-iam
+Provides-Extra: sqlmodel
 Provides-Extra: tests
 Requires-Dist: Faker (>=14.2.0,<15.0.0) ; extra == "tests"
 Requires-Dist: alembic (>=1.4.3,<2.0.0) ; extra == "tests"
@@ -45,7 +46,7 @@ Requires-Dist: fastapi (>=0.95.1)
 Requires-Dist: greenlet (>=1.1.3,<2.0.0) ; extra == "tests"
 Requires-Dist: httpx (>=0.23.0,<0.24.0) ; extra == "tests"
 Requires-Dist: isort (>=5.5.3,<6.0.0) ; extra == "tests"
-Requires-Dist: mypy[tests] (>=0.991,<0.992) ; extra == "tests"
+Requires-Dist: mypy[tests] (>=1.0.0,<2.0.0) ; extra == "tests"
 Requires-Dist: pdbpp (>=0.10.2,<0.11.0) ; extra == "tests"
 Requires-Dist: psycopg2 (>=2.8.6,<3.0.0) ; extra == "tests"
 Requires-Dist: pydantic (>=1)
@@ -54,6 +55,7 @@ Requires-Dist: pytest (>=7.2.1,<8.0.0) ; extra == "tests"
 Requires-Dist: pytest-asyncio (>=0.19.0,<0.20.0) ; extra == "tests"
 Requires-Dist: pytest-cov (>=2.10.1,<3.0.0) ; extra == "tests"
 Requires-Dist: sqlalchemy (>=1.3)
+Requires-Dist: sqlmodel (>=0.0.14,<0.0.15) ; extra == "sqlmodel"
 Requires-Dist: structlog (>=20)
 Requires-Dist: tox (>=3.26.0,<4.0.0) ; extra == "tests"
 Project-URL: Repository, https://github.com/dialoguemd/fastapi-sqla
@@ -69,7 +71,7 @@ Description-Content-Type: text/markdown
 
 
 Fastapi-SQLA is an [SQLAlchemy] extension for [FastAPI] easy to setup with support for
-pagination, asyncio, and [pytest].
+pagination, asyncio, [SQLModel] and [pytest].
 It supports SQLAlchemy>=1.3 and is fully compliant with [SQLAlchemy 2.0].
 It is developped, maintained and used on production by the team at [@dialoguemd] with
 love from Montreal 🇨🇦.
@@ -600,6 +602,41 @@ async def async_all_users_alt(
     return await paginate(select(User))
 ```
 
+# SQLModel support 🎉
+
+If your project uses [SQLModel], then `Session` dependency is an SQLModel session::
+
+```python
+    from http import HTTPStatus
+
+    from fastapi import FastAPI, HTTPException
+    from fastapi_sqla import Item, Page, Paginate, Session, setup
+    from sqlmodel import Field, SQLModel, select
+
+    class Hero(SQLModel, table=True):
+        id: int | None = Field(default=None, primary_key=True)
+        name: str
+        secret_name: str
+        age: int | None = None
+
+
+    app = FastAPI()
+    setup(app)
+
+    @app.get("/heros", response_model=Page[Hero])
+    def list_hero(paginate: Paginate) -> Page[Hero]:
+        return paginate(select(Hero))
+
+
+    @app.get("/heros/{hero_id}", response_model=Item[Hero])
+    def get_hero(hero_id: int, session: Session) -> Item[Hero]:
+        hero = session.get(Hero, hero_id)
+        if hero is None:
+            raise HTTPException(HTTPStatus.NOT_FOUND)
+        return {"data": hero}
+
+```
+
 # Pytest fixtures
 
 This library provides a set of utility fixtures, through its PyTest plugin, which is
@@ -770,6 +807,7 @@ $ poetry run tox
 [FastAPI background tasks]: https://fastapi.tiangolo.com/tutorial/background-tasks/
 [SQLAlchemy]: http://sqlalchemy.org/
 [SQLAlchemy 2.0]: https://docs.sqlalchemy.org/en/20/changelog/migration_20.html
+[SQLModel]: https://sqlmodel.tiangolo.com
 [`asyncpg`]: https://magicstack.github.io/asyncpg/current/
 [scalars]: https://docs.sqlalchemy.org/en/20/core/connections.html#sqlalchemy.engine.Result.scalars
 [alembic]: https://alembic.sqlalchemy.org/

fastapi_sqla-3.1.2.dist-info/RECORD

@@ -0,0 +1,16 @@
+fastapi_sqla/__init__.py,sha256=G9bKR6L9EnLgzelE_BLnHgc1cOm0Yu0wMzwLAdyA8iE,1153
+fastapi_sqla/_pytest_plugin.py,sha256=bjPzOuwk32Zo4hoOa_bGjTGhtHGPImh3RyiORqz-J84,5430
+fastapi_sqla/async_pagination.py,sha256=jYeZYtIi7mssM3MfwobOoaPYNZF0BE1EmCK8CqFnwOg,3164
+fastapi_sqla/async_sqla.py,sha256=7SXRH3DMsQvpjCQdvCBEjQhDZ4-cPAg175MlgNVBnCg,5888
+fastapi_sqla/aws_aurora_support.py,sha256=4dxLKOqDccgLwFqlz81L6f4HzrOXMZkY7Zuf4t_310U,838
+fastapi_sqla/aws_rds_iam_support.py,sha256=YSJNhrxmhGN-GVk9PLMTmQSWTKZBvuorKkhc_XaoL44,1189
+fastapi_sqla/base.py,sha256=0X7Gbt49rBHPiSFmNy5S2PT0dA4UBNnwrAesYSkaHBc,1606
+fastapi_sqla/models.py,sha256=fesW7BqkwOA4iC345dbybzcV8Kz4-kLwREo38oqy_7A,1108
+fastapi_sqla/pagination.py,sha256=IjbKFyUHly8jHyOO4pnyPK4RE_cFRDY03OOZeZEm3cY,4513
+fastapi_sqla/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fastapi_sqla/sqla.py,sha256=lOikCu_BjGQYfbbtcM59ZjwTL-66cM9L_yIbCEQasAQ,6356
+fastapi_sqla-3.1.2.dist-info/LICENSE,sha256=8G0-nWLqi3xRYRrtRlTE8n1mkYJcnCRoZGUhv6ZE29c,1064
+fastapi_sqla-3.1.2.dist-info/METADATA,sha256=xl5jfdozvDDEJGHW0fe9bFm_ITasdlzYb3NThMDveNk,20915
+fastapi_sqla-3.1.2.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+fastapi_sqla-3.1.2.dist-info/entry_points.txt,sha256=haa0EueKcRo8-AlJTpHBMn08wMBiULNGA53nkvaDWj0,53
+fastapi_sqla-3.1.2.dist-info/RECORD,,

fastapi_sqla-3.0.2.dist-info/RECORD

@@ -1,16 +0,0 @@
-fastapi_sqla/__init__.py,sha256=4-MHiYF6TclnQpgs2Z1KDwYe2OPHLHGEu5oJzV3494s,1128
-fastapi_sqla/_pytest_plugin.py,sha256=bjPzOuwk32Zo4hoOa_bGjTGhtHGPImh3RyiORqz-J84,5430
-fastapi_sqla/async_pagination.py,sha256=UA3KxkTa48utBFDHeAkOFxTGUIvtNEWKm4uH-bqzQH4,3114
-fastapi_sqla/async_sqla.py,sha256=BERggjeIjBW9hPqVxE7ry3iQyjBFc9KLvDGwV_LOfK8,5919
-fastapi_sqla/aws_aurora_support.py,sha256=4dxLKOqDccgLwFqlz81L6f4HzrOXMZkY7Zuf4t_310U,838
-fastapi_sqla/aws_rds_iam_support.py,sha256=YSJNhrxmhGN-GVk9PLMTmQSWTKZBvuorKkhc_XaoL44,1189
-fastapi_sqla/base.py,sha256=0X7Gbt49rBHPiSFmNy5S2PT0dA4UBNnwrAesYSkaHBc,1606
-fastapi_sqla/models.py,sha256=QhnPCX-Gz5exAZfWyCRyYSaZ7SM_8QY0Eir6b4_4oI8,1432
-fastapi_sqla/pagination.py,sha256=NsI4ZeOkgbiNNDBjtqZL1rF6j1ya--jjXiyf0GlLaXU,4459
-fastapi_sqla/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fastapi_sqla/sqla.py,sha256=ih4JBAQzn-lT86jK5ZOX3tewT1UOrw2NUJauOso0mNg,5939
-fastapi_sqla-3.0.2.dist-info/LICENSE,sha256=8G0-nWLqi3xRYRrtRlTE8n1mkYJcnCRoZGUhv6ZE29c,1064
-fastapi_sqla-3.0.2.dist-info/METADATA,sha256=hS61rcvqSFKrKWkfN6y5xpLOTRhnbvi-j0OTa5gVVAY,19809
-fastapi_sqla-3.0.2.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-fastapi_sqla-3.0.2.dist-info/entry_points.txt,sha256=haa0EueKcRo8-AlJTpHBMn08wMBiULNGA53nkvaDWj0,53
-fastapi_sqla-3.0.2.dist-info/RECORD,,