Python3 日志模块
python3 日志模块官网说明 python中日志等级从高到低依次为:CRITICAL > ERROR > WARNING > INFO > DEBUG > NOTSET 默认的日志等级为:WARNING,即在显示日志时,低于WARNING的日志不显示 示例代码:
代码语言:javascript复制#!/usr/bin/python3
import logging
logging.info('this is the info message')
logging.debug('this is the debug message')
logging.warning('this is the warning message')
logging.error('this is the error message')
logging.critical('this is the critical message')
输出: WARNING:root:this is warning message ERROR:root:this is error message CRITICAL:root:this is critical message
日志配置
logging.basicConfig()函数来配置日志等级、日志显示格式、日志显示的消息等 相关参数及含义为:
参数 | 含义 |
---|---|
filename | 指定存储日志的文件名 |
filemod | 指定日志文件打开的模式,w 或 a |
level | 指定日志级别,默认 logging.WARNING(此处一定要大写) |
format | 指定输出的格式和内容,format 的参考信息在下面说 |
datefmt | 使用指定的时间格式,format 参数中有 asctime 的话,需要使用 datefmt 指定格式 |
示例代码:
代码语言:javascript复制#!/usr/bin/python3
import logging
logging.basicConfig(filename='test.log',level=logging.DEBUG,format='%(asctime)s %(filename)s[line:%(lineno)d] %(message)s',datefmt='%Y-%m-%d %X')
logging.info(' info logging')
logging.debug('debug logging')
logging.warning('warning logging')
logging.error('error logging')
logging.critical('critical logging')
输出: WARNING:root:warning logging ERROR:root:error logging CRITICAL:root:critical logging
format 输出格式参数
参数 | 含义 |
---|---|
%(name)s | Logger的名字 |
%(levelno)s | 打印日志级别的数值 |
%(levelname)s | 打印日志级别名称 |
%(pathname)s | 打印调用日志输出函数的模块的完整路径名,可能没有 |
%(filename)s | 打印调用日志输出函数的模块的文件名 |
%(funcName)s | 打印调用日志输出函数的函数名 |
%(module)s | 打印调用日志输出函数的模块名 |
%(lineno)d | 打印调用日志输出函数的语句所在的代码行号 |
%(created)f | 当前时间,用UNIX标准的表示时间的浮 点数表示 |
%(relativeCreated)d | 打印输出日志信息时的,自Logger创建以 来的毫秒数 |
%(asctime)s | 字符串形式的当前时间。默认格式是 “2003-07-08 16:49:45,896”。逗号后面的是毫秒 |
%(thread)d | 打印线程ID,可能没有 |
%(threadName)s | 打印线程名,可能没有 |
%(process)d | 打印进程ID |
%(message)s | 打印日志信息,即用户输出的消息 |
Logger,Handler,Formatter,Filter的概念
- logger提供了应用程序可以直接使用的接口;
- handler将(logger创建的)日志记录发送到合适的目的输出;
- filter提供了细度设备来决定输出哪条日志记录;
- formatter决定日志记录的最终输出格式。
logger
每个程序在输出日志之前都要获得一个Logger。Logger通常对应了程序的模块名,比如聊天工具的图形界面模块可以这样获得它的Logger: LOG=logging.getLogger(”chat.gui”) 而核心模块可以这样: LOG=logging.getLogger(”chat.kernel”)
Logger.setLevel(lel):指定最低的日志级别,低于lel的级别将被忽略。debug是最低的内置级别,critical为最高 Logger.addFilter(filt)、Logger.removeFilter(filt):添加或删除指定的filter Logger.addHandler(hdlr)、Logger.removeHandler(hdlr):增加或删除指定的handler Logger.debug()、Logger.info()、Logger.warning()、Logger.error()、Logger.critical():可以设置的日志级别
handler
handler对象负责发送相关的信息到指定目的地。 Python的日志系统有多种Handler可以使用。 有些Handler可以把信息输出到控制台。 有些Logger可以把信息输出到文件。 还有些 Handler可以把信息发送到网络上。 如果觉得不够用,还可以编写自己的Handler。 可以通过addHandler()方法添加多个多handler Handler.setLevel(lel):指定被处理的信息级别,低于lel级别的信息将被忽略 Handler.setFormatter():给这个handler选择一个格式 Handler.addFilter(filt)、Handler.removeFilter(filt):新增或删除一个filter对象
每个Logger可以附加多个Handler。 接下来我们就来介绍一些常用的Handler: 1) logging.StreamHandler 使用这个Handler可以向类似与sys.stdout或者sys.stderr的任何文件对象(file object)输出信息。它的构造函数是: StreamHandler([strm]) 其中strm参数是一个文件对象。默认是sys.stderr
2) logging.FileHandler 和StreamHandler类似,用于向一个文件输出日志信息。 不过FileHandler会帮你打开这个文件。它的构造函数是: FileHandler(filename[,mode]) filename是文件名,必须指定一个文件名。 mode是文件的打开方式。参见Python内置函数open()的用法。默认是’a',即追加。
3) logging.handlers.RotatingFileHandler 这个Handler类似于上面的FileHandler,但是它可以管理文件大小。 当文件达到一定大小之后,它会自动将当前日志文件改名,然后创建 一个新的同名日志文件继续输出。 比如日志文件是chat.log。当chat.log达到指定的大小之后,RotatingFileHandler自动把 文件改名为chat.log.1。 不过,如果chat.log.1已经存在,会先把chat.log.1重命名为chat.log.2。。。最后重新创建 chat.log,继续输出日志信息。 它的构造函数是: RotatingFileHandler( filename[, mode[, maxBytes[, backupCount]]]) 其中filename和mode两个参数和FileHandler一样。 maxBytes用于指定日志文件的最大文件大小。 如果maxBytes为0,意味着日志文件可以无限大,这时上面描述的重命名过程就不会发生。 backupCount用于指定保留的备份文件的个数。 比如,如果指定为2,当上面描述的重命名过程发生时,原有的chat.log.2并不会被更名,而是被删除。
4) logging.handlers.TimedRotatingFileHandler 这个Handler和RotatingFileHandler类似,不过,它没有通过判断文件大小来决定何时重新创建日志文件,而是间隔一定时间就 自动创建新的日志文件。 重命名的过程与RotatingFileHandler类似,不过新的文件不是附加数字,而是当前时间。 它的构造函数是: TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]]) 其中filename参数和backupCount参数和RotatingFileHandler具有相同的意义。 interval是时间间隔。 when参数是一个字符串。表示时间间隔的单位,不区分大小写。它有以下取值: S 秒 M 分 H 小时 D 天 W 每星期(interval==0时代表星期一) midnight 每天凌晨
封装的日志函数
示例代码:
代码语言:javascript复制#!/usr/bin/python
import logging
import os
import sys
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
sys.path.append(BASE_DIR)
"""
工程使用需求:
1-不同日志名称
2-打印同时在控制台,也有文件
3-录活控制等级
"""
# logging.disable(logging.CRITICAL) # 禁止输出日志
def public_log(logger_name='default-log', log_file=os.path.join(BASE_DIR, 'log', 'dataoperate.log'), level=logging.DEBUG):
logger = logging.getLogger(logger_name)
logger.setLevel(level) # 添加日志等级
# 创建控制台 console handler
ch = logging.StreamHandler()
# 设置控制台输出时的日志等级
ch.setLevel(logging.WARNING)
# 创建文件 handler
fh = logging.FileHandler(filename=log_file, encoding='utf-8')
# 设置写入文件的日志等级
fh.setLevel(logging.DEBUG)
# 创建 formatter
formatter = logging.Formatter('%(asctime)s %(filename)s [line:%(lineno)d] %(name)s %(levelname)s %(message)s')
# 添加formatter
ch.setFormatter(formatter)
fh.setFormatter(formatter)
# 把ch fh 添加到logger
logger.addHandler(ch)
logger.addHandler(fh)
return logger