Replace click.style with an internal ANSI style helper (#2981)

Author: Kludex

uvicorn/_ansi.py

@@ -0,0 +1,29 @@
+from __future__ import annotations
+
+_ANSI_COLORS = {
+    "black": 30,
+    "red": 31,
+    "green": 32,
+    "yellow": 33,
+    "blue": 34,
+    "magenta": 35,
+    "cyan": 36,
+    "white": 37,
+    "bright_black": 90,
+    "bright_red": 91,
+    "bright_green": 92,
+    "bright_yellow": 93,
+    "bright_blue": 94,
+    "bright_magenta": 95,
+    "bright_cyan": 96,
+    "bright_white": 97,
+}
+
+
+def style(text: str, fg: str | None = None, bold: bool = False) -> str:
+    prefix = ""
+    if fg is not None:
+        prefix += f"\033[{_ANSI_COLORS[fg]}m"
+    if bold:
+        prefix += "\033[1m"
+    return f"{prefix}{text}\033[0m"

uvicorn/config.py

@@ -14,8 +14,7 @@
 from pathlib import Path
 from typing import IO, Any, Literal
 
-import click
-
+from uvicorn._ansi import style
 from uvicorn._compat import iscoroutinefunction
 from uvicorn._types import ASGIApplication
 from uvicorn.importer import ImportFromStringError, import_from_string
@@ -550,13 +549,13 @@ def bind_socket(self) -> socket.socket:
 
             message = "Uvicorn running on unix socket %s (Press CTRL+C to quit)"
             sock_name_format = "%s"
-            color_message = "Uvicorn running on " + click.style(sock_name_format, bold=True) + " (Press CTRL+C to quit)"
+            color_message = "Uvicorn running on " + style(sock_name_format, bold=True) + " (Press CTRL+C to quit)"
             logger_args = [self.uds]
         elif self.fd is not None:  # pragma: py-win32
             sock = socket.fromfd(self.fd, socket.AF_UNIX, socket.SOCK_STREAM)
             message = "Uvicorn running on socket %s (Press CTRL+C to quit)"
             fd_name_format = "%s"
-            color_message = "Uvicorn running on " + click.style(fd_name_format, bold=True) + " (Press CTRL+C to quit)"
+            color_message = "Uvicorn running on " + style(fd_name_format, bold=True) + " (Press CTRL+C to quit)"
             logger_args = [sock.getsockname()]
         else:
             family = socket.AF_INET
@@ -576,7 +575,7 @@ def bind_socket(self) -> socket.socket:
                 sys.exit(1)
 
             message = f"Uvicorn running on {addr_format} (Press CTRL+C to quit)"
-            color_message = "Uvicorn running on " + click.style(addr_format, bold=True) + " (Press CTRL+C to quit)"
+            color_message = "Uvicorn running on " + style(addr_format, bold=True) + " (Press CTRL+C to quit)"
             protocol_name = "https" if self.is_ssl else "http"
             logger_args = [protocol_name, self.host, sock.getsockname()[1]]
         logger.info(message, *logger_args, extra={"color_message": color_message})

uvicorn/logging.py

@@ -6,7 +6,7 @@
 from copy import copy
 from typing import Literal
 
-import click
+from uvicorn._ansi import style as ansi_style
 
 TRACE_LOG_LEVEL = 5
 
@@ -21,12 +21,12 @@ class ColourizedFormatter(logging.Formatter):
     """
 
     level_name_colors = {
-        TRACE_LOG_LEVEL: lambda level_name: click.style(str(level_name), fg="blue"),
-        logging.DEBUG: lambda level_name: click.style(str(level_name), fg="cyan"),
-        logging.INFO: lambda level_name: click.style(str(level_name), fg="green"),
-        logging.WARNING: lambda level_name: click.style(str(level_name), fg="yellow"),
-        logging.ERROR: lambda level_name: click.style(str(level_name), fg="red"),
-        logging.CRITICAL: lambda level_name: click.style(str(level_name), fg="bright_red"),
+        TRACE_LOG_LEVEL: lambda level_name: ansi_style(str(level_name), fg="blue"),
+        logging.DEBUG: lambda level_name: ansi_style(str(level_name), fg="cyan"),
+        logging.INFO: lambda level_name: ansi_style(str(level_name), fg="green"),
+        logging.WARNING: lambda level_name: ansi_style(str(level_name), fg="yellow"),
+        logging.ERROR: lambda level_name: ansi_style(str(level_name), fg="red"),
+        logging.CRITICAL: lambda level_name: ansi_style(str(level_name), fg="bright_red"),
     }
 
     def __init__(
@@ -72,11 +72,11 @@ def should_use_colors(self) -> bool:
 
 class AccessFormatter(ColourizedFormatter):
     status_code_colours = {
-        1: lambda code: click.style(str(code), fg="bright_white"),
-        2: lambda code: click.style(str(code), fg="green"),
-        3: lambda code: click.style(str(code), fg="yellow"),
-        4: lambda code: click.style(str(code), fg="red"),
-        5: lambda code: click.style(str(code), fg="bright_red"),
+        1: lambda code: ansi_style(str(code), fg="bright_white"),
+        2: lambda code: ansi_style(str(code), fg="green"),
+        3: lambda code: ansi_style(str(code), fg="yellow"),
+        4: lambda code: ansi_style(str(code), fg="red"),
+        5: lambda code: ansi_style(str(code), fg="bright_red"),
     }
 
     def get_status_code(self, status_code: int) -> str:
@@ -106,7 +106,7 @@ def formatMessage(self, record: logging.LogRecord) -> str:
         status_code = self.get_status_code(int(status_code))  # type: ignore[arg-type]
         request_line = f"{method} {full_path} HTTP/{http_version}"
         if self.use_colors:
-            request_line = click.style(request_line, bold=True)
+            request_line = ansi_style(request_line, bold=True)
         recordcopy.__dict__.update(
             {
                 "client_addr": client_addr,

uvicorn/server.py

@@ -17,8 +17,7 @@
 from types import FrameType
 from typing import TYPE_CHECKING, TypeAlias
 
-import click
-
+from uvicorn._ansi import style
 from uvicorn._compat import asyncio_run
 from uvicorn.config import Config
 
@@ -88,7 +87,7 @@ async def _serve(self, sockets: list[socket.socket] | None = None) -> None:
         self.lifespan = config.lifespan_class(config)
 
         message = "Started server process [%d]"
-        color_message = "Started server process [" + click.style("%d", fg="cyan") + "]"
+        color_message = "Started server process [" + style("%d", fg="cyan") + "]"
         logger.info(message, process_id, extra={"color_message": color_message})
 
         await self.startup(sockets=sockets)
@@ -98,7 +97,7 @@ async def _serve(self, sockets: list[socket.socket] | None = None) -> None:
             await self.shutdown(sockets=sockets)
 
             message = "Finished server process [%d]"
-            color_message = "Finished server process [" + click.style("%d", fg="cyan") + "]"
+            color_message = "Finished server process [" + style("%d", fg="cyan") + "]"
             logger.info(message, process_id, extra={"color_message": color_message})
 
     async def startup(self, sockets: list[socket.socket] | None = None) -> None:
@@ -220,7 +219,7 @@ def _log_started_message(self, listeners: Sequence[socket.SocketType]) -> None:
 
             protocol_name = "https" if config.ssl else "http"
             message = f"Uvicorn running on {addr_format} (Press CTRL+C to quit)"
-            color_message = "Uvicorn running on " + click.style(addr_format, bold=True) + " (Press CTRL+C to quit)"
+            color_message = "Uvicorn running on " + style(addr_format, bold=True) + " (Press CTRL+C to quit)"
             logger.info(
                 message,
                 protocol_name,

uvicorn/supervisors/basereload.py

@@ -10,8 +10,7 @@
 from socket import socket
 from types import FrameType
 
-import click
-
+from uvicorn._ansi import style
 from uvicorn._subprocess import get_subprocess
 from uvicorn.config import Config
 
@@ -73,8 +72,8 @@ def __next__(self) -> list[Path] | None:
     def startup(self) -> None:
         message = f"Started reloader process [{self.pid}] using {self.reloader_name}"
         color_message = "Started reloader process [{}] using {}".format(
-            click.style(str(self.pid), fg="cyan", bold=True),
-            click.style(str(self.reloader_name), fg="cyan", bold=True),
+            style(str(self.pid), fg="cyan", bold=True),
+            style(str(self.reloader_name), fg="cyan", bold=True),
         )
         logger.info(message, extra={"color_message": color_message})
 
@@ -111,7 +110,7 @@ def shutdown(self) -> None:
             sock.close()
 
         message = f"Stopping reloader process [{str(self.pid)}]"
-        color_message = "Stopping reloader process [{}]".format(click.style(str(self.pid), fg="cyan", bold=True))
+        color_message = "Stopping reloader process [{}]".format(style(str(self.pid), fg="cyan", bold=True))
         logger.info(message, extra={"color_message": color_message})
 
     def should_restart(self) -> list[Path] | None:

uvicorn/supervisors/multiprocess.py

@@ -9,8 +9,7 @@
 from socket import socket
 from typing import Any
 
-import click
-
+from uvicorn._ansi import style
 from uvicorn._subprocess import get_subprocess
 from uvicorn.config import Config
 
@@ -144,7 +143,7 @@ def restart_all(self) -> None:
 
     def run(self) -> None:
         message = f"Started parent process [{os.getpid()}]"
-        color_message = "Started parent process [{}]".format(click.style(str(os.getpid()), fg="cyan", bold=True))
+        color_message = "Started parent process [{}]".format(style(str(os.getpid()), fg="cyan", bold=True))
         logger.info(message, extra={"color_message": color_message})
 
         self.init_processes()
@@ -157,7 +156,7 @@ def run(self) -> None:
         self.join_all()
 
         message = f"Stopping parent process [{os.getpid()}]"
-        color_message = "Stopping parent process [{}]".format(click.style(str(os.getpid()), fg="cyan", bold=True))
+        color_message = "Stopping parent process [{}]".format(style(str(os.getpid()), fg="cyan", bold=True))
         logger.info(message, extra={"color_message": color_message})
 
     def keep_subprocess_alive(self) -> None: