Python学习-logging

2023-01-31 02:01:11 python 学习

python的logging模块提供了通用的日志系统,可以方便第三方模块或者是应用使用。这个模块提供不同的日志级别,并可以采用不同的方式记录日志。

logging的日志可以分为debug(),info(),warning(),error()和critical 五个级别


最简单用法

#!/usr/local/bin/Python
# -*- coding:utf-8 -*-
import logging


logging.debug('debug message')
logging.info('info message')
logging.warn('warn message')
logging.error('error message')
logging.critical('critical message')


WARNING:root:warn message
ERROR:root:error message
CRITICAL:root:critical message

默认情况下,logging模块将日志打印到屏幕上(stdout),日志级别为WARNING(即只有日志级别高于WARNING的日志信息才会输出)日志格式如:

WARNING   : root:       warn message
日志级别 logger实例名  日志消息内容

日志级别

级别应用
DEBUG
详细信息,典型地调试问题时会感兴趣
INFO
证明事情按预期工作
WARNING
表明发生了一些意外,或者不久的将来会发生问题(如‘磁盘满了’)。软件还是在正常工作
ERROR
由于更严重的问题,软件已不能执行一些功能了
CRITICAL
严重错误,表明软件已不能继续运行了


把日志写到文件里,简单配置

#!/usr/local/bin/python
# -*- coding:utf-8 -*-
import logging

logging.basicConfig(filename='logger.log', level=logging.INFO)

logging.debug('debug message')
logging.info('info message')
logging.warn('warn message')
logging.error('error message')
logging.critical('critical message')


INFO:root:info message
WARNING:root:warn message
ERROR:root:error message
CRITICAL:root:critical message

标准输出(屏幕)未显示任何信息,发现当前工作目录下生成了logger.log

其中下面这句level=loggin.INFO意思是,把日志纪录级别设置为INFO,也就是说,只有比日志是INFO或比INFO级别更高的日志才会被纪录到文件里,在这个例子, 第一条日志是不会被纪录的,如果希望纪录debug的日志,那把日志级别改成DEBUG就行了

如果想同时把log打印在屏幕和文件日志里,就需要了解一点复杂的知识了

几个重要的概念

Logger记录器,暴露了应用程序代码能直接使用的接口
Handler处理器,将(记录器产生的)日志记录发送至合适的目的地
Filter过滤器,提供了更好的粒度控制,它可以决定输出哪些日志记录
FORMatter格式化器,指明了最终输出中日志记录的布局


Logger 记录器

Logger是一个树形层级结构,在使用接口debug,info,warn,error,critical之前必须创建Logger实例,即创建一个记录器,如果没有显式的进行创建,则默认创建一个root logger,并应用默认的日志级别(WARN),处理器Handler(StreamHandler,即将日志信息打印输出在标准输出上),和格式化器Formatter(默认的格式即为第一个简单使用程序中输出的格式)。

# 创建方法
logger = logging.getLogger(logger_name)

创建Logger实例后,可以使用以下方法进行日志级别设置,增加处理器Handler

·logger.setLevel(logging.ERROR) # 设置日志级别为ERROR,即只有日志级别大于等于ERROR的日志才会输出

·logger.addHandler(handler_name) # 为Logger实例增加一个处理器

·logger.removeHandler(handler_name) # 为Logger实例删除一个处理器


Handler 处理器

Handler处理器类型有很多种,比较常用的有三个,StreamHandler,FileHandler,NullHandler

# 创建方法
sh = logging.StreamHandler(stream=None)
fh = logging.FileHandler(filename, mode='a', encoding=None, delay=False)

创建StreamHandler之后,可以通过使用以下方法设置日志级别,设置格式化器Formatter,增加或删除过滤器Filter

·ch.setLevel(logging.WARN) # 指定日志级别,低于WARN级别的日志将被忽略

·ch.setFormatter(formatter_name) # 设置一个格式化器formatter

·ch.addFilter(filter_name) # 增加一个过滤器,可以增加多个

·ch.removeFilter(filter_name) # 删除一个过滤器

NullHandler类位于核心logging包,不做任何的格式化或者输出。
本质上它是个“什么都不做”的handler,由库开发者使用


Formatter 格式化器

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

# 创建方法
formatter = logging.Formatter(fmt=None, datefmt=None)

其中,fmt是消息的格式化字符串,datefmt是日期字符串。如果不指明fmt,将使用'%(message)s'。如果不指明datefmt,将使用ISO8601日期格式


Filter 过滤器

暂且略过


basicConfig关键字参数

关键字描述
filename创建一个FileHandler,使用指定的文件名,而不是使用StreamHandler
filemode如果指明了文件名,指明打开文件的模式(如果没有指明filemode,默认为'a')
formathandler使用指明的格式化字符串
datefmt使用指明的日期/时间格式
level指明根logger的级别
stream使用指明的流来初始化StreamHandler。该参数与'filename'不兼容,如果两个都有,'stream'被忽略


format格式

格式描述
%(levelno)s打印日志级别的数值
%(levelname)s打印日志级别名称
%(pathname)s打印当前执行程序的路径
%(filename)s打印当前执行程序名称
%(funcName)s打印日志的当前函数
%(lineno)d打印日志的当前行号
%(asctime)s打印日志的时间
%(thread)d打印线程id
%(threadName)s打印线程名称
%(process)d打印进程ID
%(message)s打印日志信息


配置示例

显式配置

# -*- encoding:utf-8 -*-
import logging

# create logger
logger_name = "le"
logger = logging.getLogger(logger_name)
logger.setLevel(logging.DEBUG)

# create console handler and set level to debug
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)

# create file handler and set level to warning
log_path = "./log.log"
fh = logging.FileHandler(log_path)
fh.setLevel(logging.WARN)

# create formatter
fmt = "%(asctime)-15s %(levelname)s %(filename)s %(lineno)d %(process)d %(message)s"
datefmt = "%a %d %b %Y %H:%M:%S"
formatter = logging.Formatter(fmt, datefmt)

# add handler and formatter to logger
ch.setFormatter(formatter)
fh.setFormatter(formatter)
logger.addHandler(ch)
logger.addHandler(fh)

# print log info
logger.debug('debug message')
logger.info('info message')
logger.warn('warn message')
logger.error('error message')
logger.critical('critical message')


源自作者,好吃的野菜&alex大王

相关文章