Python logging模块使用指南:从控制台输出到文件记录
本文详细介绍Python内置logging模块的核心用法,涵盖如何导入模块、设置日志级别(DEBUG至CRITICAL)、自定义输出格式及时间。通过示例演示如何将日志输出至控制台或写入文件,并讲解同时实现屏幕显示与文件保存的配置方法,帮助开发者快速掌握日志记录技巧。
Python的logging模块
Python标准库中内置了一个专门用于处理日志记录的模块,即logging。
要使用logging模块,首先需要在代码中导入它,具体命令如下:
import logging
logging模块的基本使用方法如下:
1. 最简单的用法是将日志直接打印到控制台屏幕。
import logging
logging.debug("This is debug message")
logging.info("This is info message")
logging.warning("This is warning message")
logging.error("This is error message")
logging.critical("This is critical message")
执行上述代码后,控制台会输出类似以下内容:
WARNING:root:This is warning message
ERROR:root:This is error message
CRITICAL:root:This is critical message
默认情况下,Python的logging模块会将日志输出到标准输出(即屏幕),并且只显示WARNING级别及以上的日志信息。
这表明logging模块的默认日志级别被设置为WARNING(日志级别从高到低依次为:CRITICAL > ERROR > WARNING > INFO > DEBUG)。
默认的输出格式为:日志级别:Logger名称:用户输出的消息。
2. 接下来,我们可以将默认日志级别修改为DEBUG,并自定义输出时间的格式。
import logging
logging.basicConfig(level=logging.DEBUG,
format="%(asctime)s %(levelname)s %(message)s",
datefmt="%Y-%m-%d %H:%M:%S")
logging.debug("This is debug message")
logging.info("This is info message")
logging.warning("This is warning message")
logging.error("This is error message")
logging.critical("This is critical message")
修改配置后,屏幕将显示如下信息:
2017-07-02 10:41:18 DEBUG This is debug message
2017-07-02 10:41:18 INFO This is info message
2017-07-02 10:41:18 WARNING This is warning message
2017-07-02 10:41:18 ERROR This is error message
2017-07-02 10:41:18 CRITICAL This is critical message
3. 如果希望将程序产生的日志保存到文件中,可以进行如下配置:
import logging
logging.basicConfig(level=logging.DEBUG,
format="%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s",
datefmt="%Y-%m-%d %H:%M:%S",
filename="log.txt",
filemode="w")
logging.debug("This is debug message")
logging.info("This is info message")
logging.warning("This is warning message")
logging.error("This is error message")
logging.critical("This is critical message")
运行该程序后,会在脚本所在的目录下生成一个名为log.txt的文件。
打开log.txt文件,其内容如下所示:
2017-07-02 10:49:13 logging_modules.py[line:211] DEBUG This is debug message
2017-07-02 10:49:13 logging_modules.py[line:212] INFO This is info message
2017-07-02 10:49:13 logging_modules.py[line:213] WARNING This is warning message
2017-07-02 10:49:13 logging_modules.py[line:214] ERROR This is error message
2017-07-02 10:49:13 logging_modules.py[line:215] CRITICAL This is critical message
上述日志文件输出的功能是通过调用basicConfig方法实现的。
logging.basicConfig函数各参数: filename: 指定输出日志的文件名 filemode: 和file函数意义相同,指定日志文件的打开模式,写入模式用'w',追加模式使用'a' format: 指定输出的内容的格式,其中可以使用的参数有: %(levelno)s: 指定输出日志的级别的数值 %(levelname)s: 指定输出日志的级别的名称 %(pathname)s: 指定当前执行程序的路径,其实就是sys.argv[0] %(filename)s: 指定保存日志文件的名字 %(funcName)s: 打印日志的当前函数 %(lineno)d: 打印日志的当前行号 %(asctime)s: 打印日志的时间 %(thread)d: 打印线程ID %(threadName)s: 打印线程名称 %(process)d: 打印进程ID %(message)s: 打印日志信息 datefmt: 指定时间格式,同time.strftime() level: 设置日志级别,默认为logging.WARNING,这里设定为logging.DEBUG
4. 若希望既能在屏幕上实时查看日志,又能将日志持久化保存到文件中以便后续查阅,可按以下方式配置:
import logging
logger=logging.getLogger()
#创建一个file_handle变量,用于把日志写入到文件
file_handle=logging.FileHandler("log1.txt")
#创建一个stream_handle变量,用于输出日志到屏幕上
stream_handle=logging.StreamHandler()
#设定输出日志的级别为debug级别
logger.setLevel(logging.DEBUG)
#设定输出日志的格式
fmt=logging.Formatter("%(asctime)s-%(levelname)s-%(message)s")
#为写入文件的日志添加已设定的格式
file_handle.setFormatter(fmt)
#为输出到屏幕的日志添加已设定的格式
stream_handle.setFormatter(fmt)
logger.addHandler(file_handle)
logger.addHandler(stream_handle)
#设定输出日志的信息
logging.debug("This is debug message")
logging.info("This is info message")
logging.warning("This is warning message")
logging.error("This is error message")
logging.critical("This is critical message")
运行程序后,会生成一个名为log1.txt的文件,该文件内容以及屏幕显示的内容一致,格式如下:
2017-07-02 11:04:53,622-DEBUG-This is debug message
2017-07-02 11:04:53,623-INFO-This is info message
2017-07-02 11:04:53,623-WARNING-This is warning message
2017-07-02 11:04:53,623-ERROR-This is error message
2017-07-02 11:04:53,624-CRITICAL-This is critical message
在此配置中,还可以进一步添加选项,指定写入文件的日志级别为DEBUG,而输出到屏幕的日志仍保持为WARNING级别。
fh.setLevel(logging.Debug)
内容扩展:
日志的作用
通过分析日志,用户可以了解系统、软件或应用的运行状态;如果应用日志足够丰富,还可以分析以往用户的操作行为、类型偏好、地域分布等更多维度的信息;若应用日志分为了多个级别,则能轻松评估应用的健康状况,及时发现并快速定位、解决问题,从而减少损失。
简而言之,通过记录和分析日志,我们可以判断系统或软件程序运行是否正常,并在出现故障时快速定位问题。例如,运维人员在接到报警或反馈后,通常首先查看各类日志,大部分问题可在日志中找到答案;开发人员则通过IDE控制台输出的日志进行调试。经验丰富的运维人员或开发者能迅速通过日志定位根源,可见日志的重要性不容忽视。日志的作用主要可总结为以下三点:
程序调试
了解软件程序运行情况是否正常
软件程序运行故障分析与问题定位
如果应用的日志信息足够详细和丰富,还可用于用户行为分析,如分析用户的操作行为、类型偏好、地域分布及其他更多信息,从而优化业务、提升商业价值。
至此,关于Python中logging模块的学习笔记介绍完毕,更多相关Python之logging模块的内容请搜索本站历史文章或继续浏览后续文章,希望大家多多支持本站!
免责声明:本文内容仅供参考,不代表本站观点。转载或引用请注明出处。









