fastapi-sqla 3.2.1__py3-none-any.whl → 3.3.1__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/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}

{fastapi_sqla-3.2.1.dist-info → fastapi_sqla-3.3.1.dist-info}/METADATA

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: fastapi-sqla
-Version: 3.2.1
+Version: 3.3.1
 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
 Author: Hadrien David
 Author-email: hadrien.david@dialogue.co
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.9,<3.13
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Web Environment
 Classifier: Framework :: AsyncIO
@@ -35,28 +35,19 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
 Provides-Extra: asyncpg
 Provides-Extra: aws-rds-iam
+Provides-Extra: psycopg2
+Provides-Extra: pytest-plugin
 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"
-Requires-Dist: asgi_lifespan (>=1.0.1,<2.0.0) ; extra == "tests"
+Requires-Dist: alembic (>=1.4.3,<2.0.0) ; extra == "pytest-plugin"
 Requires-Dist: asyncpg (>=0.28.0,<0.29.0) ; extra == "asyncpg"
 Requires-Dist: boto3 (>=1.24.74,<2.0.0) ; extra == "aws-rds-iam"
-Requires-Dist: fastapi (>=0.95.1)
-Requires-Dist: greenlet (>=3.0.3,<4.0.0) ; extra == "tests"
-Requires-Dist: httpx (>=0.23.0,<0.24.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: 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: deprecated (>=1.2,<2.0)
+Requires-Dist: fastapi (>=0.95.1,<0.112)
+Requires-Dist: psycopg2 (>=2.8.6,<3.0.0) ; extra == "psycopg2"
+Requires-Dist: pydantic (>=1,<3)
+Requires-Dist: sqlalchemy (>=1.3,<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"
+Requires-Dist: structlog (>=20,<25)
 Project-URL: Repository, https://github.com/dialoguemd/fastapi-sqla
 Description-Content-Type: text/markdown
 
@@ -82,6 +73,8 @@ Using [pip](https://pip.pypa.io/):
 pip install fastapi-sqla
 ```
 
+Note that you need a [SQLAlchemy compatible engine](https://docs.sqlalchemy.org/en/20/core/engines.html) adapter. We test with `psycopg2` which you can install using the `psycopg2` extra.
+
 # Quick Example
 
 Assuming it runs against a DB with a table `user` with 3 columns, `id`, `name` and
@@ -89,15 +82,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):
@@ -202,7 +202,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
@@ -639,7 +655,7 @@ If your project uses [SQLModel], then `Session` dependency is an SQLModel sessio
 # Pytest fixtures
 
 This library provides a set of utility fixtures, through its PyTest plugin, which is
-automatically installed with the library.
+automatically installed with the library. Using the plugin requires the `pytest_plugin` extra.
 
 By default, no records are actually written to the database when running tests.
 There currently is no way to change this behaviour.
@@ -783,7 +799,7 @@ It returns the path of  `alembic.ini` configuration file. By default, it returns
 ## Setup
 
 ```bash
-$ poetry install --extras tests --extras asyncpg --extras aws_rds_iam
+$ poetry install --all-extras
 ```
 
 ## Running tests

{fastapi_sqla-3.2.1.dist-info → fastapi_sqla-3.3.1.dist-info}/RECORD

@@ -1,16 +1,16 @@
-fastapi_sqla/__init__.py,sha256=G9bKR6L9EnLgzelE_BLnHgc1cOm0Yu0wMzwLAdyA8iE,1153
+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=ssgt-EU7KrRg3IfvXoEZdCsDE4uQVhOVTFuamMmw-Kk,1546
+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.2.1.dist-info/LICENSE,sha256=8G0-nWLqi3xRYRrtRlTE8n1mkYJcnCRoZGUhv6ZE29c,1064
-fastapi_sqla-3.2.1.dist-info/METADATA,sha256=48-YxU0G8S7GR5zDMrLLgRY5LyMA7v0ku29SiEnqihA,20848
-fastapi_sqla-3.2.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-fastapi_sqla-3.2.1.dist-info/entry_points.txt,sha256=haa0EueKcRo8-AlJTpHBMn08wMBiULNGA53nkvaDWj0,53
-fastapi_sqla-3.2.1.dist-info/RECORD,,
+fastapi_sqla-3.3.1.dist-info/LICENSE,sha256=8G0-nWLqi3xRYRrtRlTE8n1mkYJcnCRoZGUhv6ZE29c,1064
+fastapi_sqla-3.3.1.dist-info/METADATA,sha256=fBq_qZ1JGhyzpjZGr30nYp4tgFNI4QvPIY26WvPdRi8,20994
+fastapi_sqla-3.3.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+fastapi_sqla-3.3.1.dist-info/entry_points.txt,sha256=haa0EueKcRo8-AlJTpHBMn08wMBiULNGA53nkvaDWj0,53
+fastapi_sqla-3.3.1.dist-info/RECORD,,