setup.cfg Python项目的单一源代码包版本

Question

对于具有setup.py的传统Python项目，有多种方法可以确保版本字符串不必在整个代码库中重复。有关建议列表，请参阅PyPA关于"单一采购包版本"的指南。

许多人试图从setup.py转移到setup.cfg(可能是受PEP517和PEP518的影响；无论如何，setup.py大多是以声明方式使用的，当setup.py中有逻辑时，情况可能会更糟。(这意味着大多数建议将不再起作用，因为setup.cfg不能包含"代码"。

如何为使用setup.cfg的Python项目单独获取包版本？

Answer 1

有几种方法可以做到这一点(请参阅以下示例中使用的项目结构(：

1.

setup.cfg

[metadata]
version = 1.2.3.dev4

src/my_top_level_package/__init__.py

import importlib.metadata
__version__ = importlib.metadata.version('MyProject')

2.

setup.cfg

[metadata]
version = file: VERSION.txt

VERSION.txt

1.2.3.dev4

src/my_top_level_package/__init__.py

import importlib.metadata
__version__ = importlib.metadata.version('MyProject')

3.

setup.cfg

[metadata]
version = attr: my_top_level_package.__version__

src/my_top_level_package/__init__.py

__version__ = '1.2.3.dev4'

还有更多

可能还有其他方法可以做到这一点，通过玩不同的组合子。

---

参考:

• https://setuptools.readthedocs.io/en/latest/userguide/declarative_config.html
• https://docs.python.org/3/library/importlib.metadata.html

---

前面例子中假设的结构如下。。。

MyProject
├── setup.cfg
├── setup.py
└── src
└── my_top_level_package
└── __init__.py

setup.py

#!/usr/bin/env python3
import setuptools
if __name__ == '__main__':
setuptools.setup(
# see 'setup.cfg'
)

setup.cfg

[metadata]
name = MyProject
# See above for the value of 'version = ...'
[options]
package_dir =
= src
packages = find:
[options.packages.find]
where = src

$ cd path/to/MyProject
$ python3 setup.py --version
1.2.3.dev4
$ python3 -m pip install .
# ...
$ python3 -c 'import my_top_level_package; print(my_top_level_package.__version__)'
1.2.3.dev4
$ python3 -V
Python 3.6.9
$ python3 -m pip list
Package       Version   
------------- ----------
MyProject     1.2.3.dev4
pip           20.0.2    
pkg-resources 0.0.0     
setuptools    45.2.0    
wheel         0.34.2    
zipp          3.0.0