参考博文:
logging模块
一、简单应用
import logging
logging.debug('debug message')
logging.info('info message')
logging.warning('warning message')
logging.error('error message')
logging.critical('critical message')
屏幕上输出:
WARNING:root:warning message
ERROR:root:error message
CRITICAL:root:critical message
可见,默认情况下Python的logging模块将日志打印到了标准输出中,且只显示了大于等于WARNING级别的日志,这说明默认的日志级别设置为WARNING(日志级别等级CRITICAL > ERROR > WARNING > INFO > DEBUG > NOTSET),默认的日志格式为日志级别:Logger名称:用户输出消息
二、 灵活配置日志级别,日志格式,输出位置 loggong.basicConfig()
基本使用范式如下:
import logging
logging.basicConfig(
level=logging.DEBUG, #设置日志显示级别
filename="logger.log", #不设置此项时,默认将日志信息显示在屏幕上
filemode="a", #文件模式不设置时,默认为"a"追加模式。'w'是覆盖模式(有则覆盖,没有则创建)
format='%(asctime)s %(filename)s [%(lineno)s] %(message)s'
)
logging.debug('debug message')
logging.info('info message')
logging.warning('warning message')
logging.error('error message')
logging.critical('critical message')
# logger.log 文件
2019-11-06 19:59:59,692 13
2019-11-06 19:59:59,692 14
2019-11-06 19:59:59,692 15
2019-11-06 19:59:59,692 16
2019-11-06 19:59:59,692 17
2019-11-06 20:00:15,552 [13]
2019-11-06 20:00:15,552 [14]
2019-11-06 20:00:15,553 [15]
2019-11-06 20:00:15,553 [16]
2019-11-06 20:00:15,553 [17]
2019-11-06 20:00:41,986 [13] debug message
2019-11-06 20:00:41,987 [14] info message
2019-11-06 20:00:41,987 [15] warning message
2019-11-06 20:00:41,987 [16] error message
2019-11-06 20:00:41,987 [17] critical message
2019-11-06 20:02:51,212 logging模块.py [13] debug message
2019-11-06 20:02:51,212 logging模块.py [14] info message
2019-11-06 20:02:51,212 logging模块.py [15] warning message
2019-11-06 20:02:51,212 logging模块.py [16] error message
2019-11-06 20:02:51,212 logging模块.py [17] critical message
log文件里的文本信息示例
可见在logging.basicConfig()函数中可通过具体参数来更改logging模块默认行为,可用参数有
1.filename:用指定的文件名创建FiledHandler(后边会具体讲解handler的概念),这样日志会被存储在指定的文件中。
2.filemode:文件打开方式,在指定了filename时使用这个参数,默认值为“a”(追加模式) 还可指定为“w”。
3.format:指定handler使用的日志显示格式。
4.datefmt:指定日期时间格式。(默认格式一般可以满足要求)
5.level:设置rootlogger(后边会讲解具体概念)的日志级别,默认=30 两种形式,第一种: level=DEBUG,level=INFO,level=WARNING... 第二种,数值的形式 level=10 (对应DEBUG),level=20 (对应INFO),level=30 (对应WARNING),
6.stream:用指定的stream创建StreamHandler。可以指定输出到sys.stderr,sys.stdout或者文件(f=open('test.log','w')),默认为sys.stderr。若同时列出了filename和stream两个参数,则stream参数会被忽略。
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 用户输出的消息
三、使用对象,生成日志信息 (推荐)
上述几个例子中我们了解到了logging.debug()、logging.info()、logging.warning()、logging.error()、logging.critical()(分别用以记录不同级别的日志信息),logging.basicConfig()(用默认日志格式(Formatter)为日志系统建立一个默认的流处理器(StreamHandler),设置基础配置(如日志级别等)并加到root logger(根Logger)中)这几个logging模块级别的函数,另外还有一个模块级别的函数是logging.getLogger([name])(返回一个logger对象,如果没有指定名字将返回root logger)
import logging
# 1
logger=logging.getLogger() #获取一个对象 # <class 'logging.RootLogger'>
# 2
fh=logging.FileHandler('test_log.log') # 获取一个对文件操作的对象 <class 'logging.FileHandler'>
ch=logging.StreamHandler() # 获取一个对屏幕操作的对象 <class 'logging.StreamHandler'>
fm=logging.Formatter('%(asctime)s %(filename)s [%(lineno)s] %(message)s') #获取一个设置格式的对象
# 3
fh.setFormatter(fm) #将格式对象,集成到 文件操作对象里
ch.setFormatter(fm) #将格式对象,集成到 屏幕对象里
# 4
logger.addHandler(fh) #将 文件操作对象,集成到 logger对象里
logger.addHandler(ch) #将 屏幕操作对象,集成到 logger对象里
logger.setLevel('DEBUG') #设置 logger对象的 日志级别
# logger.setLevel(logging.DEBUG) #设置 logger对象的 日志级别
# 5 使用logger对象,生成日志信息 (此时,可以打印到屏幕上,同时保存信息到文件里)
logger.debug("Hello, debug message!")
("hello, info message")
logger.warning("hello,warning")
logger.error("hello,error message")
logger.critical("hello,this is a critical message!")
示例,将日志信息写入到log文件,同时显示到屏幕
先简单介绍一下,logging库提供了多个组件:Logger、Handler、Filter、Formatter。Logger对象提供应用程序可直接使用的接口,Handler发送日志到适当的目的地,Filter提供了过滤日志信息的方法,Formatter指定日志显示格式。
(1)
Logger是一个树形层级结构,输出信息之前都要获得一个Logger(如果没有显示的获取则自动创建并使用root Logger,如第一个例子所示)。
logger = logging.getLogger()返回一个默认的Logger也即root Logger,并应用默认的日志级别、Handler和Formatter设置。
当然也可以通过Logger.setLevel(lel)指定最低的日志级别,可用的日志级别有logging.DEBUG、logging.INFO、logging.WARNING、logging.ERROR、logging.CRITICAL。
Logger.debug()、()、Logger.warning()、Logger.error()、Logger.critical()输出不同级别的日志,只有日志等级大于或等于设置的日志级别的日志才会被输出。
3.1 示例: 使用对象,在日志信息写入到 多个文档里 (使用logging.basicConfig()是无法写入到多个文档里的)
import logging
# 创建一个操作日志的对象logger(依赖FileHandler)
file_handler = logging.FileHandler('l1.log', 'a', encoding='utf-8')
file_handler.setFormatter(logging.Formatter(fmt="%(asctime)s - %(name)s - %(levelname)s -%(module)s: %(message)s"))
logger1 = logging.Logger('s1', level=logging.ERROR)
logger1.addHandler(file_handler)
logger1.error('123123123')
# 再创建一个操作日志的对象logger(依赖FileHandler)
file_handler2 = logging.FileHandler('l2.log', 'a', encoding='utf-8')
file_handler2.setFormatter(logging.Formatter(fmt="%(asctime)s - %(name)s - %(levelname)s -%(module)s: %(message)s"))
logger2 = logging.Logger('s2', level=logging.ERROR)
logger2.addHandler(file_handler2)
logger2.error('666')
3.2 捕获代码异常,并将错误信息,写入日志文件
方式一 普通模式,示例:
import os,logging,traceback
logging.basicConfig(
filename="log.log",
level=10,
filemode="a",
format="%(asctime)s %(levelname)s %(filename)s %(lineno)s %(message)s"
)
try:
os.path.exists()
except TypeError as e:
msg = traceback.format_exc()
logging.error(msg) # 将堆栈信息写入日志 (堆栈信息就是调试时,窗口下面提示的错误内容)
log文件里的内容格式,对应如下
# log.log文件
2019-11-18 09:35:01,513 ERROR test.py 16 Traceback (most recent call last):
File "D:/PyCharm/myPy/day_26/test.py", line 13, in <module>
os.path.exists()
TypeError: exists() missing 1 required positional argument: 'path'
日志文件 内容
方式二 (推荐) 使用Logger对象,示例:
import logging
# 1.实例化一个 文件处理句柄对象
file_handle=logging.FileHandler(filename="log1.log",mode="a",encoding="utf-8")
#给文件句柄对象,设置格式 (实例化一个Formatter对象)
file_handle.setFormatter(logging.Formatter(fmt="%(asctime)s [%(levelname)s] %(filename)s [%(lineno)s] %(message)s"))
# 2.示例化一个 Logger对象
objlog1=logging.Logger(name="s1",level=10) #Logger是一个日志类
#print(type(objlog1),objlog1.name) # <class 'logging.Logger'> s1
#3.给 Logger对象,添加文件句柄
objlog1.addHandler(file_handle)
# 使用Logger对象,将日志信息,写入到文件
import traceback
try:
a=a+1
except Exception as e:
msg=traceback.format_exc() #获取堆栈信息
objlog1.error(msg)
日志文件里的内容、格式如下:
#log1.log
2019-11-18 10:42:56,019 [ERROR] logging模块.py [22] Traceback (most recent call last):
File "D:/PyCharm/myPy/day_26/logging模块.py", line 19, in <module>
a=a+1
NameError: name 'a' is not defined
2019-11-18 10:43:01,588 [ERROR] logging模块.py [22] Traceback (most recent call last):
File "D:/PyCharm/myPy/day_26/logging模块.py", line 19, in <module>
a=a+1
NameError: name 'a' is not defined
日志文件 的内容