feat: update discover function to return fastapi app

Author: FlavienRx

src/fastapi_cli/cli.py

@@ -8,7 +8,7 @@
 from rich.panel import Panel
 from typing_extensions import Annotated
 
-from fastapi_cli.discover import get_import_string
+from fastapi_cli.discover import get_import_string_and_app
 from fastapi_cli.exceptions import FastAPICLIException
 
 from . import __version__
@@ -62,7 +62,9 @@ def _run(
     proxy_headers: bool = False,
 ) -> None:
     try:
-        use_uvicorn_app = get_import_string(path=path, app_name=app)
+        # Get import_string app to use it with uvicorn and enable reload or workers.
+        # Get FastAPI app to conditional printing API docs URLs
+        import_string, app = get_import_string_and_app(path=path, app_name=app_name)
     except FastAPICLIException as e:
         logger.error(str(e))
         raise typer.Exit(code=1) from None

src/fastapi_cli/discover.py

@@ -98,7 +98,9 @@ def get_module_data_from_path(path: Path) -> ModuleData:
     )
 
 
-def get_app_name(*, mod_data: ModuleData, app_name: Union[str, None] = None) -> str:
+def get_app_name_add_app(
+    *, mod_data: ModuleData, app_name: Union[str, None] = None
+) -> tuple[str, FastAPI]:
     try:
         mod = importlib.import_module(mod_data.module_import_str)
     except (ImportError, ValueError) as e:
@@ -123,22 +125,22 @@ def get_app_name(*, mod_data: ModuleData, app_name: Union[str, None] = None) ->
             raise FastAPICLIException(
                 f"The app name {app_name} in {mod_data.module_import_str} doesn't seem to be a FastAPI app"
             )
-        return app_name
+        return app_name, app
     for preferred_name in ["app", "api"]:
         if preferred_name in object_names_set:
             obj = getattr(mod, preferred_name)
             if isinstance(obj, FastAPI):
-                return preferred_name
+                return preferred_name, obj
     for name in object_names:
         obj = getattr(mod, name)
         if isinstance(obj, FastAPI):
-            return name
+            return name, obj
     raise FastAPICLIException("Could not find FastAPI app in module, try using --app")
 
 
-def get_import_string(
+def get_import_string_and_app(
     *, path: Union[Path, None] = None, app_name: Union[str, None] = None
-) -> str:
+) -> tuple[str, FastAPI]:
     if not path:
         path = get_default_path()
     logger.info(f"Using path [blue]{path}[/blue]")
@@ -147,7 +149,7 @@ def get_import_string(
         raise FastAPICLIException(f"Path does not exist {path}")
     mod_data = get_module_data_from_path(path)
     sys.path.insert(0, str(mod_data.extra_sys_path))
-    use_app_name = get_app_name(mod_data=mod_data, app_name=app_name)
+    use_app_name, app = get_app_name_add_app(mod_data=mod_data, app_name=app_name)
     import_example = Syntax(
         f"from {mod_data.module_import_str} import {use_app_name}", "python"
     )
@@ -164,4 +166,4 @@ def get_import_string(
     print(import_panel)
     import_string = f"{mod_data.module_import_str}:{use_app_name}"
     logger.info(f"Using import string [b green]{import_string}[/b green]")
-    return import_string
+    return import_string, app

tests/test_requirements.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 
 import pytest
-from fastapi_cli.discover import get_import_string
+from fastapi_cli.discover import get_import_string_and_app
 from fastapi_cli.exceptions import FastAPICLIException
 from typer.testing import CliRunner
 
@@ -37,7 +37,7 @@ def test_no_fastapi() -> None:
     fastapi_cli.discover.FastAPI = None  # type: ignore[attr-defined, assignment]
     with changing_dir(assets_path):
         with pytest.raises(FastAPICLIException) as exc_info:
-            get_import_string(path=Path("single_file_app.py"))
+            get_import_string_and_app(path=Path("single_file_app.py"))
         assert "Could not import FastAPI, try running 'pip install fastapi'" in str(
             exc_info.value
         )

tests/test_utils_default_dir.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 
 import pytest
-from fastapi_cli.discover import get_import_string
+from fastapi_cli.discover import get_import_string_and_app
 from fastapi_cli.exceptions import FastAPICLIException
 from pytest import CaptureFixture
 
@@ -12,7 +12,7 @@
 
 def test_app_dir_main(capsys: CaptureFixture[str]) -> None:
     with changing_dir(assets_path / "default_files" / "default_app_dir_main"):
-        import_string = get_import_string()
+        import_string = get_import_string_and_app()
         assert import_string == "app.main:app"
 
     captured = capsys.readouterr()
@@ -36,7 +36,7 @@ def test_app_dir_main(capsys: CaptureFixture[str]) -> None:
 
 def test_app_dir_app(capsys: CaptureFixture[str]) -> None:
     with changing_dir(assets_path / "default_files" / "default_app_dir_app"):
-        import_string = get_import_string()
+        import_string = get_import_string_and_app()
         assert import_string == "app.app:app"
 
     captured = capsys.readouterr()
@@ -58,7 +58,7 @@ def test_app_dir_app(capsys: CaptureFixture[str]) -> None:
 
 def test_app_dir_api(capsys: CaptureFixture[str]) -> None:
     with changing_dir(assets_path / "default_files" / "default_app_dir_api"):
-        import_string = get_import_string()
+        import_string = get_import_string_and_app()
         assert import_string == "app.api:app"
 
     captured = capsys.readouterr()
@@ -81,7 +81,7 @@ def test_app_dir_api(capsys: CaptureFixture[str]) -> None:
 def test_app_dir_non_default() -> None:
     with changing_dir(assets_path / "default_files" / "default_app_dir_non_default"):
         with pytest.raises(FastAPICLIException) as e:
-            get_import_string()
+            get_import_string_and_app()
         assert (
             "Could not find a default file to run, please provide an explicit path"
             in e.value.args[0]

tests/test_utils_default_file.py

@@ -3,7 +3,7 @@
 from pathlib import Path
 
 import pytest
-from fastapi_cli.discover import get_import_string
+from fastapi_cli.discover import get_import_string_and_app
 from fastapi_cli.exceptions import FastAPICLIException
 from pytest import CaptureFixture
 
@@ -20,7 +20,7 @@ def test_single_file_main(capsys: CaptureFixture[str]) -> None:
         mod = importlib.import_module("main")
 
         importlib.reload(mod)
-        import_string = get_import_string()
+        import_string = get_import_string_and_app()
         assert import_string == "main:app"
 
     captured = capsys.readouterr()
@@ -47,7 +47,7 @@ def test_single_file_app(capsys: CaptureFixture[str]) -> None:
         mod = importlib.import_module("app")
 
         importlib.reload(mod)
-        import_string = get_import_string()
+        import_string = get_import_string_and_app()
         assert import_string == "app:app"
 
     captured = capsys.readouterr()
@@ -74,7 +74,7 @@ def test_single_file_api(capsys: CaptureFixture[str]) -> None:
         mod = importlib.import_module("api")
 
         importlib.reload(mod)
-        import_string = get_import_string()
+        import_string = get_import_string_and_app()
         assert import_string == "api:app"
 
     captured = capsys.readouterr()
@@ -96,7 +96,7 @@ def test_single_file_api(capsys: CaptureFixture[str]) -> None:
 def test_non_default_file(capsys: CaptureFixture[str]) -> None:
     with changing_dir(assets_path / "default_files" / "non_default"):
         with pytest.raises(FastAPICLIException) as e:
-            get_import_string()
+            get_import_string_and_app()
         assert (
             "Could not find a default file to run, please provide an explicit path"
             in e.value.args[0]

tests/test_utils_package.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 
 import pytest
-from fastapi_cli.discover import get_import_string
+from fastapi_cli.discover import get_import_string_and_app
 from fastapi_cli.exceptions import FastAPICLIException
 from pytest import CaptureFixture
 
@@ -12,7 +12,7 @@
 
 def test_package_app_root(capsys: CaptureFixture[str]) -> None:
     with changing_dir(assets_path):
-        import_string = get_import_string(path=Path("package/mod/app.py"))
+        import_string = get_import_string_and_app(path=Path("package/mod/app.py"))
         assert import_string == "package.mod.app:app"
 
     captured = capsys.readouterr()
@@ -40,7 +40,7 @@ def test_package_app_root(capsys: CaptureFixture[str]) -> None:
 
 def test_package_api_root(capsys: CaptureFixture[str]) -> None:
     with changing_dir(assets_path):
-        import_string = get_import_string(path=Path("package/mod/api.py"))
+        import_string = get_import_string_and_app(path=Path("package/mod/api.py"))
         assert import_string == "package.mod.api:api"
 
     captured = capsys.readouterr()
@@ -68,7 +68,7 @@ def test_package_api_root(capsys: CaptureFixture[str]) -> None:
 
 def test_package_other_root(capsys: CaptureFixture[str]) -> None:
     with changing_dir(assets_path):
-        import_string = get_import_string(path=Path("package/mod/other.py"))
+        import_string = get_import_string_and_app(path=Path("package/mod/other.py"))
         assert import_string == "package.mod.other:first_other"
 
     captured = capsys.readouterr()
@@ -96,7 +96,7 @@ def test_package_other_root(capsys: CaptureFixture[str]) -> None:
 
 def test_package_app_mod(capsys: CaptureFixture[str]) -> None:
     with changing_dir(assets_path / "package/mod"):
-        import_string = get_import_string(path=Path("app.py"))
+        import_string = get_import_string_and_app(path=Path("app.py"))
         assert import_string == "package.mod.app:app"
 
     captured = capsys.readouterr()
@@ -124,7 +124,7 @@ def test_package_app_mod(capsys: CaptureFixture[str]) -> None:
 
 def test_package_api_mod(capsys: CaptureFixture[str]) -> None:
     with changing_dir(assets_path / "package/mod"):
-        import_string = get_import_string(path=Path("api.py"))
+        import_string = get_import_string_and_app(path=Path("api.py"))
         assert import_string == "package.mod.api:api"
 
     captured = capsys.readouterr()
@@ -152,7 +152,7 @@ def test_package_api_mod(capsys: CaptureFixture[str]) -> None:
 
 def test_package_other_mod(capsys: CaptureFixture[str]) -> None:
     with changing_dir(assets_path / "package/mod"):
-        import_string = get_import_string(path=Path("other.py"))
+        import_string = get_import_string_and_app(path=Path("other.py"))
         assert import_string == "package.mod.other:first_other"
 
     captured = capsys.readouterr()
@@ -180,7 +180,9 @@ def test_package_other_mod(capsys: CaptureFixture[str]) -> None:
 
 def test_package_app_above(capsys: CaptureFixture[str]) -> None:
     with changing_dir(assets_path.parent):
-        import_string = get_import_string(path=Path("assets/package/mod/app.py"))
+        import_string = get_import_string_and_app(
+            path=Path("assets/package/mod/app.py")
+        )
         assert import_string == "package.mod.app:app"
 
     captured = capsys.readouterr()
@@ -208,7 +210,9 @@ def test_package_app_above(capsys: CaptureFixture[str]) -> None:
 
 def test_package_api_parent(capsys: CaptureFixture[str]) -> None:
     with changing_dir(assets_path.parent):
-        import_string = get_import_string(path=Path("assets/package/mod/api.py"))
+        import_string = get_import_string_and_app(
+            path=Path("assets/package/mod/api.py")
+        )
         assert import_string == "package.mod.api:api"
 
     captured = capsys.readouterr()
@@ -236,7 +240,9 @@ def test_package_api_parent(capsys: CaptureFixture[str]) -> None:
 
 def test_package_other_parent(capsys: CaptureFixture[str]) -> None:
     with changing_dir(assets_path.parent):
-        import_string = get_import_string(path=Path("assets/package/mod/other.py"))
+        import_string = get_import_string_and_app(
+            path=Path("assets/package/mod/other.py")
+        )
         assert import_string == "package.mod.other:first_other"
 
     captured = capsys.readouterr()
@@ -264,7 +270,7 @@ def test_package_other_parent(capsys: CaptureFixture[str]) -> None:
 
 def test_package_mod_init_inside(capsys: CaptureFixture[str]) -> None:
     with changing_dir(assets_path / "package/mod"):
-        import_string = get_import_string(path=Path("__init__.py"))
+        import_string = get_import_string_and_app(path=Path("__init__.py"))
         assert import_string == "package.mod:app"
 
     captured = capsys.readouterr()
@@ -291,7 +297,7 @@ def test_package_mod_init_inside(capsys: CaptureFixture[str]) -> None:
 
 def test_package_mod_dir(capsys: CaptureFixture[str]) -> None:
     with changing_dir(assets_path):
-        import_string = get_import_string(path=Path("package/mod"))
+        import_string = get_import_string_and_app(path=Path("package/mod"))
         assert import_string == "package.mod:app"
 
     captured = capsys.readouterr()
@@ -318,7 +324,7 @@ def test_package_mod_dir(capsys: CaptureFixture[str]) -> None:
 
 def test_package_init_inside(capsys: CaptureFixture[str]) -> None:
     with changing_dir(assets_path / "package"):
-        import_string = get_import_string(path=Path("__init__.py"))
+        import_string = get_import_string_and_app(path=Path("__init__.py"))
         assert import_string == "package:app"
 
     captured = capsys.readouterr()
@@ -343,7 +349,7 @@ def test_package_init_inside(capsys: CaptureFixture[str]) -> None:
 
 def test_package_dir_inside_package(capsys: CaptureFixture[str]) -> None:
     with changing_dir(assets_path / "package/mod"):
-        import_string = get_import_string(path=Path("../"))
+        import_string = get_import_string_and_app(path=Path("../"))
         assert import_string == "package:app"
 
     captured = capsys.readouterr()
@@ -368,7 +374,7 @@ def test_package_dir_inside_package(capsys: CaptureFixture[str]) -> None:
 
 def test_package_dir_above_package(capsys: CaptureFixture[str]) -> None:
     with changing_dir(assets_path.parent):
-        import_string = get_import_string(path=Path("assets/package"))
+        import_string = get_import_string_and_app(path=Path("assets/package"))
         assert import_string == "package:app"
 
     captured = capsys.readouterr()
@@ -393,7 +399,7 @@ def test_package_dir_above_package(capsys: CaptureFixture[str]) -> None:
 
 def test_package_dir_explicit_app(capsys: CaptureFixture[str]) -> None:
     with changing_dir(assets_path):
-        import_string = get_import_string(path=Path("package"), app_name="api")
+        import_string = get_import_string_and_app(path=Path("package"), app_name="api")
         assert import_string == "package:api"
 
     captured = capsys.readouterr()
@@ -420,7 +426,7 @@ def test_broken_package_dir(capsys: CaptureFixture[str]) -> None:
     with changing_dir(assets_path):
         # TODO (when deprecating Python 3.8): remove ValueError
         with pytest.raises((ImportError, ValueError)):
-            get_import_string(path=Path("broken_package/mod/app.py"))
+            get_import_string_and_app(path=Path("broken_package/mod/app.py"))
 
     captured = capsys.readouterr()
     assert "Import error:" in captured.out
@@ -430,7 +436,7 @@ def test_broken_package_dir(capsys: CaptureFixture[str]) -> None:
 def test_package_dir_no_app() -> None:
     with changing_dir(assets_path):
         with pytest.raises(FastAPICLIException) as e:
-            get_import_string(path=Path("package/core/utils.py"))
+            get_import_string_and_app(path=Path("package/core/utils.py"))
         assert (
             "Could not find FastAPI app in module, try using --app" in e.value.args[0]
         )
@@ -439,7 +445,7 @@ def test_package_dir_no_app() -> None:
 def test_package_dir_object_not_an_app() -> None:
     with changing_dir(assets_path):
         with pytest.raises(FastAPICLIException) as e:
-            get_import_string(
+            get_import_string_and_app(
                 path=Path("package/core/utils.py"), app_name="get_hello_world"
             )
         assert (
@@ -451,5 +457,5 @@ def test_package_dir_object_not_an_app() -> None:
 def test_package_dir_object_app_name_not_found() -> None:
     with changing_dir(assets_path):
         with pytest.raises(FastAPICLIException) as e:
-            get_import_string(path=Path("package"), app_name="non_existent_app")
+            get_import_string_and_app(path=Path("package"), app_name="non_existent_app")
         assert "Could not find app name non_existent_app in package" in e.value.args[0]