首页 > 解决方案 > 在 __init.py__ 之类的地方初始化记录器

问题描述

我正在做一个我想实现记录器的项目。我的结构如下:

.
├── mypkg/
│   ├── __init__.py
│   ├── config/
│   │   ├── __init__.py
│   │   ├── config.json
│   │   ├── config.py
│   │   └── logger.yml
│   ├── mod1/
│   │   └── __init__.py
│   │   ├── script11.py
│   └── mod2/
│       ├── __init__.py
│       ├── script21.py
│       ├── script22.py
│       ├── script23.py
│       └── script24.py
├── README.md
├── requirements.txt
├── setup.py
└── tests/

预先注意:我已经创建了指向文件的链接以进行更深入的调查,但我相信一切都应该一口气理解,但链接是为了完整性。

但是,我正在努力分发和测试它,所以我想要一个fileHandler用于第一个,一个consoleHandler用于后者(在 中定义logger.yml)。我正在切换一些东西和设置,所以当我调整记录器的名称时,我想要一个可以快速更改它的地方,而不是进入每个文件并调整记录器命令。

现在,我config/用来保存一些配置信息。我不太喜欢这种方法,如果可能的话,我想完全删除该文件夹。现在,我在配置中读取了 each 的开头script**.py,例如Config('config/config.json'),其中 myConfig是定义的一个类,config.py用于读取.json文件并将其转换为 dict,config.json看起来就像例如:

{
  "LOGGER": "consoleLogger"
}

所以如果我想使用consoleLogger或者fileLogger我只是在里面改变它,config.json我就完成了。但是,我不喜欢仅仅为了这个目的而拥有一个完整的配置文件,并且想知道我是否可以将在 eacht 开始时的初始化移动script**.py为:

from mypkg.config import Config

config = Config("config/config.json")
logger = logging.getLogger(config["LOGGER"])

例如__init__.pymypkg/文件夹中,或类似的东西:

logger = logging.getLogger(`consoleLogger`)

我想听听你的意见。

标签: pythonloggingconfiginit

解决方案


所以初始化这样的整个目标logger是它适合一个库,并最终mypkg作为一个包发布。我对该主题进行了更多研究,并通过The Hitchhiker's guide to Python找到了一个链接,参考了 Python 的Logging HOWTO,所有这些都指出定义处理程序始终适用于user,而不是developer。因此,我已经切换到在每个文件的开头初始化我的记录器,使用

logger = logging.getLogger(__name__)

这应该创建记录器的层次结构,例如,mypkg.mod1.script11如果这getLogger被调用script11.py。这一点,再加上如果没有为记录器设置特定操作,它将查看其父级的设置。用户现在可以定义一个特定于包的记录器mypkg,或者只是简单地定义root记录器的操作。

我也将此添加到我的mypkg/__init__.py

import logging
logger = logging.getLogger(__name__)

以便用户可以简单地使用

from mypkg import logger

并根据自己的需要配置依赖包的记录器。

我已经删除了整个config文件夹,因为这只是我的记录器,现在用户依赖于它的配置方式,因为它应该根据链接的样式指南。


推荐阅读