使用多个模块进行记录时的记录器层次结构和根记录器

Question

我有这个设置：

main.py
/module
/module/__init__.py (empty)
/module.py

这是我的两个文件的代码，分别是 main.py 和 module.py：

ma​​in.py

import logging
from module import module

logger = logging.getLogger(__name__)

def test():
    logger.warning('in main.py/test')

def main():
    handler = logging.StreamHandler()
    handler.setLevel(logging.INFO)
    formatter = logging.Formatter('%(asctime)s %(name)s/%(module)s [%(levelname)s]: %(message)s', '%Y-%m-%d %H:%M:%S')
    handler.setFormatter(formatter)
    logger.addHandler(handler)

    logger.warning('in main.py/main')
    module.something()

if __name__ == "__main__":
    main()    

module.py

import logging
logger = logging.getLogger(__name__)

def something():
    logger.warning('in module.py/something')

所以，我注意到这会输出以下内容（注意模块记录器如何没有格式）：

2019-10-01 09:03:40 __main__/main [WARNING]: in main.py/main
in module.py/something

似乎只有在我在main.py 中进行编辑以将logger = logging.getLogger( __ name __ ) 更改为logger = logging.getLogger() 或在def main(): 之后添加logger = logging.getLogger() 之后它才会这样记录（即我想要什么）：

2019-10-01 09:04:13 root/main [WARNING]: in main.py/main
2019-10-01 09:04:13 module.module/module [WARNING]: in module.py/something

这是为什么呢？我认为因为main.py 正在导入module.py，所以它在层次规模上自然更高，因此module.py 将继承main.py 中定义的记录器设置。是否需要在 main 中显式设置根记录器（使用logger = logging.getLogger()）才能使继承工作？我没有正确配置我的文件夹结构以使module.py 的记录器继承main.py 的记录器设置，还是文件夹结构无关紧要？

我问的原因是因为我认为应该始终使用logger = logging.getLogger( __ name __ )（甚至在main.py），然后根据导入结构（或文件夹结构？），这将确定层次结构和记录器将相应地继承。我做出这个假设的原因是因为如果我将main.py 导入另一个程序会怎样？我想我的意思是，我想让日志记录尽可能通用，这样我就可以将一个模块导入另一个模块，并且它总是继承父级的记录器设置。有没有办法显示所有模块的底层层次结构以用于调试/学习？

Answer 1

日志层次结构与程序中的文件结构无关。层次结构仅由记录器的名称确定。当您配置一个记录器时，所有名称前缀中的记录器都是其子级，并继承其配置，除非另有明确说明。

在您的示例中，日志记录设置与执行顺序和您选择的名称有关。当您的程序运行时，它会执行以下操作：

1. 由于import logging 而从标准库运行logging.py
2. 运行module.py 以履行from module import module
3. 将main 中的logger 属性设置为名为@9​​87654328@ 的Logger。
4. 创建test 函数
5. 创建main 函数
6. 运行主函数

这一系列事件的一些后果：

• module.logger 在 main.logger 之前创建。这不会影响您看到的行为，但在这种情况下值得注意。
• 如果您将 main 作为脚本调用，main.logger 将被命名为 __main__。如果将其称为 main，您看到的行为不会改变，例如来自python -m main。
• module 显然与 main 不在同一层次结构中。两者都是根记录器沿不同分支的后代。

最后一项确实是您问题的答案。如果您希望程序中的所有记录器共享相同的默认记录方法，则应配置根记录器，或确保它们具有相同的名称前缀，然后将其配置为就像根记录器一样。

你可以让所有的记录器都继承自main。在module/module.py，你会这样做

logger = logging.getLogger('__main__.' + __name__)

这里的问题是名称__main__ 是硬编码的。您不能保证它将是 __main__ 与 main。您可以在module 中尝试import main，这样您就可以执行main.__name__ + '.' + __name__，但这不会按预期工作。如果main 以__main__ 运行，则导入它实际上会创建一个具有完全独立日志层次结构的第二个模块对象。

这就是根记录器没有名称的原因。它提供了您想要的可维护性和一致性。您不必费尽心思试图找出根名称。

话虽如此，您仍然应该将main.py 记录到__main__ 或main 记录器。根记录器只能在导入防护中设置。这样，如果 main 作为常规模块导入，它将尊重运行它的驱动程序的日志记录设置。

TL;DR

通常在程序的驱动程序中设置匿名根记录器。不要尝试从__main__ 或驱动模块名称继承记录器。