fastapi-rtk 2.1.0__tar.gz → 2.1.2__tar.gz

{fastapi_rtk-2.1.0 → fastapi_rtk-2.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-rtk
-Version: 2.1.0
+Version: 2.1.2
 Summary: A package that provides a set of tools to build a FastAPI application with a Class-Based CRUD API.
 Project-URL: Homepage, https://codeberg.org/datatactics/fastapi-rtk
 Project-URL: Issues, https://codeberg.org/datatactics/fastapi-rtk/issues

fastapi_rtk-2.1.2/fastapi_rtk/_version.py

@@ -0,0 +1 @@
+__version__ = "2.1.2"

{fastapi_rtk-2.1.0 → fastapi_rtk-2.1.2}/fastapi_rtk/cli/commands/db/__init__.py

@@ -7,7 +7,7 @@ import alembic.config
 import typer
 
 from ...cli import app
-from ...decorators import ensure_fastapi_rtk_tables_exist
+from ...decorators import ensure_app_loaded, ensure_fastapi_rtk_tables_exist
 from .. import version_callback
 
 
@@ -28,7 +28,6 @@ app.add_typer(db_app, name="db")
 
 
 @db_app.callback()
-@ensure_fastapi_rtk_tables_exist
 def callback(
     version: Annotated[
         Union[bool, None],
@@ -99,6 +98,7 @@ def init(
 
 
 @db_app.command()
+@ensure_fastapi_rtk_tables_exist
 def revision(
     directory: Annotated[
         Union[str, None], typer.Option(help="Path to migration scripts directory.")
@@ -167,6 +167,8 @@ def revision(
 
 
 @db_app.command()
+# No decorator: this is an alias that delegates to `revision`, whose own
+# decorator runs the app check once. Decorating here too would double it.
 def migrate(
     directory: Annotated[
         Union[str, None], typer.Option(help="Path to migration scripts directory.")
@@ -224,6 +226,7 @@ def migrate(
 
 
 @db_app.command()
+@ensure_app_loaded
 def edit(
     directory: Annotated[
         Union[str, None], typer.Option(help="Path to migration scripts directory.")
@@ -239,6 +242,7 @@ def edit(
 
 
 @db_app.command()
+@ensure_app_loaded
 def merge(
     directory: Annotated[
         Union[str, None], typer.Option(help="Path to migration scripts directory.")
@@ -273,6 +277,7 @@ def merge(
 
 
 @db_app.command()
+@ensure_fastapi_rtk_tables_exist
 def upgrade(
     directory: Annotated[
         Union[str, None], typer.Option(help="Path to migration scripts directory.")
@@ -300,6 +305,7 @@ def upgrade(
 
 
 @db_app.command()
+@ensure_fastapi_rtk_tables_exist
 def downgrade(
     directory: Annotated[
         Union[str, None], typer.Option(help="Path to migration scripts directory.")
@@ -327,6 +333,7 @@ def downgrade(
 
 
 @db_app.command()
+@ensure_app_loaded
 def show(
     directory: Annotated[
         Union[str, None], typer.Option(help="Path to migration scripts directory.")
@@ -340,6 +347,7 @@ def show(
 
 
 @db_app.command()
+@ensure_app_loaded
 def history(
     directory: Annotated[
         Union[str, None], typer.Option(help="Path to migration scripts directory.")
@@ -369,6 +377,7 @@ def history(
 
 
 @db_app.command()
+@ensure_app_loaded
 def heads(
     directory: Annotated[
         Union[str, None], typer.Option(help="Path to migration scripts directory.")
@@ -395,6 +404,7 @@ def heads(
 
 
 @db_app.command()
+@ensure_app_loaded
 def branches(
     directory: Annotated[
         Union[str, None], typer.Option(help="Path to migration scripts directory.")
@@ -413,6 +423,7 @@ def branches(
 
 
 @db_app.command()
+@ensure_fastapi_rtk_tables_exist
 def current(
     directory: Annotated[
         Union[str, None], typer.Option(help="Path to migration scripts directory.")
@@ -431,6 +442,7 @@ def current(
 
 
 @db_app.command()
+@ensure_fastapi_rtk_tables_exist
 def stamp(
     directory: Annotated[
         Union[str, None], typer.Option(help="Path to migration scripts directory.")
@@ -462,6 +474,7 @@ def stamp(
 
 
 @db_app.command()
+@ensure_fastapi_rtk_tables_exist
 def check(
     directory: Annotated[
         Union[str, None], typer.Option(help="Path to migration scripts directory.")

{fastapi_rtk-2.1.0 → fastapi_rtk-2.1.2}/fastapi_rtk/cli/commands/export.py

@@ -26,7 +26,7 @@ from ...globals import g
 from ...setting import Setting
 from ..cli import app
 from ..const import logger
-from ..decorators import ensure_fastapi_rtk_tables_exist
+from ..decorators import ensure_app_loaded, ensure_fastapi_rtk_tables_exist
 from ..types import (
     APIDataDocs,
     APIDocs,
@@ -50,7 +50,6 @@ table_documentation: collections.defaultdict[str, TableDocumentation] = (
 
 
 @export_app.callback()
-@ensure_fastapi_rtk_tables_exist
 def callback(
     version: typing.Annotated[
         typing.Union[bool, None],
@@ -67,6 +66,7 @@ def callback(
 
 
 @export_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def api_schema(
     apis: typing.Annotated[
@@ -131,6 +131,7 @@ async def api_schema(
 
 
 @export_app.command()
+@ensure_app_loaded
 def api_docs(
     apis: typing.Annotated[
         str | None,
@@ -261,6 +262,7 @@ def api_docs(
 
 
 @export_app.command()
+@ensure_app_loaded
 def db_docs(
     tables: typing.Annotated[
         str | None,
@@ -348,6 +350,7 @@ def db_docs(
 
 
 @export_app.command()
+@ensure_app_loaded
 def licenses(
     output_dir: typing.Annotated[
         str | None,

{fastapi_rtk-2.1.0 → fastapi_rtk-2.1.2}/fastapi_rtk/cli/commands/security.py

@@ -17,7 +17,6 @@ app.add_typer(security_app, name="security")
 
 
 @security_app.callback()
-@ensure_fastapi_rtk_tables_exist
 def callback(
     version: Annotated[
         Union[bool, None],
@@ -34,6 +33,7 @@ def callback(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def export_users(
     file_path: Annotated[
@@ -92,6 +92,7 @@ async def export_users(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def import_users(
     file_path: Annotated[
@@ -146,6 +147,7 @@ async def import_users(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def list_users(
     role: Annotated[
@@ -234,6 +236,7 @@ async def list_users(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def show_user(
     email_or_username: Annotated[
@@ -275,6 +278,7 @@ async def show_user(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def create_admin(
     username: Annotated[
@@ -328,6 +332,7 @@ async def create_admin(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def create_user(
     username: Annotated[str, typer.Option(..., help="The username of the user.")] = "",
@@ -402,6 +407,7 @@ async def create_user(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def update_user(
     email_or_username: Annotated[
@@ -461,6 +467,7 @@ async def update_user(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def activate(
     email_or_username: Annotated[
@@ -474,6 +481,7 @@ async def activate(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def deactivate(
     email_or_username: Annotated[
@@ -487,6 +495,7 @@ async def deactivate(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def verify_user(
     email_or_username: Annotated[
@@ -504,6 +513,7 @@ async def verify_user(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def unverify_user(
     email_or_username: Annotated[
@@ -521,6 +531,7 @@ async def unverify_user(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def promote(
     email_or_username: Annotated[
@@ -549,6 +560,7 @@ async def promote(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def demote(
     email_or_username: Annotated[
@@ -576,6 +588,7 @@ async def demote(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def delete_user(
     email_or_username: Annotated[
@@ -611,6 +624,7 @@ async def delete_user(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def export_roles(
     file_path: Annotated[
@@ -669,6 +683,7 @@ async def export_roles(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def import_roles(
     file_path: Annotated[
@@ -714,6 +729,7 @@ async def import_roles(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def list_roles():
     """
@@ -740,6 +756,7 @@ async def list_roles():
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def create_role(
     names: Annotated[
@@ -778,6 +795,7 @@ async def create_role(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def rename_role(
     old_name: Annotated[
@@ -815,6 +833,7 @@ async def rename_role(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def delete_role(
     name: Annotated[
@@ -873,6 +892,7 @@ async def delete_role(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def list_apis():
     """
@@ -899,6 +919,7 @@ async def list_apis():
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def list_permissions(
     role: Annotated[
@@ -953,6 +974,7 @@ async def list_permissions(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def add_role(
     email_or_username: Annotated[
@@ -1007,6 +1029,7 @@ async def add_role(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def assign_role(
     email_or_username: Annotated[
@@ -1058,6 +1081,7 @@ async def assign_role(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def revoke_role(
     email_or_username: Annotated[
@@ -1103,6 +1127,7 @@ async def revoke_role(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def check_access(
     user: Annotated[
@@ -1176,6 +1201,7 @@ async def check_access(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def reset_password(
     email_or_username: Annotated[
@@ -1208,6 +1234,7 @@ async def reset_password(
 
 
 @security_app.command()
+@ensure_fastapi_rtk_tables_exist
 @make_sync
 async def cleanup():
     """

fastapi_rtk-2.1.2/fastapi_rtk/cli/decorators.py

@@ -0,0 +1,80 @@
+import inspect
+from functools import wraps
+
+import typer
+from fastapi_cli.discover import get_import_data
+from fastapi_cli.exceptions import FastAPICLIException
+
+from ..db import db
+from ..globals import g
+from .const import logger
+from .utils import run_in_current_event_loop
+
+
+def ensure_app_loaded(f):
+    """Ensure a FastAPI app is loaded before running `f`.
+
+    Only commands that read models or config (not the database) need this.
+    """
+    return _check_existing_app(f)
+
+
+def ensure_fastapi_rtk_tables_exist(f):
+    """Ensure the fastapi-rtk tables exist before running `f`.
+
+    Implies :func:`ensure_app_loaded`. Use on commands that touch the database.
+
+    Table-init only runs in CLI mode; an in-process caller (e.g. the lifespan)
+    already created the tables on the running loop, and re-running it here on a
+    worker-thread loop would crash async drivers (cross-loop connection reuse).
+
+    For the CLI path, init and body share one loop via
+    :func:`run_in_current_event_loop`: an `async def` command (a
+    :func:`make_sync` wrapper with `f.__wrapped__`) awaits init, body, and
+    `db.close()` in one call; a sync command inits on its own loop then runs.
+    """
+
+    body = getattr(f, "__wrapped__", None)
+
+    @wraps(f)
+    def wrapper(*args, **kwargs):
+        if not g.is_cli:
+            return f(*args, **kwargs)
+
+        if body is not None and inspect.iscoroutinefunction(body):
+
+            async def run():
+                await db.init_fastapi_rtk_tables()
+                try:
+                    return await body(*args, **kwargs)
+                finally:
+                    await db.close()
+
+            return run_in_current_event_loop(run())
+
+        run_in_current_event_loop(db.init_fastapi_rtk_tables())
+        return f(*args, **kwargs)
+
+    return ensure_app_loaded(wrapper)
+
+
+def _check_existing_app(f, *, silent=False):
+    @wraps(f)
+    def wrapper(*args, **kwargs):
+        # No app loaded -> CLI invocation: flag cli (before import, so the
+        # toolkit skips the lifespan) and import from path. Else reuse it.
+        if g.current_app is None:
+            g.is_cli = True
+            try:
+                get_import_data(path=g.path)
+            except FastAPICLIException as e:
+                if not silent:
+                    logger.error(str(e))
+                    raise typer.Exit(code=1) from None
+        return f(*args, **kwargs)
+
+    return wrapper
+
+
+def check_existing_app_silent(f):
+    return _check_existing_app(f, silent=True)

{fastapi_rtk-2.1.0 → fastapi_rtk-2.1.2}/fastapi_rtk/fastapi_react_toolkit.py

@@ -630,7 +630,7 @@ class FastAPIReactToolkit:
             logger.setLevel(logging.DEBUG)
 
     def _init_lifespan(self):
-        if g.is_migrate:
+        if g.is_cli:
             return
 
         @asynccontextmanager

{fastapi_rtk-2.1.0 → fastapi_rtk-2.1.2}/fastapi_rtk/globals.py

@@ -85,9 +85,13 @@ class Globals:
     """
     The configuration settings for the FastAPI React Toolkit.
     """
+    is_cli: bool
+    """
+    A boolean value to indicate if the application is loaded by the CLI. `True` when you are running a command from `fastapi-rtk` CLI.
+    """
     is_migrate: bool
     """
-    A boolean value to indicate if the application is in migration mode. `True` when you are running a command from `fastapi-rtk` CLI.
+    Deprecated alias of `is_cli`. TODO(next-minor): remove.
     """
     sensitive_data: dict[str, list[str]]
     """
@@ -287,7 +291,9 @@ g.set_default(
     "auth", lazy_import("fastapi_rtk.auth", lambda mod: mod.AuthConfigurator())
 )
 g.set_default("config", Config())
-g.set_default("is_migrate", False)
+g.set_default("is_cli", False)
+# TODO(next-minor): remove. Deprecated alias; resolves to `is_cli`.
+g.set_default("is_migrate", lazy(lambda: g.is_cli))
 g.set_default("sensitive_data", {"User": ["password", "hashed_password"]})
 g.set_default(
     "file_manager",

{fastapi_rtk-2.1.0 → fastapi_rtk-2.1.2}/tests/conftest.py

@@ -130,6 +130,7 @@ def make_toolkit_app(tmp_path, config_setter):
         extra_apis: optional list of API classes to register via add_api.
         extra_lifespans: optional list of async context managers.
         config_overrides: optional dict of additional config values.
+        upgrade_db: run the alembic upgrade step in the lifespan.
 
     Returns:
         FastAPI app instance with toolkit initialized.
@@ -144,6 +145,7 @@ def make_toolkit_app(tmp_path, config_setter):
         extra_apis: Iterable[Any] | None = None,
         extra_lifespans: Iterable[Any] | None = None,
         config_overrides: dict | None = None,
+        upgrade_db: bool = False,
     ):
         db_path = tmp_path / "test.db"
         config_setter("SQLALCHEMY_DATABASE_URI", f"sqlite+aiosqlite:///{db_path}")
@@ -187,6 +189,7 @@ def make_toolkit_app(tmp_path, config_setter):
 
         toolkit = FastAPIReactToolkit(
             create_tables=False,
+            upgrade_db=upgrade_db,
             exclude_apis=["LicenseApi"],
             lifespans=list(extra_lifespans or []),
             auth={"secret_key": "tier-integration-secret-32-bytes!!"},

fastapi_rtk-2.1.2/tests/unit/cli/commands/conftest.py

@@ -0,0 +1,48 @@
+"""Shared fixtures for the cli/commands tests.
+
+Command callbacks used to carry the `@ensure_fastapi_rtk_tables_exist` /
+`@ensure_app_loaded` app check; it now sits on the individual commands.
+These unit tests call the command functions directly to exercise their bodies,
+so the app-import + table-init side effects are stubbed out here. The fixture
+yields the stub mocks so a test can assert whether a given command triggered
+the check.
+
+`ensure_fastapi_rtk_tables_exist` now runs the table-init and the command body
+inside one `run_in_current_event_loop` call, so the mock standing in for it must
+actually execute the coroutine it receives (otherwise async command bodies never
+run). It delegates to the real helper while still recording calls, and
+`init_fastapi_rtk_tables` is an awaitable stub so the in-loop `await` is a no-op.
+"""
+
+from types import SimpleNamespace
+from unittest.mock import AsyncMock, MagicMock
+
+import pytest
+
+from fastapi_rtk.cli import decorators
+from fastapi_rtk.cli.utils import run_in_current_event_loop as _run_loop
+
+
+@pytest.fixture(autouse=True)
+def neutralize_app_check(monkeypatch):
+    get_import_data = MagicMock(name="get_import_data")
+    run_in_current_event_loop = MagicMock(
+        name="run_in_current_event_loop", side_effect=_run_loop
+    )
+    init_fastapi_rtk_tables = AsyncMock(
+        name="init_fastapi_rtk_tables", return_value=None
+    )
+
+    monkeypatch.setattr(decorators, "get_import_data", get_import_data)
+    monkeypatch.setattr(
+        decorators, "run_in_current_event_loop", run_in_current_event_loop
+    )
+    monkeypatch.setattr(
+        decorators.db, "init_fastapi_rtk_tables", init_fastapi_rtk_tables
+    )
+
+    return SimpleNamespace(
+        get_import_data=get_import_data,
+        run_in_current_event_loop=run_in_current_event_loop,
+        init_fastapi_rtk_tables=init_fastapi_rtk_tables,
+    )

{fastapi_rtk-2.1.0 → fastapi_rtk-2.1.2}/tests/unit/cli/commands/test_db.py

@@ -176,3 +176,54 @@ class TestDbCommandWrappers:
         )
         # Just smoke - no assertion on output here, command writes to stdout
         list_templates()
+
+
+class TestAppCheckPartition:
+    """Each db command only runs the app check it actually needs."""
+
+    def _patch_alembic(self, monkeypatch, name):
+        from unittest.mock import MagicMock
+
+        from fastapi_rtk.cli.commands import db as db_mod
+
+        monkeypatch.setattr(db_mod.alembic.command, name, MagicMock())
+
+    def test_list_templates_skips_check(self, monkeypatch, neutralize_app_check):
+        from fastapi_rtk.cli.commands.db import Config, list_templates
+
+        monkeypatch.setattr(Config, "get_template_directory", lambda self: ".")
+        monkeypatch.setattr("os.listdir", lambda _p: [])
+        list_templates()
+        neutralize_app_check.get_import_data.assert_not_called()
+
+    def test_init_skips_check(self, tmp_path, monkeypatch, neutralize_app_check):
+        from fastapi_rtk.cli.commands.db import init
+
+        self._patch_alembic(monkeypatch, "init")
+        init(directory=str(tmp_path))
+        neutralize_app_check.get_import_data.assert_not_called()
+
+    def test_history_is_import_only(self, monkeypatch, neutralize_app_check):
+        from fastapi_rtk.cli.commands.db import history
+
+        self._patch_alembic(monkeypatch, "history")
+        history()
+        neutralize_app_check.get_import_data.assert_called_once()
+        neutralize_app_check.run_in_current_event_loop.assert_not_called()
+
+    def test_upgrade_runs_full_check(self, monkeypatch, neutralize_app_check):
+        from fastapi_rtk.cli.commands.db import upgrade
+
+        self._patch_alembic(monkeypatch, "upgrade")
+        upgrade(revision="head")
+        neutralize_app_check.get_import_data.assert_called_once()
+        neutralize_app_check.run_in_current_event_loop.assert_called_once()
+
+    def test_migrate_checks_once_via_revision(self, monkeypatch, neutralize_app_check):
+        from fastapi_rtk.cli.commands.db import migrate
+
+        self._patch_alembic(monkeypatch, "revision")
+        migrate(message="auto")
+        # migrate is undecorated; the single check fires through revision.
+        neutralize_app_check.get_import_data.assert_called_once()
+        neutralize_app_check.run_in_current_event_loop.assert_called_once()

{fastapi_rtk-2.1.0 → fastapi_rtk-2.1.2}/tests/unit/cli/commands/test_export.py

@@ -12,6 +12,45 @@ class TestHelpSmoke:
         assert result.exit_code == 0
 
 
+class TestAppCheckPartition:
+    """Each export command only runs the app check it actually needs."""
+
+    def test_licenses_is_import_only(self, tmp_path, monkeypatch, neutralize_app_check):
+        # Reads `LICENSE_FOLDER` from config, so the app must be imported; but
+        # it never touches the database.
+        from fastapi_rtk.cli.commands import export as ex_mod
+
+        monkeypatch.setattr(
+            ex_mod.piplicenses, "create_output_string", lambda args: "[]"
+        )
+        ex_mod.licenses(
+            output_dir=str(tmp_path / "lic"), webapp_dir=str(tmp_path / "ghost")
+        )
+        neutralize_app_check.get_import_data.assert_called_once()
+        neutralize_app_check.run_in_current_event_loop.assert_not_called()
+
+    def test_api_docs_is_import_only(self, tmp_path, monkeypatch, neutralize_app_check):
+        from unittest.mock import MagicMock
+
+        from fastapi_rtk.cli.commands import export as ex_mod
+        from fastapi_rtk.globals import g
+
+        app_mock = MagicMock()
+        app_mock.apis = []
+        app_mock.app.openapi.return_value = {"paths": {}, "components": {}}
+
+        # No app loaded yet -> CLI (from-path) branch: importing the app is what
+        # populates `g.current_app`, so the mock mirrors that side effect.
+        def _load(*args, **kwargs):
+            g.current_app = app_mock
+
+        neutralize_app_check.get_import_data.side_effect = _load
+
+        ex_mod.api_docs(filename=str(tmp_path / "out.md"))
+        neutralize_app_check.get_import_data.assert_called_once()
+        neutralize_app_check.run_in_current_event_loop.assert_not_called()
+
+
 class TestExportHelpers:
     def test_generate_fastapi_rtk_tables_docs_populates(self):
         from fastapi_rtk.cli.commands.export import (