263 lines
7.8 KiB
Python
263 lines
7.8 KiB
Python
"""日志格式化与美化模块
|
|
纯函数化输出格式,便于在不同日志组件之间复用。
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import Any, Dict, List, Optional
|
|
|
|
|
|
def format_debug_log(
|
|
message: str, level: str = "DEBUG", tag: Optional[str] = None, **fields: Any
|
|
) -> str:
|
|
parts = []
|
|
if tag:
|
|
parts.append(f"[{tag}]")
|
|
parts.append(f"[{level}]")
|
|
parts.append(message)
|
|
if fields:
|
|
kv = " ".join(f"{k}={v}" for k, v in fields.items())
|
|
parts.append(kv)
|
|
return " ".join(parts)
|
|
|
|
|
|
def format_action_log(action: str, details: Optional[str] = None, **fields: Any) -> str:
|
|
"""
|
|
生成简洁的人类可读行为日志(优先中文),同时保留字段键值以便机器解析。
|
|
|
|
输出示例:
|
|
- 上滑切换直播间 耗时=2100.00ms
|
|
- 点击参与 福袋ID=123 value=200.0 slow=1
|
|
保留原始 key=value 形式以便下游解析器仍可使用。
|
|
"""
|
|
# 常用动作名称到中文的映射(可根据需要扩展)
|
|
action_name_map = {
|
|
"swipe_up_to_next_live": "上滑切换直播间",
|
|
"swipe_down_back_from_live": "下滑回退直播间",
|
|
"attend_choujiang": "点击参与抽奖",
|
|
"get_screenshot": "截屏",
|
|
"OCR": "OCR识别",
|
|
"Decision": "决策",
|
|
"Step": "步骤",
|
|
}
|
|
|
|
# 如果 action 表示通用类别(如 Step),把 details 映射为更友好的动作名
|
|
human_parts: list[str] = []
|
|
if action == "Step" and details:
|
|
human = action_name_map.get(details, details.replace("_", " "))
|
|
human_parts.append(human)
|
|
else:
|
|
human = action_name_map.get(action, action)
|
|
human_parts.append(human)
|
|
|
|
# 格式化 elapsed_seconds 为带单位的字符串(如果提供)
|
|
kv_parts: list[str] = []
|
|
elapsed = None
|
|
if "elapsed_seconds" in fields:
|
|
try:
|
|
elapsed = float(fields.pop("elapsed_seconds"))
|
|
except Exception:
|
|
elapsed = None
|
|
elif "elapsed" in fields:
|
|
try:
|
|
elapsed = float(fields.pop("elapsed"))
|
|
except Exception:
|
|
elapsed = None
|
|
|
|
if elapsed is not None:
|
|
try:
|
|
elapsed_ms = float(elapsed) * 1000.0
|
|
kv_parts.append(f"耗时={elapsed_ms:.2f}ms")
|
|
except Exception:
|
|
kv_parts.append(f"耗时={elapsed}")
|
|
|
|
# 专门处理以 `_ms` 命名的耗时字段,使用友好中文标签并统一以 ms 单位显示
|
|
ms_kv_parts: list[str] = []
|
|
ms_keys = [k for k in list(fields.keys()) if "_ms" in k]
|
|
if ms_keys:
|
|
# 常见 ms 字段到中文的映射
|
|
ms_label_map = {
|
|
"total_ms": "总耗时",
|
|
"ocr_ms": "OCR耗时",
|
|
"image_load_ms": "图像加载耗时",
|
|
"countdown_parse_ms": "倒计时解析耗时",
|
|
"render_ms": "渲染耗时",
|
|
"detection_ms": "检测耗时",
|
|
"ocr_value_ms": "OCR价值耗时",
|
|
}
|
|
for k in ms_keys:
|
|
v = fields.pop(k, None)
|
|
try:
|
|
num = float(v)
|
|
ms_str = f"{num:.2f}ms"
|
|
except Exception:
|
|
ms_str = f"{v}"
|
|
|
|
label = ms_label_map.get(k, None)
|
|
if label:
|
|
ms_kv_parts.append(f"{label}={ms_str}")
|
|
else:
|
|
# 将 key 转为更可读形式,例如 ocr_ms -> ocr ms
|
|
pretty_key = k.replace("_", " ")
|
|
ms_kv_parts.append(f"{pretty_key}={ms_str}")
|
|
|
|
# 如果存在 ms 字段,向人类可读部分追加显眼的标签
|
|
human_parts.append("关键耗时(ms)")
|
|
# 把 ms 字段放在其它 kv 之前,增强可读性
|
|
kv_parts = ms_kv_parts + kv_parts
|
|
|
|
# 如果有 slow 标记,转换为中文提示
|
|
if "slow" in fields:
|
|
try:
|
|
if int(fields.pop("slow") or 0) == 1:
|
|
kv_parts.append("慢=1")
|
|
except Exception:
|
|
pass
|
|
|
|
# 剩余字段以 key=value 形式追加(保持紧凑,不换行)
|
|
for k, v in fields.items():
|
|
kv_parts.append(f"{k}={v}")
|
|
|
|
human_msg = " ".join(human_parts)
|
|
if kv_parts:
|
|
return f"[ACTION] {human_msg} " + " ".join(kv_parts)
|
|
return f"[ACTION] {human_msg}"
|
|
|
|
|
|
def format_error_log(
|
|
message: str, level: str = "ERROR", tag: Optional[str] = None, **fields: Any
|
|
) -> str:
|
|
"""格式化错误日志"""
|
|
parts = []
|
|
if tag:
|
|
parts.append(f"[{tag}]")
|
|
parts.append(f"[{level}]")
|
|
parts.append(message)
|
|
if fields:
|
|
kv = " ".join(f"{k}={v}" for k, v in fields.items())
|
|
parts.append(kv)
|
|
return " ".join(parts)
|
|
|
|
|
|
def format_call_stack(stack: Optional[List[str]] = None) -> str:
|
|
if not stack:
|
|
return ""
|
|
return "\n".join(stack)
|
|
|
|
|
|
def format_parameters(params: Dict[str, Any]) -> str:
|
|
if not params:
|
|
return ""
|
|
return " ".join(f"{k}={v}" for k, v in params.items())
|
|
|
|
|
|
def format_variables(vars: Dict[str, Any]) -> str:
|
|
if not vars:
|
|
return ""
|
|
return " ".join(f"{k}={v}" for k, v in vars.items())
|
|
|
|
|
|
def format_exception(exc: BaseException) -> str:
|
|
import traceback
|
|
|
|
return "".join(traceback.format_exception(type(exc), exc, exc.__traceback__))
|
|
|
|
|
|
def add_separators(text: str, label: Optional[str] = None) -> str:
|
|
if not label:
|
|
label = ""
|
|
sep = "=" * 80
|
|
return f"{sep}\n {label} \n{sep}\n{text}\n{sep}"
|
|
|
|
|
|
def add_colors(text: str, color: str = "green") -> str:
|
|
# 简易颜色支持,只有在控制台启用时有效
|
|
colors = {
|
|
"red": "\033[31m",
|
|
"green": "\033[32m",
|
|
"yellow": "\033[33m",
|
|
"blue": "\033[34m",
|
|
"reset": "\033[0m",
|
|
}
|
|
if color in colors:
|
|
return f"{colors[color]}{text}{colors['reset']}"
|
|
return text
|
|
|
|
|
|
def beautify_log_output(line: str) -> str:
|
|
"""
|
|
美化日志输出,为GUI显示优化格式。
|
|
|
|
对日志行进行美化处理,包括:
|
|
- 提取关键信息
|
|
- 简化冗余部分
|
|
- 突出重要信息
|
|
"""
|
|
if not line or not line.strip():
|
|
return line
|
|
|
|
# 对于GUI显示,我们保持相对简洁但有用的格式
|
|
# 移除过长的堆栈跟踪,但保留关键错误信息
|
|
if len(line) > 500:
|
|
# 如果行太长,进行截断
|
|
parts = line.split()
|
|
if len(parts) > 10:
|
|
# 保留前10个部分和最后的部分
|
|
shortened = " ".join(parts[:8]) + " ... " + " ".join(parts[-2:])
|
|
return shortened
|
|
|
|
# 突出显示重要关键字
|
|
important_keywords = ["ERROR", "CRITICAL", "FAILED", "EXCEPTION"]
|
|
for keyword in important_keywords:
|
|
if keyword in line.upper():
|
|
# 在GUI中我们不添加颜色代码,因为GUI使用标签系统
|
|
# 这里只是为了标识重要行
|
|
break
|
|
|
|
return line
|
|
|
|
|
|
def colorize_log_line(line: str) -> str:
|
|
"""
|
|
为日志行添加颜色代码(用于控制台输出)。
|
|
|
|
基于日志级别和内容为日志行添加ANSI颜色代码。
|
|
"""
|
|
if not line:
|
|
return line
|
|
|
|
# 检查日志级别并应用相应颜色
|
|
if "[DEBUG]" in line:
|
|
return add_colors(line, "blue")
|
|
elif "[INFO]" in line:
|
|
return add_colors(line, "green")
|
|
elif "[WARNING]" in line:
|
|
return add_colors(line, "yellow")
|
|
elif "[ERROR]" in line:
|
|
return add_colors(line, "red")
|
|
elif "[CRITICAL]" in line:
|
|
return add_colors(line, "red") # 红色加粗可以通过多次应用实现
|
|
|
|
# 检查特殊内容
|
|
if "elapsed_seconds=" in line or "耗时" in line:
|
|
return add_colors(line, "green")
|
|
if "EXCEPTION" in line.upper():
|
|
return add_colors(line, "red")
|
|
|
|
return line
|
|
|
|
|
|
__all__ = [
|
|
"format_debug_log",
|
|
"format_action_log",
|
|
"format_error_log",
|
|
"format_call_stack",
|
|
"format_parameters",
|
|
"format_variables",
|
|
"format_exception",
|
|
"add_separators",
|
|
"add_colors",
|
|
"beautify_log_output",
|
|
"colorize_log_line",
|
|
]
|