clan-cli: clan_cli.custom_logger -> clan_lib.custom_logger
This commit is contained in:
lassulus
@@ -14,6 +14,7 @@ from .clan import show, update
|
||||
# API endpoints that are not used in the cli.
|
||||
__all__ = ["directory", "disk", "mdns_discovery", "modules", "update"]
|
||||
|
||||
from clan_lib.custom_logger import setup_logging
|
||||
from clan_lib.dirs import get_clan_flake_toplevel_or_env
|
||||
from clan_lib.errors import ClanError
|
||||
from clan_lib.flake import Flake
|
||||
@@ -26,7 +27,6 @@ from . import (
|
||||
state,
|
||||
vms,
|
||||
)
|
||||
from .custom_logger import setup_logging
|
||||
from .facts import cli as facts
|
||||
from .flash import cli as flash_cli
|
||||
from .hyperlink import help_hyperlink
|
||||
|
||||
@@ -1,159 +0,0 @@
|
||||
import inspect
|
||||
import logging
|
||||
import os
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
from clan_lib.colors import AnsiColor, RgbColor, color_by_tuple
|
||||
|
||||
# https://no-color.org
|
||||
DISABLE_COLOR = not sys.stderr.isatty() or os.environ.get("NO_COLOR", "") != ""
|
||||
|
||||
|
||||
def _get_filepath(record: logging.LogRecord) -> Path:
|
||||
try:
|
||||
filepath = Path(record.pathname).resolve()
|
||||
filepath = Path("~", filepath.relative_to(Path.home()))
|
||||
except Exception:
|
||||
filepath = Path(record.pathname)
|
||||
return filepath
|
||||
|
||||
|
||||
class PrefixFormatter(logging.Formatter):
|
||||
"""
|
||||
print errors in red and warnings in yellow
|
||||
"""
|
||||
|
||||
def __init__(self, trace_prints: bool = False) -> None:
|
||||
super().__init__()
|
||||
|
||||
self.trace_prints = trace_prints
|
||||
self.hostnames: list[str] = []
|
||||
self.hostname_color_offset = 0
|
||||
|
||||
def format(self, record: logging.LogRecord) -> str:
|
||||
# If extra["color"] is set, use that color for the message.
|
||||
msg_color = getattr(record, "color", None)
|
||||
if not msg_color:
|
||||
if record.levelno == logging.DEBUG:
|
||||
msg_color = AnsiColor.BLUE.value
|
||||
elif record.levelno == logging.ERROR:
|
||||
msg_color = AnsiColor.RED.value
|
||||
elif record.levelno == logging.WARNING:
|
||||
msg_color = AnsiColor.YELLOW.value
|
||||
else:
|
||||
msg_color = AnsiColor.DEFAULT.value
|
||||
|
||||
# If extra["command_prefix"] is set, use that as the logging prefix.
|
||||
command_prefix = getattr(record, "command_prefix", None)
|
||||
|
||||
# If color is disabled, don't use color.
|
||||
if DISABLE_COLOR:
|
||||
if command_prefix:
|
||||
format_str = f"[{command_prefix}] %(message)s"
|
||||
else:
|
||||
format_str = "%(message)s"
|
||||
|
||||
# If command_prefix is set, color the prefix with a unique color.
|
||||
elif command_prefix:
|
||||
command_prefix = command_prefix[
|
||||
:20
|
||||
] # Truncate the command prefix to 10 characters.
|
||||
prefix_color = self.hostname_colorcode(command_prefix)
|
||||
format_str = color_by_tuple(f"[{command_prefix}]", fg=prefix_color)
|
||||
format_str += color_by_tuple(" %(message)s", fg=msg_color)
|
||||
|
||||
# If command_prefix is not set, color the message with the default level color.
|
||||
else:
|
||||
format_str = color_by_tuple("%(message)s", fg=msg_color)
|
||||
|
||||
# Add the source file and line number if trace_prints is enabled.
|
||||
if self.trace_prints:
|
||||
filepath = _get_filepath(record)
|
||||
format_str += f"\nSource: {filepath}:%(lineno)d::%(funcName)s\n"
|
||||
|
||||
return logging.Formatter(format_str).format(record)
|
||||
|
||||
def hostname_colorcode(self, hostname: str) -> tuple[int, int, int]:
|
||||
colorcodes = RgbColor.list_values()
|
||||
try:
|
||||
index = self.hostnames.index(hostname)
|
||||
except ValueError:
|
||||
self.hostnames += [hostname]
|
||||
index = self.hostnames.index(hostname)
|
||||
coloroffset = (index + self.hostname_color_offset) % len(colorcodes)
|
||||
colorcode = colorcodes[coloroffset]
|
||||
|
||||
return colorcode
|
||||
|
||||
|
||||
def get_callers(start: int = 2, end: int = 2) -> list[str]:
|
||||
"""
|
||||
Get a list of caller information for a given range in the call stack.
|
||||
|
||||
:param start: The starting position in the call stack (1 being directly above in the call stack).
|
||||
:param end: The end position in the call stack.
|
||||
:return: A list of strings, each containing the file, line number, and function of the caller.
|
||||
"""
|
||||
|
||||
frame = inspect.currentframe()
|
||||
if frame is None:
|
||||
return ["unknown"]
|
||||
|
||||
callers = []
|
||||
current_frame = frame.f_back # start from the caller of this function
|
||||
|
||||
# Skip `start - 1` frames.
|
||||
for _ in range(start - 1):
|
||||
if current_frame is not None:
|
||||
current_frame = current_frame.f_back
|
||||
else:
|
||||
# If there aren't enough frames, return what we have as "unknown".
|
||||
return ["unknown"] * (end - start + 1)
|
||||
|
||||
# Collect frame info until the `end` position.
|
||||
for _ in range(end - start + 1):
|
||||
if current_frame is not None:
|
||||
frame_info = inspect.getframeinfo(current_frame)
|
||||
|
||||
try:
|
||||
filepath = Path(frame_info.filename).resolve()
|
||||
filepath = Path("~", filepath.relative_to(Path.home()))
|
||||
except Exception:
|
||||
filepath = Path(frame_info.filename)
|
||||
|
||||
ret = f"{filepath}:{frame_info.lineno}::{frame_info.function}"
|
||||
callers.append(ret)
|
||||
current_frame = current_frame.f_back
|
||||
else:
|
||||
# If there are no more frames but we haven't reached `end`, append "unknown".
|
||||
callers.append("unknown")
|
||||
|
||||
return callers
|
||||
|
||||
|
||||
def print_trace(msg: str, logger: logging.Logger, prefix: str | None) -> None:
|
||||
trace_depth = int(os.environ.get("TRACE_DEPTH", "0"))
|
||||
callers = get_callers(3, 4 + trace_depth)
|
||||
callers.pop()
|
||||
|
||||
if len(callers) == 1:
|
||||
callers_str = f"Caller: {callers[0]}\n"
|
||||
else:
|
||||
callers_str = "\n".join(
|
||||
f"{i + 1}: {caller}" for i, caller in enumerate(callers)
|
||||
)
|
||||
callers_str = f"Callers:\n{callers_str}"
|
||||
logger.debug(f"{msg} \n{callers_str}", extra={"command_prefix": prefix})
|
||||
|
||||
|
||||
def setup_logging(level: int) -> None:
|
||||
root_logger = logging.getLogger()
|
||||
root_logger.setLevel(level)
|
||||
|
||||
# Set our formatter handler
|
||||
default_handler = logging.StreamHandler()
|
||||
default_handler.setLevel(level)
|
||||
trace_prints = bool(int(os.environ.get("TRACE_PRINT", "0")))
|
||||
default_handler.setFormatter(PrefixFormatter(trace_prints))
|
||||
root_logger.addHandler(default_handler)
|
||||
@@ -3,7 +3,7 @@ import logging
|
||||
import shlex
|
||||
|
||||
from clan_cli import create_parser
|
||||
from clan_cli.custom_logger import print_trace
|
||||
from clan_lib.custom_logger import print_trace
|
||||
|
||||
log = logging.getLogger(__name__)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user