init()

这是一个可选的方法,用于初始化 conanfile 中的值,专为继承自 python_requires 而设计。假设我们有一个 base/1.1 食谱

base/conanfile.py
from conan import ConanFile

class MyConanfileBase:
    license = "MyLicense"
    settings = "os", # tuple!


class PyReq(ConanFile):
    name = "base"
    version = "1.1"
    package_type = "python-require"

我们可以通过以下方式重用并继承它

pkg/conanfile.py
from conan import ConanFile

class Pkg(ConanFile):
    license = "MIT"
    settings = "arch", # tuple!
    python_requires = "base/1.1"
    python_requires_extend = "base.MyConanfileBase"

    def init(self):
        base = self.python_requires["base"].module.MyConanfileBase
        self.settings = base.settings + self.settings  # Note, adding 2 tuples = tuple
        self.license = base.license  # License is overwritten

最终的 Pkg conanfile 将同时具有 osarch 作为 settings,并将 MyLicense 作为 license。

要扩展基类的 options,需要调用 self.options.update() 方法

base/conanfile.py
from conan import ConanFile

class BaseConan:
    options = {"base": [True, False]}
    default_options = {"base": True}

class PyReq(ConanFile):
    name = "base"
    version = "1.0.0"
    package_type = "python-require"

当调用 init() 时,self.options 对象已经初始化。因此,更新 self.default_options 是无效的,需要使用基类的 options 和基类的 default options 值来更新 self.options

pkg/conanfile.py
from conan import ConanFile

class DerivedConan(ConanFile):
    name = "derived"
    python_requires = "base/1.0.0"
    python_requires_extend = "base.BaseConan"
    options = {"derived": [True, False]}
    default_options = {"derived": False}

    def init(self):
        base = self.python_requires["base"].module.BaseConan
        # Note we pass the base options and default_options
        self.options.update(base.options, base.default_options)

此方法也可用于无条件地初始化类属性,例如 licensedescription,或从 conandata.yml 之外的数据文件中初始化任何其他属性。例如,您可以有一个 json 文件,其中包含库的 licensedescriptionauthor 信息

data.json
{"license": "MIT", "description": "This is my awesome library.", "author": "Me"}

然后,您可以从 init() 方法中加载这些信息

import os
import json
from conan import ConanFile
from conan.tools.files import load


class Pkg(ConanFile):
    exports = "data.json" # Important that it is exported with the recipe

    def init(self):
        data = load(self, os.path.join(self.recipe_folder, "data.json"))
        d = json.loads(data)
        self.license = d["license"]
        self.description = d["description"]
        self.author = d["author"]

注意

最佳实践

  • 尽量保持您的 python_requires 尽可能简单,并且不要重用它们的属性(这是使用 init() 方法的主要需求),尽量避免此 init() 方法带来的复杂性。一般来说,继承可能会比组合带来更多问题(换句话说,将“使用组合而非继承”作为通用的编程良好实践),因此如果可能,请尽量避免使用它。

  • 不要滥用 init() 于此处列出的用途之外的目的,也不要使用 Python 的私有构造函数 ConanFile.__init__

  • init() 方法在食谱加载时执行。它不能包含基于 settings、options、conf 的条件判断,也不能使用除上述 python_requires 之外的任何依赖信息。