set_version()¶
动态定义 version
属性。当同一个配方用于创建同一个包的不同版本时,可能需要此方法,并且此版本在其他地方定义,例如在 Git 分支或文本或构建脚本文件中。这将是一种常见情况。
此方法仅在配方导出到缓存时执行 conan create
和 conan export
,以及在本地使用配方时,例如使用 conan install .
。在所有其他情况下,包的版本都已完全定义,并且 set_version()
不会被调用,因此不要依赖它来执行除定义 self.version
值之外的任何其他功能。
如果当前包版本在 version.txt 文件中定义,则可以执行以下操作
from conan import ConanFile
from conan.tools.files import load
class Pkg(ConanFile):
def set_version(self):
# This will execute relatively to the current user directory (version.txt in cwd)
self.version = load(self, "version.txt")
# if "version.txt" is located relative to the conanfile.py better do:
self.version = load(self, os.path.join(self.recipe_folder, "version.txt"))
包版本也可以在命令行中为某些命令使用 --version=xxxx
参数定义。如果我们想优先考虑命令行参数,我们应该执行以下操作
from conan import ConanFile
from conan.tools.files import load
class Pkg(ConanFile):
def set_version(self):
# Command line ``--version=xxxx`` will be assigned first to self.version and have priority
self.version = self.version or load(self, "version.txt")
一个常见的用例是从某些版本控制机制(如当前 Git 标签)动态定义 version
。这可以通过以下方式完成
from conan import ConanFile
from conan.tools.scm import Git
class Pkg(ConanFile):
name = "pkg"
def set_version(self):
git = Git(self, self.recipe_folder)
self.version = git.run("describe --tags")
set_version()
方法可以决定定义 version
值,而不管潜在的 --version=xxx
命令行参数如何,甚至可以被 set_version()
完全忽略。开发人员有责任提供正确的 set_version()
def set_version(self):
# This will always assign "2.1" as version, ignoring ``--version`` command line argument
# and without erroring or warning
self.version = "2.1"
如果提供了命令行参数 --version=xxx
,它将在 self.version
属性中初始化,因此 set_version()
方法可以读取和使用它
def set_version(self):
# Takes the provided command line ``--version`` argument and creates a version appending to
# it the ".extra" string
self.version = self.version + ".extra"
警告
set_version()
方法是 version
属性的替代方法。不建议或不支持同时定义 version
类属性和 set_version()
方法。