使用登录多个模块

Question

我有一个具有以下结构的小型python项目-

Project 
 -- pkg01
   -- test01.py
 -- pkg02
   -- test02.py
 -- logging.conf

我计划使用默认的日志记录模块将消息打印到stdout和日志文件。要使用日志记录模块，需要进行一些初始化-

import logging.config

logging.config.fileConfig('logging.conf')
logger = logging.getLogger('pyApp')

logger.info('testing')

目前，在开始记录消息之前，我会在每个模块中执行此初始化。是否可以只在一个位置执行一次初始化，以便通过在整个项目中记录日志来重复使用相同的设置？

Answer 1

最佳实践是在每个模块中都定义一个记录器，如下所示：

import logging
logger = logging.getLogger(__name__)

在模块顶部附近，然后在模块中的其他代码中执行例如

logger.debug('My message with %s', 'variable data')

如果您需要在模块内部细分日志记录活动，请使用例如

loggerA = logging.getLogger(__name__ + '.A')
loggerB = logging.getLogger(__name__ + '.B')

和日志记录loggerA，并loggerB适当。

在您的一个或多个主程序中，执行例如：

def main():
    "your program code"

if __name__ == '__main__':
    import logging.config
    logging.config.fileConfig('/path/to/logging.conf')
    main()

要么

def main():
    import logging.config
    logging.config.fileConfig('/path/to/logging.conf')
    # your program code

if __name__ == '__main__':
    main()

见这里用于从多个模块记录，并在这里用于代码日志配置将被用作其它的代码库模块。

更新： 调用时fileConfig()，您可能想要指定disable_existing_loggers=False是否使用Python
2.6或更高版本（有关更多信息，请参阅文档）。缺省值是True为了向后兼容，fileConfig()除非所有现有记录器或其祖先在配置中被明确命名，否则它将被禁用。将该值设置为False，将保留现有记录器。如果使用的是Python
2.7 / Python
3.2或更高版本，则不妨考虑使用dictConfig()API，fileConfig()因为它提供了对配置的更多控制，因此比它更好。