fastapi-cli 0.0.2__tar.gz → 0.0.4__tar.gz

{fastapi_cli-0.0.2 → fastapi_cli-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastapi-cli
-Version: 0.0.2
+Version: 0.0.4
 Summary: Run and manage FastAPI apps from the command line with FastAPI CLI. 🚀
 Home-page: https://github.com/tiangolo/fastapi-cli
 Author-Email: =?utf-8?q?Sebasti=C3=A1n_Ram=C3=ADrez?= <tiangolo@gmail.com>
@@ -32,8 +32,9 @@ Project-URL: Homepage, https://github.com/tiangolo/fastapi-cli
 Project-URL: Repository, https://github.com/tiangolo/fastapi-cli
 Requires-Python: >=3.8
 Requires-Dist: typer>=0.12.3
-Requires-Dist: fastapi
-Requires-Dist: uvicorn[standard]>=0.29.0
+Requires-Dist: fastapi; extra == "standard"
+Requires-Dist: uvicorn[standard]>=0.15.0; extra == "standard"
+Provides-Extra: standard
 Description-Content-Type: text/markdown
 
 # FastAPI CLI
@@ -120,6 +121,8 @@ FastAPI CLI takes the path to your Python program and automatically detects the
 
 For production you would use `fastapi run` instead. 🚀
 
+Internally, **FastAPI CLI** uses <a href="https://www.uvicorn.org" class="external-link" target="_blank">Uvicorn</a>, a high-performance, production-ready, ASGI server. 😎
+
 ## `fastapi dev`
 
 When you run `fastapi dev`, it will run on development mode.

{fastapi_cli-0.0.2 → fastapi_cli-0.0.4}/README.md

@@ -82,6 +82,8 @@ FastAPI CLI takes the path to your Python program and automatically detects the
 
 For production you would use `fastapi run` instead. 🚀
 
+Internally, **FastAPI CLI** uses <a href="https://www.uvicorn.org" class="external-link" target="_blank">Uvicorn</a>, a high-performance, production-ready, ASGI server. 😎
+
 ## `fastapi dev`
 
 When you run `fastapi dev`, it will run on development mode.

{fastapi_cli-0.0.2 → fastapi_cli-0.0.4}/pyproject.toml

@@ -33,15 +33,17 @@ classifiers = [
 ]
 dependencies = [
     "typer >= 0.12.3",
-    "fastapi",
-    "uvicorn[standard] >= 0.29.0",
 ]
-version = "0.0.2"
+version = "0.0.4"
 
 [project.license]
 text = "MIT"
 
 [project.optional-dependencies]
+standard = [
+    "fastapi",
+    "uvicorn[standard] >= 0.15.0",
+]
 
 [project.urls]
 Documentation = "https://fastapi.tiangolo.com"
@@ -75,11 +77,9 @@ source-includes = [
 name = "fastapi-cli-slim"
 
 [tool.tiangolo._internal-slim-build.packages.fastapi-cli]
-include-optional-dependencies = [
-    "standard",
-]
+include-optional-dependencies = []
 
-[tool.tiangolo._internal-slim-build.packages.fastapi-cli.project.optional-dependencies]
+[tool.tiangolo._internal-slim-build.packages.fastapi-cli.project]
 
 [tool.pytest.ini_options]
 addopts = [

fastapi_cli-0.0.4/requirements-tests.txt

@@ -0,0 +1,9 @@
+-e .
+
+pytest >=4.4.0,<9.0.0
+coverage[toml] >=6.2,<8.0
+mypy ==1.10.0
+ruff ==0.4.3
+# Needed explicitly by fastapi-cli-slim
+fastapi-slim
+uvicorn

fastapi_cli-0.0.4/src/fastapi_cli/__init__.py

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

{fastapi_cli-0.0.2 → fastapi_cli-0.0.4}/src/fastapi_cli/cli.py

@@ -3,7 +3,6 @@ from pathlib import Path
 from typing import Any, Union
 
 import typer
-import uvicorn
 from rich import print
 from rich.padding import Padding
 from rich.panel import Panel
@@ -20,6 +19,11 @@ app = typer.Typer(rich_markup_mode="rich")
 setup_logging()
 logger = getLogger(__name__)
 
+try:
+    import uvicorn
+except ImportError:  # pragma: no cover
+    uvicorn = None  # type: ignore[assignment]
+
 
 def version_callback(value: bool) -> None:
     if value:
@@ -51,6 +55,7 @@ def _run(
     host: str = "127.0.0.1",
     port: int = 8000,
     reload: bool = True,
+    workers: Union[int, None] = None,
     root_path: str = "",
     command: str,
     app: Union[str, None] = None,
@@ -80,11 +85,16 @@ def _run(
             style="green",
         )
     print(Padding(panel, 1))
+    if not uvicorn:
+        raise FastAPICLIException(
+            "Could not import Uvicorn, try running 'pip install uvicorn'"
+        ) from None
     uvicorn.run(
         app=use_uvicorn_app,
         host=host,
         port=port,
         reload=reload,
+        workers=workers,
         root_path=root_path,
         proxy_headers=proxy_headers,
     )
@@ -200,6 +210,12 @@ def run(
             help="Enable auto-reload of the server when (code) files change. This is [bold]resource intensive[/bold], use it only during development."
         ),
     ] = False,
+    workers: Annotated[
+        Union[int, None],
+        typer.Option(
+            help="Use multiple worker processes. Mutually exclusive with the --reload flag."
+        ),
+    ] = None,
     root_path: Annotated[
         str,
         typer.Option(
@@ -249,6 +265,7 @@ def run(
         host=host,
         port=port,
         reload=reload,
+        workers=workers,
         root_path=root_path,
         app=app,
         command="run",

{fastapi_cli-0.0.2 → fastapi_cli-0.0.4}/src/fastapi_cli/discover.py

@@ -5,7 +5,6 @@ from logging import getLogger
 from pathlib import Path
 from typing import Union
 
-from fastapi import FastAPI
 from rich import print
 from rich.padding import Padding
 from rich.panel import Panel
@@ -16,6 +15,11 @@ from fastapi_cli.exceptions import FastAPICLIException
 
 logger = getLogger(__name__)
 
+try:
+    from fastapi import FastAPI
+except ImportError:  # pragma: no cover
+    FastAPI = None  # type: ignore[misc, assignment]
+
 
 def get_default_path() -> Path:
     path = Path("main.py")
@@ -107,6 +111,10 @@ def get_app_name(*, mod_data: ModuleData, app_name: Union[str, None] = None) ->
             "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:

{fastapi_cli-0.0.2 → fastapi_cli-0.0.4}/tests/test_cli.py

@@ -26,6 +26,7 @@ def test_dev() -> None:
                 "host": "127.0.0.1",
                 "port": 8000,
                 "reload": True,
+                "workers": None,
                 "root_path": "",
                 "proxy_headers": True,
             }
@@ -67,6 +68,7 @@ def test_dev_args() -> None:
                 "host": "192.168.0.2",
                 "port": 8080,
                 "reload": False,
+                "workers": None,
                 "root_path": "/api",
                 "proxy_headers": False,
             }
@@ -92,6 +94,7 @@ def test_run() -> None:
                 "host": "0.0.0.0",
                 "port": 8000,
                 "reload": False,
+                "workers": None,
                 "root_path": "",
                 "proxy_headers": True,
             }
@@ -118,6 +121,8 @@ def test_run_args() -> None:
                     "--port",
                     "8080",
                     "--no-reload",
+                    "--workers",
+                    "2",
                     "--root-path",
                     "/api",
                     "--app",
@@ -133,6 +138,7 @@ def test_run_args() -> None:
                 "host": "192.168.0.2",
                 "port": 8080,
                 "reload": False,
+                "workers": 2,
                 "root_path": "/api",
                 "proxy_headers": False,
             }
@@ -171,6 +177,7 @@ def test_dev_help() -> None:
     assert "Enable auto-reload of the server when (code) files change." 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
 
 
 def test_run_help() -> None:
@@ -191,6 +198,7 @@ def test_run_help() -> None:
     assert "Enable auto-reload of the server when (code) files change." 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." in result.output
 
 
 def test_callback_help() -> None:

fastapi_cli-0.0.4/tests/test_requirements.py

@@ -0,0 +1,45 @@
+from pathlib import Path
+
+import pytest
+from fastapi_cli.discover import get_import_string
+from fastapi_cli.exceptions import FastAPICLIException
+from typer.testing import CliRunner
+
+from .utils import changing_dir
+
+runner = CliRunner()
+
+assets_path = Path(__file__).parent / "assets"
+
+
+def test_no_uvicorn() -> None:
+    import fastapi_cli.cli
+    import uvicorn
+
+    fastapi_cli.cli.uvicorn = None  # type: ignore[attr-defined, assignment]
+
+    with changing_dir(assets_path):
+        result = runner.invoke(fastapi_cli.cli.app, ["dev", "single_file_app.py"])
+        assert result.exit_code == 1
+        assert result.exception is not None
+        assert (
+            "Could not import Uvicorn, try running 'pip install uvicorn'"
+            in result.exception.args[0]
+        )
+
+    fastapi_cli.cli.uvicorn = uvicorn  # type: ignore[attr-defined]
+
+
+def test_no_fastapi() -> None:
+    import fastapi_cli.discover
+    from fastapi import FastAPI
+
+    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"))
+        assert "Could not import FastAPI, try running 'pip install fastapi'" in str(
+            exc_info.value
+        )
+
+    fastapi_cli.discover.FastAPI = FastAPI  # type: ignore[attr-defined]

fastapi_cli-0.0.2/requirements-tests.txt

@@ -1,6 +0,0 @@
--e .
-
-pytest >=4.4.0,<8.0.0
-coverage[toml] >=6.2,<8.0
-mypy ==1.4.1
-ruff ==0.2.0

fastapi_cli-0.0.2/src/fastapi_cli/__init__.py

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