fastapi-sqla 3.1.2__tar.gz → 3.2.1__tar.gz

{fastapi_sqla-3.1.2 → fastapi_sqla-3.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastapi-sqla
-Version: 3.1.2
+Version: 3.2.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
@@ -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,18 @@ 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: 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)

{fastapi_sqla-3.1.2 → fastapi_sqla-3.2.1}/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-3.1.2 → fastapi_sqla-3.2.1}/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-3.1.2 → fastapi_sqla-3.2.1}/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-3.1.2 → fastapi_sqla-3.2.1}/fastapi_sqla/base.py

@@ -30,7 +30,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-3.1.2 → fastapi_sqla-3.2.1}/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-3.1.2 → fastapi_sqla-3.2.1}/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-3.1.2 → fastapi_sqla-3.2.1}/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.2.1/pyproject.toml

@@ -0,0 +1,220 @@
+[tool.poetry]
+name = "fastapi-sqla"
+version = "3.2.1"
+description = "SQLAlchemy extension for FastAPI with support for pagination, asyncio, SQLModel, and pytest, ready for production."
+authors = [
+    "Hadrien David <hadrien.david@dialogue.co>",
+    "Victor Repkow <victor.repkow@dialogue.co>",
+]
+license = "MIT"
+readme = "README.md"
+repository = "https://github.com/dialoguemd/fastapi-sqla"
+keywords = ["FastAPI", "SQLAlchemy", "asyncio", "pytest", "alembic"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Web Environment",
+    "Framework :: AsyncIO",
+    "Framework :: FastAPI",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Information Technology",
+    "Intended Audience :: System Administrators",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python",
+    "Programming Language :: SQL",
+    "Topic :: Internet :: WWW/HTTP :: HTTP Servers",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Internet",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development",
+    "Typing :: Typed",
+]
+
+[tool.poetry.dependencies]
+python = "^3.9"
+fastapi = ">=0.95.1"
+pydantic = ">=1"
+sqlalchemy = ">=1.3"
+structlog = ">=20"
+
+alembic = { version = "^1.4.3", optional = true}
+asgi_lifespan = { version = "^1.0.1", optional = true}
+asyncpg = {version = "^0.28.0", optional = true}
+Faker = {version = "^14.2.0", optional = true}
+httpx = {version = "^0.23.0", optional = true}
+pdbpp = { version = "^0.10.2", optional = true}
+psycopg2 = { version = "^2.8.6", optional = true}
+pytest = {version = "^7.2.1", optional = true}
+pytest-asyncio = {version = "^0.19.0", optional = true}
+pytest-cov = { version = "^2.10.1", optional = true}
+ruff = {version = "^0.4.5", optional = true}
+tox = {version = "^3.26.0", optional = true}
+boto3 = {version = "^1.24.74", optional = true}
+greenlet = {version = "^3.0.3", optional = true}
+mypy = {version = "^1.0.0", extras = ["tests"], optional = true}
+sqlmodel = { version = "^0.0.14", optional = true }
+
+[tool.poetry.extras]
+# Test dependencies as extras so they can be set as extras in tox config
+# More info on https://github.com/python-poetry/poetry/issues/1941
+tests = [
+    "alembic",
+    "asgi_lifespan",
+    "coverage",
+    "Faker",
+    "greenlet",
+    "httpx",
+    "mypy",
+    "pdbpp",
+    "psycopg2",
+    "pytest",
+    "pytest-asyncio",
+    "pytest-cov",
+    "pytest-watch",
+    "ruff",
+    "tox",
+]
+asyncpg = ["asyncpg"]
+aws_rds_iam = ["boto3"]
+sqlmodel = ["sqlmodel"]
+
+[build-system]
+requires = ["poetry>=1.3.0"]
+build-backend = "poetry.masonry.api"
+
+[tool.semantic_release]
+version_toml = ["pyproject.toml:tool.poetry.version"]
+upload_to_pypi = false
+commit_message = "{version}\n\nVersion generated by python-semantic-release [ci skip]"
+
+[tool.poetry.plugins."pytest11"]
+fastapi-sqla = "fastapi_sqla._pytest_plugin"
+
+[tool.ruff]
+target-version = "py39"
+
+[tool.ruff.lint]
+select = [
+  "E", # pycodestyle
+  "W", # pycodestyle warnings
+  "F", # pyflakes
+  "I", # isort
+  "N", # pep8-naming
+  "D", # pydocstyle
+  "UP", # pyupgrade
+  "ASYNC", # flake8-async
+  "S", # flake8-bandit
+  "B", # flake8-bugbear
+  "C4", # flake8-comprehensions
+  "SIM", # flake8-simplify
+  "TD", # flake8-todos
+  "ERA", # eradicate
+  "PL", # pylint
+  "RUF" # ruff
+]
+
+# Ignore some pydocstyle rules that Google convention enables
+ignore = [
+  "D100",
+  "D101",
+  "D102",
+  "D103",
+  "D104",
+  "D105",
+  "D106",
+  "D107",
+  "D212",
+  "D415",
+  "B008", # Enable using functions in default function args. Easier to work with FastAPI dependencies that way
+  "C408", # Enable using dict/list/tuple
+  "PLR0911", # Disable max number of return
+  "PLR0912", # Disable max number of branches
+  "PLR0913", # Disable max number of args
+  "PLR0915", # Disable max number of statements
+  "PLR2004", # Enable magic values
+  "SIM105", # Allow using try - except - pass
+  "TD001", # Enable FIXMEs
+  "TD002", # Enable TODOs without author
+  "TD003", # Enable TODOs without issue link
+  "N802", # FastAPI dependency conventions is title cased
+  "N803", # Same as N802
+  "N806", # Same as N802
+]
+
+[tool.ruff.lint.extend-per-file-ignores]
+"tests/*" = [
+  "S101", # Enable assert
+  "S105", # Disable passwords check
+  "S106", # Disable passwords check
+  "S608", # Allow SQL string construction
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = "tests"
+norecursedirs = ".git,.venv"
+xfail_strict = "true"
+addopts = """
+    -p no:fastapi-sqla
+    --cov-config pyproject.toml
+    --cov-report term
+    --cov-report term-missing
+"""
+
+# https://nedbatchelder.com/blog/201810/why_warnings_is_mysterious.html
+filterwarnings = [
+    "error:.*removed in version 2.0.*:",
+]
+
+[tool.pytest-watch.run]
+ext = ".py, .yaml, .cfg"
+
+[tool.coverage.run]
+branch = true
+omit = [
+    "tests/*",
+    ".venv/*"
+]
+concurrency = ["thread", "greenlet"]
+
+[tool.coverage.report]
+skip_covered = true
+
+[tool.tox]
+legacy_tox_ini = """
+[tox]
+envlist = sqlalchemy{ 1.3, 1.4, 2.0, 2.0-sqlmodel }-{ asyncpg, noasyncpg }-{aws_rds_iam, noaws_rds_iam }-pydantic{ 1, 2 }
+
+[testenv]
+passenv = CI
+deps =
+    sqlalchemy1.3: sqlalchemy<1.4
+    sqlalchemy1.4: sqlalchemy>=1.4,<2
+    sqlalchemy2.0: sqlalchemy>=2
+    sqlalchemy2.0-sqlmodel: sqlalchemy>=2
+    sqlalchemy2.0-sqlmodel: sqlmodel
+    asyncpg: asyncpg
+    aws_rds_iam: boto3
+    pydantic1: pydantic<2
+    pydantic2: pydantic>=2
+
+extras =
+    tests
+
+commands = pytest -vv --cov={envsitepackagesdir}/fastapi_sqla --cov-report xml --cov-report html --junitxml=test-reports/pytest/junit.xml
+"""
+
+[tool.mypy]
+exclude = ["tests"]
+ignore_missing_imports = true
+plugins = "sqlalchemy.ext.mypy.plugin"

fastapi_sqla-3.1.2/pyproject.toml

@@ -1,132 +0,0 @@
-[tool]
-[tool.poetry]
-name = "fastapi-sqla"
-version = "3.1.2"
-description = "SQLAlchemy extension for FastAPI with support for pagination, asyncio, SQLModel, and pytest, ready for production."
-authors = ["Hadrien David <hadrien.david@dialogue.co>", "Victor Repkow <victor.repkow@dialogue.co>"]
-license = "MIT"
-readme = "README.md"
-repository = "https://github.com/dialoguemd/fastapi-sqla"
-keywords = ["FastAPI", "SQLAlchemy", "asyncio", "pytest", "alembic"]
-classifiers = ["Development Status :: 5 - Production/Stable", "Environment :: Web Environment", "Framework :: AsyncIO", "Framework :: FastAPI", "Intended Audience :: Developers", "Intended Audience :: Information Technology", "Intended Audience :: System Administrators", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.9", "Programming Language :: Python", "Programming Language :: SQL", "Topic :: Internet :: WWW/HTTP :: HTTP Servers", "Topic :: Internet :: WWW/HTTP", "Topic :: Internet", "Topic :: Software Development :: Libraries :: Application Frameworks", "Topic :: Software Development :: Libraries :: Python Modules", "Topic :: Software Development :: Libraries", "Topic :: Software Development", "Typing :: Typed"]
-[tool.poetry.dependencies]
-python = "^3.9"
-fastapi = ">=0.95.1"
-pydantic = ">=1"
-sqlalchemy = ">=1.3"
-structlog = ">=20"
-[tool.poetry.dependencies.alembic]
-version = "^1.4.3"
-optional = true
-[tool.poetry.dependencies.asgi_lifespan]
-version = "^1.0.1"
-optional = true
-[tool.poetry.dependencies.asyncpg]
-version = "^0.28.0"
-optional = true
-[tool.poetry.dependencies.black]
-version = "^22.8.0"
-optional = true
-[tool.poetry.dependencies.Faker]
-version = "^14.2.0"
-optional = true
-[tool.poetry.dependencies.httpx]
-version = "^0.23.0"
-optional = true
-[tool.poetry.dependencies.isort]
-version = "^5.5.3"
-optional = true
-[tool.poetry.dependencies.pdbpp]
-version = "^0.10.2"
-optional = true
-[tool.poetry.dependencies.psycopg2]
-version = "^2.8.6"
-optional = true
-[tool.poetry.dependencies.pylama]
-version = "^8.4.1"
-optional = true
-[tool.poetry.dependencies.pytest]
-version = "^7.2.1"
-optional = true
-[tool.poetry.dependencies.pytest-asyncio]
-version = "^0.19.0"
-optional = true
-[tool.poetry.dependencies.pytest-cov]
-version = "^2.10.1"
-optional = true
-[tool.poetry.dependencies.tox]
-version = "^3.26.0"
-optional = true
-[tool.poetry.dependencies.boto3]
-version = "^1.24.74"
-optional = true
-[tool.poetry.dependencies.greenlet]
-version = "^1.1.3"
-optional = true
-[tool.poetry.dependencies.mypy]
-version = "^1.0.0"
-extras = ["tests"]
-optional = true
-[tool.poetry.dependencies.sqlmodel]
-version = "^0.0.14"
-optional = true
-[tool.poetry.extras]
-tests = ["alembic", "asgi_lifespan", "black", "coverage", "Faker", "greenlet", "httpx", "isort", "mypy", "pdbpp", "psycopg2", "pylama", "pytest", "pytest-asyncio", "pytest-cov", "pytest-watch", "tox"]
-asyncpg = ["asyncpg"]
-aws_rds_iam = ["boto3"]
-sqlmodel = ["sqlmodel"]
-[tool.poetry.plugins]
-[tool.poetry.plugins.pytest11]
-fastapi-sqla = "fastapi_sqla._pytest_plugin"
-
-[[tool.poetry.source]]
-name = "dialogue-private"
-url = "https://dialogue-527641002329.d.codeartifact.us-east-1.amazonaws.com/pypi/distribution-readonly/simple/"
-default = true
-[tool.semantic_release]
-version_variable = "pyproject.toml:version"
-upload_to_pypi = false
-commit_message = "Version generated by python-semantic-release [ci skip]"
-[tool.pylama]
-paths = "fastapi_sqla tests"
-linters = "pycodestyle,mccabe,pyflakes"
-[tool.pylama.linter]
-[tool.pylama.linter.pycodestyle]
-max_line_length = 88
-[tool.isort]
-profile = "black"
-lines_between_sections = 1
-multi_line_output = 3
-include_trailing_comma = "True"
-line_length = 88
-[tool.pytest]
-[tool.pytest.ini_options]
-asyncio_mode = "auto"
-testpaths = "tests"
-norecursedirs = ".git,.venv"
-xfail_strict = "true"
-addopts = "    -p no:fastapi-sqla\n    --cov-config pyproject.toml\n    --cov-report term\n    --cov-report term-missing\n"
-filterwarnings = ["error:.*removed in version 2.0.*:"]
-[tool.pytest-watch]
-[tool.pytest-watch.run]
-ext = ".py, .yaml, .cfg"
-[tool.coverage]
-[tool.coverage.run]
-branch = true
-omit = ["tests/*", ".venv/*"]
-concurrency = ["thread", "greenlet"]
-[tool.coverage.report]
-skip_covered = true
-[tool.tox]
-legacy_tox_ini = "[tox]\nenvlist = sqlalchemy{ 1.3, 1.4, 2.0, 2.0-sqlmodel }-{ asyncpg, noasyncpg }-{aws_rds_iam, noaws_rds_iam }-pydantic{ 1, 2 }\n\n[testenv]\npassenv = CI\ndeps =\n    sqlalchemy1.3: sqlalchemy<1.4\n    sqlalchemy1.4: sqlalchemy>=1.4,<2\n    sqlalchemy2.0: sqlalchemy>=2\n    sqlalchemy2.0-sqlmodel: sqlalchemy>=2\n    sqlalchemy2.0-sqlmodel: sqlmodel\n    asyncpg: asyncpg\n    aws_rds_iam: boto3\n    pydantic1: pydantic<2\n    pydantic2: pydantic>=2\n\nextras =\n    tests\n\ncommands = pytest -vv --cov={envsitepackagesdir}/fastapi_sqla --cov-report xml --cov-report html --junitxml=test-reports/pytest/junit.xml\n"
-[tool.black]
-exclude = ".mypy_cache|.pytest_cache|.vscode|.eggs|venv"
---skip-magic-trailing-comma = true
-[tool.mypy]
-exclude = ["tests"]
-ignore_missing_imports = true
-plugins = "sqlalchemy.ext.mypy.plugin"
-
-[build-system]
-requires = ["poetry>=1.3.0"]
-build-backend = "poetry.masonry.api"