Python系列：彩色日志详解

---

前言

在使用Python进行编程时，我相信很多小伙伴都有一个共通的习惯，就是不管在什么场景下，都会先使用print()将我们获取到的数据打印出来以此来确保自己的代码没有问题。虽说在pycharm中提供了DEBUG功能，但是还是有很多小伙伴用不来这个或者是不喜欢用，自身还是比较喜欢使用print()来进行打桩验证。

但是如果我们的Python代码中有很多需要打印出来的数据时，使用print答应出来的数据就会很多，看起来就比较麻烦，那么有什么方法来解决这个问题呢？

别着急，接着往下看。Python中提供了很多丰富多彩的标准库和支持大量的第三方库，在本篇文章中，我们就会使用到coloredlogs库

coloredlogs介绍

coloredlogs是一个Python库，它允许开发人员在控制台打印彩色日志。这个库的主要优点是它可以很容易地改变日志消息的颜色，从而使日志更易于阅读和理解。这对于长时间运行的应用程序或者需要详细查看日志信息的情况非常有用。

coloredlogs库的使用

1.安装coloredlogs

在使用前我们需要在Python中下载它

pip install coloredlogs

2.设置logger日志级别

首先，在我们记录日志时，需要先设置日志级别和格式

coloredlogs.install(level='DEBUG', fmt='%(asctime)s %(levelname)s %(message)s')
 

3.自定义输出样式

如果我们不结合coloredlogs直接将我们的日志打印到控制台

logging.debug('debug message')
logging.info('info message')
logging.error('error message')
logging.warning('warning message')

输出到控制的话就只会将error和warning两个级别的日志在控制打印出来，debug和info级别的日志就无法在控制台打印出来，而且显示的两种日志都是一样的颜色并且格式也不好看

下面是在我们结合使用coloredlogs后在控制台的输出效果

import coloredlogs
import logging
 
coloredlogs.install(level='DEBUG', fmt='%(asctime)s %(levelname)s %(message)s')
 
logging.debug('debug message')
logging.info('info message')
logging.error('error message')
logging.warning('warning message')

输出效果如下

可以很明显的看出，它自动帮我们加上了日志的输出时间和根据不同日志级别显示不一样的颜色来区分，这比我们直接用logging输出要好得多

4.自定义输出格式

我们可以在之前添加的输出格式中添加其他的格式内容

import coloredlogs
import logging
 
def func_name():
    # 增加了modules、funcName两个变量，分辨标识我们日志所在文件以及在哪一个函数中输入的日志
    coloredlogs.install(level='DEBUG', fmt='%(asctime)s - %(module)s - %(funcName)s - %(levelname)s - %(message)s')
 
    logging.debug('debug message')
    logging.info('info message')
    logging.error('error message')
    logging.warning('warning message')
 
 
func_name()
 

输出结果如下

我们增加了两个变量后，可以方便我们后续寻找问题时就直接定位到了那个文件中的哪个函数出了问题，这是不是就方便我们后面解决问题的效率。

5.自定义日志级别输出样式

再上面我们是直接使用了coloredlogs中的默认日志级别颜色样式，同样的我们也可以自定义设置不同日志的显示的样色样式

import coloredlogs
import logging
 
 
def fun_name():
    level_styles = coloredlogs.DEFAULT_LEVEL_STYLES.copy()
    level_styles['debug'] = {'color': 'magenta'}
    level_styles['info'] = {'color': 'yellow'}
    level_styles['error'] = {'color': 'red'}
    level_styles['warning'] = {'color': 'blue'}
    coloredlogs.install(level="DEBUG", level_styles=level_styles,
                        fmt='%(asctime)s - %(module)s - %(funcName)s - %(levelname)s - %(message)s')
 
    logging.debug('debug message')
    logging.info('info message')
    logging.error('error message')
    logging.warning('warning message')
 
 
fun_name()

输入样式如下

6.写入到日志文件

上面我们说的是将日志打印到控制台中，但是我们Python代码写完并且在运行当中后，我们就不可能这样玩了，所以我们需要将日志保存到一个日志文件中

完整代码如下：

import coloredlogs
import logging
 
 
def func_name():
    # 创建文件handler
    file_handler = logging.FileHandler('log_file.log')
 
    # 设置日志格式
    formatter = logging.Formatter('%(asctime)s - %(module)s - %(funcName)s - %(levelname)s - %(message)s')
    file_handler.setFormatter(formatter)
 
    # 安装coloredlogs并设置级别
    level_styles = coloredlogs.DEFAULT_LEVEL_STYLES.copy()
    coloredlogs.install(level="DEBUG", level_styles=level_styles,
                        fmt='%(asctime)s - %(module)s - %(funcName)s - %(levelname)s - %(message)s')
 
    # 获取logger 并添加文件handler
    logger = logging.getLogger()
    logger.addHandler(file_handler)
 
    # 移除默认StreamHandler
    logger.removeHandler(logging.StreamHandler())
 
    # 测试输出日志
    logger.debug('debug message')
    logger.info('info message')
    logger.error('error message')
    logger.warning('warning message')
 
 
func_name()
 

打开我们log_file.log文件后，就可以看到我们生成的日志信息

可以看到我们生成的日志文件中不同级别的日志还是使用的是一样的颜色。那这是为什么呢？

其实coloredlogs 库只是在终端输出时给日志添加了颜色,但写入文件时colors并不能保留。

这是因为终端输出和文件输出使用的是不同的handler:

• 终端输出使用的是StreamHandler,可以 interpreter 处理ANSI色彩编码显示颜色。

• 文件输出使用的是FileHandler,写入的仅是纯文本,无法保存ANSI编码的颜色信息。

ANSI色彩编码只有在支持其的终端才能渲染为颜色,一旦写入文件就会失去这些编码信息。所以使用coloredlogs时,日志文件内实际保存的是未着色的原始文本。

如果想要文件中也保存颜色信息,可以考虑使用支持ANSI色彩的文件格式,比如HTML。然后通过logging模块支持的HTML Formatter输出彩色日志到HTML文件中，不过这种情况下就失去了纯文本文件的可阅读性。
综上,coloredlogs只是在终端美化日志展示效果,文件输出不保存颜色是正常情况。如果必须存储颜色,可以输出为HTML等格式,但复杂度会增加。

如果有小伙伴对写入到html文件感兴趣的，这里我提供我写的一份代码，你们可以拿去自行研究哈~~

import coloredlogs
import logging
from logutils.colorize import ColorizingStreamHandler
import sys
 
def func_name():
    # 创建一个ColorizingStreamHandler
    color_handler = ColorizingStreamHandler(sys.stdout)
    color_handler.setLevel(logging.DEBUG)
 
    # 设置格式器
    html_formatter = logging.Formatter('
%(asctime)s - %(name)s - %(levelname)s - %(message)s
')
    color_handler.setFormatter(html_formatter)
 
    # 安装coloredlogs
    coloredlogs.install(level='DEBUG',fmt='%(asctime)s - %(module)s - %(funcName)s - %(levelname)s - %(message)s')
 
    # 获取logger并添加handler
    logger = logging.getLogger()
    logger.addHandler(color_handler)
 
    # 日志输出
    logger.debug('debug message')
    logger.info('info message')
    logger.error('error message')
    logger.warning('warning message')
 
    # 重定向输出到文件
    with open('log_file.log.html', 'w') as f:
        old_stdout = sys.stdout
        sys.stdout = f
        logger.debug('debug message')
        logger.info('info message')
        logger.error('error message')
        logger.warning('warning message')
        sys.stdout = old_stdout
 
    # 关闭默认StreamHandler
    logger.removeHandler(logging.StreamHandler())
 
func_name()