fastapi-cli 0.0.18__tar.gz → 0.0.20__tar.gz

{fastapi_cli-0.0.18 → fastapi_cli-0.0.20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-cli
-Version: 0.0.18
+Version: 0.0.20
 Summary: Run and manage FastAPI apps from the command line with FastAPI CLI. 🚀
 Author-Email: =?utf-8?q?Sebasti=C3=A1n_Ram=C3=ADrez?= <tiangolo@gmail.com>
 License-Expression: MIT
@@ -19,7 +19,6 @@ Classifier: Development Status :: 4 - Beta
 Classifier: Framework :: FastAPI
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -31,7 +30,7 @@ Project-URL: Documentation, https://fastapi.tiangolo.com/fastapi-cli/
 Project-URL: Repository, https://github.com/fastapi/fastapi-cli
 Project-URL: Issues, https://github.com/fastapi/fastapi-cli/issues
 Project-URL: Changelog, https://github.com/fastapi/fastapi-cli/blob/main/release-notes.md
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Requires-Dist: typer>=0.15.1
 Requires-Dist: uvicorn[standard]>=0.15.0
 Requires-Dist: rich-toolkit>=0.14.8

{fastapi_cli-0.0.18 → fastapi_cli-0.0.20}/pdm_build.py

@@ -1,5 +1,5 @@
 import os
-from typing import Any, Dict
+from typing import Any
 
 from pdm.backend.hooks import Context
 
@@ -9,12 +9,12 @@ TIANGOLO_BUILD_PACKAGE = os.getenv("TIANGOLO_BUILD_PACKAGE", "fastapi-cli")
 def pdm_build_initialize(context: Context):
     metadata = context.config.metadata
     # Get custom config for the current package, from the env var
-    config: Dict[str, Any] = context.config.data["tool"]["tiangolo"][
+    config: dict[str, Any] = context.config.data["tool"]["tiangolo"][
         "_internal-slim-build"
     ]["packages"].get(TIANGOLO_BUILD_PACKAGE)
     if not config:
         return
-    project_config: Dict[str, Any] = config["project"]
+    project_config: dict[str, Any] = config["project"]
     # Override main [project] configs with custom configs for this package
     for key, value in project_config.items():
         metadata[key] = value

{fastapi_cli-0.0.18 → fastapi_cli-0.0.20}/pyproject.toml

@@ -5,7 +5,7 @@ description = "Run and manage FastAPI apps from the command line with FastAPI CL
 authors = [
     { name = "Sebastián Ramírez", email = "tiangolo@gmail.com" },
 ]
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 readme = "README.md"
 license = "MIT"
 license-files = [
@@ -26,7 +26,6 @@ classifiers = [
     "Framework :: FastAPI",
     "Intended Audience :: Developers",
     "Programming Language :: Python :: 3 :: Only",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
@@ -40,7 +39,7 @@ dependencies = [
     "rich-toolkit >= 0.14.8",
     "tomli >= 2.0.0; python_version < '3.11'",
 ]
-version = "0.0.18"
+version = "0.0.20"
 
 [project.optional-dependencies]
 standard = [

fastapi_cli-0.0.20/src/fastapi_cli/__init__.py

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

{fastapi_cli-0.0.18 → fastapi_cli-0.0.20}/src/fastapi_cli/cli.py

@@ -1,12 +1,11 @@
 import logging
 from pathlib import Path
-from typing import Any, List, Union
+from typing import Annotated, Any, Union
 
 import typer
 from pydantic import ValidationError
 from rich import print
 from rich.tree import Tree
-from typing_extensions import Annotated
 
 from fastapi_cli.config import FastAPIConfig
 from fastapi_cli.discover import get_import_data, get_import_data_from_import_string
@@ -78,7 +77,7 @@ def callback(
     setup_logging(level=log_level)
 
 
-def _get_module_tree(module_paths: List[Path]) -> Tree:
+def _get_module_tree(module_paths: list[Path]) -> Tree:
     root = module_paths[0]
     name = f"🐍 {root.name}" if root.is_file() else f"📁 {root.name}"
 
@@ -105,6 +104,7 @@ def _run(
     host: str = "127.0.0.1",
     port: int = 8000,
     reload: bool = True,
+    reload_dirs: Union[list[Path], None] = None,
     workers: Union[int, None] = None,
     root_path: str = "",
     command: str,
@@ -220,6 +220,11 @@ def _run(
             host=host,
             port=port,
             reload=reload,
+            reload_dirs=(
+                [str(directory.resolve()) for directory in reload_dirs]
+                if reload_dirs
+                else None
+            ),
             workers=workers,
             root_path=root_path,
             proxy_headers=proxy_headers,
@@ -256,6 +261,12 @@ def dev(
             help="Enable auto-reload of the server when (code) files change. This is [bold]resource intensive[/bold], use it only during development."
         ),
     ] = True,
+    reload_dir: Annotated[
+        Union[list[Path], None],
+        typer.Option(
+            help="Set reload directories explicitly, instead of using the current working directory."
+        ),
+    ] = None,
     root_path: Annotated[
         str,
         typer.Option(
@@ -319,6 +330,7 @@ def dev(
         host=host,
         port=port,
         reload=reload,
+        reload_dirs=reload_dir,
         root_path=root_path,
         app=app,
         entrypoint=entrypoint,

{fastapi_cli-0.0.18 → fastapi_cli-0.0.20}/src/fastapi_cli/config.py

@@ -1,6 +1,6 @@
 import logging
 from pathlib import Path
-from typing import Any, Dict, Optional
+from typing import Any, Optional
 
 from pydantic import BaseModel, StrictStr
 
@@ -11,7 +11,7 @@ class FastAPIConfig(BaseModel):
     entrypoint: Optional[StrictStr] = None
 
     @classmethod
-    def _read_pyproject_toml(cls) -> Dict[str, Any]:
+    def _read_pyproject_toml(cls) -> dict[str, Any]:
         """Read FastAPI configuration from pyproject.toml in current directory."""
         pyproject_path = Path.cwd() / "pyproject.toml"
 

{fastapi_cli-0.0.18 → fastapi_cli-0.0.20}/src/fastapi_cli/discover.py

@@ -3,7 +3,7 @@ import sys
 from dataclasses import dataclass
 from logging import getLogger
 from pathlib import Path
-from typing import List, Union
+from typing import Union
 
 from fastapi_cli.exceptions import FastAPICLIException
 
@@ -39,7 +39,7 @@ def get_default_path() -> Path:
 class ModuleData:
     module_import_str: str
     extra_sys_path: Path
-    module_paths: List[Path]
+    module_paths: list[Path]
 
 
 def get_module_data_from_path(path: Path) -> ModuleData:

{fastapi_cli-0.0.18 → fastapi_cli-0.0.20}/src/fastapi_cli/utils/cli.py

@@ -1,5 +1,5 @@
 import logging
-from typing import Any, Dict
+from typing import Any
 
 from rich_toolkit import RichToolkit, RichToolkitTheme
 from rich_toolkit.styles import TaggedStyle
@@ -20,7 +20,7 @@ class CustomFormatter(DefaultFormatter):
         return result
 
 
-def get_uvicorn_log_config() -> Dict[str, Any]:
+def get_uvicorn_log_config() -> dict[str, Any]:
     return {
         "version": 1,
         "disable_existing_loggers": False,

{fastapi_cli-0.0.18 → fastapi_cli-0.0.20}/tests/conftest.py

@@ -1,5 +1,5 @@
 import sys
-from typing import Generator
+from collections.abc import Generator
 
 import pytest
 from typer import rich_utils

{fastapi_cli-0.0.18 → fastapi_cli-0.0.20}/tests/test_cli.py

@@ -27,6 +27,7 @@ def test_dev() -> None:
                 "host": "127.0.0.1",
                 "port": 8000,
                 "reload": True,
+                "reload_dirs": None,
                 "workers": None,
                 "root_path": "",
                 "proxy_headers": True,
@@ -72,6 +73,7 @@ def test_dev_package() -> None:
                 "host": "127.0.0.1",
                 "port": 8000,
                 "reload": True,
+                "reload_dirs": None,
                 "workers": None,
                 "root_path": "",
                 "proxy_headers": True,
@@ -121,6 +123,7 @@ def test_dev_args() -> None:
                 "host": "192.168.0.2",
                 "port": 8080,
                 "reload": False,
+                "reload_dirs": None,
                 "workers": None,
                 "root_path": "/api",
                 "proxy_headers": False,
@@ -151,6 +154,7 @@ def test_dev_env_vars() -> None:
                 "host": "127.0.0.1",
                 "port": 8111,
                 "reload": True,
+                "reload_dirs": None,
                 "workers": None,
                 "root_path": "",
                 "proxy_headers": True,
@@ -188,6 +192,7 @@ def test_dev_env_vars_and_args() -> None:
                 "host": "127.0.0.1",
                 "port": 8080,
                 "reload": True,
+                "reload_dirs": None,
                 "workers": None,
                 "root_path": "",
                 "proxy_headers": True,
@@ -233,6 +238,7 @@ def test_run() -> None:
                 "host": "0.0.0.0",
                 "port": 8000,
                 "reload": False,
+                "reload_dirs": None,
                 "workers": None,
                 "root_path": "",
                 "proxy_headers": True,
@@ -259,6 +265,7 @@ def test_run_trust_proxy() -> None:
                 "host": "0.0.0.0",
                 "port": 8000,
                 "reload": False,
+                "reload_dirs": None,
                 "workers": None,
                 "root_path": "",
                 "proxy_headers": True,
@@ -305,6 +312,7 @@ def test_run_args() -> None:
                 "host": "192.168.0.2",
                 "port": 8080,
                 "reload": False,
+                "reload_dirs": None,
                 "workers": 2,
                 "root_path": "/api",
                 "proxy_headers": False,
@@ -336,6 +344,7 @@ def test_run_env_vars() -> None:
                 "host": "0.0.0.0",
                 "port": 8111,
                 "reload": False,
+                "reload_dirs": None,
                 "workers": None,
                 "root_path": "",
                 "proxy_headers": True,
@@ -369,6 +378,7 @@ def test_run_env_vars_and_args() -> None:
                 "host": "0.0.0.0",
                 "port": 8080,
                 "reload": False,
+                "reload_dirs": None,
                 "workers": None,
                 "root_path": "",
                 "proxy_headers": True,
@@ -404,6 +414,7 @@ def test_dev_help() -> None:
     assert "The host to serve on." in result.output
     assert "The port to serve on." in result.output
     assert "Enable auto-reload of the server when (code) files change." in result.output
+    assert "Set reload directories explicitly" in result.output
     assert "The root path is used to tell your app" in result.output
     assert "The name of the variable that contains the FastAPI app" in result.output
     assert "Use multiple worker processes." not in result.output
@@ -443,6 +454,30 @@ def test_version() -> None:
     assert "FastAPI CLI version:" in result.output
 
 
+def test_dev_reload_dir() -> None:
+    with changing_dir(assets_path):
+        with patch.object(uvicorn, "run") as mock_run:
+            result = runner.invoke(
+                app,
+                [
+                    "dev",
+                    "single_file_app.py",
+                    "--reload-dir",
+                    "src",
+                    "--reload-dir",
+                    "lib",
+                ],
+            )
+            assert result.exit_code == 0, result.output
+            assert mock_run.called
+            assert mock_run.call_args
+            # Paths are resolved to absolute paths
+            reload_dirs = mock_run.call_args.kwargs["reload_dirs"]
+            assert len(reload_dirs) == 2
+            assert reload_dirs[0] == str((assets_path / "src").resolve())
+            assert reload_dirs[1] == str((assets_path / "lib").resolve())
+
+
 def test_dev_with_import_string() -> None:
     with changing_dir(assets_path):
         with patch.object(uvicorn, "run") as mock_run:
@@ -456,6 +491,7 @@ def test_dev_with_import_string() -> None:
                 "host": "127.0.0.1",
                 "port": 8000,
                 "reload": True,
+                "reload_dirs": None,
                 "workers": None,
                 "root_path": "",
                 "proxy_headers": True,
@@ -477,6 +513,7 @@ def test_run_with_import_string() -> None:
                 "host": "0.0.0.0",
                 "port": 8000,
                 "reload": False,
+                "reload_dirs": None,
                 "workers": None,
                 "root_path": "",
                 "proxy_headers": True,

{fastapi_cli-0.0.18 → fastapi_cli-0.0.20}/tests/test_cli_pyproject.py

@@ -13,9 +13,10 @@ assets_path = Path(__file__).parent / "assets"
 
 
 def test_dev_with_pyproject_app_config_uses() -> None:
-    with changing_dir(assets_path / "pyproject_config"), patch.object(
-        uvicorn, "run"
-    ) as mock_run:
+    with (
+        changing_dir(assets_path / "pyproject_config"),
+        patch.object(uvicorn, "run") as mock_run,
+    ):
         result = runner.invoke(app, ["dev"])
         assert result.exit_code == 0, result.output
 
@@ -28,9 +29,10 @@ def test_dev_with_pyproject_app_config_uses() -> None:
 
 
 def test_run_with_pyproject_app_config() -> None:
-    with changing_dir(assets_path / "pyproject_config"), patch.object(
-        uvicorn, "run"
-    ) as mock_run:
+    with (
+        changing_dir(assets_path / "pyproject_config"),
+        patch.object(uvicorn, "run") as mock_run,
+    ):
         result = runner.invoke(app, ["run"])
         assert result.exit_code == 0, result.output
 
@@ -43,9 +45,10 @@ def test_run_with_pyproject_app_config() -> None:
 
 
 def test_cli_arg_overrides_pyproject_config() -> None:
-    with changing_dir(assets_path / "pyproject_config"), patch.object(
-        uvicorn, "run"
-    ) as mock_run:
+    with (
+        changing_dir(assets_path / "pyproject_config"),
+        patch.object(uvicorn, "run") as mock_run,
+    ):
         result = runner.invoke(app, ["dev", "another_module.py"])
 
         assert result.exit_code == 0, result.output

{fastapi_cli-0.0.18 → fastapi_cli-0.0.20}/tests/utils.py

@@ -1,7 +1,8 @@
 import os
+from collections.abc import Generator
 from contextlib import contextmanager
 from pathlib import Path
-from typing import Generator, Union
+from typing import Union
 
 
 @contextmanager

fastapi_cli-0.0.18/src/fastapi_cli/__init__.py

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