0

0

Python 日志着色:如何仅对控制台输出添加颜色而不影响文件日志

碧海醫心

碧海醫心

发布时间:2026-01-29 15:23:00

|

188人浏览过

|

来源于php中文网

原创

Python 日志着色:如何仅对控制台输出添加颜色而不影响文件日志

本文详解为何 logging.filter 无法实现“仅终端着色”,并提供基于自定义 formatter 的正确解决方案,确保颜色代码只作用于 streamhandler,完全隔离文件日志的纯净性。

在 Python 日志系统中,一个常见误区是试图用 logging.Filter 实现日志内容的样式化(如为 levelname 添加 ANSI 颜色)。但正如示例所揭示的:Filter 在日志记录被格式化前就已修改 record 对象本身——而 record 是跨所有 Handler 共享的。因此,即使你只将 ColourLevelNameFilter 添加到 StreamHandler,它仍会污染 FileHandler 所用的同一 LogRecord 实例,导致颜色转义序列(如 \x1b[031m)意外写入日志文件。

根本原因在于:

  • Filter.filter(record) 接收的是原始 LogRecord 对象;
  • record.levelname = ... 是原地修改(in-place mutation);
  • 同一 record 会被依次传递给所有已注册的 Handler(包括 FileHandler),此时 levelname 已含颜色码。

✅ 正确解法是避免修改 record,改在格式化阶段动态注入样式——即继承 logging.Formatter,重写 format() 方法,在生成最终字符串时精准替换目标字段。

以下是一个健壮、生产就绪的着色 Formatter 示例:

立即学习Python免费学习笔记(深入)”;

笔头写作
笔头写作

AI为论文写作赋能,协助你从0到1。

下载
import logging

class ColourFormatter(logging.Formatter):
    FORMATS = {
        logging.DEBUG: '\x1b[36m{0}\x1b[0m',    # cyan
        logging.INFO:  '\x1b[32m{0}\x1b[0m',    # green
        logging.WARNING: '\x1b[33m{0}\x1b[0m',  # yellow
        logging.ERROR: '\x1b[31m{0}\x1b[0m',    # red
        logging.CRITICAL: '\x1b[41m{0}\x1b[0m', # white-on-red
    }

    def format(self, record: logging.LogRecord) -> str:
        # 先调用父类获取标准格式化字符串
        msg = super().format(record)
        # 获取对应级别的着色 levelname
        colour_levelname = self.FORMATS.get(
            record.levelno, '{0}'
        ).format(record.levelname)
        # 精准替换:仅替换独立出现的 levelname(避免误染 message 中同名文本)
        # 使用 f-string 模式匹配时间+级别组合,进一步提升安全性
        timestamp_level = f'{record.asctime} {record.levelname}'
        colour_timestamp_level = f'{record.asctime} {colour_levelname}'
        return msg.replace(timestamp_level, colour_timestamp_level, 1)

使用时,为不同 Handler 分配不同 Formatter 即可实现完全隔离:

# 控制台使用着色 Formatter
stream_handler = logging.StreamHandler()
stream_handler.setFormatter(ColourFormatter(
    fmt='%(asctime)s %(levelname)s => %(message)s',
    datefmt='%Y-%m-%d %H:%M:%S'
))

# 文件使用纯文本 Formatter(无颜色)
file_handler = logging.FileHandler('app.log', mode='a')
file_handler.setFormatter(logging.Formatter(
    fmt='%(asctime)s %(levelname)s => %(message)s',
    datefmt='%Y-%m-%d %H:%M:%S'
))

⚠️ 注意事项:

  • 永远不要在 Filter 中修改 record 的核心字段(如 levelname, msg, message)——这违反了 Filter 的设计契约(应仅做“是否通过”判断);
  • Formatter.format() 是安全的着色入口,因它作用于最终字符串,且每个 Handler 独立调用;
  • 替换逻辑建议优先匹配 asctime + levelname 组合,而非单独 levelname,可彻底规避日志消息中偶然出现相同单词导致的误着色;
  • 若需兼容 Windows 终端(旧版 cmd),可在程序启动时调用 colorama.init() 或检查 sys.stdout.isatty() 再启用颜色。

总结:日志着色的本质是输出层定制,而非记录层干预。通过分离关注点(Filter 做路由,Formatter 做渲染),你既能获得直观的终端体验,又能保证文件日志的机器可读性与跨平台兼容性。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

782

2023.07.31

python中的format是什么意思
python中的format是什么意思

python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

434

2024.06.27

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

298

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

212

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1501

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

624

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

633

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

588

2024.04.29

clawdbot ai使用教程 保姆级clawdbot部署安装手册
clawdbot ai使用教程 保姆级clawdbot部署安装手册

Clawdbot是一个“有灵魂”的AI助手,可以帮用户清空收件箱、发送电子邮件、管理日历、办理航班值机等等,并且可以接入用户常用的任何聊天APP,所有的操作均可通过WhatsApp、Telegram等平台完成,用户只需通过对话,就能操控设备自动执行各类任务。

8

2026.01.29

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.4万人学习

Django 教程
Django 教程

共28课时 | 3.6万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号