🐛 Avoid fancy logs for non-TTY output

Shortcake-Parent: main

Author: patrick91

src/fastapi_cli/cli.py

@@ -20,7 +20,7 @@
 
 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_toolkit
 
 app = typer.Typer(
     rich_markup_mode="rich", context_settings={"help_option_names": ["-h", "--help"]}
@@ -139,15 +139,20 @@ def _run(
     forwarded_allow_ips: str | None = None,
     public_url: str | None = None,
 ) -> None:
-    with get_rich_toolkit() as toolkit:
+    use_rich = should_use_rich_toolkit()
+    with get_rich_toolkit(use_rich=use_rich) as toolkit:
         server_type = "development" if command == "dev" else "production"
 
-        toolkit.print_title(f"Starting {server_type} server 🚀", tag="FastAPI")
-        toolkit.print_line()
+        if use_rich:
+            toolkit.print_title(f"Starting {server_type} server 🚀", tag="FastAPI")
+        else:
+            toolkit.print_title("⚡️ Starting FastAPI")
 
-        toolkit.print(
-            "Searching for package file structure from directories with [blue]__init__.py[/blue] files"
-        )
+        if use_rich:
+            toolkit.print_line()
+            toolkit.print(
+                "Searching for package file structure from directories with [blue]__init__.py[/blue] files"
+            )
 
         if entrypoint and (path or app):
             toolkit.print_line()
@@ -193,69 +198,76 @@ 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()
-
-        if module_data.module_paths:
-            root_tree = _get_module_tree(module_data.module_paths)
-
-            toolkit.print(root_tree, tag="module")
+        if use_rich:
+            toolkit.print(f"Importing from {module_data.extra_sys_path}")
             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]"
-        )
-        toolkit.print_line()
-
-        toolkit.print(
-            f"Using import string: [blue]{import_string}[/]",
-            tag="app",
-        )
+            if module_data.module_paths:
+                root_tree = _get_module_tree(module_data.module_paths)
 
-        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")
-        if mod_source_desc == app_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(root_tree, tag="module")
+                toolkit.print_line()
 
-        if import_data.module_config_source == "auto-discovery":
+            toolkit.print(
+                "Importing the FastAPI app object from the module with the following code:",
+                tag="code",
+            )
             toolkit.print_line()
             toolkit.print(
-                "You can configure an entrypoint in [blue]pyproject.toml[/] for this app with:",
-                tag="tip",
+                f"[underline]from [bold]{module_data.module_import_str}[/bold] import [bold]{import_data.app_name}[/bold]"
             )
             toolkit.print_line()
+
             toolkit.print(
-                Syntax(
-                    (
-                        "[tool.fastapi]\n"
-                        f'entrypoint = "{import_data.module_data.module_import_str}:{import_data.app_name}"'
-                    ),
-                    "toml",
-                    theme="ansi_light",
-                )
+                f"Using import string: [blue]{import_string}[/]",
+                tag="app",
             )
+        else:
+            toolkit.print(f"🐍 App: [blue]{import_string}[/]")
+
+        if use_rich:
+            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")
+            if mod_source_desc == app_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}")
+
+            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",
+                )
+                toolkit.print_line()
+                toolkit.print(
+                    Syntax(
+                        (
+                            "[tool.fastapi]\n"
+                            f'entrypoint = "{import_data.module_data.module_import_str}:{import_data.app_name}"'
+                        ),
+                        "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",
-        )
+        if use_rich:
+            toolkit.print_line()
+            toolkit.print(f"Server started at [link={url}]{url}[/]", tag="server")
+            toolkit.print(
+                f"Documentation at [link={url_docs}]{url_docs}[/]", tag="server"
+            )
+        else:
+            toolkit.print(f"🌐 Server: [link={url}]{url}[/]")
+            toolkit.print(f"📚 Docs: [link={url_docs}]{url_docs}[/]")
 
-        if command == "dev":
+        if command == "dev" and use_rich:
             toolkit.print_line()
             toolkit.print(
                 "Running in development mode, for production use: [bold]fastapi run[/]",
@@ -267,9 +279,10 @@ def _run(
                 "Could not import Uvicorn, try running 'pip install uvicorn'"
             ) from None
 
-        toolkit.print_line()
-        toolkit.print("Logs:")
-        toolkit.print_line()
+        if use_rich:
+            toolkit.print_line()
+            toolkit.print("Logs:")
+            toolkit.print_line()
 
         uvicorn.run(
             app=import_string,

src/fastapi_cli/logging.py

@@ -1,22 +1,40 @@
 import logging
+import sys
+from typing import Any
 
 from rich.console import Console
 from rich.logging import RichHandler
 
 
-def setup_logging(terminal_width: int | None = None, level: int = logging.INFO) -> None:
+def _stream_is_tty(stream: Any) -> bool:
+    return bool(getattr(stream, "isatty", lambda: False)())
+
+
+def setup_logging(
+    terminal_width: int | None = None,
+    level: int = logging.INFO,
+    use_rich: bool | None = None,
+) -> None:
     logger = logging.getLogger("fastapi_cli")
-    console = Console(width=terminal_width) if terminal_width else None
-    rich_handler = RichHandler(
-        show_time=False,
-        rich_tracebacks=True,
-        tracebacks_show_locals=True,
-        markup=True,
-        show_path=False,
-        console=console,
-    )
-    rich_handler.setFormatter(logging.Formatter("%(message)s"))
-    logger.addHandler(rich_handler)
+    if use_rich is None:
+        use_rich = _stream_is_tty(sys.stderr)
+
+    if use_rich:
+        console = Console(width=terminal_width) if terminal_width else None
+        handler: logging.Handler = RichHandler(
+            show_time=False,
+            rich_tracebacks=True,
+            tracebacks_show_locals=True,
+            markup=True,
+            show_path=False,
+            console=console,
+        )
+        handler.setFormatter(logging.Formatter("%(message)s"))
+    else:
+        handler = logging.StreamHandler()
+        handler.setFormatter(logging.Formatter("%(levelname)s:%(name)s:%(message)s"))
+
+    logger.addHandler(handler)
 
     logger.setLevel(level)
     logger.propagate = False

src/fastapi_cli/utils/cli.py

@@ -1,15 +1,16 @@
 import logging
+import sys
 from typing import Any
 
 from rich_toolkit import RichToolkit, RichToolkitTheme
 from rich_toolkit.styles import TaggedStyle
-from uvicorn.logging import DefaultFormatter
+from uvicorn.logging import AccessFormatter, DefaultFormatter
 
 
 class CustomFormatter(DefaultFormatter):
     def __init__(self, *args: Any, **kwargs: Any) -> None:
         super().__init__(*args, **kwargs)
-        self.toolkit = get_rich_toolkit()
+        self.toolkit = get_rich_toolkit(use_rich=True)
 
     def formatMessage(self, record: logging.LogRecord) -> str:
         message = record.getMessage()
@@ -20,20 +21,40 @@ def formatMessage(self, record: logging.LogRecord) -> str:
         return result
 
 
-def get_uvicorn_log_config() -> dict[str, Any]:
+def _stream_is_tty(stream: Any) -> bool:
+    return bool(getattr(stream, "isatty", lambda: False)())
+
+
+def get_uvicorn_log_config(use_rich: bool | None = None) -> dict[str, Any]:
+    if use_rich is None:
+        use_rich = _stream_is_tty(sys.stderr) and _stream_is_tty(sys.stdout)
+
+    default_formatter: dict[str, Any] = {
+        "()": DefaultFormatter,
+        "fmt": "%(levelprefix)s %(message)s",
+        "use_colors": None,
+    }
+    access_formatter: dict[str, Any] = {
+        "()": AccessFormatter,
+        "fmt": '%(levelprefix)s %(client_addr)s - "%(request_line)s" %(status_code)s',
+    }
+    if use_rich:
+        default_formatter = {
+            "()": CustomFormatter,
+            "fmt": "%(levelprefix)s %(message)s",
+            "use_colors": None,
+        }
+        access_formatter = {
+            "()": CustomFormatter,
+            "fmt": "%(levelprefix)s %(client_addr)s - '%(request_line)s' %(status_code)s",
+        }
+
     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",
-            },
+            "default": default_formatter,
+            "access": access_formatter,
         },
         "handlers": {
             "default": {
@@ -66,7 +87,17 @@ def get_uvicorn_log_config() -> dict[str, Any]:
 logger = logging.getLogger(__name__)
 
 
-def get_rich_toolkit() -> RichToolkit:
+def should_use_rich_toolkit() -> bool:
+    return _stream_is_tty(sys.stdout)
+
+
+def get_rich_toolkit(use_rich: bool | None = None) -> RichToolkit:
+    if use_rich is None:
+        use_rich = should_use_rich_toolkit()
+
+    if not use_rich:
+        return RichToolkit()
+
     theme = RichToolkitTheme(
         style=TaggedStyle(tag_width=11),
         theme={

tests/test_cli.py

@@ -16,6 +16,11 @@
 assets_path = Path(__file__).parent / "assets"
 
 
+@pytest.fixture(autouse=True)
+def force_rich_toolkit(monkeypatch: pytest.MonkeyPatch) -> None:
+    monkeypatch.setattr("fastapi_cli.cli.should_use_rich_toolkit", lambda: True)
+
+
 def test_dev() -> None:
     with changing_dir(assets_path):
         with patch.object(uvicorn, "run") as mock_run:
@@ -51,6 +56,32 @@ def test_dev() -> None:
         assert "🐍 single_file_app.py" in result.output
 
 
+def test_run_uses_minimal_output_without_tty(monkeypatch: pytest.MonkeyPatch) -> None:
+    monkeypatch.setattr("fastapi_cli.cli.should_use_rich_toolkit", 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 "⚡️ Starting FastAPI" in result.output
+    assert "🐍 App: single_file_app:app" in result.output
+    assert "🌐 Server: http://0.0.0.0:8000" in result.output
+    assert "📚 Docs: http://0.0.0.0:8000/docs" in result.output
+    assert "Logs:" not in result.output
+    assert "Source:" not in result.output
+    assert "Server started at" not in result.output
+    assert "Documentation at" not in result.output
+    assert "Searching for package file structure" not in result.output
+    assert "Importing from" not in result.output
+    assert "🐍 single_file_app.py" not in result.output
+    assert "Importing the FastAPI app object" not in result.output
+    assert "Using import string:" not in result.output
+    assert "Configuration sources:" not in result.output
+    assert "You can configure an entrypoint" not in result.output
+
+
 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"):

tests/test_cli_pyproject.py

@@ -1,6 +1,7 @@
 from pathlib import Path
 from unittest.mock import patch
 
+import pytest
 import uvicorn
 from typer.testing import CliRunner
 
@@ -12,6 +13,11 @@
 assets_path = Path(__file__).parent / "assets"
 
 
+@pytest.fixture(autouse=True)
+def force_rich_toolkit(monkeypatch: pytest.MonkeyPatch) -> None:
+    monkeypatch.setattr("fastapi_cli.cli.should_use_rich_toolkit", lambda: True)
+
+
 def test_dev_with_pyproject_app_config_uses() -> None:
     with (
         changing_dir(assets_path / "pyproject_config"),