Skip to main content
 首页 » 编程设计

Python 跨子类共享日志记录

2024年11月01日8java哥

我正在尝试寻找一种最佳实践方法来跨类/子类/模块共享日志记录。以下类可以在同一个文件中或分布在包/模块中。

例如

-- A.py   
class A: 
  def __init__(self): 
    self.logger = logging.getLogger(someName) 
 
-- B.py   
class B(A): 
  ... 
 
-- C.py   
class C(B): 
  def foo(self): 
    self.logger.info('Hello from C!') 

现在在这种情况下,整个类层次结构共享同一个记录器实例,由基类设置。

这是一个好的做法吗?或者我应该在每个 .py 文件的顶部设置一个全局变量,例如:

logger = logging.getLogger(__name__) 

第一种方法看起来更面向对象,并且避免在模块导入时做任何事情(仅在创建对象时),而第二种方法创建了一个不同的记录器,每个类都可以看到,其名称反射(reflect)了它所在的模块。

第一种情况的另一个优点是我可以在单个实例上设置自定义日志记录选项,它将适用于所有类,而在第二种情况下,它仅在每个记录器名称扩展父/基本记录器名称时才有效,例如logging.getLogger('A.B.C').然而,这些类不需要位于相同的包或包层次结构中,因此这可能并不总是有意义。

什么是最好的方法?

请您参考如下方法:

这是相当主观的,但我之前采用的方法是在 commons 或 utils 模块中配置 logging 设置,这可以由不同的文件导入。每个文件都会实例化自己的 logger。我认为始终执行 logger = logging.getLogger(__name__) 是一种很好的做法,因为它确实有助于调试。

例子:

-- commons.py 
logging.setLevel('INFO') 
 
-- A.py 
from commons import logging 
 
logger = logging.getLogger(__name__) 
 
class A: 
    def __init__(self): 
        logger.info("init") 
 
    def foo(self): 
        logger.info("foo") 

在此示例中,好处是您可以集中配置而不是将日志分散到各处。唯一的缺点是每次都实例化一个新记录器的样板。