🐛 Avoid fancy logs for non-TTY output

Shortcake-Parent: main

Author: patrick91

src/fastapi_cli/cli.py

@@ -20,7 +20,11 @@
 
 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_uvicorn_logs,
+)
 
 app = typer.Typer(
     rich_markup_mode="rich", context_settings={"help_option_names": ["-h", "--help"]}
@@ -271,22 +275,25 @@ def _run(
         toolkit.print("Logs:")
         toolkit.print_line()
 
-        uvicorn.run(
-            app=import_string,
-            host=host,
-            port=port,
-            reload=reload,
-            reload_dirs=(
+        uvicorn_kwargs: dict[str, Any] = {
+            "app": import_string,
+            "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,
-            forwarded_allow_ips=forwarded_allow_ips,
-            log_config=get_uvicorn_log_config(),
-        )
+            "workers": workers,
+            "root_path": root_path,
+            "proxy_headers": proxy_headers,
+            "forwarded_allow_ips": forwarded_allow_ips,
+        }
+        if should_use_rich_uvicorn_logs():
+            uvicorn_kwargs["log_config"] = get_uvicorn_log_config()
+
+        uvicorn.run(**uvicorn_kwargs)
 
 
 @app.command()

src/fastapi_cli/logging.py

@@ -1,22 +1,35 @@
 import logging
+import sys
 
 from rich.console import Console
 from rich.logging import RichHandler
 
 
-def setup_logging(terminal_width: int | None = None, level: int = logging.INFO) -> None:
+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 = sys.stderr.isatty()
+
+    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,4 +1,5 @@
 import logging
+import sys
 from typing import Any
 
 from rich_toolkit import RichToolkit, RichToolkitTheme
@@ -20,6 +21,10 @@ def formatMessage(self, record: logging.LogRecord) -> str:
         return result
 
 
+def should_use_rich_uvicorn_logs() -> bool:
+    return sys.stderr.isatty() and sys.stdout.isatty()
+
+
 def get_uvicorn_log_config() -> dict[str, Any]:
     return {
         "version": 1,

tests/test_cli.py

@@ -16,6 +16,11 @@
 assets_path = Path(__file__).parent / "assets"
 
 
+@pytest.fixture(autouse=True)
+def force_rich_uvicorn_logs(monkeypatch: pytest.MonkeyPatch) -> None:
+    monkeypatch.setattr("fastapi_cli.cli.should_use_rich_uvicorn_logs", lambda: True)
+
+
 def test_dev() -> None:
     with changing_dir(assets_path):
         with patch.object(uvicorn, "run") as mock_run:
@@ -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_uvicorn_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"):

tests/test_logging.py

@@ -0,0 +1,54 @@
+import io
+import logging
+import sys
+
+from pytest import MonkeyPatch
+from rich.logging import RichHandler
+
+from fastapi_cli.logging import setup_logging
+
+
+def test_setup_logging_uses_rich_handler_when_requested() -> None:
+    logger = logging.getLogger("fastapi_cli")
+    original_handlers = logger.handlers[:]
+    original_level = logger.level
+    original_propagate = logger.propagate
+    try:
+        logger.handlers = []
+
+        setup_logging(use_rich=True)
+
+        assert len(logger.handlers) == 1
+        assert isinstance(logger.handlers[0], RichHandler)
+    finally:
+        for handler in logger.handlers:
+            if handler not in original_handlers:
+                handler.close()
+        logger.handlers = original_handlers
+        logger.setLevel(original_level)
+        logger.propagate = original_propagate
+
+
+def test_setup_logging_uses_stream_handler_without_tty(
+    monkeypatch: MonkeyPatch,
+) -> None:
+    logger = logging.getLogger("fastapi_cli")
+    original_handlers = logger.handlers[:]
+    original_level = logger.level
+    original_propagate = logger.propagate
+    try:
+        logger.handlers = []
+        monkeypatch.setattr(sys, "stderr", io.StringIO())
+
+        setup_logging()
+
+        assert len(logger.handlers) == 1
+        assert isinstance(logger.handlers[0], logging.StreamHandler)
+        assert not isinstance(logger.handlers[0], RichHandler)
+    finally:
+        for handler in logger.handlers:
+            if handler not in original_handlers:
+                handler.close()
+        logger.handlers = original_handlers
+        logger.setLevel(original_level)
+        logger.propagate = original_propagate

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_uvicorn_logs,
+)
 
 
 def test_get_uvicorn_config_uses_custom_formatter() -> None:
@@ -14,6 +20,15 @@ def test_get_uvicorn_config_uses_custom_formatter() -> None:
     assert config["loggers"]["uvicorn"]["propagate"] is False
 
 
+def test_should_use_rich_uvicorn_logs_is_false_without_tty(
+    monkeypatch: MonkeyPatch,
+) -> None:
+    monkeypatch.setattr(sys, "stderr", io.StringIO())
+    monkeypatch.setattr(sys, "stdout", io.StringIO())
+
+    assert should_use_rich_uvicorn_logs() is False
+
+
 def test_custom_formatter() -> None:
     formatter = CustomFormatter()