configure()

在配方中，应使用 configure() 方法来配置设置和选项，以便在后续方法中使用，例如 generate()、build() 或 package()。此方法在构建依赖图并扩展包依赖项时执行，这意味着当此方法执行时，依赖项尚不存在，无法访问 self.dependencies。

例如，对于 C（而非 C++）库，compiler.libcxx 和 compiler.cppstd 设置在 build() 期间甚至不应该存在。这不仅是因为它们不是 package_id 的一部分，而且不应该在构建过程中使用它们。它们将在 profile 中定义，因为图中的其他包可能是 C++ 包，需要它们，但删除它们以避免在配方中使用它们是此配方的责任

settings = "os", "compiler", "build_type", "arch"

def configure(self):
    # Not all compilers have libcxx subsetting, so we use rm_safe
    # to avoid exceptions
    self.settings.rm_safe("compiler.libcxx")
    self.settings.rm_safe("compiler.cppstd")

def package_id(self):
    # No need to delete those settings here, they were already deleted
    pass

注意

从 Conan 2.4 开始，如果定义了 languages = "C" 配方属性（实验性），则上述 configure() 方法是不必要的。

对于希望删除设置的所有子设置的包，可以使用 rm_safe 方法和通配符

settings = "os", "compiler", "build_type", "arch"

def configure(self):
    self.settings.rm_safe("compiler.*")

这将删除 compiler 设置的所有子设置，例如 compiler.libcxx 或 compiler.cppstd，但保留 compiler 设置本身（而 self.settings.rm_safe("compiler") 会删除它）。

同样，对于包含库的包，fPIC 选项仅在库编译为静态库时适用，否则，fPIC 选项没有意义，因此应将其删除

options = {"shared": [True, False], "fPIC": [True, False]}
default_options = {"shared": False, "fPIC": True}

def configure(self):
    if self.options.shared:
        # fPIC might have been removed in config_options(), so we use rm_safe
        self.options.rm_safe("fPIC")

可用的自动实现

警告

此功能是实验性的，可能会发生重大更改。有关更多信息，请参阅 Conan 稳定性 部分。

如果未定义 configure() 方法，Conan 可以自动管理 implements ConanFile 属性中指定的某些常规选项

auto_shared_fpic

自动管理的选项

  • fPIC (True, False)。

  • shared (True, False)。

  • header_only (True, False)。

可以将其添加到配方中，如下所示

from conan import ConanFile

class Pkg(ConanFile):
    implements = ["auto_shared_fpic"]
    ...

然后，如果配方中未指定 configure() 方法，Conan 将自动管理 configure 步骤中的 fPIC 设置，如下所示

if conanfile.options.get_safe("header_only"):
    conanfile.options.rm_safe("fPIC")
    conanfile.options.rm_safe("shared")
elif conanfile.options.get_safe("shared"):
    conanfile.options.rm_safe("fPIC")

请注意，将此实现添加到配方中也可能会影响 configure 步骤。

如果您需要在配方中实现自定义行为，但还需要此逻辑，则必须显式声明它

def configure(self):
    if conanfile.options.get_safe("header_only"):
        conanfile.options.rm_safe("fPIC")
        conanfile.options.rm_safe("shared")
    elif conanfile.options.get_safe("shared"):
        conanfile.options.rm_safe("fPIC")
    self.settings.rm_safe("compiler.libcxx")
    self.settings.rm_safe("compiler.cppstd")

配方可以建议其依赖项的选项值，如 default_options = {"*:shared": True}，但无法有条件地执行此操作。为此，也可以使用 configure() 方法

def configure(self):
    if something:
        self.options["*"].shared = True

注意

最佳实践

  • 请记住，在配方中定义 settings 或 conf 值是不可能的，它们是只读的。

  • 定义 options 值只是一个“建议”，具体取决于图计算、优先级等，options 的最终值可能与配方设置的值不同。

另请参阅