logging模块

logging模块

导入模块：import logging

日志模块有五个级别：

• debug 级别为10
• info 级别为20
• warning 级别为30
• error 级别为40
• critical 级别为50

使用日志有两种形式，一种是将日志保存到日志文件，一种是将日志打印到终端。

日志默认是warning以及以上的级别才会打印输出。

直接使用logging.debug('我是debug')，会默认打印到终端。

logging模块日志保存到文件

import logging
#配置handler, 文件默认是a模式，也可以是w模式。
file_handler = logging.FileHandler(filename='x1.log', mode='a', encoding='utf-8')
#logging基本配置
'''
		format:日志输出格式
		datefmt:日期格式
		handlers:处理器列表
		level:日志级别，小于这个level的日志级别不能打印或者输出到文件。
'''
logging.basicConfig(
    format='%(asctime)s - %(name)s - %(levelname)s -%(module)s:  %(message)s',
    datefmt='%Y-%m-%d %H:%M:%S %p',
    handlers=[file_handler,],
    level=logging.ERROR
)
#logging使用
logging.error('你好')
logging.debug('我是debug')  #debug级别为10，低于error的40，不会输出到文件

logger对象的配置

import logging

#1、创建一个logger对象
logger = logging.getLogger()

#filter对象(用来过滤日志的)
#2、Handler对象
#Handler对象创建一个将日志输出到文件的handler, FileHandler
fd = logging.FileHandler('file_handler.log', encoding='UTF-8')
#创建一个将日志打印到控制台的handler, StreamHandler
sd = logging.StreamHandler()

#3、日志对象
#创建日志格式
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

#将日志格式配置到handler中
fd.setFormatter(formatter)
sd.setFormatter(formatter)

#将handler配置添加到logger对象中
logger.addHandler(fd)
logger.addhandler(sd)

#配置logger对象的级别
logger.setLevel(10)  #logger.setLevel(DEBUG)

#使用logger对象
logger.debug('logger debug message') 
logger.info('logger info message') 
logger.warning('logger warning message') 
logger.error('logger error message') 
logger.critical('logger critical message')

logging字典的配置

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指定的名字

simple_format = '[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s'

# 定义日志输出格式 结束
"""
下面的两个变量对应的值 需要你手动修改
"""
logfile_dir = os.path.dirname(__file__)  # log文件的目录
logfile_name = 'a3.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': 'DEBUG',
            '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配置
        '': {
            'handlers': ['default', 'console'],  # 这里把上面定义的两个handler都加上，即log数据既写入文件又打印到屏幕
            'level': 'DEBUG',
            'propagate': True,  # 向上（更高level的logger）传递
        },  # 当键不存在的情况下 默认都会使用该k:v配置
    },
}

# 使用日志字典配置
logging.config.dictConfig(LOGGING_DIC)  # 自动加载字典中的配置
logger1 = logging.getLogger('asajdjdskaj')
logger1.debug('好好的 不要浮躁 努力就有收获')

logging在项目中的使用

项目结构

ATM/
|-- core/
|  |-- src.py    #核心功能文件
|-- conf/
|  |-- settings.py   #conf下的settings存放日志字典配置
|-- lib/
|  |-- common.py   #存放公共方法，公共修饰器
|-- db
|-- README.md   
|-- start.py    #启动文件

start.py

import os
import sys

BASE_DIR = os.path.dirname(__file__)
sys.path.append(BASE_DIR)

from core import src

if __name__ == '__main__':
		src.run()

settings.py

在这个文件里面需要修改log文件夹的路径、log文件的名称。

common.py

from conf import settings
import logging.config

#返回一个logger对象
def get_logger(name):
  logging.config.dictConfig(settings.LOGGING_DICT)
  logger = logging.getLogger(name)
  return logger

src.py

在src.py文件里面导入common模块，使用logger

from lib import common
#生成logger对象
logger = common.get_logger('我是log的名称')
logger.debug()
logger.info()
logger.warning()
logger.error()
logger.critical()