带有bump2版本的策略路由

这个解决方案来自本文

用例- python GUI包通过PyInstaller分发。需要显示版本信息。

这里是项目包的结构

packagex
├── packagex
│   ├── __init__.py
│   ├── main.py
│   └── _version.py
├── packagex.spec
├── LICENSE
├── README.md
├── .bumpversion.cfg
├── requirements.txt
├── setup.cfg
└── setup.py

setup.py在哪里

# setup.py
import os

import setuptools

about = {}
with open("packagex/_version.py") as f:
    exec(f.read(), about)

os.environ["PBR_VERSION"] = about["__version__"]

setuptools.setup(
    setup_requires=["pbr"],
    pbr=True,
    version=about["__version__"],
)

Packagex /_version.py包含just

__version__ = "0.0.1"

和packagex / __init__ . py

from ._version import __version__

对于.bumpversion.cfg

[bumpversion]
current_version = 0.0.1
commit = False
tag = False
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\-(?P<release>[a-z]+)(?P<build>\d+))?
serialize = 
    {major}.{minor}.{patch}-{release}{build}
    {major}.{minor}.{patch}

[bumpversion:part:release]
optional_value = prod
first_value = dev
values = 
    dev
    prod

[bumpversion:file:packagex/_version.py]

根据延迟的[STOP PRESS: rejected] PEP 396(模块版本号)，有一种建议的方法来做到这一点。它描述了模块遵循的基本原理(当然是可选的)标准。下面是一个片段:

当模块(或包)包含版本号时，该版本应该在__version__属性中可用。

对于位于命名空间包中的模块，模块应该包含__version__属性。命名空间包本身不应该包含自己的__version__属性。

__version__属性的值应该是一个字符串。

我在这里描述了一种标准的现代方法，它依赖于setuptools_scm。 在过去的几年中，这种模式已经成功地应用于许多已发布的包，因此我强烈推荐它。

注意，您不需要getversion包来实现这个模式。getversion文档恰好包含这个技巧。

我在包目录中使用了一个JSON文件。这符合Zooko的要求。

内部pkg_dir / pkg_info.json:

{"version": "0.1.0"}

在setup . py:

from distutils.core import setup
import json

with open('pkg_dir/pkg_info.json') as fp:
    _info = json.load(fp)

setup(
    version=_info['version'],
    ...
    )

内部pkg_dir / __init__ . py:

import json
from os.path import dirname

with open(dirname(__file__) + '/pkg_info.json') as fp:
    _info = json.load(fp)

__version__ = _info['version']

我还在pkg_info中放入了其他信息。Json，比如author。我 我喜欢使用JSON，因为我可以自动管理元数据。

我使用一个单独的_version.py文件作为“曾经正确的位置”来存储版本信息:

It provides a __version__ attribute. It provides the standard metadata version. Therefore it will be detected by pkg_resources or other tools that parse the package metadata (EGG-INFO and/or PKG-INFO, PEP 0345). It doesn't import your package (or anything else) when building your package, which can cause problems in some situations. (See the comments below about what problems this can cause.) There is only one place that the version number is written down, so there is only one place to change it when the version number changes, and there is less chance of inconsistent versions.

它是这样工作的:存储版本号的“一个规范的地方”是一个.py文件，名为“_version.py”，它在你的Python包中，例如在myniftyapp/_version.py中。这个文件是一个Python模块，但是你的setup.py没有导入它!(这将击败功能3。)相反，你的setup.py知道这个文件的内容非常简单，就像:

__version__ = "3.6.5"

所以你的setup.py打开文件并解析它，代码如下:

import re
VERSIONFILE="myniftyapp/_version.py"
verstrline = open(VERSIONFILE, "rt").read()
VSRE = r"^__version__ = ['\"]([^'\"]*)['\"]"
mo = re.search(VSRE, verstrline, re.M)
if mo:
    verstr = mo.group(1)
else:
    raise RuntimeError("Unable to find version string in %s." % (VERSIONFILE,))

然后你的setup.py将这个字符串作为"version"参数的值传递给setup()，这样就满足了特性2。

为了满足特性1，你可以让你的包(在运行时，而不是在设置时!)像这样从myniftyapp/__init__.py导入_version文件:

from _version import __version__

这是我多年来一直在使用的一个技巧的例子。

这个例子中的代码有点复杂，但是我写在这个注释中的简化的例子应该是一个完整的实现。

下面是导入版本的示例代码。

如果你发现这种方法有任何问题，请告诉我。

我还看到了另一种风格:

>>> django.VERSION
(1, 1, 0, 'final', 0)