add logging overriding

Author: 07pepa

src/fastapi_cli/cli.py

@@ -6,6 +6,7 @@
 from rich import print
 from rich.tree import Tree
 from typing_extensions import Annotated
+from uvicorn.config import LOGGING_CONFIG
 
 from fastapi_cli.discover import get_import_data
 from fastapi_cli.exceptions import FastAPICLIException
@@ -86,6 +87,7 @@ def _run(
     command: str,
     app: Union[str, None] = None,
     proxy_headers: bool = False,
+    log_config: Union[Path, None] = None,
 ) -> None:
     with get_rich_toolkit() as toolkit:
         server_type = "development" if command == "dev" else "production"
@@ -167,7 +169,7 @@ def _run(
             workers=workers,
             root_path=root_path,
             proxy_headers=proxy_headers,
-            log_config=get_uvicorn_log_config(),
+            log_config=get_uvicorn_log_config() if not log_config else str(log_config),
         )
 
 
@@ -216,6 +218,12 @@ def dev(
             help="Enable/Disable X-Forwarded-Proto, X-Forwarded-For, X-Forwarded-Port to populate remote address info."
         ),
     ] = True,
+    log_config: Annotated[
+        Union[Path, None],
+        typer.Option(
+            help="Logging configuration file. Supported formats: .ini, .json, .yaml. be tried."
+        ),
+    ] = None,
 ) -> Any:
     """
     Run a [bold]FastAPI[/bold] app in [yellow]development[/yellow] mode. 🧪
@@ -251,6 +259,7 @@ def dev(
         app=app,
         command="dev",
         proxy_headers=proxy_headers,
+        log_config=log_config,
     )
 
 
@@ -305,6 +314,12 @@ def run(
             help="Enable/Disable X-Forwarded-Proto, X-Forwarded-For, X-Forwarded-Port to populate remote address info."
         ),
     ] = True,
+    log_config: Annotated[
+        Union[Path, None],
+        typer.Option(
+            help="Logging configuration file. Supported formats: .ini, .json, .yaml."
+        ),
+    ] = None,
 ) -> Any:
     """
     Run a [bold]FastAPI[/bold] app in [green]production[/green] mode. 🚀
@@ -341,6 +356,7 @@ def run(
         app=app,
         command="run",
         proxy_headers=proxy_headers,
+        log_config=log_config,
     )
 
 

tests/assets/log_config.yaml

@@ -0,0 +1,34 @@
+version: 1
+disable_existing_loggers: False
+formatters:
+  default:
+    # "()": uvicorn.logging.DefaultFormatter
+    format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
+  access:
+    # "()": uvicorn.logging.AccessFormatter
+    format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
+handlers:
+  default:
+    formatter: default
+    class: logging.StreamHandler
+    stream: ext://sys.stderr
+  access:
+    formatter: access
+    class: logging.StreamHandler
+    stream: ext://sys.stdout
+loggers:
+  uvicorn.error:
+    level: DEBUG
+    handlers:
+      - default
+    propagate: no
+  uvicorn.access:
+    level: DEBUG
+    handlers:
+      - access
+    propagate: no
+root:
+  level: INFO
+  handlers:
+    - default
+  propagate: no

tests/test_cli.py

@@ -94,6 +94,8 @@ def test_dev_args() -> None:
                     "--app",
                     "api",
                     "--no-proxy-headers",
+                    "--log-config",
+                    "log_config.yaml",
                 ],
             )
             assert result.exit_code == 0, result.output
@@ -107,7 +109,7 @@ def test_dev_args() -> None:
                 "workers": None,
                 "root_path": "/api",
                 "proxy_headers": False,
-                "log_config": get_uvicorn_log_config(),
+                "log_config": "log_config.yaml",
             }
         assert "Using import string: single_file_app:api" in result.output
         assert "Starting development server 🚀" in result.output
@@ -166,6 +168,8 @@ def test_run_args() -> None:
                     "--app",
                     "api",
                     "--no-proxy-headers",
+                    "--log-config",
+                    "log_config.yaml",
                 ],
             )
             assert result.exit_code == 0, result.output
@@ -179,7 +183,7 @@ def test_run_args() -> None:
                 "workers": 2,
                 "root_path": "/api",
                 "proxy_headers": False,
-                "log_config": get_uvicorn_log_config(),
+                "log_config": "log_config.yaml",
             }
 
         assert "Using import string: single_file_app:api" in result.output
@@ -218,6 +222,10 @@ def test_dev_help() -> None:
     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
+    assert (
+        "Logging configuration file. Supported formats: .ini, .json, .yaml."
+        in result.output
+    )
 
 
 def test_run_help() -> None:
@@ -239,6 +247,10 @@ def test_run_help() -> None:
     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
+    assert (
+        "Logging configuration file. Supported formats: .ini, .json, .yaml."
+        in result.output
+    )
 
 
 def test_callback_help() -> None: