Split docs_url discovery from import_data discovery

Author: YuriiMotov

src/fastapi_cli/cli.py

@@ -8,7 +8,11 @@
 from rich.tree import Tree
 
 from fastapi_cli.config import FastAPIConfig
-from fastapi_cli.discover import get_import_data, get_import_data_from_import_string
+from fastapi_cli.discover import (
+    get_docs_urls,
+    get_import_data,
+    get_import_data_from_import_string,
+)
 from fastapi_cli.exceptions import FastAPICLIException
 
 from . import __version__
@@ -164,9 +168,6 @@ def _run(
 
         module_data = import_data.module_data
         import_string = import_data.import_string
-        openapi_url = import_data.openapi_url
-        docs_url = import_data.docs_url
-        redoc_url = import_data.redoc_url
 
         toolkit.print(f"Importing from {module_data.extra_sys_path}")
         toolkit.print_line()
@@ -192,28 +193,30 @@ def _run(
             tag="app",
         )
 
-        url = f"http://{host}:{port}"
-        docs_str = ""
-
-        if openapi_url and (docs_url or redoc_url):
-            if docs_url:
-                docs_str += f"[link={url}{docs_url}]{url}{docs_url}[/]"
+        docs_urls = get_docs_urls(import_data)
 
-            if docs_url and redoc_url:
-                docs_str += " or "
+        url = f"http://{host}:{port}"
+        docs_url = ""
 
-            if redoc_url:
-                docs_str += f"[link={url}{redoc_url}]{url}{redoc_url}[/]"
+        if docs_urls.openapi_url and (docs_urls.docs_url or docs_urls.redoc_url):
+            if docs_urls.docs_url:
+                docs_url = (
+                    f"[link={url}{docs_urls.docs_url}]{url}{docs_urls.docs_url}[/]"
+                )
+            else:
+                docs_url = (
+                    f"[link={url}{docs_urls.redoc_url}]{url}{docs_urls.redoc_url}[/]"
+                )
 
         toolkit.print_line()
         toolkit.print(
             f"Server started at [link={url}]{url}[/]",
             tag="server",
         )
 
-        if docs_str:
+        if docs_url:
             toolkit.print(
-                f"Documentation at {docs_str}",
+                f"Documentation at {docs_url}",
                 tag="server",
             )
 

src/fastapi_cli/discover.py

@@ -69,9 +69,7 @@ def get_module_data_from_path(path: Path) -> ModuleData:
     )
 
 
-def get_app_infos(
-    *, mod_data: ModuleData, app_name: str | None = None
-) -> tuple[str, str | None, str | None, str | None]:
+def get_app_name(*, mod_data: ModuleData, app_name: str | None = None) -> str:
     try:
         mod = importlib.import_module(mod_data.module_import_str)
     except (ImportError, ValueError) as e:
@@ -80,41 +78,32 @@ def get_app_infos(
             "Ensure all the package directories have an [blue]__init__.py[/blue] file"
         )
         raise
-
     if not FastAPI:  # type: ignore[truthy-function]
         raise FastAPICLIException(
             "Could not import FastAPI, try running 'pip install fastapi'"
         ) from None
-
     object_names = dir(mod)
     object_names_set = set(object_names)
-
     if app_name:
         if app_name not in object_names_set:
             raise FastAPICLIException(
                 f"Could not find app name {app_name} in {mod_data.module_import_str}"
             )
-
         app = getattr(mod, app_name)
-
         if not isinstance(app, FastAPI):
             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, app.openapi_url, app.docs_url, app.redoc_url
-
+        return app_name
     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, obj.openapi_url, obj.docs_url, obj.redoc_url
-
+                return preferred_name
     for name in object_names:
         obj = getattr(mod, name)
         if isinstance(obj, FastAPI):
-            return name, obj.openapi_url, obj.docs_url, obj.redoc_url
-
+            return name
     raise FastAPICLIException("Could not find FastAPI app in module, try using --app")
 
 
@@ -123,9 +112,6 @@ class ImportData:
     app_name: str
     module_data: ModuleData
     import_string: str
-    openapi_url: str | None = None
-    docs_url: str | None = None
-    redoc_url: str | None = None
 
 
 def get_import_data(
@@ -139,22 +125,14 @@ def get_import_data(
 
     if not path.exists():
         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, openapi_url, docs_url, redoc_url = get_app_infos(
-        mod_data=mod_data, app_name=app_name
-    )
+    use_app_name = get_app_name(mod_data=mod_data, app_name=app_name)
 
     import_string = f"{mod_data.module_import_str}:{use_app_name}"
 
     return ImportData(
-        app_name=use_app_name,
-        module_data=mod_data,
-        import_string=import_string,
-        openapi_url=openapi_url,
-        docs_url=docs_url,
-        redoc_url=redoc_url,
+        app_name=use_app_name, module_data=mod_data, import_string=import_string
     )
 
 
@@ -170,21 +148,35 @@ def get_import_data_from_import_string(import_string: str) -> ImportData:
 
     sys.path.insert(0, str(here))
 
-    module_data = ModuleData(
-        module_import_str=module_str,
-        extra_sys_path=here,
-        module_paths=[],
-    )
-
-    _, openapi_url, docs_url, redoc_url = get_app_infos(
-        mod_data=module_data, app_name=app_name
-    )
-
     return ImportData(
         app_name=app_name,
-        module_data=module_data,
+        module_data=ModuleData(
+            module_import_str=module_str,
+            extra_sys_path=here,
+            module_paths=[],
+        ),
         import_string=import_string,
-        openapi_url=openapi_url,
-        docs_url=docs_url,
-        redoc_url=redoc_url,
+    )
+
+
+@dataclass
+class DocsURLs:
+    openapi_url: str | None
+    docs_url: str | None
+    redoc_url: str | None
+
+
+def get_docs_urls(import_data: ImportData) -> DocsURLs:
+    module = importlib.import_module(import_data.module_data.module_import_str)
+    app_name = import_data.app_name
+    app = getattr(module, app_name)
+
+    # Just for type checking, it's already checked in get_app_name
+    assert FastAPI is not None
+    assert isinstance(app, FastAPI)
+
+    return DocsURLs(
+        openapi_url=app.openapi_url,
+        docs_url=app.docs_url,
+        redoc_url=app.redoc_url,
     )

tests/assets/single_file_docs.py

@@ -40,9 +40,17 @@ def full_docs_root():
     return {"message": "single file full_docs"}
 
 
-custom_docs = FastAPI(docs_url="/custom-docs-url", redoc_url="/custom-redoc-url")
+custom_docs = FastAPI(docs_url="/custom-docs-url")
 
 
 @custom_docs.get("/")
 def custom_docs_root():
     return {"message": "single file custom_docs"}
+
+
+custom_redoc = FastAPI(docs_url=None, redoc_url="/custom-redoc-url")
+
+
+@custom_redoc.get("/")
+def custom_redoc_root():
+    return {"message": "single file custom_redoc"}

tests/test_cli.py

@@ -453,7 +453,7 @@ def test_full_docs() -> None:
             assert mock_run.called
 
         assert "http://127.0.0.1:8000/docs" in result.output
-        assert "http://127.0.0.1:8000/redoc" in result.output
+        assert "http://127.0.0.1:8000/redoc" not in result.output  # docs has precedence
 
 
 def test_custom_docs() -> None:
@@ -466,6 +466,17 @@ def test_custom_docs() -> None:
             assert mock_run.called
 
         assert "http://127.0.0.1:8000/custom-docs-url" in result.output
+
+
+def test_custom_redoc() -> None:
+    with changing_dir(assets_path):
+        with patch.object(uvicorn, "run") as mock_run:
+            result = runner.invoke(
+                app, ["dev", "single_file_docs.py", "--app", "custom_redoc"]
+            )
+            assert result.exit_code == 0, result.output
+            assert mock_run.called
+
         assert "http://127.0.0.1:8000/custom-redoc-url" in result.output
 
 

tests/test_discover.py

@@ -7,20 +7,18 @@
     get_import_data_from_import_string,
 )
 from fastapi_cli.exceptions import FastAPICLIException
-from tests.utils import changing_dir
 
 assets_path = Path(__file__).parent / "assets"
 
 
 def test_get_import_data_from_import_string_valid() -> None:
-    with changing_dir(assets_path):
-        result = get_import_data_from_import_string("package.mod.app:app")
+    result = get_import_data_from_import_string("module.submodule:app")
 
     assert isinstance(result, ImportData)
     assert result.app_name == "app"
-    assert result.import_string == "package.mod.app:app"
-    assert result.module_data.module_import_str == "package.mod.app"
-    assert result.module_data.extra_sys_path == Path(assets_path).resolve()
+    assert result.import_string == "module.submodule:app"
+    assert result.module_data.module_import_str == "module.submodule"
+    assert result.module_data.extra_sys_path == Path(".").resolve()
     assert result.module_data.module_paths == []
 
 

tests/utils.py

@@ -2,11 +2,10 @@
 from collections.abc import Generator
 from contextlib import contextmanager
 from pathlib import Path
-from typing import Union
 
 
 @contextmanager
-def changing_dir(directory: Union[str, Path]) -> Generator[None, None, None]:
+def changing_dir(directory: str | Path) -> Generator[None, None, None]:
     initial_dir = os.getcwd()
     os.chdir(directory)
     try: