Skip to content

✨ Add --reload-dir option to dev command #267

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tiangolo merged 5 commits into from
Dec 22, 2025
Merged

✨ Add --reload-dir option to dev command #267

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
050f050
🔧 Drop support for Python 3.8
patrick91 Dec 22, 2025
c8f27b3
🎨 [pre-commit.ci] Auto format from pre-commit.com hooks
pre-commit-ci[bot] Dec 22, 2025
4b6a822
✨ Add --reload-dir option to dev command
patrick91 Dec 22, 2025
14a9f0b
🎨 [pre-commit.ci] Auto format from pre-commit.com hooks
pre-commit-ci[bot] Dec 22, 2025
5240e1c
Merge branch 'main' into add-reload-dir-option-to-dev-command
tiangolo Dec 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions src/fastapi_cli/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,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,
Expand Down Expand Up @@ -219,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,
Expand Down Expand Up @@ -255,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(
Expand Down Expand Up @@ -318,6 +330,7 @@ def dev(
host=host,
port=port,
reload=reload,
reload_dirs=reload_dir,
root_path=root_path,
app=app,
entrypoint=entrypoint,
Expand Down
37 changes: 37 additions & 0 deletions tests/test_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand All @@ -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,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand All @@ -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,
Expand All @@ -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,
Expand Down