【Python】logging 日志模块

- 日理万妓 2023-07-15 13:04 2阅读 0赞

### 文章目录 ###

*   *   *  级别
         *  日志收集器
         *  日志的两种输出途径
         *   *  1. 控制台输出
             *  2. 文件输出
             *   *  exception方法
         *  日志的输出格式（Formatter）
         *  日志轮转
         *   *  按大小轮转（logging.handlers.RotatingFileHandler）
             *  按时间轮转（logging.handlers.TimedRotatingFileHandler）

### 级别 ###

logging 一共有五个级别：

<table> 
 <thead> 
  <tr> 
   <th>级别</th> 
   <th>介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>DEBUG</td> 
   <td>输出详细的运行情况，主要用于调试</td> 
  </tr> 
  <tr> 
   <td>INFO</td> 
   <td>确认一切按预期运行，一般用于输出重要运行情况</td> 
  </tr> 
  <tr> 
   <td>WARNING</td> 
   <td>一些意想不到的事情发生了（比如：“警告：内存空间不足”），但是这个软件还能按预期工作，在不久的将来将会出现问题</td> 
  </tr> 
  <tr> 
   <td>ERROR</td> 
   <td>发生了错误，软件没能执行一些功能，还可以继续执行</td> 
  </tr> 
  <tr> 
   <td>CRITICAL</td> 
   <td>一个严重的错误，表名程序本身可能无法继续运行</td> 
  </tr> 
 </tbody> 
</table>

这五个等级，也分别对应五种打日志的方法：debug、info、warning、error、critical。默认的是Warning，当在Warning或之上时才被跟踪。

### 日志收集器 ###

日志收集器用于收集日志，能够设置级别用来收集指定等级的日志。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NjU5Nzc3_size_16_color_FFFFFF_t_70]  
示例代码：

import logging
    
    # 自己创建一个新的日志收集器,如果不传名称，就会返回默认的日志收集器root
    mylog = logging.getLogger('kaishui')
    # 设置日志收集器收集的等级
    mylog.setLevel('INFO')
    
    # logging 的五种级别的输出，logging收集器默认值只收集WARNING以上的日志，所以输出也只会输出WARNING以上等级的日志
    mylog.debug('这是一个DEBUG级别的日志')
    mylog.info('这是一个INFO级别的日志')
    mylog.warning('这是一个WARNING级别的日志')  # 结果显示默认收集器root: WARNING:root:这是一个WARNING级别的日志
    mylog.error('这是一个ERROR级别的日志')
    mylog.critical('这是一个CRITICAL级别的日志')

执行以上代码，控制台只会输出INFO级别以上的日志。

### 日志的两种输出途径 ###

#### 1. 控制台输出 ####

将日志收集器中的日志在控制台中输出，也能够对其设置等级，这样控制台只会打印出该级别以上的日志。

import logging
    
    # 自己创建一个新的日志收集器,如果不传名称，就会返回默认的日志收集器root
    mylog = logging.getLogger('kaishui')
    # 设置日志收集器收集的等级
    mylog.setLevel('INFO')
    # 设置输出渠道以及输出渠道的等级
    # 以控制台作为输出渠道
    sh = logging.StreamHandler()
    sh.setLevel('ERROR')
    mylog.addHandler(sh)
    
    # logging 的五种级别的输出，logging收集器默认值只收集WARNING以上的日志，所以输出也只会输出WARNING以上等级的日志
    mylog.debug('这是一个DEBUG级别的日志')
    mylog.info('这是一个INFO级别的日志')
    mylog.warning('这是一个WARNING级别的日志')  # 结果显示默认收集器root: WARNING:root:这是一个WARNING级别的日志
    mylog.error('这是一个ERROR级别的日志')
    mylog.critical('这是一个CRITICAL级别的日志')

执行以上代码，控制台中只会输出ERROR级别及以上的日志信息。

#### 2. 文件输出 ####

将日志收集器中的日志写入指定的文件，能够对其设置等级。

import logging
    
    # 自己创建一个新的日志收集器,如果不传名称，就会返回默认的日志收集器root
    mylog = logging.getLogger('kaishui')
    # 设置日志收集器收集的等级
    mylog.setLevel('INFO')
    # 设置输出渠道以及输出渠道的等级
    # 以文件作为输出渠道
    fh = logging.FileHandler('mylog.log',encoding='utf8')
    fh.setLevel('INFO')
    mylog.addHandler(fh)
    
    # logging 的五种级别的输出，logging收集器默认值只收集WARNING以上的日志，所以输出也只会输出WARNING以上等级的日志
    mylog.debug('这是一个DEBUG级别的日志')
    mylog.info('这是一个INFO级别的日志')
    mylog.warning('这是一个WARNING级别的日志')  # 结果显示默认收集器root: WARNING:root:这是一个WARNING级别的日志
    mylog.error('这是一个ERROR级别的日志')
    mylog.critical('这是一个CRITICAL级别的日志')

执行以上代码，文件中会写入所有日志等级为INFO及以上的日志信息。

##### exception方法 #####

日志收集器的exception方法，专门用来将捕获到的异常记录到日志中（对应的等级是error）

# 捕获这个 AssertionError 错误并写入到日志中
    log.exception(AssertionError)

### 日志的输出格式（Formatter） ###

Formatter对象设置日志信息最后的规则、结构和内容，默认的时间格式为%Y-%m-%d %H:%M:%S，下面是Formatter常用的一些信息

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>%(name)s</td> 
   <td>Logger的名字</td> 
  </tr> 
  <tr> 
   <td>%(levelno)s</td> 
   <td>数字形式的日志级别</td> 
  </tr> 
  <tr> 
   <td>%(levelname)s</td> 
   <td>文本形式的日志级别</td> 
  </tr> 
  <tr> 
   <td>%(pathname)s</td> 
   <td>调用日志输出函数的模块的完整路径名，可能没有</td> 
  </tr> 
  <tr> 
   <td>%(filename)s</td> 
   <td>调用日志输出函数的模块的文件名</td> 
  </tr> 
  <tr> 
   <td>%(module)s</td> 
   <td>调用日志输出函数的模块名</td> 
  </tr> 
  <tr> 
   <td>%(funcName)s</td> 
   <td>调用日志输出函数的函数名</td> 
  </tr> 
  <tr> 
   <td>%(lineno)d</td> 
   <td>调用日志输出函数的语句所在的代码行</td> 
  </tr> 
  <tr> 
   <td>%(created)f</td> 
   <td>当前时间，用UNIX标准的表示时间的浮 点数表示</td> 
  </tr> 
  <tr> 
   <td>%(relativeCreated)d</td> 
   <td>输出日志信息时的，自Logger创建以 来的毫秒数</td> 
  </tr> 
  <tr> 
   <td>%(asctime)s</td> 
   <td>字符串形式的当前时间。默认格式是 “2003-07-08 16:49:45,896”。逗号后面的是毫秒</td> 
  </tr> 
  <tr> 
   <td>%(thread)d</td> 
   <td>线程ID。可能没有</td> 
  </tr> 
  <tr> 
   <td>%(threadName)s</td> 
   <td>线程名。可能没有</td> 
  </tr> 
  <tr> 
   <td>%(process)d</td> 
   <td>进程ID。可能没有</td> 
  </tr> 
  <tr> 
   <td>%(message)s</td> 
   <td>用户输出的消息</td> 
  </tr> 
 </tbody> 
</table>

这里推荐一个常用的格式`%(asctime)s -- [%(filename)s-->line:%(lineno)d] - %(levelname)s: %(message)s`

如何给日志设置上这个格式呢？代码如下：

# 设置输出格式
    formats='%(asctime)s -- [%(filename)s-->line:%(lineno)d] - %(levelname)s: %(message)s'
    # 创建一个输出格式对象
    form = logging.Formatter(formats)
    # 将输出格式添加到文件输出渠道
    # fh.setFormatter(form)
    # 将输出格式添加到文件输出渠道
    sh.setFormatter(form)

### 日志轮转 ###

日志轮转的作用就是能够让日志文件按照设置好的大小或者时间对产生的日志数据进行切割，切割成不同的想要的日志文件。（这是我的理解，看看就好）

日志轮转有两种方式：1. 按大小进行轮转，2. 按时间进行轮转  
比如我每天其实都会产生许多的日志数据，如果全部将其存放在一个日志文件中，过一段时间就会发现文件太大，打开太慢。而且我们也不能够准确快速的定位到具体的日志内容。  
这时候我们就可以设置按照时间进行轮转，每天生成一个日志文件，这样首先一个日志文件中的数据不会太多，二是我们知道哪天出现了问题，也能够直接打开这天的日志文件，快速的定位到该错误信息。

那么下面我们就来看一下日志轮转的两种方式分别的代码是什么。

#### 按大小轮转（logging.handlers.RotatingFileHandler） ####

**logging.handlers.RotatingFileHandler** \-> 按照大小自动分割日志文件，一旦达到指定的大小重新生成文件

当文件达到一定大小之后，它会自动将当前日志文件改名，然后创建 一个新的同名日志文件继续输出。  
比如日志文件是chat.log。当chat.log达到指定的大小之后，RotatingFileHandler自动把 文件改名为chat.log.1。不过，如果chat.log.1已经存在，会先把chat.log.1重命名为chat.log.2。最后重新创建 chat.log，继续输出日志信息。  
它的构造函数是：

RotatingFileHandler( filename[, mode[, maxBytes[, backupCount]]])

**maxBytes**用于指定日志文件的最大文件大小，单位为byte。如果maxBytes为0，意味着日志文件可以无限大，这时上面描述的重命名过程就不会发生。  
**backupCount**用于指定保留的备份文件的个数。比如，如果指定为2，当上面描述的重命名过程发生时，原有的chat.log.2并不会被更名，而是被删除。

示例：

fh = RotatingFileHandler('debug.log', encoding='utf8', maxBytes=1024 * 1024 * 20, backupCount=7)
    fh.setLevel('ERROR')
    mylog.addHandler(fh)

#### 按时间轮转（logging.handlers.TimedRotatingFileHandler） ####

间隔一定时间就自动创建新的日志文件。重命名的过程与RotatingFileHandler类似，不过新的文件不是附加数字，而是当前时间。它的构造函数是：

TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]])

其中filename参数和backupCount参数和RotatingFileHandler具有相同的意义。  
**interval**是时间间隔。  
**when**参数是一个字符串。表示时间间隔的单位，不区分大小写。它有以下取值：

*  S 秒
 *  M 分
 *  H 小时
 *  D 天
 *  W 每星期（interval==0时代表星期一）

示例代码：

# 创建一个按时间进行轮转的文件输出渠道
    fh = TimedRotatingFileHandler('debug.log', encoding='utf8', when='D', interval=1, backupCount=7)
    fh.setLevel('ERROR')
    mylog.addHandler(fh)

最后总结一下：  
如果你对此文有任何疑问，如果你也需要接口项目实战，如果你对软件测试、接口测试、自动化测试、面试经验交流感兴趣欢迎加入：软件测试技术群：**593462778**，群里的免费资料都是笔者十多年测试生涯的精华。还有同行大神一起交流技术哦。

作者：暗潮汹涌  
原创不易，欢迎转载，但未经作者同意请保留此段声明，并在文章页面明显位置给出原文链接。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NjU5Nzc3_size_16_color_FFFFFF_t_70]: /images/20230528/286971301e984723b1a883f9bf8ffc80.png