Python logging模块使用详解与配置模板

logging模块概述

logging日志模块是Python标准库中用于记录程序运行日志的工具，通常用于追踪用户在软件系统中的具体操作行为。

配置模板与使用方法

使用该模块时，可以直接套用提供的配置模板，并根据实际项目需求手动修改相关参数即可。

# 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为get_logger中指定的名字
simple_format = '[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s'
id_simple_format = '[%(levelname)s][%(asctime)s] %(message)s'
# 定义日志输出格式 结束


# (*****)注意1: log文件的目录(手动修改)
BASE_PATH = os.path.dirname(os.path.dirname(__file__))  # 获取项目路径
logfile_dir = os.path.join(BASE_PATH, 'log')  # 存放log文件的目录
# (*****)注意2: log文件名(手动修改)
logfile_name = 'user.log'


# 如果不存在定义的日志目录就创建一个
if not os.path.isdir(logfile_dir):
  os.mkdir(logfile_dir)
# log文件的全路径
logfile_path = os.path.join(logfile_dir, logfile_name)


# (*****)注意3: 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）传递
    },
  },
}


# (*****)注意4：定义日志函数，传入的参数可以是日志信息中的"用户id"或者"用户名字"，也可以是某一类型的统称
def get_logger(user_type):
  # 1.加载log配置字典到logging模块的配置中
  logging.config.dictConfig(LOGGING_DIC)
  # 2.获取日志对象
  # logger = logging.getLogger('user')
  # logger = logging.getLogger('bank')
  # logger = logging.getLogger('shop')
  logger = logging.getLogger(user_type)
  return logger

# 调用函数，记录日志# 通过logger日志对象，调用内部的日志打印
logger = get_logger('user')  # 这里的参数为日志信息中的"用户id"或者"用户名字"
# 调用获取日志函数的日志对象
# logger.debug('学习不要浮躁，一步一个脚印!')
logger.info('学习不要浮躁，一步一个脚印!')  # debug和info均为日志等级，用info即可，info后面传入的内容就是需要记录日志的内容

配置注意事项

使用前需注意：前三个配置项可根据具体场景进行调整，而第四个部分为log的配置字典，通常无需修改，了解其结构即可。

执行结果与示例

配置完成后的执行结果如下所示。

[INFO][2020-10-22 20:23:07,405][04 logging模块.py:100]学习不要浮躁，一步一个脚印!

以下是logging模块应用输出的具体示例。

总结

以上即为Python logging模块的详细使用指南，如需了解更多关于python logging模块的资料，请持续关注本站发布的其他相关文章。