fastapi-cli 0.0.28__tar.gz → 0.0.30__tar.gz

{fastapi_cli-0.0.28 → fastapi_cli-0.0.30}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-cli
-Version: 0.0.28
+Version: 0.0.30
 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

{fastapi_cli-0.0.28 → fastapi_cli-0.0.30}/pyproject.toml

@@ -38,7 +38,7 @@ dependencies = [
     "rich-toolkit >= 0.14.8",
     "tomli >= 2.0.0; python_version < '3.11'",
 ]
-version = "0.0.28"
+version = "0.0.30"
 
 [project.optional-dependencies]
 standard = [

fastapi_cli-0.0.30/src/fastapi_cli/__init__.py

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

{fastapi_cli-0.0.28 → fastapi_cli-0.0.30}/src/fastapi_cli/cli.py

@@ -20,7 +20,11 @@ from fastapi_cli.exceptions import FastAPICLIException
 
 from . import __version__
 from .logging import setup_logging
-from .utils.cli import get_rich_toolkit, get_uvicorn_log_config
+from .utils.cli import (
+    get_rich_toolkit,
+    get_uvicorn_log_config,
+    should_use_rich_logs,
+)
 
 app = typer.Typer(
     rich_markup_mode="rich", context_settings={"help_option_names": ["-h", "--help"]}
@@ -142,11 +146,12 @@ def _run(
     with get_rich_toolkit() as toolkit:
         server_type = "development" if command == "dev" else "production"
 
-        toolkit.print_title(f"Starting {server_type} server 🚀", tag="FastAPI")
-        toolkit.print_line()
+        toolkit.print(f"Starting FastAPI in {server_type} mode", emoji="⚡️")
 
+        toolkit.print_line()
         toolkit.print(
-            "Searching for package file structure from directories with [blue]__init__.py[/blue] files"
+            "Searching for package file structure from directories with [blue]__init__.py[/blue] files",
+            emoji="🔎",
         )
 
         if entrypoint and (path or app):
@@ -154,7 +159,6 @@ def _run(
             toolkit.print(
                 "[error]Cannot use --entrypoint together with path or --app arguments"
             )
-            toolkit.print_line()
             raise typer.Exit(code=1)
 
         try:
@@ -168,8 +172,6 @@ def _run(
                 field = ".".join(str(loc) for loc in error["loc"])
                 toolkit.print(f"  [red]•[/red] {field}: {error['msg']}")
 
-            toolkit.print_line()
-
             raise typer.Exit(code=1) from None
 
         try:
@@ -193,45 +195,43 @@ def _run(
         module_data = import_data.module_data
         import_string = import_data.import_string
 
-        toolkit.print(f"Importing from {module_data.extra_sys_path}")
+        toolkit.print_line()
+        toolkit.print(f"Importing from {module_data.extra_sys_path}", emoji="📂")
         toolkit.print_line()
 
         if module_data.module_paths:
             root_tree = _get_module_tree(module_data.module_paths)
 
-            toolkit.print(root_tree, tag="module")
-            toolkit.print_line()
+            toolkit.print(root_tree)
+
+        toolkit.print_line()
 
         toolkit.print(
             "Importing the FastAPI app object from the module with the following code:",
-            tag="code",
         )
         toolkit.print_line()
         toolkit.print(
-            f"[underline]from [bold]{module_data.module_import_str}[/bold] import [bold]{import_data.app_name}[/bold]"
+            f"[blue]from [bold]{module_data.module_import_str}[/bold] import [bold]{import_data.app_name}[/bold]",
         )
-        toolkit.print_line()
 
-        toolkit.print(
-            f"Using import string: [blue]{import_string}[/]",
-            tag="app",
-        )
+        toolkit.print_line()
+        toolkit.print(f"Using import string: [blue]{import_string}[/]", emoji="🐍")
 
+        toolkit.print_line()
         mod_source_desc = SOURCE_DESCRIPTIONS[import_data.module_config_source]
         app_source_desc = SOURCE_DESCRIPTIONS[import_data.app_name_config_source]
-        toolkit.print_line()
-        toolkit.print("Configuration sources:", tag="info")
+        toolkit.print("Configuration sources:", emoji="📋")
         if mod_source_desc == app_source_desc:
-            toolkit.print(f" • Import string: {mod_source_desc}")
+            toolkit.print(f"• Import string: {mod_source_desc}")
         else:
-            toolkit.print(f" • Module: {mod_source_desc}")
-            toolkit.print(f" • App name: {app_source_desc}")
+            toolkit.print(f"• Module: {mod_source_desc}")
+            toolkit.print(f"• App name: {app_source_desc}")
 
         if import_data.module_config_source == "auto-discovery":
             toolkit.print_line()
             toolkit.print(
                 "You can configure an entrypoint in [blue]pyproject.toml[/] for this app with:",
-                tag="tip",
+                emoji="💡",
             )
             toolkit.print_line()
             toolkit.print(
@@ -242,24 +242,21 @@ def _run(
                     ),
                     "toml",
                     theme="ansi_light",
-                )
+                ),
             )
 
         url = public_url.rstrip("/") if public_url else f"http://{host}:{port}"
         url_docs = f"{url}/docs"
 
         toolkit.print_line()
-        toolkit.print(
-            f"Server started at [link={url}]{url}[/]",
-            f"Documentation at [link={url_docs}]{url_docs}[/]",
-            tag="server",
-        )
+        toolkit.print(f"Server started at [link={url}]{url}[/]", emoji="🌐")
+        toolkit.print(f"Documentation at [link={url_docs}]{url_docs}[/]")
 
         if command == "dev":
             toolkit.print_line()
             toolkit.print(
                 "Running in development mode, for production use: [bold]fastapi run[/]",
-                tag="tip",
+                emoji="💡",
             )
 
         if not uvicorn:
@@ -268,9 +265,13 @@ def _run(
             ) from None
 
         toolkit.print_line()
-        toolkit.print("Logs:")
+        toolkit.print("Logs:", bullet=False)
         toolkit.print_line()
 
+        extra_uvicorn_kwargs: dict[str, Any] = (
+            {"log_config": get_uvicorn_log_config()} if should_use_rich_logs() else {}
+        )
+
         uvicorn.run(
             app=import_string,
             host=host,
@@ -285,7 +286,7 @@ def _run(
             root_path=root_path,
             proxy_headers=proxy_headers,
             forwarded_allow_ips=forwarded_allow_ips,
-            log_config=get_uvicorn_log_config(),
+            **extra_uvicorn_kwargs,
         )
 
 

fastapi_cli-0.0.30/src/fastapi_cli/utils/cli.py

@@ -0,0 +1,190 @@
+import logging
+import sys
+from typing import Any
+
+from rich._loop import loop_first
+from rich.console import Console, ConsoleOptions, RenderableType, RenderResult
+from rich.segment import Segment
+from rich.text import Text
+from rich_toolkit import RichToolkit
+from rich_toolkit.element import Element
+from rich_toolkit.styles import BaseStyle
+from uvicorn.logging import DefaultFormatter
+
+logger = logging.getLogger(__name__)
+
+
+def should_use_rich_logs() -> bool:
+    """Return True when stdout is a TTY and rich logs should be used, False otherwise."""
+    return sys.stdout.isatty()
+
+
+class IndentedBlock:
+    """Indent a renderable, hanging a prefix (e.g. an emoji bullet) on the
+    first line and aligning wrapped/extra lines under the text."""
+
+    def __init__(
+        self,
+        renderable: RenderableType,
+        *,
+        first_prefix: Text,
+        prefix: Text,
+    ) -> None:
+        self.renderable = renderable
+        self.first_prefix = first_prefix
+        self.prefix = prefix
+
+        # Text renders its `end` ("\n" by default), which would break lines
+        self.first_prefix.end = ""
+        self.prefix.end = ""
+
+    def __rich_console__(
+        self, console: Console, options: ConsoleOptions
+    ) -> RenderResult:
+        prefix_width = max(self.first_prefix.cell_len, self.prefix.cell_len)
+        lines = console.render_lines(
+            self.renderable,
+            options.update_width(options.max_width - prefix_width),
+            pad=False,
+        )
+
+        new_line = Segment.line()
+
+        for first, line in loop_first(lines):
+            if any(segment.text.strip() for segment in line):
+                yield from console.render(
+                    self.first_prefix if first else self.prefix, options
+                )
+                yield from line
+
+            yield new_line
+
+
+class FastAPIStyle(BaseStyle):
+    """Uniform left indent with emoji bullets hanging to the left of the text.
+
+    ``emoji=`` renders as a bullet in a fixed column; ``bullet=False`` drops
+    the bullet column and just indents. This is a small, purpose-built subset
+    of the richer style in fastapi-cloud-cli.
+    """
+
+    content_padding = 1
+    emoji_column_width = 3
+
+    def render_element(
+        self,
+        element: Any,
+        is_active: bool = False,
+        done: bool = False,
+        parent: Element | None = None,
+        **kwargs: Any,
+    ) -> RenderableType:
+        rendered = super().render_element(
+            element=element, is_active=is_active, done=done, parent=parent, **kwargs
+        )
+
+        emoji = kwargs.get("emoji", "")
+
+        if not emoji and not kwargs.get("bullet", True):
+            indent = Text(" " * (self.content_padding + 1))
+            return IndentedBlock(rendered, first_prefix=indent, prefix=indent)
+
+        return IndentedBlock(
+            rendered,
+            first_prefix=self._get_bullet_prefix(emoji),
+            prefix=Text(" " * (self.content_padding + self.emoji_column_width)),
+        )
+
+    def _get_bullet_prefix(self, emoji: str) -> Text:
+        prefix = Text(" " * self.content_padding)
+
+        if emoji:
+            prefix.append_text(Text.from_markup(emoji))
+
+        prefix.pad_right(
+            self.content_padding + self.emoji_column_width - prefix.cell_len
+        )
+
+        return prefix
+
+
+LOG_LEVEL_COLORS = {
+    "debug": "blue",
+    "info": "cyan",
+    "warning": "yellow",
+    "warn": "yellow",
+    "error": "red",
+    "critical": "magenta",
+    "fatal": "magenta",
+}
+
+
+def _get_log_bullet(level: str) -> str:
+    """Colored bar rendered in the emoji bullet column, matching the log
+    level, like the ``fastapi cloud logs`` output."""
+    color = LOG_LEVEL_COLORS.get(level.lower(), "dim")
+
+    return f"[{color}]▕[/{color}]"
+
+
+class CustomFormatter(DefaultFormatter):
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+        self.toolkit = get_rich_toolkit()
+
+    def formatMessage(self, record: logging.LogRecord) -> str:
+        message = record.getMessage()
+        result = self.toolkit.print_as_string(
+            message, emoji=_get_log_bullet(record.levelname)
+        )
+        # Prepend newline to fix alignment after ^C is printed by the terminal
+        if message == "Shutting down":
+            result = "\n" + result
+        return result
+
+
+def get_uvicorn_log_config() -> dict[str, Any]:
+    return {
+        "version": 1,
+        "disable_existing_loggers": False,
+        "formatters": {
+            "default": {
+                "()": CustomFormatter,
+                "fmt": "%(levelprefix)s %(message)s",
+                "use_colors": None,
+            },
+            "access": {
+                "()": CustomFormatter,
+                "fmt": "%(levelprefix)s %(client_addr)s - '%(request_line)s' %(status_code)s",
+            },
+        },
+        "handlers": {
+            "default": {
+                "formatter": "default",
+                "class": "logging.StreamHandler",
+                "stream": "ext://sys.stderr",
+            },
+            "access": {
+                "formatter": "access",
+                "class": "logging.StreamHandler",
+                "stream": "ext://sys.stdout",
+            },
+        },
+        "loggers": {
+            "uvicorn": {
+                "handlers": ["default"],
+                "level": "INFO",
+                "propagate": False,
+            },
+            "uvicorn.error": {"level": "INFO"},
+            "uvicorn.access": {
+                "handlers": ["access"],
+                "level": "INFO",
+                "propagate": False,
+            },
+        },
+    }
+
+
+def get_rich_toolkit() -> RichToolkit:
+    return RichToolkit(style=FastAPIStyle())

{fastapi_cli-0.0.28 → fastapi_cli-0.0.30}/tests/test_cli.py

@@ -16,6 +16,11 @@ runner = CliRunner()
 assets_path = Path(__file__).parent / "assets"
 
 
+@pytest.fixture(autouse=True)
+def force_rich_logs(monkeypatch: pytest.MonkeyPatch) -> None:
+    monkeypatch.setattr("fastapi_cli.cli.should_use_rich_logs", lambda: True)
+
+
 def test_dev() -> None:
     with changing_dir(assets_path):
         with patch.object(uvicorn, "run") as mock_run:
@@ -40,7 +45,7 @@ def test_dev() -> None:
         assert "Module: path CLI argument" in result.output
         assert "App name: auto-discovery" in result.output
         assert "You can configure an entrypoint in pyproject.toml" not in result.output
-        assert "Starting development server 🚀" in result.output
+        assert "Starting FastAPI in development mode" in result.output
         assert "Server started at http://127.0.0.1:8000" in result.output
         assert "Documentation at http://127.0.0.1:8000/docs" in result.output
         assert (
@@ -51,6 +56,21 @@ def test_dev() -> None:
         assert "🐍 single_file_app.py" in result.output
 
 
+def test_run_uses_uvicorn_default_log_config_without_rich_logs(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    monkeypatch.setattr("fastapi_cli.cli.should_use_rich_logs", lambda: False)
+
+    with changing_dir(assets_path):
+        with patch.object(uvicorn, "run") as mock_run:
+            result = runner.invoke(app, ["run", "single_file_app.py"])
+            assert result.exit_code == 0, result.output
+            assert mock_run.called
+            assert mock_run.call_args
+
+    assert "log_config" not in mock_run.call_args.kwargs
+
+
 def test_dev_no_args_auto_discovery() -> None:
     """Test that auto-discovery works when no args and no pyproject.toml entrypoint"""
     with changing_dir(assets_path / "default_files" / "default_main"):
@@ -94,7 +114,7 @@ def test_dev_package() -> None:
         assert "Module: path CLI argument" in result.output
         assert "App name: auto-discovery" in result.output
         assert "You can configure an entrypoint in pyproject.toml" not in result.output
-        assert "Starting development server 🚀" in result.output
+        assert "Starting FastAPI in development mode" in result.output
         assert "Server started at http://127.0.0.1:8000" in result.output
         assert "Documentation at http://127.0.0.1:8000/docs" in result.output
         assert (
@@ -147,7 +167,7 @@ def test_dev_args() -> None:
         assert "Module: path CLI argument" in result.output
         assert "App name: --app CLI option" in result.output
         assert "You can configure an entrypoint in pyproject.toml" not in result.output
-        assert "Starting development server 🚀" in result.output
+        assert "Starting FastAPI in development mode" in result.output
         assert "Server started at http://192.168.0.2:8080" in result.output
         assert "Documentation at http://192.168.0.2:8080/docs" in result.output
         assert (
@@ -181,7 +201,7 @@ def test_dev_env_vars() -> None:
         assert "Module: path CLI argument" in result.output
         assert "App name: auto-discovery" in result.output
         assert "You can configure an entrypoint in pyproject.toml" not in result.output
-        assert "Starting development server 🚀" in result.output
+        assert "Starting FastAPI in development mode" in result.output
         assert "Server started at http://127.0.0.1:8111" in result.output
         assert "Documentation at http://127.0.0.1:8111/docs" in result.output
         assert (
@@ -222,7 +242,7 @@ def test_dev_env_vars_and_args() -> None:
         assert "Module: path CLI argument" in result.output
         assert "App name: auto-discovery" in result.output
         assert "You can configure an entrypoint in pyproject.toml" not in result.output
-        assert "Starting development server 🚀" in result.output
+        assert "Starting FastAPI in development mode" in result.output
         assert "Server started at http://127.0.0.1:8080" in result.output
         assert "Documentation at http://127.0.0.1:8080/docs" in result.output
         assert (
@@ -271,7 +291,7 @@ def test_run() -> None:
         assert "Module: path CLI argument" in result.output
         assert "App name: auto-discovery" in result.output
         assert "You can configure an entrypoint in pyproject.toml" not in result.output
-        assert "Starting production server 🚀" in result.output
+        assert "Starting FastAPI in production mode" in result.output
         assert "Server started at http://0.0.0.0:8000" in result.output
         assert "Documentation at http://0.0.0.0:8000/docs" in result.output
 
@@ -298,7 +318,7 @@ def test_run_trust_proxy() -> None:
                 "log_config": get_uvicorn_log_config(),
             }
         assert "Using import string: single_file_app:app" in result.output
-        assert "Starting production server 🚀" in result.output
+        assert "Starting FastAPI in production mode" in result.output
         assert "Server started at http://0.0.0.0:8000" in result.output
         assert "Documentation at http://0.0.0.0:8000/docs" in result.output
         assert (
@@ -349,7 +369,7 @@ def test_run_args() -> None:
         assert "Module: path CLI argument" in result.output
         assert "App name: --app CLI option" in result.output
         assert "You can configure an entrypoint in pyproject.toml" not in result.output
-        assert "Starting production server 🚀" in result.output
+        assert "Starting FastAPI in production mode" in result.output
         assert "Server started at http://192.168.0.2:8080" in result.output
         assert "Documentation at http://192.168.0.2:8080/docs" in result.output
         assert (
@@ -383,7 +403,7 @@ def test_run_env_vars() -> None:
         assert "Module: path CLI argument" in result.output
         assert "App name: auto-discovery" in result.output
         assert "You can configure an entrypoint in pyproject.toml" not in result.output
-        assert "Starting production server 🚀" in result.output
+        assert "Starting FastAPI in production mode" in result.output
         assert "Server started at http://0.0.0.0:8111" in result.output
         assert "Documentation at http://0.0.0.0:8111/docs" in result.output
 
@@ -420,7 +440,7 @@ def test_run_env_vars_and_args() -> None:
         assert "Module: path CLI argument" in result.output
         assert "App name: auto-discovery" in result.output
         assert "You can configure an entrypoint in pyproject.toml" not in result.output
-        assert "Starting production server 🚀" in result.output
+        assert "Starting FastAPI in production mode" in result.output
         assert "Server started at http://0.0.0.0:8080" in result.output
         assert "Documentation at http://0.0.0.0:8080/docs" in result.output
 
@@ -465,7 +485,7 @@ def test_public_url_env_var(command: str, public_url: str) -> None:
 
         assert "Using import string: single_file_app:app" in result.output
         assert (
-            f"Starting {'development' if command == 'dev' else 'production'} server 🚀"
+            f"Starting FastAPI in {'development' if command == 'dev' else 'production'} mode"
             in result.output
         )
         expected_url_base = public_url.rstrip("/")

{fastapi_cli-0.0.28 → fastapi_cli-0.0.30}/tests/test_utils_cli.py

@@ -1,9 +1,15 @@
+import io
 import logging
+import sys
 from logging.config import dictConfig
 
-from pytest import LogCaptureFixture
+from pytest import LogCaptureFixture, MonkeyPatch
 
-from fastapi_cli.utils.cli import CustomFormatter, get_uvicorn_log_config
+from fastapi_cli.utils.cli import (
+    CustomFormatter,
+    get_uvicorn_log_config,
+    should_use_rich_logs,
+)
 
 
 def test_get_uvicorn_config_uses_custom_formatter() -> None:
@@ -14,6 +20,14 @@ def test_get_uvicorn_config_uses_custom_formatter() -> None:
     assert config["loggers"]["uvicorn"]["propagate"] is False
 
 
+def test_should_use_rich_logs_is_false_without_tty(
+    monkeypatch: MonkeyPatch,
+) -> None:
+    monkeypatch.setattr(sys, "stdout", io.StringIO())
+
+    assert should_use_rich_logs() is False
+
+
 def test_custom_formatter() -> None:
     formatter = CustomFormatter()
 
@@ -33,7 +47,8 @@ def test_custom_formatter() -> None:
 
     formatted = formatter.formatMessage(record)
 
-    assert "INFO" in formatted
+    # the log level is shown as a colored bar bullet, like `fastapi cloud logs`
+    assert "▕" in formatted
     assert "127.0.0.1" in formatted
     assert "GET / HTTP/1.1" in formatted
     assert "200" in formatted

fastapi_cli-0.0.28/src/fastapi_cli/__init__.py

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

fastapi_cli-0.0.28/src/fastapi_cli/utils/cli.py

@@ -1,85 +0,0 @@
-import logging
-from typing import Any
-
-from rich_toolkit import RichToolkit, RichToolkitTheme
-from rich_toolkit.styles import TaggedStyle
-from uvicorn.logging import DefaultFormatter
-
-
-class CustomFormatter(DefaultFormatter):
-    def __init__(self, *args: Any, **kwargs: Any) -> None:
-        super().__init__(*args, **kwargs)
-        self.toolkit = get_rich_toolkit()
-
-    def formatMessage(self, record: logging.LogRecord) -> str:
-        message = record.getMessage()
-        result = self.toolkit.print_as_string(message, tag=record.levelname)
-        # Prepend newline to fix alignment after ^C is printed by the terminal
-        if message == "Shutting down":
-            result = "\n" + result
-        return result
-
-
-def get_uvicorn_log_config() -> dict[str, Any]:
-    return {
-        "version": 1,
-        "disable_existing_loggers": False,
-        "formatters": {
-            "default": {
-                "()": CustomFormatter,
-                "fmt": "%(levelprefix)s %(message)s",
-                "use_colors": None,
-            },
-            "access": {
-                "()": CustomFormatter,
-                "fmt": "%(levelprefix)s %(client_addr)s - '%(request_line)s' %(status_code)s",
-            },
-        },
-        "handlers": {
-            "default": {
-                "formatter": "default",
-                "class": "logging.StreamHandler",
-                "stream": "ext://sys.stderr",
-            },
-            "access": {
-                "formatter": "access",
-                "class": "logging.StreamHandler",
-                "stream": "ext://sys.stdout",
-            },
-        },
-        "loggers": {
-            "uvicorn": {
-                "handlers": ["default"],
-                "level": "INFO",
-                "propagate": False,
-            },
-            "uvicorn.error": {"level": "INFO"},
-            "uvicorn.access": {
-                "handlers": ["access"],
-                "level": "INFO",
-                "propagate": False,
-            },
-        },
-    }
-
-
-logger = logging.getLogger(__name__)
-
-
-def get_rich_toolkit() -> RichToolkit:
-    theme = RichToolkitTheme(
-        style=TaggedStyle(tag_width=11),
-        theme={
-            "tag.title": "white on #009485",
-            "tag": "white on #007166",
-            "placeholder": "grey85",
-            "text": "white",
-            "selected": "#007166",
-            "result": "grey85",
-            "progress": "on #007166",
-            "error": "red",
-            "log.info": "black on blue",
-        },
-    )
-
-    return RichToolkit(theme=theme)