最近做python项目的时候碰到和要整合其他同事的模块,然后发现整合后这位同事的logging日志已经事无巨细全部打印到root logger了... 又回头去看了下python官方教程,总结了一下一些其中的注意事项和最佳实践。
Best Practice部分: 官方建议在做library开发时,总是使用logging.getLogger(__name__)
的方法命名logger,因为logger遵循一个类似package和module的层级结构,使用此类方法可以让其他用户方便的获取到针对某个module的logger名。 另外由于调用logger对象的debug/info/warnning/error方法时,默认 需要有至少一个handler,为了防止出现 No handlers could be found for logger 'xx'
这种warning信息,建议总是为logger添加一个NullHandler,这个handler可以添加在package的__init__.py
文件里,无需单独为每个module添加上去。
如果上面的解释没有看明白,可以看下面的具体代码再理解一下。
考虑如下结果的project,注意红色方框的地方:
通过package的方式获取logger的效果:
通过package.module的方式获取logger的效果:
注意不要使用如下方式重复获取logger,会导致重复打印的问题: