Python常用模块3-Python的logging模块简介

淡淡的烟草味﹌ 2022-11-16 04:58 266阅读 0赞

### 文章目录 ###

*  一.logging模块简介
 *   *  1.1 logging日志级别
     *  1.2 logging.basicConfig介绍
 *  二.logging模块的处理流程
 *   *  2.1 四大组件
     *  2.2 Logger
     *  2.3 Handler
 *  三.logging模块使用
 *   *  2.1 日志输出到文件
 *  参考:

# 一.logging模块简介 #

logging模块是Python内置的标准模块，主要用于输出运行日志，可以设置输出日志的等级、日志保存路径、日志文件回滚等；相比print，具备如下优点：

1.  可以通过设置不同的日志等级，在release版本中只输出重要信息，而不必显示大量的调试信息；
2.  print将所有信息都输出到标准输出中，严重影响开发者从标准输出中查看其它数据；logging则可以由开发者决定将信息输出到什么地方，以及怎么输出；

## 1.1 logging日志级别 ##

日志级别从低到高 :

1.  debug  
    打印全部的日志,详细的信息,通常只出现在诊断问题上
2.  info  
    打印info,warning,error,critical级别的日志,确认一切按预期运行
3.  warning（默认）  
    打印warning,error,critical级别的日志,一个迹象表明,一些意想不到的事情发生了,或表明一些问题在不久的将来(例如。磁盘空间低”),这个软件还能按预期工作
4.  error  
    打印error,critical级别的日志,更严重的问题,软件没能执行一些功能
5.  critical  
    打印critical级别,一个严重的错误,这表明程序本身可能无法继续运行

默认的输出格式为：WARNING:root:warning messages  
日志级别：用户：信息

## 1.2 logging.basicConfig介绍 ##

一个例子:

logging.basicConfig(level=logging.DEBUG,  
                        format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',  
                        datefmt='%a, %d %b %Y %H:%M:%S',  
                        filename='/tmp/test.log',  
                        filemode='w')

**level**  
上一个章节已经介绍了

**format**  
指定handler使用的日志显示格式  
format参数中可能用到的格式化串：

<table> 
 <thead> 
  <tr> 
   <th>format参数</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>

**datefmt**  
指定日期格式，同time.strftime()

**filename**  
输出日志的文件

**filemode**  
文件打开方式  
a 默认值，追加  
w 覆盖写

# 二.logging模块的处理流程 #

## 2.1 四大组件 ##

（1）日志器（Logger）:产生日志的一个接口。  
（2）处理器（Handler）：把产生的日志发送到相应的目的地。  
（3）过滤器（Filter）：更精细的控制那些日志输出。  
（4）格式器（Formatter）：对输出的信息进行格式化。

## 2.2 Logger ##

（1）产生一个日志  
（2）操作

Logger.setLevel() #设置日志器将会处理的日志消息的最低严重级别
    
    Logger.addHandler()
    
    Logger.moveHander() #上面两个函数，为该logger对象添加和移除一个handler对象
    
    Logger.addFilter()
    
    Logger.removeFilter() #上面两个函数，为该logger对象添加和移除一个filter对象
    
    Logger.debug: #产生一条debug级别的日志，同理，info,error的日志消息
    
    Logger.exception #创建一个类似于Logger.error的日志消息
    
    Logger.log() #获取一个明确的日志level参数类型创建一个日志记录

（3)如何得到一个logger对象  
实例化；logging.getLogger()

## 2.3 Handler ##

（1）把log发送到指定位置  
（2）方法  
setLevel\\setFormat\\addFilter\\removeFilter  
（3）不需要直接使用，Handler是基类

logging.StreamHandler #将日志消息发送到输出到Stream。如std.out,std.err或任何file-like对
    
    logging.FileHandler #将日志消息发送到磁盘文件。默认情况下文件大小会无限增长
    
    logging.handlers.RotatongFileHandler #将日志消息发送到磁盘文件，并支持日志文件按大小切割
    
    logging.handlers.TimeRotatingFileHandler #将日志消息发送到磁盘文件，并支持日志文件按时间切割
    
    logging.handlers.HTTPHandler #将日志消息以GET或POST的方式发送到一个指定email地址
    
    logging.NullHandler  #该Handler实例会忽略error message 通常想被想使用logging的library

# 三.logging模块使用 #

## 2.1 日志输出到文件 ##

目录已存在，此时我们需要重新再创建一个，此时肯定会报错，我们通过logging模块把日志输出到文件中保存起来，方便后面定位和解决问题。

代码:

import logging
    import os
    import time
    
    file_path1 = 'E:/python/os_test'
    
    # logging的基本配置
    logging.basicConfig(level=logging.DEBUG,
                        format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',
                        # datefmt='%a, %d %b %Y %H:%M:%S',
                        filename='E:/python/os_test/test.log',
                        filemode='w')
    
    # 目录已存在，重新创建会报错
    logging.info("Start create directory")
    try:
        os.mkdir(file_path1)
    except Exception:
        logging.error("Something was wrong,please check it!", exc_info=True)

测试记录:

2021-03-09 19:35:37,782 logging_test1.py[line:15] INFO Start create directory
    2021-03-09 19:35:37,782 logging_test1.py[line:19] ERROR Something was wrong,please check it!
    Traceback (most recent call last):
      File "E:/python/learn_python1/logging_test1.py", line 17, in <module>
        os.mkdir(file_path1)
    FileExistsError: [WinError 183] 当文件已存在时，无法创建该文件。: 'E:/python/os_test'

# 参考: #

1.https://www.cnblogs.com/jpfss/p/9686050.html  
2.https://www.cnblogs.com/xianyulouie/p/11041777.html  
3.https://www.jb51.net/article/168670.htm