set_name()¶
动态定义 name
属性。此方法很少用到,因为它唯一有意义的用例是当一个配方被共享并用于创建具有相同配方的不同包时。在大多数情况下,推荐的方法是在配方中定义 name = "mypkg"
属性。
此方法仅在配方导出到缓存中(conan create
和 conan export
)以及配方在本地使用时(如 conan install .
)执行。在所有其他情况下,包的名称已完全定义,并且 set_name()
将不会被调用,因此不要依赖它实现定义 self.name
值之外的任何其他功能。
如果当前包名是在 name.txt 文件中定义的,则可以这样做:
from conan import ConanFile
from conan.tools.files import load
class Pkg(ConanFile):
def set_name(self):
# This will execute relatively to the current user directory (name.txt in cwd)
self.name = load(self, "name.txt")
# if "name.txt" is located relative to the conanfile.py better do:
self.name = load(self, os.path.join(self.recipe_folder, "name.txt"))
包名也可以通过命令行参数 --name=xxxx
在某些命令中定义。如果我们想优先考虑命令行参数,我们应该这样做:
from conan import ConanFile
from conan.tools.files import load
class Pkg(ConanFile):
def set_name(self):
# Command line ``--name=xxxx`` will be assigned first to self.name and have priority
self.name = self.name or load(self, "name.txt")
set_name()
方法可以决定定义 name
值,而不管潜在的 --name=xxx
命令行参数,甚至可以被 set_name()
完全忽略。提供正确的 set_name()
是开发人员的责任。
def set_name(self):
# This will always assign "pkg" as name, ignoring ``--name`` command line argument
# and without erroring or warning
self.name = "pkg"
如果提供了命令行参数 --name=xxx
,它将被初始化到 self.name
属性中,因此 set_name()
方法可以读取并使用它:
def set_name(self):
# Takes the provided command line ``--name`` argument and creates a name appending to
# it the ".extra" string
self.name = self.name + ".extra"
警告
set_name()
方法是 name
属性的替代方案。不建议或不支持同时定义 name
属性和 set_name()
方法。