使用 setup.cfg 和使用 attr 访问的版本时出现 ModuleNotFoundError

Question

我有一个 Python 包，其结构如下：

├── setup.cfg
├── setup.py
└── src
    └── myproject
        ├── base.py
        ├── __init__.py
        └── version.py

在setup.cfg中，版本是用attr定义的：

[metadata]
name = myproject
version = attr: myproject.version.__version__

version.py 很简单：

__version__ = "1.2.3"

包的依赖项列在setup.cfg 中。另一方面，包的顶层__init__.py 导入包的一些对象：

from myproject.base import Stuff

__all__ = ["Stuff"]

而且，很明显，base.py 从依赖项中导入了一些对象。

现在的问题是，如果我在未安装依赖项的情况下尝试使用python setup.py，我有一个ModuleNotFoundError/ImportError，因为__init__.py 导入了导入这些依赖项的对象（这非常适合案例6在the Python documentation on managing version file):

python setup.py --version
Traceback (most recent call last):
<snip>
ModuleNotFoundError: No module named 'dependency_module'

这使得无法安装依赖项。那么针对版本文件的最佳策略应该是什么？

到目前为止，我已经在__init__.py 上尝试过这种奇怪的异常处理方法：

try:
    from myproject.base import Stuff
except ImportError:
    pass

有没有更好的方法？还是其他方法？

Answer 1

您似乎遇到了此处提交的问题：https://github.com/pypa/setuptools/issues/1724

最好将版本号写入VERSION.txt，从setup.cfg 和version = file: VERSION.txt 读取它，然后从__init__.py 和import importlib_metadata; __version__ = importlib_metadata.version('myproject') 加载它。

---

更新

包importlib_metadata is on PyPI for current Python versions 并以Python 3.8 in the standard library as importlib.metadata 开头。

综上所述，可以重新考虑是否需要将版本字符串放在单独的文件中。由于可以直接从代码中读取版本字符串，因此version.py 或VERSION.txt 的用途可能会丢失。

或者，我倾向于将我的设置脚本改为read the version string from the changelog。

---

更新 2020 年 11 月 3 日：

看起来attr: 的情况在此期间有所改善，这要感谢change。如果可能，使用 attr: 实际上不会导入代码，因此问题中最初报告的 ModuleNotFoundError 不应再发生。已在v46.4.0 on 16 May 2020发布。