如何使用 logging.config.dictConfig 简化多模块日志记录？

python

2024-03-12 16:12:33

利用 logging.config.dictConfig 简化多模块日志记录

引言

在复杂的 Python 项目中，跨多个模块进行日志记录至关重要，以跟踪事件、错误和调试信息。默认的 Python 日志记录模块提供了一套全面的功能，但它需要一些初始化工作，这在每个模块中重复执行会变得繁琐。

问题：重复初始化日志记录

在传统方法中，每个模块都独立执行日志记录初始化，包括加载配置文件、获取日志记录器等。这会导致冗余、代码维护不便，并增加了出错的风险。

解决方案：使用 logging.config.dictConfig

logging.config.dictConfig 函数提供了简化的日志记录初始化方法。它允许你在项目的一个集中位置定义日志记录配置，然后通过此配置对所有模块进行一次性初始化。

步骤

创建日志记录配置文件： 创建一个配置文件（例如 logging.conf），其中包含日志级别、日志文件路径和日志格式等日志记录配置。
使用 dictConfig 初始化日志记录： 在主模块或项目入口点，使用 dictConfig 函数加载配置文件并初始化日志记录：

import logging.config

logging.config.dictConfig(config)

其中，config 是一个包含日志记录配置的字典。

获取日志记录器： 在每个模块中，使用相同的名称获取一个日志记录器：

logger = logging.getLogger('my_app')

使用日志记录器： 使用 logger 对象记录信息：

logger.info('This is a log message.')

示例代码

# logging.conf
config = {
    'version': 1,
    'formatters': {
        'simple': {
            'format': '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
        }
    },
    'handlers': {
        'console': {
            'class': 'logging.StreamHandler',
            'formatter': 'simple',
            'level': 'INFO'
        },
        'file': {
            'class': 'logging.FileHandler',
            'filename': 'app.log',
            'formatter': 'simple',
            'level': 'INFO'
        }
    },
    'loggers': {
        'my_app': {
            'handlers': ['console', 'file'],
            'level': 'INFO'
        }
    }
}

# main.py
logging.config.dictConfig(config)
logger = logging.getLogger('my_app')
logger.info('Log message from main module.')

# module1.py
logger = logging.getLogger('my_app')
logger.info('Log message from module1.')

# module2.py
logger = logging.getLogger('my_app')
logger.info('Log message from module2.')