我们正在开发的 Python 应用程序需要一个记录器。一位同事认为应该在每个使用它的类中创建和配置记录器。我的观点是它应该在应用程序启动时创建和配置,并作为构造函数参数传递。
两种变体都有其优点,我们不确定最佳实践是什么。
通常不会;它通常不打算作为参数传递。
约定是log = logging.getLogger(__name__)
在每个模块的顶部使用。__name__
每个模块的值是不同的。的结果值__name__
然后可以反映在每个日志消息中。
也许这可以帮助您获得一个想法?当然,您可以做得更好,从配置文件或其他任何内容中读取设置,但这是一个简单的示例。
用于配置日志记录的单独模块mylogmod.py
:
import logging
FILENAME = "mylog.log" # Your logfile
LOGFORMAT = "%(message)s" # Your format
DEFAULT_LEVEL = "info" # Your default level, usually set to warning or error for production
LEVELS = {
'debug':logging.DEBUG,
'info':logging.INFO,
'warning':logging.WARNING,
'error':logging.ERROR,
'critical':logging.CRITICAL}
def startlogging(filename=FILENAME, level=DEFAULT_LEVEL):
logging.basicConfig(filename=filename, level=LEVELS[level], format=LOGFORMAT)
main.py
: _
import logging
from mylogmod import startlogging
from myclass import MyClass
startlogging()
logging.info("Program started...")
mc = MyClass()
myclass.py
具有自检功能的模块中的类。您可以在单元测试中执行类似的操作:(请注意,您不需要在单元测试中导入日志记录模块,只需startlogging
功能就足够了。这样您可以将默认级别设置为警告或错误以及单元测试和自测调试)
import logging
class MyClass(object):
def __init__(self):
logging.info("Initialze MyClass instance...")
if __name__ == "__main__":
from mylogmod import startlogging
startlogging(level="debug")
logging.debug("Test MyClass...")
#... rest of test code...
我认为将记录器作为参数传递并不是一个好主意。您应该将全局记录器视为自己的模块,这将是最好的主意。例如:
logger.py
import logging
log = logging.getLogger('')
类Foo.py
form logger import log
log.debug('debug message')
类吧.py
form logger import log
log.warn('warn!')