Loguru日志库中处理日志记录末尾换行符的问题

在使用Python的Loguru日志库时，开发者可能会遇到日志记录末尾出现多余换行符的情况。本文将深入分析这一现象的原因，并提供多种解决方案。

问题现象

当使用Loguru配置日志处理器时，每条日志记录后可能会出现额外的空行。例如：

2024-11-15T14:02:36.888251+0100 - DEBUG - aimtools.cli - execute - [stdout] installing to /home/unprivileged/.local/bin

2024-11-15T14:02:36.888521+0100 - DEBUG - aimtools.cli - execute - [stdout]   uv

这种格式不仅影响日志的可读性，还会在文件输出时增加不必要的行数。

根本原因分析

经过深入调查，发现这个问题通常源于以下两种情况：

1. 从子进程读取输出时保留换行符：当开发者从子进程的stderr读取内容并使用readline()方法时，返回的字符串会包含末尾的换行符。如果直接将这个字符串传递给Loguru，就会导致额外的空行。

2. 自定义格式处理不当：当使用函数而非字符串定义日志格式时，开发者需要手动控制换行符的处理。

解决方案

方法一：清理输入字符串

在将子进程输出传递给日志记录器之前，可以去除字符串末尾的换行符：

line = subprocess_stderr.readline().rstrip('\n')
logger.debug(line)

这种方法简单直接，适用于大多数从外部进程读取日志的场景。

方法二：自定义格式函数

Loguru允许开发者使用函数来完全控制日志格式。通过这种方式，可以精确控制换行符的输出：

logger.configure(
    handlers=[
        {
            "format": lambda _: "<d>{time}</d> - <red>{level}</red> - {name} - {function} - <b>{message}</b>",
            # 其他配置...
        }
    ]
)

需要注意的是，当使用函数定义格式时，开发者需要自行处理异常信息的格式化，确保{exception}被包含在格式中。

方法三：调整StreamHandler终止符

如果日志处理器使用的是Python标准库的StreamHandler，可以通过设置terminator属性来控制行尾字符：

handler.terminator = ""

这种方法适用于需要与Python标准日志库集成的场景。

最佳实践建议

1. 保持一致性：在整个项目中统一采用一种换行符处理方式，避免混用导致格式混乱。

2. 考虑可读性：在去除换行符时，确保日志仍然保持良好的可读性，特别是在多行日志的情况下。

3. 异常处理：当自定义日志格式时，不要忘记包含异常信息的格式化，确保错误堆栈能够正确显示。

4. 性能考量：对于高频日志场景，字符串处理可能会带来性能开销，建议在前期就确定好日志格式方案。

通过理解Loguru的日志格式化机制和合理应用上述解决方案，开发者可以有效地控制日志输出格式，创建更清晰、更专业的日志记录系统。