pythong的logging模块

清疚 2022-09-22 11:40 70阅读 0赞

**官方文档：[http://python.usyiyi.cn/python\_278/howto/logging.html\#logging-basic-tutorial][http_python.usyiyi.cn_python_278_howto_logging.html_logging-basic-tutorial]**

日志是跟踪软件运行时所发生的事件的一种方法。软件开发者在代码中调用日志函数，表明发生了特定的事件。事件由消息描述，可以包含可变的数据（即每次事件发生时都可能会不一样的数据）。事件有开发者给予的重要性；重要性也被叫做级别 或者 严重程度。

### 一、必须了解的知识 ###

> 日志的级别：debug < info < warning < error < critical

<table> 
 <thead> 
  <tr> 
   <th align="center">级别</th> 
   <th align="center">何时使用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">DEBUG</td> 
   <td align="center">详细信息，典型地调试问题时会感兴趣。</td> 
  </tr> 
  <tr> 
   <td align="center">INFO</td> 
   <td align="center">证明事情按预期工作。</td> 
  </tr> 
  <tr> 
   <td align="center">WARNING</td> 
   <td align="center">表明发生了一些意外，或者不久的将来会发生问题（如‘磁盘满了’）。软件还是在正常工作。</td> 
  </tr> 
  <tr> 
   <td align="center">ERROR</td> 
   <td align="center">由于更严重的问题，软件已不能执行一些功能了。</td> 
  </tr> 
  <tr> 
   <td align="center">CRITICAL</td> 
   <td align="center">严重错误，表明软件已不能继续运行了。</td> 
  </tr> 
 </tbody> 
</table>

**注：低于设定级别的日志都将不会被打印**

logging库采取了模块化的设计，提供了许多组件：记录器、处理器、过滤器和格式化器。

*  Logger 记录器，暴露了应用程序代码能直接使用的接口。
 *  Handler 处理器，将（记录器产生的）日志记录发送至合适的目的地。
 *  Filter 过滤器，提供了更好的粒度控制，它可以决定输出哪些日志记录。
 *  Formatter 格式化器，指明了最终输出中日志记录的布局。

日志事件信息以LogRecord实例的方式在记录器、处理器、过滤器和格式化器之间传递。

#### 1、记录器 ####

Logger是一个树形层级结构，在使用接口debug，info，warn，error，critical之前必须创建Logger实例，即创建一个记录器，如果没有显式的进行创建，则默认创建一个root logger，并应用默认的日志级别(WARN)，处理器Handler(StreamHandler，即将日志信息打印输出在标准输出上)，和格式化器Formatter(默认的格式即为第一个简单使用程序中输出的格式)。

> logger = logging.getLogger(logger\_name) \# 创建

创建Logger实例后，可以使用以下方法进行日志级别设置，增加处理器Handler。

*  Logger.setLevel()指明了记录器能处理的日志消息的最低级别，内置级别中debug（调试）最低，critical（严重）最高。例如，如果严重程度为INFO，记录器将只处理INFO，WARNING，- ERROR和CRITICAL消息，DEBUG消息被忽略。
 *  Logger.addHandler() 和 Logger.removeHandler() 在记录器对象上添加或者移除处理器对象。处理器详见[Handlers][]。
 *  Logger.addFilter() 和 Logger.removeFilter() 在记录器对象上添加或者移除过滤器对象。过滤器详见[Filter Objects][]。

#### 2、处理器 ####

Handler／处理器对象用来将合适的日志消息分发到处理器特定的目的地（基于日志消息的级别）。Logger通过addHandler()方法给它自己添加零个或多个处理器对象。常用的是StreamHandler，FileHandler，NullHandler  
常用的方法：

*  setLevel()方法和日志对象的一样，指明了将会分发日志的最低级别。为什么会有两个setLevel()方法？记录器的级别决定了消息是否要传递给处理器。每个处理器的级别决定了消息是否要分发。
 *  setFormatter()为该处理器选择一个格式化器。
 *  addFilter()和removeFilter()给处理器添加或移除过滤器对象。

### 3、过滤器 ###

Handlers和Loggers可以使用Filters来完成比级别更复杂的过滤。Filter基类只允许特定Logger层次以下的事件。例如用‘A.B’初始化的Filter允许Logger ‘A.B’, ‘A.B.C’, ‘A.B.C.D’, ‘A.B.D’等记录的事件，logger‘A.BB’, ‘B.A.B’ 等就不行。 如果用空字符串来初始化，所有的事件都接受。

> filter = logging.Filter(name=”) \# 创建

### 4、格式化器 ###

格式化器对象决定了日志消息最终的顺序，结构和内容。不象logging.Handler类，应用代码可以实例化格式化类；尽管如此，如果你的应用需要特殊的行为，你更可能会子类化一个格式化器。构造函数有两个可选的参数——消息格式化字符串和日期格式化字符串。

> formatter = logging.Formatter(fmt=None, datefmt=None) \# 创建

常用的formatter格式

<table> 
 <thead> 
  <tr> 
   <th align="center">格式</th> 
   <th align="center">描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">%(levelno)s</td> 
   <td align="center">打印日志级别的数值</td> 
  </tr> 
  <tr> 
   <td align="center">%(levelname)s</td> 
   <td align="center">打印日志级别名称</td> 
  </tr> 
  <tr> 
   <td align="center">%(pathname)s</td> 
   <td align="center">打印当前执行程序的路径</td> 
  </tr> 
  <tr> 
   <td align="center">%(filename)s</td> 
   <td align="center">打印当前执行程序名称</td> 
  </tr> 
  <tr> 
   <td align="center">%(funcName)s</td> 
   <td align="center">打印日志的当前函数</td> 
  </tr> 
  <tr> 
   <td align="center">%(lineno)d</td> 
   <td align="center">打印日志的当前行号</td> 
  </tr> 
  <tr> 
   <td align="center">%(asctime)s</td> 
   <td align="center">打印日志的时间</td> 
  </tr> 
  <tr> 
   <td align="center">%(thread)d</td> 
   <td align="center">打印线程id</td> 
  </tr> 
  <tr> 
   <td align="center">%(threadName)s</td> 
   <td align="center">打印线程名称</td> 
  </tr> 
  <tr> 
   <td align="center">%(process)d</td> 
   <td align="center">打印进程ID</td> 
  </tr> 
  <tr> 
   <td align="center">%(message)s</td> 
   <td align="center">打印日志信息</td> 
  </tr> 
 </tbody> 
</table>

### 二、如何使用日志 ###

#### 1、不设置日志配置–> 直接在终端上输出 ####

import logging
    logging.warning('Watch out!') # will print a message to the console
    logging.info('I told you so') # will not print anything

会输出`WARNING:root:Watch out!`， INFO没有输出，因为默认级别为 WARNING（低于WARNING级别的日志不会输出）

#### 2、使用basicConfig()函数直接进行日志配置 ####

basicConfig关键字参数

<table> 
 <thead> 
  <tr> 
   <th align="center">关键字</th> 
   <th align="center">描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">filename</td> 
   <td align="center">创建一个FileHandler，使用指定的文件名，而不是使用StreamHandler。</td> 
  </tr> 
  <tr> 
   <td align="center">filemode</td> 
   <td align="center">指明打开文件的模式（如果没有指明filemode，默认为’a’）。</td> 
  </tr> 
  <tr> 
   <td align="center">format</td> 
   <td align="center">handler使用指明的格式化字符串。</td> 
  </tr> 
  <tr> 
   <td align="center">datefmt</td> 
   <td align="center">使用指明的日期／时间格式。</td> 
  </tr> 
  <tr> 
   <td align="center">level</td> 
   <td align="center">指明根logger的级别。</td> 
  </tr> 
  <tr> 
   <td align="center">stream</td> 
   <td align="center">使用指明的流来初始化StreamHandler。该参数与’filename’不兼容，如果两个都有，’stream’被忽略。</td> 
  </tr> 
 </tbody> 
</table>

eg：

import logging
    logging.basicConfig(filename='example.log',level=logging.DEBUG)
    logging.debug('This message should go to the log file')
    logging.info('So should this')
    logging.warning('And this, too')

在当前目录下会生成一个example.log文件，且内容如下：

DEBUG:root:This message should go to the log file
    INFO:root:So should this
    WARNING:root:And this, too

#### 3、使用Python代码显式的创建记录器、处理器和格式化器，并进行相应的设置。 ####

simple\_logging\_module.py

#!/usr/bin/env python
    
    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

#### 4、创建日志配置文件并用fileConfig()函数来读该文件 ####

simple\_logging\_module.py

import logging
    import logging.config
    
    logging.config.fileConfig('logging.conf')
    
    # create logger
    logger = logging.getLogger('simpleExample')
    
    # 'application' code
    logger.debug('debug message')
    logger.info('info message')
    logger.warn('warn message')
    logger.error('error message')
    logger.critical('critical message')

logging.conf

[loggers]
    keys=root,simpleExample
    
    [handlers]
    keys=consoleHandler
    
    [formatters]
    keys=simpleFormatter
    
    [logger_root]
    level=DEBUG
    handlers=consoleHandler
    
    [logger_simpleExample]
    level=DEBUG
    handlers=consoleHandler
    qualname=simpleExample
    propagate=0
    
    [handler_consoleHandler]
    class=StreamHandler
    level=DEBUG
    formatter=simpleFormatter
    args=(sys.stdout,)
    
    [formatter_simpleFormatter]
    format=%(asctime)s - %(name)s - %(levelname)s - %(message)s
    datefmt=

输出和上述的例子一样

#### 创建一个配置信息字典并传递给dictConfig()函数。 ####

config文件

version: 1
    formatters:
      simple:
        format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
    handlers:
      console:
        class: logging.StreamHandler
        level: DEBUG
        formatter: simple
        stream: ext://sys.stdout
    loggers:
      simpleExample:
        level: DEBUG
        handlers: [console]
        propagate: no
    root:
      level: DEBUG
      handlers: [console]

下面代码演示如何加载这个配置文件：

import logging.config
    import yaml
    stream = file('config', 'r')
    config_dict = yaml.load(config)
    logging.config.dictConfig(config_dict)

安装yaml模块：`sudo pip install pyyaml`，我们将文件转化为dict，然后用函数dictConfig()使用指定的字典配置日志，下面是一些获取日志记录器并输出的消息例子：

logger = logging.getLogger(simpleExample)
    logger.debug('debug message')
    logger.info('info message')
    logger.warn('warn message')
    logger.error('error message')
    logger.critical('critical message')

输出：

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

[http_python.usyiyi.cn_python_278_howto_logging.html_logging-basic-tutorial]: http://python.usyiyi.cn/python_278/howto/logging.html#logging-basic-tutorial
[Handlers]: http://python.usyiyi.cn/python_278/howto/logging.html#handler-basic
[Filter Objects]: http://python.usyiyi.cn/python_278/library/logging.html#filter