Loguru日志库中自动高亮特定文本的实现方法

Loguru作为Python生态中广受欢迎的日志记录库，其强大的功能和简洁的API设计深受开发者喜爱。本文将深入探讨如何在Loguru中实现自动高亮日志消息中特定格式文本的技术方案。

背景与需求分析

在实际开发中，我们经常需要在日志中突出显示某些关键信息，例如变量值、重要参数或特殊标记。Loguru原生支持通过<color>标签来着色文本，但每次手动添加这些标签会显得繁琐且不优雅。

理想情况下，我们希望系统能够自动识别并高亮日志消息中的特定模式文本，比如用尖括号包裹的内容<example>，而无需每次显式调用opt(colors=True)方法。

技术实现方案

原生Loguru的着色机制

Loguru的着色处理发生在消息格式化之前，这意味着我们无法直接在标准格式化函数中修改原始消息的着色行为。这是Loguru内部设计的一个限制，但我们可以通过其他方式实现类似效果。

自定义格式化函数方案

通过自定义Loguru的格式化函数，我们可以实现自动高亮功能。以下是实现的核心代码：

from loguru import logger
import re
import sys

def highlight_formatter(record):
    # 转义大括号避免二次格式化
    message = record["message"].replace("{", "{{").replace("}", "}}")
    # 使用正则表达式匹配并着色尖括号内容
    colored_message = re.sub(r"<(.*?)>", r"<red>\1</red>", message)
    return "[<level>{level}</level>] " + colored_message + "\n{exception}"

# 配置logger使用自定义格式化器
logger.remove()
logger.add(sys.stderr, format=highlight_formatter)

# 使用示例
logger.info("系统检测到<非法输入>，参数值为<42>")

实现要点解析

1. 消息转义处理：为了避免与Loguru的格式化语法冲突，我们需要先对消息中的大括号进行转义处理。

2. 正则表达式选择：使用非贪婪匹配模式r"<(.*?)>"可以正确处理消息中多个需要高亮的部分。

3. 颜色标签注入：在匹配到的文本周围添加Loguru的颜色标签<red>和</red>，实现着色效果。

4. 格式化字符串构造：最终返回的字符串需要包含日志级别等标准信息，并保留异常输出的可能性。

注意事项

1. 性能考量：正则表达式处理会增加少量开销，在极高频率日志场景下需评估性能影响。

2. 标签冲突：如果日志消息本身包含Loguru的颜色标签，可能会产生意外结果。

3. 功能限制：使用此方法后，opt(colors=True)将不再影响该sink的着色行为。

4. 多sink场景：如需对不同输出采用不同高亮策略，需要为每个sink单独配置格式化器。

扩展应用

此技术方案不仅限于高亮尖括号内容，通过修改正则表达式模式，我们可以实现更复杂的文本高亮策略：

• 高亮特定格式的变量名
• 突出显示错误代码
• 标记敏感数据
• 区分不同类型的参数

总结

通过自定义Loguru的格式化函数，我们成功实现了日志消息中特定模式文本的自动高亮功能。这种方法既保持了Loguru原有的简洁API风格，又增加了实用的可视化增强功能，是Loguru高级用法的典型示例。开发者可以根据实际需求调整正则表达式和颜色标签，打造更适合自己项目的日志呈现方案。