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

fastapi_sqla/__init__.py

@@ -1,4 +1,4 @@
-from fastapi_sqla.base import setup
+from fastapi_sqla.base import setup, setup_middlewares, startup
 from fastapi_sqla.models import Collection, Item, Page
 from fastapi_sqla.pagination import Paginate, PaginateSignature, Pagination
 from fastapi_sqla.sqla import (
@@ -22,6 +22,8 @@ __all__ = [
     "SqlaSession",
     "open_session",
     "setup",
+    "setup_middlewares",
+    "startup",
 ]
 
 

fastapi_sqla/_pytest_plugin.py

@@ -28,7 +28,6 @@ def db_host():
     When CI key is set in environment variables, it uses `postgres` as host name else,
     host used is `localhost`
     """
-
     return "postgres" if "CI" in os.environ else "localhost"
 
 
@@ -38,7 +37,6 @@ def db_user():
 
     postgres
     """
-
     return "postgres"
 
 
@@ -48,7 +46,6 @@ def db_url(db_host, db_user):
 
     db url example postgresql://{db_user}@{db_host}/postgres
     """
-
     return f"postgresql://{db_user}@{db_host}/postgres"
 
 
@@ -107,7 +104,6 @@ def sqla_reflection(sqla_modules, sqla_connection):
 @fixture
 def patch_engine_from_config(request, sqla_connection):
     """So that all DB operations are never written to db for real."""
-
     if "dont_patch_engines" in request.keywords:
         yield
     else:
@@ -153,7 +149,7 @@ def async_sqlalchemy_url(db_url):
     return format_async_async_sqlalchemy_url(db_url)
 
 
-if asyncio_support:  # noqa: C901
+if asyncio_support:
 
     @fixture
     def async_engine(async_sqlalchemy_url):
@@ -167,7 +163,6 @@ if asyncio_support:  # noqa: C901
     @fixture
     async def patch_new_engine(request, async_sqla_connection):
         """So that all async DB operations are never written to db for real."""
-
         if "dont_patch_engines" in request.keywords:
             yield
         else:

fastapi_sqla/async_pagination.py

@@ -1,6 +1,6 @@
 import math
-from collections.abc import Awaitable, Callable
-from typing import Annotated, Iterator, Optional, Union, cast
+from collections.abc import Awaitable, Callable, Iterator
+from typing import Annotated, Optional, Union, cast
 
 from fastapi import Depends, Query
 from sqlalchemy.sql import Select, func, select

fastapi_sqla/aws_rds_iam_support.py

@@ -20,7 +20,8 @@ def setup(engine: Engine):
     aws_rds_iam_enabled = lc_environ.get("fastapi_sqla_aws_rds_iam_enabled") == "true"
 
     if aws_rds_iam_enabled:
-        assert boto3_installed, boto3_installed_err
+        if not boto3_installed:
+            raise ImportError(f"boto3 is required for RDS IAM : {boto3_installed_err}")
         # Cache the client at startup
         get_rds_client()
         event.listen(engine, "do_connect", set_connection_token)

fastapi_sqla/base.py

@@ -2,6 +2,7 @@ import functools
 import os
 import re
 
+from deprecated import deprecated
 from fastapi import FastAPI
 from sqlalchemy.engine import Engine
 
@@ -20,6 +21,33 @@ except ImportError as err:  # pragma: no cover
 _ENGINE_KEYS_REGEX = re.compile(r"fastapi_sqla__(?!_)(.+)(?<!_)__(?!_).+")
 
 
+async def startup():
+    engine_keys = _get_engine_keys()
+    engines = {key: sqla.new_engine(key) for key in engine_keys}
+    for key, engine in engines.items():
+        if not _is_async_dialect(engine):
+            sqla.startup(key=key)
+        else:
+            await async_sqla.startup(key=key)
+
+
+def setup_middlewares(app: FastAPI):
+    engine_keys = _get_engine_keys()
+    engines = {key: sqla.new_engine(key) for key in engine_keys}
+    for key, engine in engines.items():
+        if not _is_async_dialect(engine):
+            app.middleware("http")(
+                functools.partial(sqla.add_session_to_request, key=key)
+            )
+        else:
+            app.middleware("http")(
+                functools.partial(async_sqla.add_session_to_request, key=key)
+            )
+
+
+@deprecated(
+    reason="FastAPI events are deprecated. This function will be remove in the upcoming major release."  # noqa: E501
+)
 def setup(app: FastAPI):
     engine_keys = _get_engine_keys()
     engines = {key: sqla.new_engine(key) for key in engine_keys}
@@ -30,7 +58,6 @@ def setup(app: FastAPI):
                 functools.partial(sqla.add_session_to_request, key=key)
             )
         else:
-            assert has_asyncio_support, asyncio_support_err
             app.add_event_handler(
                 "startup", functools.partial(async_sqla.startup, key=key)
             )

fastapi_sqla/models.py

@@ -3,7 +3,7 @@ from typing import Generic, TypeVar
 from pydantic import BaseModel, Field
 from pydantic import __version__ as pydantic_version
 
-major, _, _ = [int(v) for v in pydantic_version.split(".")]
+major, _, _ = (int(v) for v in pydantic_version.split("."))
 is_pydantic2 = major == 2
 if is_pydantic2:
     GenericModel = BaseModel

fastapi_sqla/pagination.py

@@ -1,7 +1,7 @@
 import math
-from collections.abc import Callable
+from collections.abc import Callable, Iterator
 from functools import singledispatch
-from typing import Annotated, Iterator, Optional, Union, cast
+from typing import Annotated, Optional, Union, cast
 
 from fastapi import Depends, Query
 from sqlalchemy.orm import Query as LegacyQuery
@@ -52,7 +52,7 @@ def paginate_query(
     limit: int,
     scalars: bool = True,
 ) -> Page:  # pragma: no cover
-    "Dispatch on registered functions based on `query` type"
+    """Dispatch on registered functions based on `query` type"""
     raise NotImplementedError(f"no paginate_query registered for type {type(query)!r}")
 
 

fastapi_sqla/sqla.py

@@ -24,7 +24,7 @@ except ImportError:
     DeclarativeBase = declarative_base()  # type: ignore
 
 try:
-    from sqlmodel import Session as SqlaSession  # type: ignore  # noqa
+    from sqlmodel import Session as SqlaSession  # type: ignore
 
 except ImportError:
     pass

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastapi-sqla
-Version: 3.1.2
+Version: 3.3.0
 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
@@ -22,6 +22,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: SQL
 Classifier: Topic :: Internet
@@ -40,20 +41,19 @@ Requires-Dist: Faker (>=14.2.0,<15.0.0) ; extra == "tests"
 Requires-Dist: alembic (>=1.4.3,<2.0.0) ; extra == "tests"
 Requires-Dist: asgi_lifespan (>=1.0.1,<2.0.0) ; extra == "tests"
 Requires-Dist: asyncpg (>=0.28.0,<0.29.0) ; extra == "asyncpg"
-Requires-Dist: black (>=22.8.0,<23.0.0) ; extra == "tests"
 Requires-Dist: boto3 (>=1.24.74,<2.0.0) ; extra == "aws-rds-iam"
+Requires-Dist: deprecated (>=1.2)
 Requires-Dist: fastapi (>=0.95.1)
-Requires-Dist: greenlet (>=1.1.3,<2.0.0) ; extra == "tests"
+Requires-Dist: greenlet (>=3.0.3,<4.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] (>=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)
-Requires-Dist: pylama (>=8.4.1,<9.0.0) ; extra == "tests"
 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: ruff (>=0.4.5,<0.5.0) ; extra == "tests"
 Requires-Dist: sqlalchemy (>=1.3)
 Requires-Dist: sqlmodel (>=0.0.14,<0.0.15) ; extra == "sqlmodel"
 Requires-Dist: structlog (>=20)
@@ -90,15 +90,22 @@ unique `email`:
 
 ```python
 # main.py
+from contextlib import asynccontextmanager
 from fastapi import FastAPI, HTTPException
-from fastapi_sqla import Base, Item, Page, Paginate, Session, setup
+from fastapi_sqla import Base, Item, Page, Paginate, Session, setup_middlewares, startup
 from pydantic import BaseModel, EmailStr
 from sqlalchemy import select
 from sqlalchemy.exc import IntegrityError
 
-app = FastAPI()
 
-setup(app)
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    await startup()
+    yield
+
+
+app = FastAPI(lifespan=lifespan)
+setup_middlewares(app)
 
 
 class User(Base):
@@ -203,7 +210,23 @@ And define the environment variable `sqlalchemy_url` with `postgres+asyncpg` sch
 export sqlalchemy_url=postgresql+asyncpg://postgres@localhost
 ```
 
-## Setup the app:
+## Setup the app AsyncContextManager (recommended):
+
+```python
+import fastapi_sqla
+from fastapi import FastAPI
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    await fastapi_sqla.startup()
+    yield
+
+
+app = FastAPI(lifespan=lifespan)
+fastapi_sqla.setup_middlewares(app)
+```
+
+## Setup the app using startup/shutdown events (deprecated):
 
 ```python
 import fastapi_sqla

fastapi_sqla-3.3.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+fastapi_sqla/__init__.py,sha256=RRkwo9xZzidQ-k3BRXfqT0jtWm8d08w94XuOLteFCdU,1221
+fastapi_sqla/_pytest_plugin.py,sha256=IQUlj-O874Sfuth254LBrEBGCrwH3rNHST9OMZl2pIk,5411
+fastapi_sqla/async_pagination.py,sha256=3DHGUjvrpkbWMIc_BEX4GvM-_PTcn62K9z48ucTJlH0,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=Uw-XaiwShMMWYKCvlSqXoxvtKMblCAvbCZ1m6BYVpJk,1257
+fastapi_sqla/base.py,sha256=8XHIKO8sBOmnRvCsOYRWhg5Y-XYqobM5DypeIMvJTFs,2501
+fastapi_sqla/models.py,sha256=-B1xwINpTc9rEQd3KYHEC1s5s7jdVQkJ6Gy6xpmT13c,1108
+fastapi_sqla/pagination.py,sha256=1gfIGcmt1OFspbRgtJ8AZOZdFd14DGRc4FkDgyh5bJ8,4517
+fastapi_sqla/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fastapi_sqla/sqla.py,sha256=irHuZaun027o9WJrdcZPavCN2vXNHupCWYhU5Dx-AqE,6348
+fastapi_sqla-3.3.0.dist-info/LICENSE,sha256=8G0-nWLqi3xRYRrtRlTE8n1mkYJcnCRoZGUhv6ZE29c,1064
+fastapi_sqla-3.3.0.dist-info/METADATA,sha256=sNlfIYlzk2w8fmVxJh8jsOinZLJHrmOgWMLCZi4DV4o,21391
+fastapi_sqla-3.3.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+fastapi_sqla-3.3.0.dist-info/entry_points.txt,sha256=haa0EueKcRo8-AlJTpHBMn08wMBiULNGA53nkvaDWj0,53
+fastapi_sqla-3.3.0.dist-info/RECORD,,

{fastapi_sqla-3.1.2.dist-info → fastapi_sqla-3.3.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.6.1
+Generator: poetry-core 1.9.0
 Root-Is-Purelib: true
 Tag: py3-none-any

fastapi_sqla-3.1.2.dist-info/RECORD

@@ -1,16 +0,0 @@
-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,,