Python colorlog 库：为你的日志穿上彩色外衣

原创 已于 2025-10-20 09:45:10 修改 · 1k 阅读 · 30 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#python #日志 #colorlog

于 2025-10-20 09:20:10 首次发布

诸神缄默不语-个人技术博文与视频目录

还在看单调的黑白日志吗？给日志加点颜色，让调试变得更高效！

https://pypi.org/project/colorlog/

前言：为什么需要彩色日志？

在日常开发和调试中，日志是我们最亲密的伙伴。但是，面对密密麻麻的黑白日志文本，快速定位错误、警告或关键信息往往如同大海捞针。这时候，colorlog 库就能大显身手了！它能为不同级别的日志信息添加不同的颜色，让日志输出一目了然，大大提升调试效率。

使用 colorlog 为日志添加色彩编码，能让不同严重级别的信息一目了然，从而提升调试体验。

什么是 colorlog？

colorlog 是一个 Python 日志格式化工具，它扩展了 Python 标准库中的 logging 模块，专门用于在终端输出带颜色的日志 。通过为不同日志级别配置不同颜色，我们可以快速区分 DEBUG、INFO、WARNING、ERROR 等级别的信息。

安装 colorlog

安装 colorlog 非常简单，只需使用 pip：

pip install colorlog

基础用法：快速上手

让我们先来看一个简单的例子，了解 colorlog 的基本使用方法：

import colorlog
import logging

# 创建 logger 实例
logger = colorlog.getLogger('example')

# 创建 StreamHandler
handler = colorlog.StreamHandler()

# 设置格式化器
handler.setFormatter(colorlog.ColoredFormatter(
    '%(log_color)s%(levelname)s:%(name)s:%(message)s'
))

# 添加 handler 到 logger
logger.addHandler(handler)

# 设置日志级别
logger.setLevel(logging.DEBUG)

# 测试不同级别的日志输出
logger.debug("这是一条 DEBUG 级别的日志")
logger.info("这是一条 INFO 级别的日志")
logger.warning("这是一条 WARNING 级别的日志")
logger.error("这是一条 ERROR 级别的日志")
logger.critical("这是一条 CRITICAL 级别的日志")

运行上面的代码，你将在终端中看到不同颜色的日志输出，默认情况下：

  • DEBUG：青色
  • INFO：绿色
  • WARNING：黄色
  • ERROR：红色
  • CRITICAL：红色背景白色文字

核心组件详解

ColoredFormatter 类

ColoredFormatter 是 colorlog 的核心类，它继承自 Python 标准的 logging.Formatter，专门用于生成带颜色的日志输出 。

主要参数说明：

  • format：用于输出日志的格式化字符串（必需）
  • datefmt：可选的日期格式，传递给基类
  • reset：默认为 True，表示在消息输出结束时添加颜色重置代码
  • log_colors：日志级别到颜色名称的映射
  • secondary_log_colors：定义在格式化字符串中可用的其他颜色
  • style：在 Python 3.2 以上版本可用

颜色配置详解

colorlog 支持丰富的颜色配置选项：

基本颜色名称： black, red, green, yellow, blue, purple, cyan, white

颜色前缀：

  • fg_{color}：设置前景色（文字颜色）
  • bg_{color}：设置背景色
  • bold、bold_{color}：设置粗体/亮色

特殊代码：

  • reset：清除所有格式（包括前景色和背景色）

高级配置技巧

1. 自定义日志颜色

你可以完全自定义每个日志级别的颜色：

from colorlog import ColoredFormatter

formatter = ColoredFormatter(
    "%(log_color)s%(levelname)-8s%(reset)s %(blue)s%(message)s",
    datefmt=None,
    reset=True,
    log_colors={
        'DEBUG': 'cyan',
        'INFO': 'green',
        'WARNING': 'yellow',
        'ERROR': 'red',
        'CRITICAL': 'red,bg_white',
    },
    secondary_log_colors={},
    style='%'
)

handler = logging.StreamHandler()
handler.setFormatter(formatter)

logger = logging.getLogger('custom_example')
logger.addHandler(handler)
logger.setLevel(logging.DEBUG)

2. 使用辅助颜色

secondary_log_colors 允许你为同一日志消息的不同部分设置不同的颜色规则：

formatter = ColoredFormatter(
    "%(log_color)s%(levelname)-8s%(reset)s %(message_log_color)s%(message)s",
    secondary_log_colors={
        'message': {
            'ERROR': 'red',
            'CRITICAL': 'red'
        }
    }
)

这个配置会让 ERROR 和 CRITICAL 级别的日志消息本身显示为红色，而其他级别的消息保持默认颜色 。

3. 使用字典配置

对于大型项目，推荐使用 dictConfig 进行配置：

import logging.config

logging.config.dictConfig({
    'formatters': {
        'colored': {
            '()': 'colorlog.ColoredFormatter',
            'format': "%(log_color)s%(levelname)-8s%(reset)s %(blue)s%(message)s"
        }
    },
    'handlers': {
        'stream': {
            'class': 'logging.StreamHandler',
            'formatter': 'colored',
        },
    },
    'root': {
        'handlers': ['stream'],
        'level': 'DEBUG',
    }
})

logger = logging.getLogger('dict_config_example')

4. 配置文件方式

你也可以使用 .ini 格式的配置文件：

[loggers]
keys=root

[logger_root]
handlers=stream
level=DEBUG

[formatters]
keys=color

[formatter_color]
class=colorlog.ColoredFormatter
format=%(log_color)s%(levelname)s:%(name)s:%(message)s
datefmt=%H:%M:%S

[handlers]
keys=stream

[handler_stream]
class=StreamHandler
formatter=color
args=()

然后在代码中加载配置：

import logging
import logging.config

logging.config.fileConfig('logging_config.ini')
logger = logging.getLogger('config_file_example')

实际应用示例

在 FastAPI 项目中使用 colorlog

让我们看看如何在 FastAPI 项目中使用 colorlog 来美化日志输出：

import colorlog
import logging
from fastapi import FastAPI, HTTPException
from pydantic import BaseModel

# 配置日志
handler = colorlog.StreamHandler()
formatter = colorlog.ColoredFormatter(
    "%(log_color)s%(asctime)s - %(levelname)-8s%(reset)s %(blue)s%(name)-15s %(message)s",
    datefmt="%Y-%m-%d %H:%M:%S",
    log_colors={
        'DEBUG': 'cyan',
        'INFO': 'bold_green',
        'WARNING': 'bold_yellow',
        'ERROR': 'bold_red',
        'CRITICAL': 'bold_red,bg_white',
    }
)
handler.setFormatter(formatter)

# 为 FastAPI 相关日志器配置 colorlog
uvicorn_logger = logging.getLogger("uvicorn")
uvicorn_logger.handlers = []
uvicorn_logger.addHandler(handler)
uvicorn_logger.setLevel(logging.DEBUG)

uvicorn_access = logging.getLogger("uvicorn.access")
uvicorn_access.handlers = []
uvicorn_access.addHandler(handler)

app = FastAPI(title="Colorful API", version="1.0.0")
logger = colorlog.getLogger("api")
logger.addHandler(handler)
logger.setLevel(logging.DEBUG)

class Item(BaseModel):
    name: str
    description: str = None
    price: float

@app.get("/")
async def read_root():
    logger.info("访问根路径")
    return {"message": "欢迎使用彩色日志 API！"}

@app.post("/items/")
async def create_item(item: Item):
    logger.debug(f"创建商品: {item.name}, 价格: {item.price}")
    
    if item.price <= 0:
        logger.warning(f"商品价格无效: {item.price}")
        raise HTTPException(status_code=400, detail="价格必须大于0")
    
    logger.info(f"成功创建商品: {item.name}")
    return {"status": "success", "item": item}

@app.get("/error-test")
async def error_test():
    try:
        # 模拟一个错误
        result = 1 / 0
    except Exception as e:
        logger.error(f"发生错误: {str(e)}", exc_info=True)
        raise HTTPException(status_code=500, detail="内部服务器错误")

if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app, host="0.0.0.0", port=8000, log_config=None)

同时输出到控制台和文件

有时候，我们既想要在控制台看到彩色日志，又希望将日志保存到文件中（不包含颜色代码）：

import colorlog
import logging

# 创建 logger
logger = colorlog.getLogger('multi_handler')

# 控制台 Handler（带颜色）
console_handler = colorlog.StreamHandler()
console_formatter = colorlog.ColoredFormatter(
    "%(log_color)s%(asctime)s %(levelname)-8s%(reset)s %(blue)s%(message)s",
    datefmt="%H:%M:%S"
)
console_handler.setFormatter(console_formatter)

# 文件 Handler（无颜色）
file_handler = logging.FileHandler('app.log')
file_formatter = logging.Formatter(
    "%(asctime)s %(levelname)-8s %(message)s",
    datefmt="%Y-%m-%d %H:%M:%S"
)
file_handler.setFormatter(file_formatter)

# 添加两个 handler
logger.addHandler(console_handler)
logger.addHandler(file_handler)
logger.setLevel(logging.DEBUG)

# 测试日志
logger.info("这条消息会同时显示在控制台（带颜色）和文件（无颜色）中")

自定义日志级别

你甚至可以创建自定义的日志级别并为其指定颜色：

import logging
import colorlog

# 创建自定义日志级别
TRACE = 5
logging.addLevelName(TRACE, 'TRACE')

# 添加 trace 方法到 logger
def trace(self, message, *args, **kws):
    if self.isEnabledFor(TRACE):
        self._log(TRACE, message, args, **kws)

logging.Logger.trace = trace

# 配置 colorlog 包含自定义级别
formatter = colorlog.ColoredFormatter(
    log_colors={
        'TRACE': 'yellow',
        'DEBUG': 'cyan',
        'INFO': 'green',
        'WARNING': 'yellow',
        'ERROR': 'red',
        'CRITICAL': 'red,bg_white',
    },
    format='%(log_color)s%(levelname)-8s%(reset)s %(message)s'
)

handler = logging.StreamHandler()
handler.setFormatter(formatter)

logger = colorlog.getLogger('custom_level')
logger.addHandler(handler)
logger.setLevel(TRACE)

# 使用自定义级别
logger.trace("这是一条 TRACE 级别的日志")

注意事项和最佳实践

  1. 兼容性：colorlog 主要适用于终端输出，在文件日志中颜色代码可能会显示为乱码。

  2. 性能：在生产环境中，可以考虑根据环境变量决定是否启用彩色日志，以减少不必要的性能开销。

  3. 一致性：在团队项目中，建议统一颜色配置，确保所有成员对颜色含义有相同的理解。

  4. 可访问性：考虑到色盲或色弱用户，不要完全依赖颜色来区分日志级别，还应该保留文字级别的信息。

Python实战 | 使用 Python 的日志库（logging）和 pandas 库对日志数据进行分析
AI时代光年
11-08 6286
在 Python 中，实现日志收集和分析的方法有很多，这里我为您介绍一个简单的示例，使用 Python 的日志库（logging）和 pandas 库对日志数据进行分析。以上代码将模拟的日志数据保存到 CSV 文件，并使用 pandas 对其进行简单的统计和分析。这些日志记录将分别对应不同的日志级别，从低到高依次为：DEBUG、INFO、WARNING、ERROR、CRITICAL。4. 运行上述代码后，您将在当前目录下看到一个名为 app.log 的日志文件，其中包含了您刚刚记录的日志。
Python 进阶（十七）：日志输出（logging 模块）
水滴的博客
12-23 4357
在开发和维护应用程序时，了解应用程序的行为和状态对于故障排查、调试和性能优化至关重要。Python提供了一个强大的日志输出模块——logging库，它使我们能够将应用程序的关键信息记录到日志文件、控制台甚至是网络中。本文将详细介绍Python日志输出的概念、组件以及如何在应用程序中使用它。')Python日志输出是一种重要的工具，可帮助我们记录和跟踪应用程序的关键信息。通过设置适当的日志级别、创建日志记录器和选择合适的日志处理器，我们可以将日志消息输出到不同的目标，如控制台、文件、网络等。
Python：colorlog的三个例子
Python热爱者的博客
07-02 2262
例1：默认的log_colors import logging from logging.handlers import RotatingFileHandler from colorlog import ColoredFormatter #第一步：创建一个日志收集器logger logger = logging.getLogger("autotest") #第二步：修改日志的输出级别 logger.setLevel(logging.DEBUG) #第三步：设置输出的日志内容格式 fmt = "%(lo
Python Colorlog 开源项目教程
最新发布
gitblog_00921的博客
11-15 1136
Python Colorlog 是一个扩展了标准logging模块的库，它允许在日志记录中使用ANSI转义序列来显示带有颜色的日志条目。这对于开发时的日志可视化非常有用，能够帮助开发者迅速区分不同级别的日志信息，提高效率。此项目由[@borntyping](https://github.com/borntyping)维护，提供了更加直观的日志阅读体验。 ## 项目快速启动 要开始使用Pytho
python中的colorlog库使用详解
01-21
一. 描述 colorlog.ColoredFormatter是一个Python logging模块的格式化，用于在终端输出日志的颜色 二. 安装 pip install colorlog 三. 用法 import colorlog handler = colorlog.StreamHandler() handler.setFormatter(colorlog.ColoredFormatter( '%(log_color)s%(levelname)s:%(name)s:%(message)s')) logger = colorlog.getLogger('example') log
Python-Colorlog 开源项目教程
gitblog_00339的博客
11-14 403
Python-Colorlog 是一个用于在终端输出彩色日志的 Python 库。以下是该项目的目录结构及其介绍： ``` python-colorlog/ ├── colorlog/ │ ├── __init__.py │ ├── colortext.py │ ├── escape_codes.py │ ├── formatter.py │ ├── logging.py │
python color属性_python中的colorlog库使用详解
weixin_39604276的博客
11-20 849
一. 描述colorlog.ColoredFormatter是一个Python logging模块的格式化，用于在终端输出日志的颜色二. 安装pip install colorlog三. 用法import colorloghandler = colorlog.StreamHandler()handler.setFormatter(colorlog.ColoredFormatter('%(log_c...
Python WordCloud库：词云图制作
GitHub_miao的博客
06-16 4132
更多Python学习内容：ipengtao.comWordCloud是一个用于生成词云图的Python库。词云图是一种数据可视化方法，通过将词语的频率或权重用不同的字体大小和颜色展示，使得信息更加直观和易于理解。WordCloud库能够根据文本内容生成美观的词云图，并提供了丰富的自定义选项。本文将详细介绍WordCloud库的安装、主要功能、基本操作、高级功能及其实践应用，并提供丰富的示例代码。安...
Python爬虫详解：原理、常用库与实战案例
qq_56262770的博客
07-16 5466
1.什么是爬虫爬虫（Spider），也被称为网络爬虫或网络蜘蛛，是一种自动化程序，用于在互联网上浏览和提取信息。爬虫通过模拟人类用户访问网页的行为，从网页中提取数据并将其存储或进行进一步处理。爬虫可以自动遍历互联网上的各个网页，并根据预设的规则和算法来解析和收集感兴趣的信息。这些信息可以包括网页的文本内容、图片、链接、视频等等。爬虫可以用于很多领域，例如搜索引擎的网页索引、数据挖掘、自动化测试、价格比较、舆情监测等等。
Python金融量化的高级库：TA-Lib-0.4.24（包含python3.7、3.8、3.9、3.10的32位和64位版本）
08-02
TA-Lib（Technical Analysis Library, 即技术分析库）是Python金融量化的高级库，涵盖了150多种股票、期货交易软件中常用的技术分析指标，如MACD、RSI、KDJ、动量指标、布林带等。但很多人安装指标计算ta-lib库就总...
python-colorlog：python日志记录模块的彩色格式化程序
02-03
用颜色记录格式！ colorlog.ColoredFormatter是与Python的logging模块一起使用的格式化程序，该模块使用终端颜色输出记录。 安装 通过以下方式从PyPI安装： pip install colorlog 一些Linux发行版提供了官方软件包（ ， ， 和 ），而其他则有用户提供的软件包（ ， ， ， ）。 用法 import colorlog handler = colorlog . StreamHandler () handler . setFormatter ( colorlog . ColoredFormatter ( '%(log_colo
logcat.py -v time ( 根据level，设置颜色 )
04-18
usage: ./logcat.py -v time 这个脚本可以使logcat的信息按等级，加上颜色，一目了然。方便好用，快收藏一下吧
Python-logging详解（彩色日志扩展，多进程安全等）_python的logging
2401_86640671的博客
09-08 1258
name |%(name)s| 用于记录调用的日志记录器名称。| 发出日志记录调用的源文件的完整路径名（如果可用）。| 进程ID（如果可用） || 进程名（如果可用） || 以毫秒数表示的 LogRecord 被创建的时间，即相对于 logging 模块被加载时间的差值。| stack_info | 此属性不需要用户进行格式化。| 当前线程中从堆栈底部起向上直到包括日志记录调用并引发创建当前记录堆栈帧创建的堆栈帧信息（如果可用）。
Python系列：彩色日志详解
Rocky006的博客
10-12 2176
在使用Python进行编程时，我相信很多小伙伴都有一个共通的习惯，就是不管在什么场景下，都会先使用print()将我们获取到的数据打印出来以此来确保自己的代码没有问题。虽说在pycharm中提供了DEBUG功能，但是还是有很多小伙伴用不来这个或者是不喜欢用，自身还是比较喜欢使用print()来进行打桩验证。
一个彩色的Logging日志，后续调用的时候，可以直接引用
↓ ↓
08-14 359
python中一个彩色的Logging日志，后续调用的时候，可以直接引用
python命令行or控制台or日志带有颜色的输出
qq_46158060的博客
08-22 532
python命令行or控制台or日志带有颜色的输出。
python logging 封装（colorlog版本）
菜鸟吴de博客
12-07 545
python logging 封装 colorlog使用
colorlog：为日志输出增加颜色格式化的Python组件
4. **ColoredFormatter**：colorlog组件的自定义Formatter，它继承自logging模块中的Formatter，并添加了颜色代码。 ### 标签说明 从给定的标签`color log format webcomponent litelement HTML`可以看出，colorlog...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

诸神缄默不语

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值