fastapi-rtk 2.6.0__tar.gz → 2.7.0__tar.gz

{fastapi_rtk-2.6.0 → fastapi_rtk-2.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-rtk
-Version: 2.6.0
+Version: 2.7.0
 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.7.0/fastapi_rtk/_version.py

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

{fastapi_rtk-2.6.0 → fastapi_rtk-2.7.0}/fastapi_rtk/cli/decorators.py

@@ -1,6 +1,7 @@
 import functools
 import inspect
 
+import click
 import fastapi_cli.discover
 import fastapi_cli.exceptions
 import typer
@@ -58,13 +59,35 @@ def ensure_fastapi_rtk_tables_exist(f):
     return ensure_app_loaded(wrapper)
 
 
+def _current_command_path() -> str | None:
+    """Build the full CLI command path from the active Click context.
+
+    Walks from the invoked command up to (but excluding) the program root and
+    joins the names with spaces (group then subcommand).
+
+    Returns:
+        str | None: The space-joined command names, or `None` when there is no active Click context.
+    """
+    ctx = click.get_current_context(silent=True)
+    if ctx is None:
+        return None
+    names = []
+    node = ctx
+    while node is not None and node.parent is not None:
+        names.append(node.info_name)
+        node = node.parent
+    return " ".join(reversed(names)) or None
+
+
 def _check_existing_app(f, *, silent=False):
     @functools.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.
+        # toolkit skips the lifespan), record the command, then import from
+        # path. Else reuse it.
         if g.current_app is None:
             g.is_cli = True
+            g.cli_command = _current_command_path()
             try:
                 fastapi_cli.discover.get_import_data(path=g.path)
             except fastapi_cli.exceptions.FastAPICLIException as e:

{fastapi_rtk-2.6.0 → fastapi_rtk-2.7.0}/fastapi_rtk/globals.py

@@ -87,6 +87,10 @@ class Globals:
     """
     A boolean value to indicate if the application is loaded by the CLI. `True` when you are running a command from `fastapi-rtk` CLI.
     """
+    cli_command: str | None
+    """
+    The full CLI command path currently running (group and subcommand, space-joined), or `None` outside the CLI. Set before the app module is imported.
+    """
     sensitive_data: dict[str, list[str]]
     """
     A dictionary used to store list of sensitive columns for each model that should not be returned in the list and get endpoints. Default is `{"User": ["password", "hashed_password"]}`.
@@ -283,6 +287,7 @@ g.set_default(
 )
 g.set_default("config", Config())
 g.set_default("is_cli", False)
+g.set_default("cli_command", None)
 g.set_default("sensitive_data", {"User": ["password", "hashed_password"]})
 g.set_default(
     "file_manager",

{fastapi_rtk-2.6.0 → fastapi_rtk-2.7.0}/tests/unit/cli/test_decorators.py

@@ -3,10 +3,10 @@
 import asyncio
 import unittest.mock
 
+import click
 import fastapi_cli.exceptions
 import pytest
 import typer
-
 from fastapi_rtk.cli.decorators import (
     _check_existing_app,
     check_existing_app_silent,
@@ -102,6 +102,63 @@ class TestEnsureAppLoaded:
                 g.is_cli = False
 
 
+class TestCommandRecording:
+    """`g.cli_command` holds the full CLI path and is set before the app import."""
+
+    def test_records_full_command_path_before_import(self, global_setter):
+        global_setter("is_cli", False)
+
+        from fastapi_rtk.globals import g
+
+        captured = {}
+
+        def _capture(*args, **kwargs):
+            # Grab g.cli_command at import time: the guard runs during this import.
+            captured["cli_command"] = g.cli_command
+
+        root = click.Context(click.Command("fastapi-rtk"), info_name="fastapi-rtk")
+        export = click.Context(click.Command("export"), parent=root, info_name="export")
+        leaf = click.Context(
+            click.Command("licenses"), parent=export, info_name="licenses"
+        )
+
+        with unittest.mock.patch(
+            "fastapi_cli.discover.get_import_data", side_effect=_capture
+        ):
+
+            @ensure_app_loaded
+            def fn():
+                return "done"
+
+            try:
+                with leaf:
+                    assert fn() == "done"
+                assert captured["cli_command"] == "export licenses"
+                assert g.cli_command == "export licenses"
+            finally:
+                g.is_cli = False
+                g.cli_command = None
+
+    def test_command_is_none_without_click_context(self, global_setter):
+        global_setter("is_cli", False)
+
+        from fastapi_rtk.globals import g
+
+        g.cli_command = "stale"
+        with unittest.mock.patch("fastapi_cli.discover.get_import_data"):
+
+            @ensure_app_loaded
+            def fn():
+                return "done"
+
+            try:
+                assert fn() == "done"
+                assert g.cli_command is None
+            finally:
+                g.is_cli = False
+                g.cli_command = None
+
+
 class TestInProcessReusesLoadedApp:
     """When `g.current_app` is set (in-process, e.g. the app lifespan) the
     decorators reuse the loaded app: no import, no CLI flag, no table-init.

fastapi_rtk-2.6.0/fastapi_rtk/_version.py

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