Python 日志输出

谁借莪１个温暖的怀抱￠ 2022-06-18 10:23 306阅读 0赞

打印日志是很多程序的重要需求，良好的日志输出可以帮我们更方便的检测程序运行状态。Python标准库提供了logging模块，让我们也可以方便的在Python中打印日志。

## 日志介绍 ##

完整的使用方法可以参考[标准库文档][Link 1]。这里做一下简单介绍。

### 日志级别 ###

日志级别有如下几种。当获取根Logger的时候，默认级别为NOTSET，这样会显示所有输出。当获取非根Logger的时候，根Logger的默认级别是WARNING，非根Logger会继承这个级别，只有WARNING以上的日志才会输出。

<table> 
 <thead> 
  <tr> 
   <th>级别</th> 
   <th>数值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>CRITICAL</td> 
   <td>50</td> 
  </tr> 
  <tr> 
   <td>ERROR</td> 
   <td>40</td> 
  </tr> 
  <tr> 
   <td>WARNING</td> 
   <td>30</td> 
  </tr> 
  <tr> 
   <td>INFO</td> 
   <td>20</td> 
  </tr> 
  <tr> 
   <td>DEBUG</td> 
   <td>10</td> 
  </tr> 
  <tr> 
   <td>NOTSET</td> 
   <td>0</td> 
  </tr> 
 </tbody> 
</table>

### 日志对象 ###

日志对象通过模块的`getLogger(name)`函数获得，可以向该函数传递一个名称。如果不传递名字的话，就会获取根Logger。

日志对象常用方法如下。

<table> 
 <thead> 
  <tr> 
   <th>方法名</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>setLevel(lvl)</td> 
   <td>设置日志级别</td> 
  </tr> 
  <tr> 
   <td>isEnabledFor(lvl)</td> 
   <td>检查某级别的日志是否启用</td> 
  </tr> 
  <tr> 
   <td>getEffectiveLevel()</td> 
   <td>获取实际的日志级别</td> 
  </tr> 
  <tr> 
   <td><code>debug/warning/info/error(msg, *args, **kwargs)</code></td> 
   <td>输出对应级别的日志</td> 
  </tr> 
  <tr> 
   <td><code>log(lvl, msg, *args, **kwargs)</code></td> 
   <td>输出指定级别的日志</td> 
  </tr> 
  <tr> 
   <td>addFilter(filt)/removeFilter(filt)</td> 
   <td>添加或删除指定的过滤器</td> 
  </tr> 
  <tr> 
   <td>addHandler(hdlr)/removeHandler(hdlr)</td> 
   <td>添加或删除指定的处理器</td> 
  </tr> 
 </tbody> 
</table>

### Handler对象 ###

日志对象用于输出日志，而Handler对象用于指定日志向哪里输出（文件、终端等等）。Handler列表可以参考[Handler类型][Handler]。

常用的Handler有以下几种：

*  StreamHandler， 用于向标准输入输出流等输出日志。
 *  FileHandler，用于向文件输出日志。
 *  NullHandler，什么也不输出。
 *  RotatingFileHandler，向文件输出日志，如果文件到达指定大小，创建新文件并继续输出日志。

还有好多种Handler，可以向HTTP服务器发送日志、向系统日志管理器写入日志、向指定电子邮箱发送日志等Handler。这里就不介绍了。如果有相关需求请参考相应文档。

### Formatter对象 ###

Formatter对象用于格式化日志输出。格式化字符串使用传统的`%`形式来格式化日志，可以参考[官方文档][Link 2]了解更多信息。

### 过滤器对象 ###

过滤器对象用于过滤日志的输出。

### LogRecord对象 ###

LogRecord对象基本上和我们没多大关系，简单地说，我们输出的每一条日志，就是一个LogRecord对象。它有日志系统自动创建和使用。如果我们留心一下日志模块的方法，会发现有很多地方都要接受LogRecord参数。LogRecord有很多属性信息，对日志打印有帮助，可以参考[16.6.6. LogRecord Objects][]下面的属性和格式化符的对照表。例如`%(asctime)s`会生成人类可读的时间戳，`%(lineno)d`返回当前行号等等。

### 模块级别函数 ###

日志模块还包含了一些模块级别的函数。简单不完整列举如下：

<table> 
 <thead> 
  <tr> 
   <th>函数名</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>getLogger(name=None)</td> 
   <td>获取对应名称的Logger，如果不指定名称会返回根Logger</td> 
  </tr> 
  <tr> 
   <td>debug/info等函数</td> 
   <td>在根Logger上打印对应级别的日志信息</td> 
  </tr> 
  <tr> 
   <td>disable(lvl)</td> 
   <td>禁用某级别的日志打印</td> 
  </tr> 
  <tr> 
   <td>basicConfig(关键字参数)</td> 
   <td>这个函数可以快速设置日志的级别、格式、Handler、Formatter等</td> 
  </tr> 
 </tbody> 
</table>

## 使用日志 ##

前面都是纸面上的介绍，下面来真正使用日志模块来打印日志。下面的代码所用知识，前面都已介绍过。运行代码之后，可以验证日志同时在终端输出和文件中输出。

import logging
    
    # 创建Logger
    logger = logging.getLogger()
    logger.setLevel(logging.DEBUG)
    
    # 创建Handler
    
    # 终端Handler
    consoleHandler = logging.StreamHandler()
    consoleHandler.setLevel(logging.DEBUG)
    
    # 文件Handler
    fileHandler = logging.FileHandler('log.log', mode='w', encoding='UTF-8')
    fileHandler.setLevel(logging.NOTSET)
    
    # Formatter
    formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
    consoleHandler.setFormatter(formatter)
    fileHandler.setFormatter(formatter)
    
    # 添加到Logger中
    logger.addHandler(consoleHandler)
    logger.addHandler(fileHandler)
    
    # 打印日志
    logger.debug('debug 信息')
    logger.info('info 信息')
    logger.warning('warn 信息')
    logger.error('error 信息')
    logger.critical('critical 信息')
    logger.debug('%s 是自定义信息' % '这些东西')

运行结果。

2017-04-04 21:45:16,742 - root - DEBUG - debug 信息
    2017-04-04 21:45:16,742 - root - INFO - info 信息
    2017-04-04 21:45:16,742 - root - WARNING - warn 信息
    2017-04-04 21:45:16,742 - root - ERROR - error 信息
    2017-04-04 21:45:16,742 - root - CRITICAL - critical 信息
    2017-04-04 21:45:16,742 - root - DEBUG - 这些东西 是自定义信息

## 外部配置 ##

前面都是在代码中配置日志的输出，我们还可以将配置写到配置文件中，然后传递给日志模块。旧式程序会使用`conf`格式配置文件，不过这种配置文件比较传统，所以就不介绍了。

自Python 3.2起，引入了一种新的基于键值对的配置方式。这种新方式的优点是配置文件非常灵活，我们可以使用XML、YAML、JSON等格式存储配置，也可以从网络上接收序列化的Python对象当做配置对象。总之，想怎么来就怎么来。我们下面就介绍这种新方式。

具体的键值对需要参考[官方文档][Link 3]。例如下面就是Python官方给出的一个YAML格式的配置文件。

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:
      main:
        level: DEBUG
        handlers: [console]
        propagate: no
    root:
      level: DEBUG
      handlers: [console]

然后引入`logging.config`模块，并将配置文件传递给`logging.config`模块的`dictConfig`方法。这样就做好了日志打印的准备工作了。

import logging.config
    
    logging.config.dictConfig('config.yaml')
    
    logger = logging.getLogger('fuck')

[Link 1]: https://docs.python.org/3/library/logging.html#logger-objects
[Handler]: https://docs.python.org/3/library/logging.handlers.html#module-logging.handlers
[Link 2]: https://docs.python.org/3/library/stdtypes.html#old-string-formatting
[16.6.6. LogRecord Objects]: https://docs.python.org/3/library/logging.html#logrecord-objects
[Link 3]: https://docs.python.org/3/library/logging.config.html#dictionary-schema-details