-
文章主要包括以下的内容:
1 - 日志级别
1.1 从低到高分别是:DEBUG > INFO > WARNING > ERROR > CRITICAL
2 - 基本操作
2.1 输出到控制台:通过basicConfig()方法的level参数
2.2 保存到文件:通过basicConfig()方法的filename参数
2.3 格式化输出内容:通过basicConfig()方法的format参数
2.4 format中允许使用的变量:
2.4 basicConfig([**kwargs])方法支持的关键字参数:
3 - logging模块的高级用法
3.1 - 日志记录器: logging.getLogger([name])
3.2 - 日志记录器:Handlers
3.3 - 日志格式器:logging.Formatter()
3.3 - 一个完整的日志记录器。
一、 日志级别:
-
logging模块将日志分为了五个等级:
-
从低到高分别是:DEBUG > INFO > WARNING > ERROR > CRITICAL
- DEBUG:调试信息;通常只出现在诊断问题上。
- INFO:普通信息;确认程序安装预期运行。
- WARNING:警告信息;表示发生了意想不到的事情,或者指示接下来可能会出现一些问题,但是程序还是继续运行。
- ERROR:错误信息;更严重的问题,软件没能执行一些功能。
- CRITICAL:危险信息;一个严重的错误,导致程序可能无法继续运行。
备注:模块等级默认的是WARNING,当在WARNING或之上时才被跟踪。
-
五个等级分别对应的方法是:logging模块的debug()、info()、warning()、error()、critical()。
二、基本操作:
-
2.1 输出到控制台:
- A - 未设置等级,直接使用模块默认等级输出。
import logging
logging.debug('1 调试信息')
logging.info('2 普通信息')
logging.warning('3 警告信息')
logging.error('4 错误信息')
logging.critical('5 危险信息')
#输出内容:
# WARNING:root:3 警告信息
# ERROR:root:4 错误信息
# CRITICAL:root:5 危险信息
# 总结:因为模块等级默认的是WARNING,所有只有等级在WARNING或之上时才会被跟踪;
# 所以我们需要对日志输出的格式进行设置
- B - 使用basicConfig()方法,利用其level参数进行设置:level=logging.DEBUG,就可以输出等级大于等于DEBUG的日志信息。
import logging
#使用 basicConfig() 方法设置模块的等级为DEBUG,输出等级大于等于DEBUG的日志信息
logging.basicConfig(level=logging.DEBUG)
logging.debug('1 调试信息')
logging.info('2 普通信息')
logging.warning('3 警告信息')
logging.error('4 错误信息')
logging.critical('5 危险信息')
#输出内容:
# DEBUG:root:1 调试信息
# INFO:root:2 普通信息
# WARNING:root:3 警告信息
# ERROR:root:4 错误信息
# CRITICAL:root:5 危险信息
2.2 保存到文件:
- 使用basicConfig()方法,利用其filename参数进行设置:filename='test.log'
import logging
# 0.使用basicConfig()方法
# 1.设置模块的等级为:DEBUG
# 2.设置保存日志信息的文件名:test.log
logging.basicConfig(level=logging.DEBUG,filename='test.log')
logging.debug('1 调试信息')
logging.info('2 普通信息')
logging.warning('3 警告信息')
logging.error('4 错误信息')
logging.critical('5 危险信息')
-
接下来打开我们的文件夹就会发现多了一个test.log文件,里面就是详细的程序日志。
日志信息文件:test.log
2.3 格式化输出内容:
- 使用basicConfig()方法,利用其format参数进行格式设置:
import logging
# 0.使用basicConfig()方法中的format参数进行设置
# 1.%(asctime)s:日志创建时的普通时间;
# 2.%(name)s:日志器的名称;
# 3.%(message)s:日志消息;
logging.basicConfig(format=('%(asctime)s-%(name)s:%(message)s'))
logging.warning('3 警告信息')
logging.error('4 错误信息')
logging.critical('5 危险信息')
#输出内容:
# 2018-06-14 00:26:32,527-root:3 警告信息
# 2018-06-14 00:26:32,527-root:4 错误信息
# 2018-06-14 00:26:32,527-root:5 危险信息
2.4 format中允许使用的变量:
- %(name)s Logger的名字
- %(levelno)s 数字形式的日志级别
- %(levelname)s 文本形式的日志级别
- %(pathname)s 调用日志输出函数的模块的完整路径名,可能没有
- %(filename)s 调用日志输出函数的模块的文件名
- %(module)s 调用日志输出函数的模块名|
- %(funcName)s 调用日志输出函数的函数名|
- %(lineno)d 调用日志输出函数的语句所在的代码行
- %(created)f 当前时间,用UNIX标准的表示时间的浮点数表示|
- %(relativeCreated)d 输出日志信息时的,自Logger创建以来的毫秒数|
- %(asctime)s 字符串形式的当前时间。默认格式是“2003-07-08 16:49:45,896”。逗号后面的是毫秒
- %(thread)d 线程ID。可能没有
- %(threadName)s 线程名。可能没有
- %(process)d 进程ID。可能没有
- %(message)s 用户输出的消息
2.5 basicConfig([**kwargs])方法支持的关键字参数:
filename :日志文件的保存路径。如果配置了些参数,将自动创建一个FileHandler作为Handler;
filemode :日志文件的打开模式。 默认值为'a',表示日志消息以追加的形式添加到日志文件中。如果设为'w', 那么每次程序启动的时候都会创建一个新的日志文件;
format :设置日志输出格式;
datefmt :定义日期格式;如:datefmt='%Y/%m/%d %I:%M:%S %p'
level :设置日志的级别.对低于该级别的日志消息将被忽略;
stream :设置特定的流用于初始化StreamHandler;
三、 logging模块的高级用法
-
logging框架中主要由四个部分组成:
- Loggers: 可供程序直接调用的接口
- Handlers: 决定将日志记录分配至正确的目的地
- Filters: 提供更细粒度的日志是否输出的判断
- Formatters: 制定最终记录打印的格式布局
-
3.1 - 日志记录器: logging.getLogger([name])
-
通过logging的getLogger()方法,我们可以创建一个日志记录器,并指定其名称,方便在任何地方都可以调用。
-
如果省略了name参数, getLogger将返回日志对象层次关系中的根Logger。
import logging
# 1 通过logging的getLogger()方法,可以创建一个日志记录器,并指定其名称,方便在任何地方都可以调用:
log = logging.getLogger('Test')
# 2 设置日志记录器的等级为:DEBUG
log.setLevel(logging.DEBUG)
-
3.2 - 日志记录器:Handlers
-
Handlers 负责将相应的日志记录消息分发到指定的目标上。
-
每个Handler同样有一个日志级别,一个logger可以拥有多个handler也就是说logger可以根据不同的日志级别将日志传递给不同的handler。当然也可以相同的级别传递给多个handlers这就根据需求来灵活的设置了。
-
常用的几个方法:
- StreamHandler:用于将日志消息发送到控制台;
- FileHandler:用于将日志消息写入文件中;
- SMTPHandler:用于将日志消息发送到指定的电子邮箱;
- HTTPHandler:使用GET或POST方法将日志消息发送给某个HTTP服务器;
# 3 使用logging.FileHandler()可以创建一个FileHandler处理器处理器,将日志消息写入文件中。
# 并指定日志的文件名为test.log。
logHandler = logging.FileHandler(filename='test.log')
# 4 设置日志处理器的等级为:DEBUG
logHandler.setLevel(logging.DEBUG)
# 5 创建日志处理器之后,我们需要使用日志记录器 log 的addHandler()方法,将处理器添加到记录器中。
log.addHandler(logHandler)
-
3.3 - 日志格式器:logging.Formatter()
- logging.Formatter()的使用和通过设置logging.basicConfig()的format参数来格式化输出内容都是差不多的。
# 6 传入参数,设置格式,通过 datefmt 参数对输出的日期进行格式化
format = logging.Formatter('%(asctime)s-%(name)s:%(message)s',datefmt='%Y/%m/%d %I:%M:%S %p')
# 7 创建好日志格式后,需要通过日志处理器 logHandler 的setFormatter()方法,将日志格式添加到日志处理器中:
logHandler.setFormatter(format)
-
3.4 - 然后我们就可以把上面的写好的模块组合起来,做成一个完整的日志记录器。
import logging
def my_log():
# 1 通过logging的getLogger()方法,可以创建一个日志记录器,并指定其名称,方便在任何地方都可以调用::
log = logging.getLogger('Test')
# 2 设置日志记录器的等级为:DEBUG
log.setLevel(logging.DEBUG)
# 3 使用logging.FileHandler()可以创建一个FileHandler处理器处理器,将日志消息写入文件中。
# 并指定日志的文件名为test.log。
logHandler = logging.FileHandler(filename='Test.log')
# 4 设置日志处理器的等级为:DEBUG
logHandler.setLevel(logging.DEBUG)
# 6 传入参数,设置格式,通过 datefmt 参数对输出的日期进行格式化
format = logging.Formatter('%(asctime)s-%(name)s:%(message)s', datefmt='%Y/%m/%d %I:%M:%S %p')
# 6 创建好日志格式后,需要通过日志处理器 logHandler 的setFormatter()方法,将日志格式添加到日志处理器中:
logHandler.setFormatter(format)
# 5 创建日志处理器之后,我们需要使用日志记录器 log 的addHandler()方法,将处理器添加到记录器中。
log.addHandler(logHandler)
'''备注:为了更符合逻辑,创建好日志格式后,才把处理器添加如记录器中'''
return log
if __name__ == '__main__':
log = my_log()
log.debug('1 调试信息')
log.info('2 普通信息')
log.warning('3 警告信息')
log.error('4 错误信息')
log.critical('5 危险信息')

- 暂时学习了logging模块的一些简单使用,不过差不多够自己的使用了,如果以后有更多的需要再做深入。。
- 参考资料:
网友评论