版本范围¶
在上一节中,我们以 pkg
包的几个版本结束。让我们移除它们并创建以下简单的项目
from conan import ConanFile
class pkgRecipe(ConanFile):
name = "pkg"
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.1
的新版本,它不会自动被 app
使用
$ 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]
括号引入)
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
食谱的requires
,tool_requires
,test_requires
,python_requires
中在
conanfile.txt
文件的[requires]
,[tool_requires]
,[test_requires]
部分中在命令行参数中,例如
--requires=
和--tool_requires
。在配置文件(profiles)的
[tool_requires]
部分中
语义版本控制¶
语义版本控制规范,即 semver,规定包的版本应始终使用由点分隔的 3 位数字,如 MAJOR.MINOR.PATCH
,并且每个数字都有非常特定的含义。
Conan 扩展了 semver 规范,允许任意位数的数字,并允许包含小写字母。这样做是因为在 1.X 版本中积累了大量用户经验和反馈,并且很明显在 C++ 中版本控制方案通常更复杂,用户要求更高的灵活性,必要时允许像 1.2.3.a.8
这样的版本。
Conan 非数字标识符的版本遵循与包名相同的规则,只能包含小写字母。这是为了避免 1.2.3-Beta
与 1.2.3-beta
不同,这可能会导致问题,甚至存在安全风险。
当需要比较版本时(例如决定版本范围内的最新版本),比较顺序是从左到右,逐个比较版本中由点分隔的每个实体。数字将按数值比较,所以 2 < 11,包含字母的实体将按字母顺序比较(即使它们也包含一些数字)。
与 semver 规范类似,Conan 可以管理以下形式的预发布版(prereleases)和构建(builds):VERSION-prerelease+build
。Conan 也会根据相同的规则对预发布版和构建进行排序,并且它们中的每一个也可以包含任意数量的项,例如 1.2.3-pre.1.2.1+build.45.a
。请注意,semver 标准不对构建进行任何排序,但 Conan 会,其逻辑与用于排序主版本和预发布版相同。
重要
请注意,预发布版的顺序有时会令人困惑。预发布版在时间上发生在其所限定的发布版之前。因此 1.1-alpha.1
比 1.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。
也可以使用 OR 运算符应用多个条件,例如 requires = "pkg/[>1 <2.0 || ^3.2]"
,但在实践中不建议使用这种复杂的表达式,仅应在非常极端的情况下使用。
可以通过对字符串末尾进行字符串匹配来简化一些范围,否则可能需要更复杂的条件(此功能是实验性的)。定义 requires=pkg/[1.2.3.*]
将匹配任何以 1.2.3.
开头的版本,并丢弃其他版本。例如,它将匹配 1.2.3.5
和 1.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_prereleases
不接受参数,因此无法通过 include_prerelease=False
来禁用预发布版本。
有关有效范围表达式的更多信息,请参阅 Requires 参考