从git标记获取版本(通过pbr)

Question

我使用pbr进行包装。它从git标记获取版本，并将其应用于setup.py。

现在，我还希望在包中有可用的版本。例如，拥有一个__version__属性。为此，我可以使用pbr库吗？

还有另一个库：审查员，它也从git标记中提取版本，但这将增加一个额外的要求。我更希望从pbr获得这个功能

Answer 1

正确设置setuptools和pbr之后，以下是几种方法：

import pkg_resources  # part of setuptools

# I don't like this one because the version method is hidden
v1 = pkg_resources.require("my_package_name")[0].version
print('v1 {}'.format(v1))

# This is my favorite - the output without .version is just a longer string with
# both the package name, a space, and the version string
v2 = pkg_resources.get_distribution('my_package_name').version
print('v2 {}'.format(v2))

from pbr.version import VersionInfo

# This one seems to be slower, and with pyinstaller makes the exe a lot bigger
v3 = VersionInfo('my_package_name').release_string()
print('v3 {}'.format(v3))

# Update, new option as of Python 3.8 (credit: sinoroc)
# In Python 3.8, importlib.metadata is part of the stdlib,
# which removes run-time dependencies on `pbr` or `setuptools`
import importlib.metadata

__version__ = importlib.metadata.version('my_package_name')

如果您想要从命令行获得它，您可以这样做：

py setup.py --version

甚至在脚本中运行setup.py脚本，如果包总是在本地安装的话：

from subprocess import Popen, PIPE

(output, err) = Popen('py setup.py --version'.split(' '),
                      stdout=PIPE, stderr=PIPE, text=True).communicate()
if err: print('ERROR: "{}"'.format(err))
else: print('setup.py --version = {}'.format(output))

注意:关于使用子进程启动和读取stdout等方面的更多细节，参见这个答案，特别是关于较旧版本(3.7之前)的信息。

然后，您可以将__version__添加到包__init__.py中，如下所示：

__all__ = (
    '__version__',
    'my_package_name'
)

# Or substitute a different method and assign the result to __version__
import pkg_resources  # part of setuptools

__version__ = pkg_resources.get_distribution("my_package_name").version

其他一些问答可能有助于设置和详细说明如何更新版本和其他信息，特别是如果从Git (从标记、作者和ChangeLog信息获得的版本)获得信息的话：

• 如何使用Setuptools和PBR更新Python包中的git元数据
• 和PBR --如何使用git标记作为版本创建包发行版？

Answer 2

如果您认为pbr是包的运行时依赖项，则可以使用pbr.version中的VersionInfo类。

from pbr.version import VersionInfo

package_name='my_package'
info = VersionInfo(package_name)

print(info.version_string())

(另见变量(如果使用pbr )？)

Answer 3

考虑一下供应链管理，它在可用时从git或hg标记中提取版本，或者生成适当的开发版本(例如，hgvs-1.2.5.dev6+hb5d989061852.d20181124)。与硬编码版本一样，该版本被写入包元数据中。不需要非标准的运行时支持。

虽然我在许多项目中都使用了setuptools_scm，但我没有使用PBR。我很好奇，于是制作了这个简单的演示：

snafu$ head setup.py setup.cfg pbrversiontest/*.py
==> setup.py <==
from setuptools import setup

setup(
    setup_requires=[
        "pbr",
        "setuptools_scm"
    ],
    pbr=True,
    use_scm_version=True,
)

==> setup.cfg <==
[metadata]
name = pbrversiontest
summary = test whether we can use pbr and setuptools_scm

[files]
packages =
    pbrversiontest

==> pbrversiontest/__init__.py <==
# This is straight from setuptools_scm README
from pkg_resources import get_distribution, DistributionNotFound
try:
    __version__ = get_distribution(__name__).version
except DistributionNotFound:
    # package is not installed
    pass

==> pbrversiontest/__main__.py <==
# this isn't required -- only for the demo
import pbrversiontest

print("version is " + pbrversiontest.__version__)

在开发目录中，您可能有如下所示的会话：

snafu$ python3.6 -mvenv venv/3.6
snafu$ source venv/3.6/bin/activate
(3.6) snafu$ git tag 0.1.2
(3.6) snafu$ pip install -e .
(3.6) snafu$ python -m pbrversiontest 
version is 0.1.2
(3.6) snafu$ pip install wheel
(3.6) snafu$ python setup.py bdist_wheel
...
creating 'dist/pbrversiontest-0.1.2-py3-none-any.whl' and adding 'build/bdist.linux-x86_64/wheel' to it
...
(3.6) snafu$ unzip -l dist/pbrversiontest-0.1.2-py3-none-any.whl 
Archive:  dist/pbrversiontest-0.1.2-py3-none-any.whl
  Length      Date    Time    Name
---------  ---------- -----   ----
      192  2018-11-25 05:26   pbrversiontest/__init__.py
       73  2018-11-25 05:46   pbrversiontest/__main__.py
       33  2018-11-25 06:06   pbrversiontest-0.1.2.dist-info/AUTHORS
      217  2018-11-25 06:06   pbrversiontest-0.1.2.dist-info/METADATA
       92  2018-11-25 06:06   pbrversiontest-0.1.2.dist-info/WHEEL
       47  2018-11-25 06:06   pbrversiontest-0.1.2.dist-info/pbr.json
       15  2018-11-25 06:06   pbrversiontest-0.1.2.dist-info/top_level.txt
      675  2018-11-25 06:06   pbrversiontest-0.1.2.dist-info/RECORD
---------                     -------
     1344                     8 files