python3--logging模块

logging模块用于日志相关操作。详参https://docs.python.org/3.7/library/

一、直接使用logging

通过basicConfig参数设置输出日志内容的格式、日志级别等信息。

basicConfig参数说明

参数名	参数说明
filename	指定日志存储文件
filemode	指定日志写入方式，在指定了filename时使用这个参数，默认值为“a”--追加，可指定为“w”
format	指定日志显示格式
datefmt	指定日期时间格式https://mp.csdn.net/postedit/90639025
level	设置日志级别，日志级别等级CRITICAL> ERROR > WARNING > INFO > DEBUG
stream	用指定的stream创建StreamHandler。可以指定输出到sys.stderr,sys.stdout或者文件，默认为sys.stderr。若同时列出了filename和stream两个参数，则stream参数会被忽略。

basicConfig中参数format格式化串说明

格式化串	说明
%(asctime)s	字符串形式的当前时间。默认格式是 '2019-06-13 16:55:36,537'。最后三位是毫秒。可使用datefmt参数格式化日期。
%(name)s	Logger的名字，getLogger可查看
%(levelno)s	数字形式的日志级别
%(levelname)s	文本形式的日志级别
%(pathname)s	日志输出所在模块完整路径名
%(filename)s	日志输出所在模块文件名
%(module)s	日志输出所在模块名
%(funcName)s	日志输出所在函数名
%(lineno)d	日志输出语句所在的代码行
%(created)f	当前时间，UNIX表示时间的浮点数
%(relativeCreated)d	自Logger创建以来到输出日志信息时的毫秒数
%(thread)d	线程ID
%(process)d	进程ID
%(message)s	用户输出的消息

1.在控制台输出日志信息

import logging
sh = logging.StreamHandler()
logging.basicConfig(
    format='%(asctime)s - %(name)s - %(levelname)s -%(module)s:  %(message)s',
    datefmt='%Y-%m-%d %H:%M:%S %p',
    handlers=[sh],
    level=logging.INFO
)
logging.info('没错吧')   # 控制台输出  2019-06-14 15:35:51 PM - root - INFO -testlogging:  没错吧

2.在指定文件中存储日志信息，不切分日志

import logging
fh = logging.FileHandler(filename='test.log', encoding='utf-8')
logging.basicConfig(    # 指定日志输出格式及内容
    format='%(asctime)s - %(name)s - %(levelno)s - %(levelname)s - %(filename)s - %(message)s',
    datefmt='%Y-%m-%d %H:%M:%S %p',
    handlers=[fh],
    level=logging.ERROR
)
logging.error("错误信息")
# test.log文件中存储内容 2019-06-14 11:21:53 AM - root - 40 - ERROR - testlogging.py - 错误信息
print(logging.getLogger())   # <RootLogger root (ERROR)>

3.在指定文件中存储日志信息，切分日志

• 按照存储文件大小切分

import time
import logging
from logging import handlers

# 日志存放在app.log文件，如果日志内容超过maxBytes设定的最大值，则将app.log文件重命名为app.log.1，
# 后续生成的日志文件依旧存放在app.log文件中，如果又超过设置的最大值，将app.log.1重命名为app.log.2，app.log文件重命名为app.log.1，
# 后续生成的日志文件依旧存放在app.log文件中，如果又超过设置的最大值，将app.log.2重命名为app.log.3，app.log.1重命名为app.log.2，app.log文件重命名为app.log.1，
# 后续生成的日志文件依旧存放在app.log文件中，如果又超过设置的最大值，将app.log.3重命名为app.log.4，app.log.2重命名为app.log.3，app.log.1重命名为app.log.2，app.log文件重命名为app.log.1，
# 后续生成的日志文件依旧存放在app.log文件中，如果又超过设置的最大值，将app.log.4重命名为app.log.5，app.log.3重命名为app.log.4，app.log.2重命名为app.log.3，app.log.1重命名为app.log.2，app.log文件重命名为app.log.1。
# backupCount=5设定备份文件数为5个
# 当超过备份文件能够存储的大小时，之前的内容将丢失，重复下面的操作：
# 后续生成的日志文件依旧存放在app.log文件中，如果又超过设置的最大值，将app.log.4重命名为app.log.5，app.log.3重命名为app.log.4，app.log.2重命名为app.log.3，app.log.1重命名为app.log.2，app.log文件重命名为app.log.1。
rh = handlers.RotatingFileHandler('app.log', maxBytes=1024,backupCount=5,encoding='utf-8')   

logging.basicConfig(
    format='%(asctime)s - %(name)s - %(levelname)s -%(module)s:  %(message)s',
    datefmt='%Y-%m-%d %H:%M:%S',
    handlers=[rh],
    level=logging.ERROR
)
  
for i in range(1,1000):
    time.sleep(1)
    logging.error('这是第{}行错误'.format(i))

• 按照时间切分

import time
import logging
from logging import handlers 
# 日志文件存放在timeapp.log中，when参数设置备份时间单位s为秒，interval为备份间隔，此处为10s备份一次，
# 每10秒将timeapp.log重命名为timeapp.log.%Y-%m-%d_%H-%M-%S
# backupCount=5为设置备份文件个数，超过5个备份文件时，之前的备份文件被删除，使用默认值时，不会删除备份文件。
# when的取值： S秒\M分\H时
#             D天  
#            'W0'-'W6' 周一至周日
#            'midnight'午夜
th = handlers.TimedRotatingFileHandler(filename='timeapp.log', when='S', interval=10, encoding='utf-8',backupCount=5)  # 按时间切分日志
logging.basicConfig(
    format='%(asctime)s - %(name)s - %(levelname)s -%(module)s:  %(message)s',
    datefmt='%Y-%m-%d %H:%M:%S',
    handlers=[th],
    level=logging.ERROR
)
   
for i in range(1,1000):
    time.sleep(1)
    logging.error('这是第{}行错误'.format(i))

4.控制台及文件中都显示日志

import logging
fh = logging.FileHandler(filename='test.log', encoding='utf-8')
sh = logging.StreamHandler()
logging.basicConfig(
    format='%(asctime)s - %(name)s - %(levelno)s - %(levelname)s - %(filename)s - %(message)s',
    datefmt='%Y-%m-%d %H:%M:%S %p',
    handlers=[fh,sh],    # 多个handler
    level=logging.ERROR
)
logging.error("错误信息")

二、使用Logger对象

import time
import logging
logger = logging.getLogger('testLogger')  # 可设置Logger的名称
# 将日志写入文件中
fh = logging.FileHandler('testLogger.log',encoding='utf-8') 
# logging.Formatter与logging.basicConfig中format参数作用相同
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
formatter.datefmt='%Y-%m-%d %H:%M:%S %p'   # 设置日期格式
fh.setFormatter(formatter) 
# logger.addHandler与logging.basicConfig中handlers参数作用类似
logger.addHandler(fh)   # 可添加多个
# logger.setLevel与logging.basicConfig中level参数作用相同
logger.setLevel(logging.CRITICAL)  # 设置日志级别
for i in range(1,1000):
    time.sleep(1)
    logger.critical('这是第{}行错误'.format(i))