程序员文章、书籍推荐和程序员创业信息与资源分享平台

网站首页 > 技术文章 正文

每天一个 Python 库:logging 用法精讲,高效简洁的输出日志

hfteth 2025-04-30 16:58:08 技术文章 5 ℃

一、为什么你必须掌握 logging?


你是否还在用 print() 调试程序?

简单场景 OK,但当项目逐渐复杂,print 就显得力不从心:


  • 无法区分信息等级
  • 不带时间,无法定位日志时间点
  • 不易写入日志文件
  • 无法控制是否显示


logging 是 Python 标准库,轻量、强大且灵活,帮你统一管理日志信息,先看疗效。



二、logging 五大等级速查表

学习本来就不是一蹴而就的事,不过只要你肯练、敢用,坚持一阵子,你一定能看到变化!


#!/usr/bin/env python
# -*- coding: UTF-8 -*-
"""
@Project :Fish 
@File    :D11.py
@Date    :2025/4/23 19:27 
@Author : malijie
"""
import logging

logging.debug("调试信息")
logging.info("正常信息")
logging.warning("警告信息")
logging.error("错误信息")
logging.critical("严重错误")

等级

说明

适用场景

DEBUG

调试级别

开发阶段

INFO

普通信息

程序正常运行时记录

WARNING

警告

潜在问题

ERROR

错误

出现异常

CRITICAL

严重错误

程序无法运行


为什么只输出了3行?

这是因为 Python 的 logging 模块有一个默认的日志等级:WARNING

低于这个等级的日志(如 DEBUG 和 INFO)默认不会被输出。

#!/usr/bin/env python
# -*- coding: UTF-8 -*-
"""
@Project :Fish 
@File    :D11.py
@Date    :2025/4/23 19:27 
@Author : malijie
"""
import logging

logging.basicConfig(level=logging.DEBUG)

logging.debug("调试信息")
logging.info("正常信息")
logging.warning("警告信息")
logging.error("错误信息")
logging.critical("严重错误")

再看效果如何



三、日志同时写入控制台和文件(推荐)

#!/usr/bin/env python
# -*- coding: UTF-8 -*-
"""
@Project :Fish 
@File    :D11.py
@Date    :2025/4/23 19:27 
@Author : malijie
"""
import logging
import colorlog
import os
from datetime import datetime

# 创建日志器
logger = logging.getLogger("my_logger")
logger.setLevel(logging.DEBUG)

# 控制台处理器(彩色)
console_handler = colorlog.StreamHandler()
console_formatter = colorlog.ColoredFormatter(
    "%(log_color)s%(asctime)s - %(levelname)s - %(message)s",
    log_colors={
        'DEBUG': 'cyan',
        'INFO': 'green',
        'WARNING': 'yellow',
        'ERROR': 'red',
        'CRITICAL': 'bold_red',
    }
)
console_handler.setFormatter(console_formatter)

# 日志文件名(带时间)
log_dir = "logs"
os.makedirs(log_dir, exist_ok=True)
log_file = os.path.join(log_dir, f"log_{datetime.now().strftime('%Y%m%d_%H%M%S')}.log")

# 文件处理器(无颜色)
file_handler = logging.FileHandler(log_file, encoding='utf-8')
file_formatter = logging.Formatter("%(asctime)s - %(levelname)s - %(message)s")
file_handler.setFormatter(file_formatter)

# 添加两个处理器
logger.addHandler(console_handler)
logger.addHandler(file_handler)

# 输出不同等级日志
logger.debug("调试信息")
logger.info("正常信息")
logger.warning("警告信息")
logger.error("错误信息")
logger.critical("严重错误")

输出到 log_20250423_194518.log 文件:

2025-04-23 19:45:18,499 - DEBUG - 调试信息
2025-04-23 19:45:18,500 - INFO - 正常信息
2025-04-23 19:45:18,500 - WARNING - 警告信息
2025-04-23 19:45:18,500 - ERROR - 错误信息
2025-04-23 19:45:18,500 - CRITICAL - 严重错误



四、实用封装:获取通用 logger(建议写到工具模块)

#!/usr/bin/env python
# -*- coding: UTF-8 -*-
"""
@Project :Fish 
@File    :D11.py
@Date    :2025/4/23 19:27 
@Author : malijie
"""
import logging
import os
from datetime import datetime
import colorlog


def get_logger(name="my_logger", log_dir="logs", level=logging.DEBUG):
    logger = logging.getLogger(name)
    logger.setLevel(level)

    # 避免重复添加处理器
    if logger.handlers:
        return logger

    # 控制台处理器(彩色)
    console_handler = colorlog.StreamHandler()
    console_formatter = colorlog.ColoredFormatter(
        "%(log_color)s%(asctime)s - %(levelname)s - %(message)s",
        log_colors={
            'DEBUG': 'cyan',
            'INFO': 'green',
            'WARNING': 'yellow',
            'ERROR': 'red',
            'CRITICAL': 'bold_red',
        }
    )
    console_handler.setFormatter(console_formatter)
    logger.addHandler(console_handler)

    # 文件处理器(不带颜色)
    os.makedirs(log_dir, exist_ok=True)
    log_file = os.path.join(log_dir, f"log_{datetime.now().strftime('%Y%m%d_%H%M%S')}.log")
    file_handler = logging.FileHandler(log_file, encoding="utf-8")
    file_formatter = logging.Formatter("%(asctime)s - %(levelname)s - %(message)s")
    file_handler.setFormatter(file_formatter)
    logger.addHandler(file_handler)

    return logger

调用方式:

#!/usr/bin/env python
# -*- coding: UTF-8 -*-
"""
@Project :Fish 
@File    :test.py
@Date    :2025/4/23 20:01 
@Author : malijie
"""
import logging

from D11.D11 import get_logger

if __name__ == '__main__':
    logger = get_logger(level=logging.DEBUG)
    logger.debug("关税让美国进口订单开始腰斩")
    logger.info("特朗普就印控克什米尔发生恐袭发声")
    logger.warning("广州越秀一宾馆疑似发生火灾")
    logger.error("美在菲建全球最大战备仓库")
    logger.critical("特朗普再加关税!")



五、日志等级控制技巧


你可以通过 level 参数,灵活控制输出级别:

#!/usr/bin/env python
# -*- coding: UTF-8 -*-
"""
@Project :Fish 
@File    :test.py
@Date    :2025/4/23 20:01 
@Author : malijie
"""
import logging

from D11.D11 import get_logger

if __name__ == '__main__':
    logger = get_logger(level=logging.WARNING)
    logger.debug("关税让美国进口订单开始腰斩")
    logger.info("特朗普就印控克什米尔发生恐袭发声")
    logger.warning("广州越秀一宾馆疑似发生火灾")
    logger.error("美在菲建全球最大战备仓库")
    logger.critical("特朗普再加关税!")

上面这行设置只输出 WARNING 及以上等级的日志。



六、logging 在自动化测试中的典型应用

日志通常用于记录:

  • 接口请求 / 响应数据
  • 步骤执行结果
  • 错误堆栈信息
  • 断言失败信息
log.info(f"请求接口成功,返回状态码:{status_code}")
log.error(f"断言失败,返回数据:{response.json()}")

结合 try-except 提升稳定性:

#!/usr/bin/env python
# -*- coding: UTF-8 -*-
"""
@Project :Fish 
@File    :D11.py
@Date    :2025/4/23 19:27 
@Author : malijie
"""
import logging
import os
from datetime import datetime
import colorlog


def get_logger(name="my_logger", log_dir="logs", level=logging.DEBUG):
    logger = logging.getLogger(name)
    logger.setLevel(level)

    # 避免重复添加处理器
    if logger.handlers:
        return logger

    # 控制台处理器(彩色)
    console_handler = colorlog.StreamHandler()
    console_formatter = colorlog.ColoredFormatter(
        "%(log_color)s%(asctime)s - %(levelname)s - %(message)s",
        log_colors={
            'DEBUG': 'cyan',
            'INFO': 'green',
            'WARNING': 'yellow',
            'ERROR': 'red',
            'CRITICAL': 'bold_red',
        }
    )
    console_handler.setFormatter(console_formatter)
    logger.addHandler(console_handler)

    # 文件处理器(不带颜色)
    os.makedirs(log_dir, exist_ok=True)
    log_file = os.path.join(log_dir, f"log_{datetime.now().strftime('%Y%m%d_%H%M%S')}.log")
    file_handler = logging.FileHandler(log_file, encoding="utf-8")
    file_formatter = logging.Formatter("%(asctime)s - %(levelname)s - %(message)s")
    file_handler.setFormatter(file_formatter)
    logger.addHandler(file_handler)

    return logger


def ctr(c=None, t=None, r=None):
    if c == "唱" and t == "跳" and r == "RAP":
        logger.info("你太美!")
    else:
        1 / 0


if __name__ == '__main__':
    logger = get_logger(level=logging.DEBUG)
    ctr("唱", "跳", "RAP")
    try:
        ctr()
    except Exception as e:
        logger.exception("执行出错")  # 自动带 traceback



小结

场景

推荐写法

快速调试

logging.basicConfig()

项目标准日志

get_logger() 封装

自动化日志记录

info / error / exception

控制台 + 文件双输出

logger + handler

记住一句话:print 只能看,logging 能分析!



下期预告


每天一个 Python 库:argparse 命令行参数解析,给脚本配上交互能力!



点关注点赞不迷路,后续更新更多自动化测试经验,我们一起成长!

欢迎留言交流:你在用 logging 吗?都用来记录哪些信息?


点击头像,查看更多文章系列

下一期更精彩,不见不散!

最近发表
标签列表