Python-logging模块

一、 日志级别

CRITICAL = 50 # FATAL = CRITICAL 软件整体性的挂掉
ERROR = 40 # 报错后记录日志
WARNING = 30 # WARN = WARNING,有可能发生风险的日志
INFO = 20	# 常规日志
DEBUG = 10 # 调试日志,开发过程中记录,上线后则不记录
NOTSET = 0 # 不设置

日志级别是自下而上匹配,如果 将日志级别记录为 INFO ,那么INFO以及以上的级别日志都会记录,以下的不记

二、logging 模块的使用

logging 模块会提供四种对象:

1、logger 对象:只负责产生日志,就是只给日志打上级别的标签。

2、handler 对象:控制日志输出到哪里(可以输出到文件中保存,也可以打印到屏幕)

3、filter 对象:负责过滤 (但是很少用,可以忽略)

4、formatter 对象:控制日志的格式

在这里插入图片描述

三、定制 logging 模块

"""
logging配置
"""

import os

# 1、定义三种日志输出格式,日志中可能用到的格式化串如下

# %(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用户输出的消息

# 2、强调:其中的%(name)s为getlogger时指定的名字
"这里都是自己定义的输出的日志格式,可以自己添加,修改"

standard_format = '[%(asctime)s][%(threadName)s:%(thread)d][task_id:%(name)s][%(filename)s:%(lineno)d]' \
                  '[%(levelname)s][%(message)s]'

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

test_format = '%(asctime)s] %(message)s'


# 3、日志配置字典
LOGGING_DIC = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'standard': {
            'format': standard_format
        },
        'simple': {
            'format': simple_format
        },
        'test': {
            'format': test_format
        },
    },
    'filters': {},
    'handlers': {
        #打印到终端的日志
        'console': {
            'level': 'DEBUG',
            'class': 'logging.StreamHandler',  # 打印到屏幕
            'formatter': 'simple'
        },
        #打印到文件的日志,收集info及以上的日志
        'default': {
            'level': 'DEBUG',
            'class': 'logging.handlers.RotatingFileHandler',  # 保存到文件,日志轮转
            'formatter': 'standard',
            # 可以定制日志文件路径
            # BASE_DIR = os.path.dirname(os.path.abspath(__file__))  # log文件的目录
            # LOG_PATH = os.path.join(BASE_DIR,'a1.log')
            'filename': 'a1.log',  # 日志文件
            'maxBytes': 1024*1024*5,  # 日志大小 5M
            'backupCount': 5,
            'encoding': 'utf-8',  # 日志文件的编码,再也不用担心中文log乱码了
        },
        'other': {
            'level': 'DEBUG',
            'class': 'logging.FileHandler',  # 保存到文件
            'formatter': 'test',
            'filename': 'a2.log',
            'encoding': 'utf-8',
        },
    },
    'loggers': {
        #logging.getLogger(__name__)拿到的logger配置
        '': {
            'handlers': ['default', 'console'],  # 这里把上面定义的两个handler都加上,即log数据既写入文件又打印到屏幕
            'level': 'DEBUG', # loggers(第一层日志级别关限制)--->handlers(第二层日志级别关卡限制)
            'propagate': False,  # 默认为True,向上(更高level的logger)传递,通常设置为False即可,否则会一份日志向上层层传递
        },
        '专门的采集': {
            'handlers': ['other',],
            'level': 'DEBUG',
            'propagate': False,
        },
    },
}

LOGGING_DIC,日志配置字典

字典中共有 6 个 key:‘version’,‘disable_existing_loggers’,‘formatters’,‘filters’,‘handlers’,‘loggers’

其中,‘version’,‘disable_existing_loggers’,‘filters’,是不需要去研究的,默认即可

注意:这 6 个 key 不可以修改

‘formatters’ 自定义配置

LOGGING_DIC={
	...
'formatters': {
        'standard': {
            'format': standard_format
        },
        'simple': {
            'format': simple_format
        },
        'test': {
            'format': test_format
        },
    }
}

formatters 对应的 值是一个字典,其中每一个小字典,代表一种日志格式,可以自定义

LOGGING_DIC={
	...
'formatters': {
        'formatter1': {
            'format': "这里按照一定格式进行自定义"
        },
        'formatter1': {
            'format': "这里按照一定格式进行自定义"
        },
    }
}

在每一个自定义的格式 key 之后还跟有一个小字典,这里的 key "format"是不可以更改的

LOGGING_DIC={
	...
'formatters': {
        'formatter1': {
            'format': "%(asctime)s : %(message)s"
        },
        'formatter1': {
            'format': "这里按照一定格式进行自定义"
        },
    }
}

简化修改日志输出格式,可以不用每次都到字典中去修改,用一个变量来代替即可

fm1 = "%(asctime)s : %(message)s" # 日志格式
fm2 = "%(asctime)s-%(filename)s-%(levelname)s : %(message)s"

LOGGING_DIC={
	...
'formatters': {
        'formatter1': {
            'format': fm1
        },
        'formatter1': {
            'format': fm2
        },
    }
}

‘handlers’ 自定义配置

LOGGING_DIC = {
    ...
    'handlers': {
        #打印到终端的日志
        'console': {
            ...
        },
        #打印到文件的日志,收集info及以上的日志
        'default': {
            ...
        },
        'other': {
           ...
        },
    },
    ...
}

与 formatter 类似的自定义方式–‘console’,‘default’, 'other’都是可以修改的

LOG2_PATH = 'a2.log'
LOG1_PATH = 'a1.log'

LOGGING_DIC = {
    ...
    'console': {
        #打印到终端的日志
        'console': {
            'level': 'DEBUG',
            'class': 'logging.StreamHandler',  # 打印到屏幕
            'formatter': 'formatter2' # 日志格式选择
        },
        #打印到文件1的日志,收集info及以上的日志
        'file1': {
            'level': 'DEBUG',
            'class': 'logging.FileHandler',  # 保存到文件
            'formatter': 'formatter1', # 日志格式选择
            'filename': LOG2_PATH, # 日志文件路径,可以自定义路径
            'encoding': 'utf-8', 
        },
        #打印到文件2的日志,收集info及以上的日志
        'file2': {
            'level': 'DEBUG',
            'class': 'logging.handlers.RotatingFileHandler',  # 保存到文件,日志轮转
            'formatter': 'formatter1',
            # 可以定制日志文件路径
            # BASE_DIR = os.path.dirname(os.path.abspath(__file__))  # log文件的目录
            # LOG_PATH = os.path.join(BASE_DIR,'a1.log')
            'filename': LOG1_PATH,  # 日志文件路径
            'maxBytes': 1024*1024*5,  # 日志大小 5M
            'backupCount': 5,
            'encoding': 'utf-8',  # 日志文件的编码,再也不用担心中文log乱码了
        },
    },
    ...
}

‘loggers’ 自定义配置

LOGGING_DIC = {
  ...
  'loggers':{
    #logging.getLogger(__name__)拿到的logger配置
    '自定义的logger对象 1':{
      'handlers': [ 'console','file1','file2'],  
      		# 这里把上面定义的两个handler都加上,即log数据既写入文件又打印到屏幕
      'level': 'DEBUG', 
      		# loggers(第一层日志级别关限制)--->handlers(第二层日志级别关卡限制)
      'propagate': False, 
      		# 默认为True,向上(更高level的logger)传递,通常设置为False即可,否则会一份日志向上层层传递
        
    }
  }
}

四、logging 模块的使用

import settings
# 先导入配置字典所在的模块
"""
!!!强调!!!
1、logging是一个包,需要使用其下的config、getLogger,可以如下导入
from logging import config
from logging import getLogger
"""

# 2、也可以使用如下导入
import logging.config # 这样连同logging.getLogger都一起导入了,然后使用前缀logging.config.

# 3、加载配置
logging.config.dictConfig(settings.LOGGING_DIC)

# 4、输出日志
名字传入的必须是'自定义的logger对象 1',与LOGGING_DIC中的'loggers'配置下 对应
logger1=logging.getLogger('自定义的logger对象 1')

logger1.debug('这是一条 debug日志')
logger1.info('这是一条 info日志')
logger1.warning('这是一条 warning日志')
logger1.error('这是一条 error日志')
logger1.critical('这是一条 critical日志')

实例

不同的使用者对应不同的配置字典,和保存路径
在配置各自的字典之前,要先将保存路径拼接好
最后再配置字典
注意:在各自的字典中

lib.common.py

def get_logger(name, username):
    log_dic = {
        'admin': [settings.admin_log_path, settings.LOGGING_DIC_ADMIN, ],
        'teacher': [settings.teacher_log_path, settings.LOGGING_DIC_TEACHER],
        'student': [settings.student_log_path, settings.LOGGING_DIC_STUDENT],
    }

    file_path = os.path.join(log_dic[name][0], f'{username}.log')
    log_dic[name][1]['handlers']['to_file']['filename'] = file_path
    logging.config.dictConfig(log_dic[name][1])

    return logging.getLogger(name)

conf.settings.py

# 格式配置
standard_format = '[%(asctime)s][task_id:%(name)s][%(filename)s:%(lineno)d][%(levelname)s][%(message)s]'
simple_format = '[%(levelname)s][%(asctime)s]%(message)s'

# 路径配置
admin_log_path = os.path.join(BASE_DIR, 'log', 'admin_log')
student_log_path = os.path.join(BASE_DIR, 'log', 'student_log')
teacher_log_path = os.path.join(BASE_DIR, 'log', 'teacher_log')

if not os.path.exists(admin_log_path):
    os.mkdir(admin_log_path)

if not os.path.exists(student_log_path):
    os.mkdir(student_log_path)

if not os.path.exists(teacher_log_path):
    os.mkdir(teacher_log_path)



# 日志配置字典
# 管理员字典
LOGGING_DIC_ADMIN = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'to_file_format': {
            'format': standard_format
        },
        'to_console_format': {
            'format': simple_format
        },

    },
    'filters': {},
    'handlers': {
        # 打印到终端的日志
        'console': {
            'level': 'DEBUG',
            'class': 'logging.StreamHandler',  # 打印到屏幕
            'formatter': 'to_console_format'
        },
        # 打印到文件的日志,收集info及以上的日志
        'to_file': {
            'level': 'DEBUG',
            'class': 'logging.handlers.RotatingFileHandler',  # 保存到文件,日志轮转
            'formatter': 'to_file_format',
            
            'filename': None,  # 日志文件
            'maxBytes': 1024 * 1024 * 5,  # 日志大小 5M
            'backupCount': 5,
            'encoding': 'utf-8',  # 日志文件的编码,再也不用担心中文log乱码了
        },

    },
    'loggers': {
        'admin': {
            'handlers': ['to_file', 'console'],  # 这里把上面定义的两个handler都加上,即log数据既写入文件又打印到屏幕
            'level': 'DEBUG',  # loggers(第一层日志级别关限制)--->handlers(第二层日志级别关卡限制)
            'propagate': False,  # 默认为True,向上(更高level的logger)传递,通常设置为False即可,否则会一份日志向上层层传递
        },
    },
}
# 学生用户字典
LOGGING_DIC_STUDENT = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'to_file_format': {
            'format': standard_format
        },
        'to_console_format': {
            'format': simple_format
        },

    },
    'filters': {},
    'handlers': {
        # 打印到终端的日志
        'console': {
            'level': 'DEBUG',
            'class': 'logging.StreamHandler',  # 打印到屏幕
            'formatter': 'to_console_format'
        },
        # 打印到文件的日志,收集info及以上的日志

        'to_file': {
            'level': 'DEBUG',
            'class': 'logging.handlers.RotatingFileHandler',  # 保存到文件,日志轮转
            'formatter': 'to_file_format',
            'filename': None,  # 日志文件
            'maxBytes': 1024 * 1024 * 5,  # 日志大小 5M
            'backupCount': 5,
            'encoding': 'utf-8',  # 日志文件的编码,再也不用担心中文log乱码了
        },
    },
    'loggers': {
        'student': {
            'handlers': ['to_file', 'console'],  # 这里把上面定义的两个handler都加上,即log数据既写入文件又打印到屏幕
            'level': 'DEBUG',  # loggers(第一层日志级别关限制)--->handlers(第二层日志级别关卡限制)
            'propagate': False,  # 默认为True,向上(更高level的logger)传递,通常设置为False即可,否则会一份日志向上层层传递
        },
    },
}
# 讲师用户字典
LOGGING_DIC_TEACHER = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'to_file_format': {
            'format': standard_format
        },
        'to_console_format': {
            'format': simple_format
        },

    },
    'filters': {},
    'handlers': {
        # 打印到终端的日志
        'console': {
            'level': 'DEBUG',
            'class': 'logging.StreamHandler',  # 打印到屏幕
            'formatter': 'to_console_format'
        },
        # 打印到文件的日志,收集info及以上的日志
        'to_file': {
            'level': 'DEBUG',
            'class': 'logging.handlers.RotatingFileHandler',  # 保存到文件,日志轮转
            'formatter': 'to_file_format',
            'filename': None,  # 日志文件
            'maxBytes': 1024 * 1024 * 5,  # 日志大小 5M
            'backupCount': 5,
            'encoding': 'utf-8',  # 日志文件的编码,再也不用担心中文log乱码了
        },
    },
    'loggers': {
        'teacher': {
            'handlers': ['to_file', 'console'],  # 这里把上面定义的两个handler都加上,即log数据既写入文件又打印到屏幕
            'level': 'DEBUG',  # loggers(第一层日志级别关限制)--->handlers(第二层日志级别关卡限制)
            'propagate': False,  # 默认为True,向上(更高level的logger)传递,通常设置为False即可,否则会一份日志向上层层传递
        },

    },
}

以管理员注册新账户功能为例
interface.admin_interface.py
先获取 admin 的 logger 对象-- 调用了 common.pyget_logger方法
再用 logger 对象的记录日志方法

def register_interface(username, pwd):
   		# 注册的简要逻辑... ...
        # 获取 admin 的 logger 对象
        logger = common.get_logger('admin',username)
		# 记录日志
        logger.debug(f'注册了新的管理员账户--{username}')
        return True, '注册成功!~~~'
    else:
        return False, '用户已存在,注册失败, 请重试!~~~'

  • 1
    点赞
  • 18
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值