Skip to content

API log color controlled by rich #198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
robnagler wants to merge 1 commit into
base: main
Choose a base branch
from
Open

API log color controlled by rich #198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ dependencies = [
"requests~=2.32",
"structlog~=24.4",
"colorama~=0.4",
"rich>=14.2.0",
"xarray>=2024.11", # uses datever
"damnit~=0.2.1",
"aiohttp~=3.11",
Expand All @@ -55,7 +56,6 @@ docs = [
develop = [
"datamodel-code-generator[http]>=0.35.0",
"pre-commit>=4.5.1",
"rich>=14.2.0",
"strawberry-graphql[debug-server]>=0.283.3",
]
dev = [
Expand Down
31 changes: 14 additions & 17 deletions api/src/damnit_api/_logging.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
from typing import TYPE_CHECKING

import colorama
import rich.console
import structlog
import structlog.typing
import ulid
Expand Down Expand Up @@ -74,31 +75,27 @@ def configure(

from .shared.settings import settings

def _render_kwargs() -> dict:
rv = dict(
colors=rich.console.Console().color_system is not None,
exception_formatter=RichTracebackFormatter(max_frames=1),
level_styles=None,
sort_keys=False,
)
if rv["colors"]:
rv["level_styles"] = structlog.dev.ConsoleRenderer.get_default_level_styles()
rv["level_styles"]["debug"] = colorama.Fore.MAGENTA
return rv

debug = settings.debug if debug is None else debug
level = settings.log_level if level is None else level

if isinstance(level, str):
level = logging.getLevelNamesMapping()[level.upper()]

level_styles = structlog.dev.ConsoleRenderer.get_default_level_styles()

if debug:
level_styles["debug"] = colorama.Fore.MAGENTA

if debug:
try:
import rich as _ # noqa: F401

exception_formatter = RichTracebackFormatter(max_frames=1)
except Exception:
# Fall back to plain traceback if `rich` isn't installed or import fails
exception_formatter = structlog.dev.plain_traceback # type: ignore[attr-defined]

renderer: structlog.typing.Processor = structlog.dev.ConsoleRenderer(
colors=True,
level_styles=level_styles,
sort_keys=False,
exception_formatter=exception_formatter,
**_render_kwargs()
) # type: ignore[assignment]
else:
renderer = structlog.processors.JSONRenderer(indent=1)
Expand Down