logging模块

目录

• logging模块
  • 配置日志文件

logging模块

用于便捷记录日志且线程安全的模块

日志总共分为以下五个级别，这五个级别自下而上进行匹配debug-->info-->warning-->error-->critical

CRITICAL = 50
ERROR = 40
WARNING = 30
INFO = 20
DEBUG = 10

import logging

logging.basicConfig(filename='access.log',  # 指定日志保存的文件名
                    format='%(asctime)s - %(name)s - %(levelname)s -%(module)s: %(message)s',  # 指定日志的格式
                    datefmt='%Y-%m-%d %H:%M:%S %p',  # 时间
                    level=10)  # 控制保存的最低等级

name = input('name>>>')
total_prize = input('total_prize>>>')

logging.info(f'{name}消费了{total_prize}元')  # 10
logging.debug(f'{name}消费了{total_prize}元')  # 20
logging.warning(f'{name}消费了{total_prize}元')  # 30
logging.error(f'{name}消费了{total_prize}元')  # 40
logging.critical(f'{name}消费了{total_prize}元')  # 50

logging模块包含四个角色：logger、Filter、Formatter、Handler

• logger: 产生日志的对象
• Filter: 过滤日志的对象
• handler: 保存在文件中，还是打印在屏幕上
• Formatter: 控制日志的格式

import logging
# 1.logger对象：负责产生日志
logger = logging.getLogger('bank')

# 2.Filter:过滤日志的对象，不常用

# 3.Handler:接收logger传来的日志，然后控制输出
t1 = logging.FileHandler('t1.log')  # 打印到文件
t2 = logging.FileHandler('t2.log')  # 打印到文件
sm = logging.StreamHandler()  # 打印到终端

# 4.Formmatter:日志格式
formatter1 = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s -%(module)s:  %(message)s',
                               datefmt='%Y-%m-%d %H:%M:%S %p',)

formatter2 = logging.Formatter('%(asctime)s :  %(message)s',
                               datefmt='%Y-%m-%d %H:%M:%S %p',)

formatter3 = logging.Formatter('%(name)s %(message)s',)

# 5.为Handler对象绑定格式
t1.setFormatter(formatter1)
t2.setFormatter(formatter2)
sm.setFormatter(formatter3)

# 6.将Handler添加到logger并设置日志界别
logger.addHandler(t1)
logger.addHandler(t2)
logger.addHandler(sm)

# 设置日志级别，可以在两个关卡进行设置logger与handler,logger是第一季过滤，然后才能到handler
logger.setLevel(30)  # 不写默认级别默认为30
t1.setLevel(10)
t2.setLevel(20)
sm.setLevel(20)

# 7.测试
logger.debug('debug')
logger.info('info')
logger.warning('warning')
logger.error('error')
logger.critical('critical')

配置日志文件

import os
import logging.config

# 定义三种日志输出格式
standard_format = '[%(asctime)s][%(threadName)s:%(thread)d][task_id:%(name)s][%(filename)s:%(lineno)d]' 
                  '[%(levelname)s][%(message)s]'  # 其中name为getLogger()指定的名字；lineno为调用日志输出函数的语句所在的代码行
simple_format = '[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s'
id_simple_format = '[%(levelname)s][%(asctime)s] %(message)s'

# log文件的目录，需要自定义文件路径
logfile_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
logfile_name = 'log.log'  # log文件名，需要自定义路径名

# 如果不存在定义的日志目录就创建一个
if not os.path.isdir(logfile_dir):
    os.mkdir(logfile_dir)

# log文件的全路径
logfile_path = os.path.join(logfile_dir, logfile_name)

# log配置字典
LOGGING_DIC = {
    'version': 1,  # 版本
    'disable_existing_loggers': False,
    'formatters': {
        'standard': {
            'format': standard_format
        },
        'simple': {
            'format': simple_format
        },
    },
    'filters': {},  # 可以不定义
    'handlers': {
        # 打印到终端的日志
        'console': {
            'level': 'DEBUG',
            'class': 'logging.StreamHandler',  # 打印到屏幕
            'formatter': 'simple'
        },
        # 打印到文件的日志，收集info及以上的日志
        'default': {
            'level': 'INFO',
            'class': 'logging.handlers.RotatingFileHandler',  # 保存到文件
            'formatter': 'standard',
            'filename': logfile_path,  # 日志文件
            'maxBytes': 1024 * 1024 * 5,  # 日志大小 5M
            'backupCount': 5,
            'encoding': 'utf-8',  # 日志文件的编码，再也不用担心中文log乱码了
        },
    },
    'loggers': {
        # logging.getLogger(__name__)拿到的logger配置，如果''设置为固定值logger1，则下次导入必须设置成logging.getLogger('logger1')
        '': {
            # 这里把上面定义的两个handler都加上，即log数据既写入文件又打印到屏幕
            'handlers': ['default', 'console'],
            'level': 'DEBUG',
            'propagate': False,  # 向上（更高level的logger）传递
        },
    },
}


def load_my_logging_cfg():
    logging.config.dictConfig(LOGGING_DIC)  # 导入上面定义的logging配置
    logger = logging.getLogger(__name__)  # 生成一个log实例
    logger.info('It works!')  # 记录该文件的运行状态


if __name__ == '__main__':
    load_my_logging_cfg()

# 附录
可在logging.basicConfig()函数中可通过具体参数来更改logging模块默认行为，可用参数有:
    
filename：用指定的文件名创建FiledHandler（后边会具体讲解handler的概念），这样日志会被存储在指定的文件中。
filemode：文件打开方式，在指定了filename时使用这个参数，默认值为“a”还可指定为“w”。
format：指定handler使用的日志显示格式。
datefmt：指定日期时间格式。
level：设置rootlogger（后边会讲解具体概念）的日志级别
stream：用指定的stream创建StreamHandler。可以指定输出到sys.stderr,sys.stdout或者文件，默认为sys.stderr。若同时列出了filename和stream两个参数，则stream参数会被忽略。


format参数中可能用到的格式化串：

%(name)s Logger的名字
%(levelno)s 数字形式的日志级别
%(levelname)s 文本形式的日志级别
%(pathname)s 调用日志输出函数的模块的完整路径名，可能没有
%(filename)s 调用日志输出函数的模块的文件名
%(module)s 调用日志输出函数的模块名
%(funcName)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用户输出的消息