Python - 避免在函数之间传递记录器引用？

Question

我有一个简单的Python脚本，使用内置的logging。

我正在配置函数内的日志记录。基本结构是这样的：

#!/usr/bin/env python 
import logging 
import ... 

def configure_logging(): 
    logger = logging.getLogger("my logger") 
    logger.setLevel(logging.DEBUG) 
    # Format for our loglines 
    formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s") 
    # Setup console logging 
    ch = logging.StreamHandler() 
    ch.setLevel(logging.DEBUG) 
    ch.setFormatter(formatter) 
    logger.addHandler(ch) 
    # Setup file logging as well 
    fh = logging.FileHandler(LOG_FILENAME) 
    fh.setLevel(logging.DEBUG) 
    fh.setFormatter(formatter) 
    logger.addHandler(fh) 
    return logger 

def count_parrots(): 
    ... 
    logger.debug?? 

if __name__ == '__main__': 
    logger = configure_logging() 
    logger.debug("I'm a log file") 
    parrots = count_parrots() 

我可以从里面__main__调用记录的罚款。但是，如何从count_parrots（）函数内部调用记录器？处理像这样配置记录器的最pythonic方式是什么？

Answer 1

您可以使用根（默认）记录器，因此模块级别功能logging.debug，...或使用它的函数中获取您的记录器。 事实上，getLogger函数是一个类似工厂的函数，它具有注册表（单例），即它始终为给定的记录器名称返回相同的实例。 您可以通过简单地使用

logger = logging.getLogger("my logger") 

之初从而获得count_parrots你的记录。但是，惯例是为记录器使用点分层名称。见http://docs.python.org/library/logging.html#logging.getLogger

编辑：

您可以使用一个装饰来记录行为添加到您的个性化功能，例如：

def debug(loggername): 
    logger = logging.getLogger(loggername) 
    def log_(enter_message, exit_message=None): 
     def wrapper(f): 
      def wrapped(*args, **kargs): 
       logger.debug(enter_message) 
       r = f(*args, **kargs) 
       if exit_message: 
        logger.debug(exit_message) 
       return r 
      return wrapped 
     return wrapper 
    return log_ 

my_debug = debug('my.logger') 

@my_debug('enter foo', 'exit foo') 
def foo(a, b): 
    return a+b 

可以“硬编码”记录器名称，取下顶关闭级别和my_debug。

Answer 2

您可以给logger作为count_parrots()的参数或者，我会做什么，创建类鹦鹉并使用记录器作为其方法之一。

Answer 3

处理日志记录的典型方法是将每个模块的记录器存储在全局变量中。该模块中的任何函数和方法都只引用同一个记录器实例。

这是在介绍简要讨论到文档中的提前采伐教程： http://docs.python.org/howto/logging.html#advanced-logging-tutorial

您可以通记录身边的实例作为参数，但这样做通常是罕见的。

Answer 4

你可以这样做：

logger = logging.getLogger("my logger") 

在count_parrots()方法。当您传递之前使用的名称（即“我的记录器”）时，日志记录模块将返回与该名称相对应的相同实例。

更新：从logging tutorial （emphais矿）

getLogger（）返回如果 不具有指定 名称的引用到 记录器实例，如果提供，或根。这些名称是以期限分隔的 分层结构。多个 调用getLogger（）与相同的 名称将返回对同一个记录器对象 的引用。

Answer 5

我对Python的全局变量是如何工作感到困惑。在一个函数中，只需要声明global logger，如果您正在执行类似logger = logging.getLogger("my logger")并希望修改全球logger的。

因此，要修改您的示例，您可以在文件的开头创建一个全局记录器对象。如果您的模块可以由另一个模块导入，则应该添加NullHandler，这样如果库的导入器不需要启用日志记录，那么它们与您的lib没有任何问题（ref）。

#!/usr/bin/env python 
import logging 
import ... 

logger = logging.getLogger("my logger").addHandler(logging.NullHandler()) 

def configure_logging(): 
    logger.setLevel(logging.DEBUG) 
    # Format for our loglines 
    formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s") 
    # Setup console logging 
    ch = logging.StreamHandler() 
    ch.setLevel(logging.DEBUG) 
    ch.setFormatter(formatter) 
    logger.addHandler(ch) 
    # Setup file logging as well 
    fh = logging.FileHandler(LOG_FILENAME) 
    fh.setLevel(logging.DEBUG) 
    fh.setFormatter(formatter) 
    logger.addHandler(fh) 

def count_parrots(): 
    ... 
    logger.debug('counting parrots') 
    ... 
    return parrots 

if __name__ == '__main__': 
    configure_logging() 
    logger.debug("I'm a log file") 
    parrots = count_parrots()