在多个模块中使用日志记录

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

实际上，每个记录器都是父包记录器的子包（即package.subpackage.module从package.subpackage)继承配置，所以您需要做的只是配置根记录器。这可以通过logging.config.fileconfig（您自己的记录器配置）或logging.basicconfig（设置根记录器）来实现。在您的条目模块中安装日志记录(__main__.py或您想要运行的任何内容，例如main_script.py.__init__.py也可以运行）

使用BasicConfig：

# package/__main__.py
import logging
import sys

logging.basicConfig(stream=sys.stdout, level=logging.INFO)

使用FileConfig：

# package/__main__.py
import logging
import logging.config

logging.config.fileConfig('logging.conf')

然后使用以下方法创建每个记录器：

# package/submodule.py
# or
# package/subpackage/submodule.py
import logging
log = logging.getLogger(__name__)

log.info("Hello logging!")

有关更多信息，请参阅高级日志记录教程。

Answer 2

最佳实践是,在每个模块中,有一个记录器定义如下：

import logging
logger = logging.getLogger(__name__)

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

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

如果需要在模块中细分日志记录activity，请使用例如。

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()时，如果您使用的是Python2.6或更高版本，您可能希望指定disable_existing_loggers=false（有关更多信息，请参阅文档）。为了向后兼容，默认值为true，这会导致fileconfig()禁用所有现有记录器，除非它们或它们的祖先在配置中显式命名。当值设置为false时，现有的记录器就不存在了。如果使用Python 2.7/Python 3.2或更高版本，您可能希望考虑dictConfig()API，它比fileConfig()更好，因为它提供了对配置的更多控制。