与setup.py和软件包共享软件包版本的正确方法是什么？

Question

使用distutils，setuptools等，在setup.py以下位置指定软件包版本：

# file: setup.py
...
setup(
name='foobar',
version='1.0.0',
# other attributes
)

我希望能够从包中访问相同的版本号：

>>> import foobar
>>> foobar.__version__
'1.0.0'

我可以将其添加__version__ = '1.0.0'到包的__init__.py中，但是我还想在包中包括其他导入，以创建包的简化接口：

# file: __init__.py

from foobar import foo
from foobar.bar import Bar

__version__ = '1.0.0'

和

# file: setup.py

from foobar import __version__
...
setup(
name='foobar',
version=__version__,
# other attributes
)

但是，foobar如果这些其他导入导入尚未安装的其他软件包，则可能导致安装失败。与setup.py和软件包共享软件包版本的正确方法是什么？

Answer 1

setup.py仅设置版本，然后使用读取自己的版本pkg_resources，从而有效地查询setuptools元数据：

文件： setup.py

setup(
    name='foobar',
    version='1.0.0',
    # other attributes
)

文件： __init__.py

from pkg_resources import get_distribution

__version__ = get_distribution('foobar').version

为了在所有情况下都能正常工作，您可能最终无需安装就运行它，请测试DistributionNotFound并确定分发位置：

from pkg_resources import get_distribution, DistributionNotFound
import os.path

try:
    _dist = get_distribution('foobar')
    # Normalize case for Windows systems
    dist_loc = os.path.normcase(_dist.location)
    here = os.path.normcase(__file__)
    if not here.startswith(os.path.join(dist_loc, 'foobar')):
        # not installed, but there is another version that *is*
        raise DistributionNotFound
except DistributionNotFound:
    __version__ = 'Please install this project with setup.py'
else:
    __version__ = _dist.version