Python模块学习——logging

最新推荐文章于 2023-10-16 20:37:07 发布

tycoon1988

最新推荐文章于 2023-10-16 20:37:07 发布

阅读量404

点赞数

分类专栏： Python

本文链接：https://blog.csdn.net/tycoon1988/article/details/38761605

版权

Python 专栏收录该内容

82 篇文章 2 订阅

订阅专栏

、从一个使用场景开始

开发一个日志系统，既要把日志输出到控制台，还要写入日志文件

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')

运行后，在控制台和日志文件都有一条日志：

Java代码

2011-08-31 19:18:29,816 - mylogger - INFO - foorbar

<span style="font-size:18px;">2011-08-31 19:18:29,816 - mylogger - INFO - foorbar</span>

二、logging模块的API

结合上面的例子，我们说下几个最常使用的API

logging.getLogger([name]) 返回一个logger实例，如果没有指定name，返回root logger。只要name相同，返回的logger实例都是同一个而且只有一个，即name和logger实例是一一对应的。这意味着，无需把logger实例在各个模块中传递。只要知道name，就能得到同一个logger实例
Logger.setLevel(lvl) 设置logger的level， level有以下几个级别：

NOTSET < DEBUG < INFO < WARNING < ERROR < CRITICAL
如果把looger的级别设置为INFO，那么小于INFO级别的日志都不输出，大于等于INFO级别的日志都输出

Python代码

logger.debug("foobar") # 不输出
logger.info("foobar") # 输出
logger.warning("foobar") # 输出
logger.error("foobar") # 输出
logger.critical("foobar") # 输出

<span style="font-size:18px;">logger.debug("foobar")    # 不输出 
logger.info("foobar")        # 输出
logger.warning("foobar") # 输出
logger.error("foobar")      # 输出
logger.critical("foobar")    # 输出</span>

Logger.addHandler(hdlr) logger可以雇佣handler来帮它处理日志， handler主要有以下几种： StreamHandler: 输出到控制台 FileHandler: 输出到文件 handler还可以设置自己的level以及输出格式。
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：

Python代码

import logging
logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.DEBUG)
logging.debug('This message should appear on the console')

<span style="font-size:18px;">import logging
logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.DEBUG)
logging.debug('This message should appear on the console')</span>

三、关于root logger以及logger的父子关系
前面多次提到root logger，实际上logger实例之间还有父子关系， root logger就是处于最顶层的logger，它是所有logger的祖先。如下图:

root logger是默认的logger 如果不创建logger实例，直接调用logging.debug()、logging.info()logging.warning()、logging.error()、logging.critical()这些函数， 那么使用的logger就是 root logger，它可以自动创建，也是单实例的。
如何得到root logger 通过logging.getLogger()或者logging.getLogger("")得到root logger实例。
默认的level root logger默认的level是logging.WARNING
如何表示父子关系 logger的name的命名方式可以表示logger之间的父子关系. 比如： parent_logger = logging.getLogger('foo') child_logger = logging.getLogger('foo.bar')
什么是effective level logger有一个概念，叫effective level。如果一个logger没有显示地设置level，那么它就用父亲的level。如果父亲也没有显示地设置level，就用父亲的父亲的level，以此推.... 最后到达root logger，一定设置过level。默认为logging.WARNING child loggers得到消息后，既把消息分发给它的handler处理，也会传递给所有祖先logger处理，
来看一个例子

Python代码

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')

<span style="font-size:18px;">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')</span>

输出如下：

Python

2011-08-31 21:04:29,893 - foo
2011-08-31 21:04:29,893 - DEBUG - foo

<span style="font-size:18px;">2011-08-31 21:04:29,893 - foo
2011-08-31 21:04:29,893 - DEBUG - foo</span>

可见，孩子logger没有任何handler，所以对消息不做处理。但是它把消息转发给了它的父 亲以及root logger。最后输出两条日志。

大小: 2 KB

大小: 10.1 KB

logging模块是在2.3新引进的功能，下面是一些常用的类和模块级函数

模块级函数

logging.getLogger([name]):返回一个logger对象，如果没有指定名字将返回root logger

logging.debug()、logging.info()、logging.warning()、logging.error()、logging.critical()：设定root logger的日志级别

logging.basicConfig():用默认Formatter为日志系统建立一个StreamHandler，设置基础配置并加到root logger中

 
          import logging 
         
          import sys 
         
          LEVELS = {'debug': logging.DEBUG, 
         
                    'info': logging.INFO, 
         
                    'warning': logging.WARNING, 
         
                    'error': logging.ERROR, 
         
                    'critical': logging.CRITICAL} 
         
          if len(sys.argv) >  1: 
         
              level_name = sys.argv[1] 
         
              level = LEVELS.get(level_name, logging.NOTSET) 
         
              logging.basicConfig(level=level) 
         
          logging.debug('This is a debug message') 
         
          logging.info('This is an info message') 
         
          logging.warning('This is a warning message') 
         
          logging.error('This is an error message') 
         
          logging.critical('This is a critical error message')

$ python logging_level_example.py debug
DEBUG:root:This is a debug message
INFO:root:This is an info message
WARNING:root:This is a warning message
ERROR:root:This is an error message
CRITICAL:root:This is a critical error message

$ python logging_level_example.py info
INFO:root:This is an info message
WARNING:root:This is a warning message
ERROR:root:This is an error message
CRITICAL:root:This is a critical error message

Loggers

Logger.setLevel(lel):指定最低的日志级别，低于lel的级别将被忽略。debug是最低的内置级别，critical为最高

Logger.addFilter(filt)、Logger.removeFilter(filt):添加或删除指定的filter

Logger.addHandler(hdlr)、Logger.removeHandler(hdlr)：增加或删除指定的handler

Logger.debug()、Logger.info()、Logger.warning()、Logger.error()、Logger.critical()：可以设置的日志级别

 
          import logging 
         
          # create logger 
         
          logger = logging.getLogger("simple_example") 
         
          logger.setLevel(logging.DEBUG) 
         
          # create console handler and set level to debug 
         
          ch = logging.StreamHandler() 
         
          ch.setLevel(logging.DEBUG) 
         
          # create formatter 
         
          formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s") 
         
          # add formatter to ch 
         
          ch.setFormatter(formatter) 
         
          # add ch to logger 
         
          logger.addHandler(ch) 
         
          # "application" code 
         
          logger.debug("debug message") 
         
          logger.info("info message") 
         
          logger.warn("warn message") 
         
          logger.error("error message") 
         
          logger.critical("critical message")

$ python simple_logging_module.py
2005-03-19 15:10:26,618 - simple_example - DEBUG - debug message
2005-03-19 15:10:26,620 - simple_example - INFO - info message
2005-03-19 15:10:26,695 - simple_example - WARNING - warn message
2005-03-19 15:10:26,697 - simple_example - ERROR - error message
2005-03-19 15:10:26,773 - simple_example - CRITICAL - critical message