记录日志是追踪事件的一种手段。通过添加日志,开发者可以清楚地了解发生了哪些事件,包括出现了哪些错误。logging 模块提供了一系列便捷的函数,用于简单的日志记录。它们分别是 debug(), info(), warning(), error() 和 critical()。
1. 简单例子:
import logging
# 创建一个logger
logger = logging.getLogger('mylogger')
logger.setLevel(logging.DEBUG)
# 创建一个handler,用于写入日志文件
fh = logging.FileHandler('test.log')
fh.setLevel(logging.DEBUG)
# 再创建一个handler,用于输出到控制台
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)
# 定义handler的输出格式
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
fh.setFormatter(formatter)
ch.setFormatter(formatter)
# 给logger添加handler
logger.addHandler(fh)
logger.addHandler(ch)
# 记录一条日志
logger.info('foorbar')
输出
2018-05-09 10:18:24,807 - mylogger - INFO - foorbar
- 运行之后控制台输出日志,另外在相同的目录之下创建一个test.log用于记录日志,里面也存放着相同的内容。
- 要在日志中显示日期和时间,你需要在格式串中加入 %(asctime)s,格式串中的时间格式参数与中支持的参数相同。 strftime
- %(message)s 是可以输入到格式化的数据,比如这里的’foorbar’
2. logging模块常用的API
2.1 logging.getLogger([name])
- 返回一个logger实例,如果没有指定name,返回root logger。
- 只要name相同,返回的logger实例都是同一个而且只有一个,即name和logger实例是 一一对应的。这意味着,无需把logger实例在各个模块中传递。只要知道name,就能得到同一个logger实例。
- Logger是一个树形层级结构,在使用接口debug,info,warn,error,critical之前必须创建Logger实例,即创建一个记录器,如果没有显式的进行创建,则默认创建一个root logger,并应用默认的日志级别(WARN),处理器Handler(StreamHandler,即将日志信息打印输出在标准输出上),和格式化器Formatter(默认的格式即为第一个简单使用程序中输出的格式)。
- 创建Logger实例后,可以使用以下方法进行日志级别设置,增加处理器Handler。
logger.setLevel(logging.ERROR) # 设置日志级别为ERROR,即只有日志级别大于等于ERROR的日志才会输出
logger.addHandler(handler_name) # 为Logger实例增加一个处理器 -logger.removeHandler(handler_name) # 为Logger实例删除一个处理器
2.2 Logger.setLevel(lvl)
设置logger的level, level有以下几个级别:
NOTSET < DEBUG < INFO < WARNING < ERROR < CRITICAL
如果把looger的级别设置为INFO, 那么小于INFO级别的日志都不输出, 大于等于INFO级别的日志都输出
级别 | 何时使用 |
---|---|
DEBUG | 详细信息,典型地调试问题时会感兴趣。 |
INFO | 证明事情按预期工作。 |
WARNING | 表明发生了一些意外,或者不久的将来会发生问题(如‘磁盘满了’)。软件还是在正常工作。 |
ERROR | 由于更严重的问题,软件已不能执行一些功能了。 |
CRITICAL | 严重错误,表明软件已不能继续运行了。 |
#!/usr/local/bin/python
# -*- coding:utf-8 -*-
import logging
# 通过下面的方式进行简单配置输出方式与日志级别
logging.basicConfig(filename='logger.log', level=logging.INFO)
logging.debug('debug message')
logging.info('info message')
logging.warn('warn message')
logging.error('error message')
logging.critical('critical message')
输出:
DEBUG:debug message
2018-05-09 10:58:22,325 - DEBUG - debug message
INFO:info message
2018-05-09 10:58:22,326 - INFO - info message
/usr/local/anaconda3/lib/python3.6/site-packages/ipykernel_launcher.py:10: DeprecationWarning: The 'warn' function is deprecated, use 'warning' instead
# Remove the CWD from sys.path while we load stuff.
WARNING:warn message
2018-05-09 10:58:22,327 - WARNING - warn message
ERROR:error message
2018-05-09 10:58:22,328 - ERROR - error message
CRITICAL:critical message
2018-05-09 10:58:22,329 - CRITICAL - critical message
2.3 Logger.addHandler(hdlr)
- logger可以雇佣handler来帮它处理日志, handler主要有以下几种:
- StreamHandler: 输出到控制台
2.FileHandler: 输出到文件 - handler还可以设置自己的level以及输出格式。
- StreamHandler: 输出到控制台
2.4 logging.basicConfig([**kwargs])
这个函数用来配置root logger, 为root logger创建一个StreamHandler, 设置默认的格式。
- 这些函数: logging.debug()、logging.info()、logging.warning()、 logging.error()、logging.critical() 如果调用的时候发现root logger没有任何 handler, 会自动调用basicConfig添加一个handler
- 如果root logger已有handler, 这个函数不做任何事情
- 使用basicConfig来配置root logger的输出格式和level:
import logging
logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.DEBUG)
logging.debug('This message should appear on the console')
输出:
DEBUG:This message should appear on the console
3. 关于root logger以及logger的父子关系
前面多次提到root logger, 实际上logger实例之间还有父子关系, root logger就是处于最顶层的logger,它是所有logger的祖先。
3.1 root logger是默认的logger
- 如果不创建logger实例, 直接调用logging.debug()、logging.info()logging.warning()、logging.error()、logging.critical()这些函数, 那么使用的logger就是 root logger, 它可以自动创建,也是单实例的。
3.2 如何得到root logger?
- 通过logging.getLogger()或者logging.getLogger(“”)得到root logger实例。
3.3 默认的level
- root logger默认的level是logging.WARNING
3.4 如何表示父子关系?
logger的name的命名方式可以表示logger之间的父子关系. 比如:parent_logger = logging.getLogger(‘foo’)child_logger = logging.getLogger(‘foo.bar’)
3.5 什么是effective level?
- logger有一个概念,叫effective level。 如果一个logger没有显示地设置level,那么它就用父亲的level。如果父亲也没有显示地设置level, 就用父亲的父亲的level,以此推….最后到达root logger,一定设置过level。默认为logging.WARNINGchild loggers得到消息后,既把消息分发给它的handler处理,也会传递给所有祖先logger处理,
import logging
# 设置root logger
r = logging.getLogger()
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)
formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
ch.setFormatter(formatter)
r.addHandler(ch)
# 创建一个logger作为父亲
p = logging.getLogger('foo')
p.setLevel(logging.DEBUG)
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)
formatter = logging.Formatter('%(asctime)s - %(message)s')
ch.setFormatter(formatter)
p.addHandler(ch)
# 创建一个孩子logger
c = logging.getLogger('foo.bar')
c.debug('foo')
输出:
2018-05-09 10:51:26,674 - foo
DEBUG:foo
2018-05-09 10:51:26,674 - DEBUG - foo
可见, 孩子logger没有任何handler,所以对消息不做处理。但是它把消息转发给了它的父亲以及root logger。最后输出两条日志。