Python_logging

最新推荐文章于 2023-11-16 12:57:44 发布

Never_LY

最新推荐文章于 2023-11-16 12:57:44 发布

阅读量185

点赞数

本文链接：https://blog.csdn.net/yigui3542/article/details/80859357

版权

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

一、日志级别

import logging             #引入logging模块
#将信息打印到控制台上
logging.debug('Alice')
logging.info('Summer')
logging.warning('Peter')
logging.error('Ave')
logging.critical('Min')

输出结果：

WARNING:root:Peter
ERROR:root:Ave
CRITICAL:root:Min

输出结果只有三行，默认生成的root logger的级别是logging.WARNING，低于该级别的就不输出了。一般的级别排序为：

critical> error > warning > info > debug，这五个方法的具体含义为：

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

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

warning: 打印warning，error，critical级别的日志，表明一些问题在不久的将来(例如磁盘空间低等)可能发生，但软件还能按预期工作。

error: 打印error,critical级别的日志，表明可能存在一些严重的问题，例如软件没能执行一些功能等。

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

二、名词解释

logging.Formatter()

构造时需要带两个参数：一个是格式化的模板fmt，默认会包含最基本的level和message信息；

另一个是格式化的时间样式datefmt，默认为 2003-07-08 16:49:45,896(%Y-%m-%d %H:%M:%S)

logging.getLogger()

参数可为空，默认的logger名称是root，通过日志名来区分不同的模块。

logging.Handler()

Handler基于日志级别对日志进行分发，如设置为 WARNING级别的Handler只会处理WARNING及以上级别的日志。

最常用的handler是StreamHandler 和FileHandler，除此之外，还有以下几种：

StreamHandler：实例将错误消息发送到流（类文件对象）。

FileHandler：实例将错误消息发送到磁盘文件。

RotatingFileHandler：实例将错误消息发送到磁盘文件，支持最大日志文件大小和日志文件轮换。

TimedRotatingFileHandler:实例将错误消息发送到磁盘文件，并以特定的时间间隔旋转日志文件。

SocketHandler: 实例将错误消息发送到TCP / IP套接字。

logging.Formatter()

构造时需要带两个参数：一个是格式化的模板fmt，默认会包含最基本的level和message信息；

另一个是格式化的时间样式datefmt，默认为 2003-07-08 16:49:45,896(%Y-%m-%d %H:%M:%S)

logging.getLogger()

参数可为空，默认的logger名称是root，通过日志名来区分不同的模块。

logging.Handler()

Handler基于日志级别对日志进行分发，如设置为 WARNING级别的Handler只会处理WARNING及以上级别的日志。

最常用的handler是StreamHandler 和FileHandler，除此之外，还有以下几种：

StreamHandler：实例将错误消息发送到流（类文件对象）。

FileHandler：实例将错误消息发送到磁盘文件。

RotatingFileHandler：实例将错误消息发送到磁盘文件，支持最大日志文件大小和日志文件轮换。

TimedRotatingFileHandler:实例将错误消息发送到磁盘文件，并以特定的时间间隔旋转日志文件。

SocketHandler: 实例将错误消息发送到TCP / IP套接字。

logging.basicConfig()

调用该方法时系统会默认创建一个handler，如果再添加一个控制台handler时就会出现重复日志。

logging.logger()

logger是logging模块的主体，进行以下三项工作：

1、为程序提供记录日志的接口；

2、判断日志所处级别，并判断是否要过滤

3、根据其日志级别将该条日志分发给不同handler

logger.setLevel()	设置日志级别
logger.addFilter()	添加一个Filter，过滤作用
logger.addHandler()	添加一个Handler
logger.removeHandler()	删除一个Handler

三、日志输出——控制台

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级别以上的信息都输出显示再控制台上。

回显：

四、日志输出到文件

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()))
	#time.time():从1970年1月1日0分0时0秒起至当前时间，经过的浮点数
	#time.localtime()：转换为time.struct_time类型的对象的秒数。
	# time.strptime() 函数根据指定的格式把一个时间字符串解析为时间元组。
log_path = os.path.dirname(os.getcwd()) +'/Logs/'
	# os.getcwd()方法用于返回当前工作目录。
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')

回显（打开同一目录下生成的文件）

五、日志输出—控制台和文件

只要在输入到日志中的第二步和第三步插入一个handler输出到控制台：创建一个handler，用于输出到控制台。

ch= logging.StreamHandler()

ch.setLevel(logging.WARNING) # 输出到console的log等级的开关

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

ch.setFormatter(formatter)

logger.addHandler(ch)

六、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: 打印日志信息

七、捕捉异常，用traceback记录

# -*- coding:utf-8 -*-
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)

# 定义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 as e:
    logger.error('Failed to open file', exc_info=True)

回显（存储在文件中）：

如果需要将日志不上报错误，仅记录，可以将exc_info=False，回显如下：

八、多模块调用logging，日志输出顺序

warning_output.py

import logging

def write_warning():
    logging.warning("记录文件warning_output.py的日志")

error_output.py

import logging

def write_error():
    logging.error(u"记录文件error_output.py的日志")

main.py

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方法

回显：

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

九、日志滚动和过期删除

# -*- coding:utf-8 -*-
import logging
from logging.handlers import TimedRotatingFileHandler
import time

#创建一个logger
logger = logging.getLogger()
logger.setLevel(logging.INFO)

#创建一个handler,用于写入文件
log_file_handler = TimedRotatingFileHandler(filename = 'ds_1_update',
                    when = 'M', interval = 2, backupCount = 2)
log_file_handler.setLevel(logging.INFO)

ch = logging.StreamHandler()
ch.setLevel(logging.INFO)

#设置输出格式
formatter = logging.Formatter('%(asctime)s\tFile \ "%(filename)s",line %(lineno)s\t%(levelname)s: %(message)s')
log_file_handler.setFormatter(formatter)
ch.setFormatter(formatter)

#将logger添加到handler里面
logger.addHandler(log_file_handler)
logger.addHandler(ch)

#循环打印日志
log_content = 'test log'
count = 0
while count < 30:
    logger.error(log_content)
    time.sleep(2)
    count = count + 1
logger.removeFilter(log_file_handler)

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：表示日志文件的保留个数

Never_LY

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Python_logging

用Python写代码的时候，在想看的地方写个print (xx) 就能在控制台上显示打印信息，这样子就能知道它是什么了，但是当我需要看大量的地方或者在一个文件中查看的时候，这时候print就不大方便了，所以Python引入了logging模块来记录我想要的信息。一、日志级别import logging #引入logging模块#将信息打印到控制台上loggi...
复制链接

扫一扫