python中logging模块的一些简单用法的使用

时间:2022-11-30 18:48:41

python写代码的时候,在想看的地方写个print xx 就能在控制台上显示打印信息,这样子就能知道它是什么了,但是当我需要看大量的地方或者在一个文件中查看的时候,这时候print就不大方便了,所以python引入了logging模块来记录我想要的信息。

print也可以输入日志,logging相对print来说更好控制输出在哪个地方,怎么输出及控制消息级别来过滤掉那些不需要的信息。

1、日志级别

?
1
2
3
4
5
6
7
import logging # 引入logging模块
# 将信息打印到控制台上
logging.debug(u"苍井空")
logging.info(u"麻生希")
logging.warning(u"小泽玛利亚")
logging.error(u"桃谷绘里香")
logging.critical(u"泷泽萝拉")

回显:

python中logging模块的一些简单用法的使用

上面可以看到只有后面三个能打印出来

默认生成的root logger的level是logging.warning,低于该级别的就不输出了

级别排序:critical > error > warning > info > debug

debug : 打印全部的日志,详细的信息,通常只出现在诊断问题上

info : 打印info,warning,error,critical级别的日志,确认一切按预期运行

warning : 打印warning,error,critical级别的日志,一个迹象表明,一些意想不到的事情发生了,或表明一些问题在不久的将来(例如。磁盘空间低”),这个软件还能按预期工作

error : 打印error,critical级别的日志,更严重的问题,软件没能执行一些功能

critical : 打印critical级别,一个严重的错误,这表明程序本身可能无法继续运行

这时候,如果需要显示低于warning级别的内容,可以引入notset级别来显示:

?
1
2
3
import logging # 引入logging模块
logging.basicconfig(level=logging.notset) # 设置日志级别
logging.debug(u"如果设置了日志级别为notset,那么这里可以采取debug、info的级别的内容也可以显示在控制台上了")

回显:

python中logging模块的一些简单用法的使用

2、部分名词解释

logging.formatter:这个类配置了日志的格式,在里面自定义设置日期和时间,输出日志的时候将会按照设置的格式显示内容。

logging.logger:logger是logging模块的主体,进行以下三项工作:

1. 为程序提供记录日志的接口
2. 判断日志所处级别,并判断是否要过滤
3. 根据其日志级别将该条日志分发给不同handler

常用函数有:
logger.setlevel() 设置日志级别
logger.addhandler() 和 logger.removehandler() 添加和删除一个handler
logger.addfilter() 添加一个filter,过滤作用
logging.handler:handler基于日志级别对日志进行分发,如设置为warning级别的handler只会处理warning及以上级别的日志。

常用函数有:
setlevel() 设置级别
setformatter() 设置formatter

3、日志输出-控制台

?
1
2
3
4
5
6
7
8
9
import logging # 引入logging模块
logging.basicconfig(level=logging.debug,
          format='%(asctime)s - %(filename)s[line:%(lineno)d] - %(levelname)s: %(message)s') # logging.basicconfig函数对日志的输出格式及方式做相关配置
# 由于日志基本配置中级别设置为debug,所以一下打印信息将会全部显示在控制台上
logging.info('this is a loggging info message')
logging.debug('this is a loggging debug message')
logging.warning('this is loggging a warning message')
logging.error('this is an loggging error message')
logging.critical('this is a loggging critical message')

上面代码通过logging.basicconfig函数进行配置了日志级别和日志内容输出格式;因为级别为debug,所以会将debug级别以上的信息都输出显示再控制台上。

回显:

python中logging模块的一些简单用法的使用

4、日志输出-文件

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
import logging # 引入logging模块
import os.path
import time
# 第一步,创建一个logger
logger = logging.getlogger()
logger.setlevel(logging.info) # log等级总开关
# 第二步,创建一个handler,用于写入日志文件
rq = time.strftime('%y%m%d%h%m', time.localtime(time.time()))
log_path = os.path.dirname(os.getcwd()) + '/logs/'
log_name = log_path + rq + '.log'
logfile = log_name
fh = logging.filehandler(logfile, mode='w')
fh.setlevel(logging.debug) # 输出到file的log等级的开关
# 第三步,定义handler的输出格式
formatter = logging.formatter("%(asctime)s - %(filename)s[line:%(lineno)d] - %(levelname)s: %(message)s")
fh.setformatter(formatter)
# 第四步,将logger添加到handler里面
logger.addhandler(fh)
# 日志
logger.debug('this is a logger debug message')
logger.info('this is a logger info message')
logger.warning('this is a logger warning message')
logger.error('this is a logger error message')
logger.critical('this is a logger critical message')

回显(打开同一目录下生成的文件):

python中logging模块的一些简单用法的使用

python中logging模块的一些简单用法的使用

5、日志输出-控制台和文件

只要在输入到日志中的第二步和第三步插入一个handler输出到控制台:

创建一个handler,用于输出到控制台

?
1
2
ch = logging.streamhandler()
ch.setlevel(logging.warning) # 输出到console的log等级的开关

第四步和第五步分别加入以下代码即可

?
1
2
ch.setformatter(formatter)
logger.addhandler(ch)

6、format常用格式说明

  • %(levelno)s: 打印日志级别的数值
  • %(levelname)s: 打印日志级别名称
  • %(pathname)s: 打印当前执行程序的路径,其实就是sys.argv[0]
  • %(filename)s: 打印当前执行程序名
  • %(funcname)s: 打印日志的当前函数
  • %(lineno)d: 打印日志的当前行号
  • %(asctime)s: 打印日志的时间
  • %(thread)d: 打印线程id
  • %(threadname)s: 打印线程名称
  • %(process)d: 打印进程id
  • %(message)s: 打印日志信息

7、捕捉异常,用traceback记录

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
import os.path
import time
import logging
# 创建一个logger
logger = logging.getlogger()
logger.setlevel(logging.info) # log等级总开关
 
# 创建一个handler,用于写入日志文件
rq = time.strftime('%y%m%d%h%m', time.localtime(time.time()))
log_path = os.path.dirname(os.getcwd()) + '/logs/'
log_name = log_path + rq + '.log'
logfile = log_name
fh = logging.filehandler(logfile, mode='w')
fh.setlevel(logging.debug) # 输出到file的log等级的开关
 
# 定义handler的输出格式
formatter = logging.formatter("%(asctime)s - %(filename)s[line:%(lineno)d] - %(levelname)s: %(message)s")
fh.setformatter(formatter)
logger.addhandler(fh)
# 使用logger.xx来记录错误,这里的"error"可以根据所需要的级别进行修改
try:
  open('/path/to/does/not/exist', 'rb')
except (systemexit, keyboardinterrupt):
  raise
except exception, e:
  logger.error('failed to open file', exc_info=true)

回显(存储在文件中):

python中logging模块的一些简单用法的使用

如果需要将日志不上报错误,仅记录,可以将exc_info=false,回显如下:

8、多模块调用logging,日志输出顺序

warning_output.py

?
1
2
3
import logging
def write_warning():
  logging.warning(u"记录文件warning_output.py的日志")

error_output.py

?
1
2
3
import logging
def write_error():
  logging.error(u"记录文件error_output.py的日志")

main.py

?
1
2
3
4
5
6
7
8
9
10
import logging
import warning_output
import error_output
def write_critical():
  logging.critical(u"记录文件main.py的日志")
 
 
warning_output.write_warning() # 调用warning_output文件中write_warning方法
write_critical()
error_output.write_error() # 调用error_output文件中write_error方法

回显:

python中logging模块的一些简单用法的使用

从上面来看,日志的输出顺序和模块执行顺序是一致的。

9、日志滚动和过期删除(按时间)

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# coding:utf-8
import logging
import time
import re
from logging.handlers import timedrotatingfilehandler
from logging.handlers import rotatingfilehandler
 
 
def backroll():
  #日志打印格式
  log_fmt = '%(asctime)s\tfile \"%(filename)s\",line %(lineno)s\t%(levelname)s: %(message)s'
  formatter = logging.formatter(log_fmt)
  #创建timedrotatingfilehandler对象
  log_file_handler = timedrotatingfilehandler(filename="ds_update", when="m", interval=2, backupcount=2)
  #log_file_handler.suffix = "%y-%m-%d_%h-%m.log"
  #log_file_handler.extmatch = re.compile(r"^\d{4}-\d{2}-\d{2}_\d{2}-\d{2}.log$")
  log_file_handler.setformatter(formatter)
  logging.basicconfig(level=logging.info)
  log = logging.getlogger()
  log.addhandler(log_file_handler)
  #循环打印日志
  log_content = "test log"
  count = 0
  while count < 30:
    log.error(log_content)
    time.sleep(20)
    count = count + 1
  log.removehandler(log_file_handler)
 
 
if __name__ == "__main__":
  backroll()

filename:日志文件名的prefix;

when:是一个字符串,用于描述滚动周期的基本单位,字符串的值及意义如下:
“s”: seconds
“m”: minutes
“h”: hours
“d”: days
“w”: week day (0=monday)
“midnight”: roll over at midnight

interval: 滚动周期,单位有when指定,比如:when='d',interval=1,表示每天产生一个日志文件

backupcount: 表示日志文件的保留个数

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持服务器之家。

原文链接:https://www.cnblogs.com/CJOKER/p/8295272.html