版本范围

在上一个章节中,我们以几个版本的 pkg 包结束。我们来删除它们,并创建一个如下的简单项目:

pkg/conanfile.py
from conan import ConanFile

class pkgRecipe(ConanFile):
    name = "pkg"
app/conanfile.py
from conan import ConanFile

class appRecipe(ConanFile):
    name = "app"
    requires = "pkg/1.0"

让我们创建 pkg/1.0 并安装 app,看看它需要 pkg/1.0

$ conan remove "pkg*" -c
$ conan create pkg --version=1.0
... pkg/1.0 ...
$ conan install app
...
Requirements
    pkg/1.0

然后,如果我们创建一个新版本的 pkg/1.1app 不会自动使用它。

$ conan create pkg --version=1.1
... pkg/1.0 ...
# Note how this still uses the previous 1.0 version
$ conan install app
...
Requirements
    pkg/1.0

所以我们可以修改 app 的 conanfile 来显式使用新的 pkg/1.1 版本,但除此之外,让我们使用以下版本范围表达式(由 [expression] 方括号引入):

app/conanfile.py
from conan import ConanFile

class appRecipe(ConanFile):
    name = "app"
    requires = "pkg/[>=1.0 <2.0]"

现在当我们安装 app 的依赖项时,它将自动使用范围内的最新版本,即使我们创建一个新版本,也无需修改 app 的 conanfile。

# this will now use the newer 1.1
$ conan install app
...
Requirements
    pkg/1.1

$ conan create pkg --version=1.2
... pkg/1.2 ...
# Now it will automatically use the newest 1.2
$ conan install app
...
Requirements
    pkg/1.2

只要新版本落在定义的范围内,这种情况就会成立。如果我们创建一个 pkg/2.0 版本,app 将不会使用它。

$ conan create pkg --version=2.0
... pkg/2.0 ...
# Conan will use the latest in the range
$ conan install app
...
Requirements
    pkg/1.2

使用版本范围时,缓存中的版本优先于远程版本。因此,如果您有一个本地的 pkg/1.2 包,它将被使用而不是远程的,即使远程的更新。要确保您使用的是可用的最新版本,可以在 install/create 命令中使用 --update 参数。请注意,--update 参数将查看命令中指定的所有远程仓库,寻找可能更新的版本,并且不会在找到第一个更新版本时停止。

版本范围可以在多个地方定义:

  • conanfile.py 配方中的 requirestool_requirestest_requirespython_requires

  • conanfile.txt 文件中的 [requires][tool_requires][test_requires] 部分。

  • 在命令行参数中,例如 --requires=--tool_requires

  • 在配置文件 [tool_requires] 部分。

语义化版本

语义化版本规范(semver)规定,软件包的版本应始终使用三个用点分隔的数字,如 MAJOR.MINOR.PATCH,每个数字都有非常具体的含义。

Conan 将 semver 规范扩展到任意数量的数字,并且还允许在其中包含小写字母。这是因为在 1.X 版本中收集了大量的用户经验和反馈,并且很明显 C++ 中的版本控制方案通常更复杂,用户要求更大的灵活性,允许在必要时使用 1.2.3.a.8 这样的版本。

Conan 版本中的非数字标识符遵循与包名称相同的规则,它们只能包含小写字母。这是为了避免 1.2.3-Beta1.2.3-beta 被视为不同版本,这可能成为一个问题,甚至带来安全风险。

版本排序(当需要时,例如决定版本范围内的哪个是最新版本)是通过从左到右逐个比较版本中用点分隔的实体来完成的。数字将按数值比较,所以 2 < 11,包含字母的条目将按字母顺序比较(即使它们也包含一些数字)。

与 semver 规范类似,Conan 可以管理形式为 VERSION-prerelease+build 的**预发布版**和**构建版**。Conan 也会根据相同的规则对预发布版和构建版进行排序,并且每个版本都可以包含任意数量的项目,例如 1.2.3-pre.1.2.1+build.45.a。请注意,semver 标准不对构建版进行任何排序,但 Conan 会使用与排序主版本和预发布版相同的逻辑来进行排序。

重要

请注意,预发布版的排序有时可能令人困惑。预发布版发生在它所限定的发布之前。因此,1.1-alpha.11.1 更早,而不是更新。

范围表达式

范围表达式可以包含下界和上界的比较运算符,并用空格分隔。此外,单独的下界和上界也是允许的,尽管在正常版本控制方案下,特别是仅下界,通常不推荐这样做。requires = "pkg/[>=1.0 <2.0]" 将包含 1.0、1.2.3 和 1.9 等版本,但将不包含 0.3、2.0 或 2.1 版本。

波浪号 ~ 运算符可用于定义“近似”等于的版本范围。requires = "pkg/[~1]" 将包含 1.3 和 1.8.1 等版本,但将排除 0.8 或 2.0 等版本。类似地,requires = "pkg/[~2.5]" 将包含 2.5.0 和 2.5.3 等版本,但排除 2.1、2.7、2.8。

插入符号 ^ 运算符与波浪号非常相似,但允许在第一个非零数字之后的数字上进行变动。requires = "pkg/[^1.2]" 将包含 1.2.1、1.3 和 1.51,但将排除 1.0、2、2.0。^1.2.0 的行为相同,而 ^0.1.2 将包含 0.1.2.1 和 0.1.3,但排除 0.1.1 和 0.2.0。

也可以使用 OR 运算符应用多个条件,例如 requires = "pkg/[>1 <2.0 || ^3.2]",但这种复杂的表达式在实践中不推荐使用,只应在非常极端的情况下使用。

可以通过字符串末尾的字符串匹配来简化某些范围,否则这些范围需要更复杂的条件(此功能是实验性的)。定义 requires=pkg/[1.2.3.*] 将匹配任何以 1.2.3. 开头的版本,并丢弃其他版本。例如,它将匹配 1.2.3.51.2.3.abc,但会丢弃 1.2.3(因为它没有最后的点)。

最后,请注意,预发布版默认情况下不被解析。包含它们在范围内的处理方法是使用 include_prerelease 选项(requires = "pkg/[>1 <2, include_prerelease]")或通过 core.version_ranges:resolve_prereleases=True 配置显式启用,您可以在此处了解更多关于此信息。在此示例中,将包含 1.0-pre.1 和 1.5.1-pre1,但将排除 2.0-pre1。

注意

虽然可以在 requires 版本范围中硬编码 include_prerelease,但这通常不推荐。预发布版应该是选择加入的,并由用户控制,由用户决定是否要使用预发布版。另外,请注意 include_prerelease 不接收参数,因此无法使用 include_prerelease=False 来禁用预发布版。

有关有效范围表达式的更多信息,请参阅 Requires 参考