Python requires¶

介绍¶

python_requires 功能是一种在不同配方之间共享文件和代码的非常便捷的方式。Python require 是一种特殊的配方，它不创建包，仅用于被其他配方重用。

我们想要重用的一个非常简单的配方可能是

from conan import ConanFile

myvar = 123

def myfunct():
    return 234

class Pkg(ConanFile):
    name = "pyreq"
    version = "0.1"
    package_type = "python-require"

然后我们将使用 conan create . 使其可供其他包使用。请注意，python-require 包不会创建二进制文件，它只是配方部分。

$ conan create .
# It will only export the recipe, but will NOT create binaries
# python-requires do NOT have binaries

我们可以在 python_requires 属性中声明依赖项来重用上述配方功能，并可以使用 self.python_requires["<name>"].module 访问其成员

from conan import ConanFile

class Pkg(ConanFile):
    name = "pkg"
    version = "0.1"
    python_requires = "pyreq/0.1"

    def build(self):
        v = self.python_requires["pyreq"].module.myvar  # v will be 123
        f = self.python_requires["pyreq"].module.myfunct()  # f will be 234
        self.output.info(f"{v}, {f}")

$ conan create .
...
pkg/0.1: 123, 234

Python requires 也可以使用版本范围，在许多情况下，如果这些 python-requires 需要随着时间的推移而演变，这是推荐的做法

from conan import ConanFile

class Pkg(ConanFile):
    python_requires = "pyreq/[>=1.0 <2]"

也可以使用 python_requires = "pyreq/0.1", "other/1.2" 要求多个 python-requires

扩展基类¶

一个常见的用例是声明一个带有我们想要通过继承在多个配方中重用的方法的基类。我们将把这个基类写在一个 python-requires 包中

from conan import ConanFile

class MyBase:
    def source(self):
        self.output.info("My cool source!")
    def build(self):
        self.output.info("My cool build!")
    def package(self):
        self.output.info("My cool package!")
    def package_info(self):
        self.output.info("My cool package_info!")

class PyReq(ConanFile):
    name = "pyreq"
    version = "0.1"
    package_type = "python-require"

并使其可供重用

$ conan create .

请注意，配方文件中包含两个类

MyBase 是用于继承的类，并且不扩展 ConanFile。

PyReq 是定义当前导出包的类，它是引用 pyreq/0.1 的配方。

一旦包含我们想要重用的基类的包可用，我们就可以在其他配方中使用它来继承该基类中的功能。我们需要像以前一样声明 python_requires，并且我们需要在属性 python_requires_extend 中告诉 Conan 要使用的基类。在这里，我们的配方将继承自类 MyBase

from conan import ConanFile

class Pkg(ConanFile):
    name = "pkg"
    version = "0.1"
    python_requires = "pyreq/0.1"
    python_requires_extend = "pyreq.MyBase"

结果继承等同于将我们的 Pkg 类声明为 class Pkg(pyreq.MyBase, ConanFile)。因此，创建包，我们可以看到如何重用基类中的方法

$ conan create .
...
pkg/0.1: My cool source!
pkg/0.1: My cool build!
pkg/0.1: My cool package!
pkg/0.1: My cool package_info!
...

通常，基类属性不会被继承，应尽可能避免使用它们。有一些方法可以替代它们，例如 export() 或 set_version()。对于特殊情况，请参阅 init() 方法文档以获取有关扩展继承属性的更多信息。

也可以重新实现一些基类方法，并且还可以使用 Python super() 语法显式调用基类方法

from conan import ConanFile

class Pkg(ConanFile):
    name = "pkg"
    version = "0.1"
    python_requires = "pyreq/0.1"
    python_requires_extend = "pyreq.MyBase"

    def source(self):
        super().source()  # call the base class method
        self.output.info("MY OWN SOURCE") # Your own implementation

不强制调用基类方法，完全覆盖而不调用 super() 是可能的。也可以更改调用顺序，并且可以先调用自己的代码，然后再调用 super()。

重用文件¶

可以访问由使用 python_requires 的配方导出的文件。我们可以拥有这个配方，以及包含“Hello”文本的 myfile.txt 文件。

from conan import ConanFile

class PyReq(ConanFile):
    name = "pyreq"
    version = "1.0"
    package_type = "python-require"
    exports = "*"

$ echo "Hello" > myfile.txt
$ conan create .

现在已经创建了 python-require，我们可以使用 path 属性访问其路径（myfile.txt 所在的位置）

import os

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

class Pkg(ConanFile):
    python_requires = "pyreq/0.1"

    def build(self):
        pyreq_path = self.python_requires["pyreq"].path
        myfile_path = os.path.join(pyreq_path, "myfile.txt")
        content = load(self, myfile_path)  # content = "Hello"
        self.output.info(content)
        # we could also copy the file, instead of reading it

请注意，只有 exports 适用于这种情况，但 exports_sources 不适用。

测试 python-requires¶

可以通过添加 test_package/conanfile.py 使用 test_package 测试 python_require

conanfile.py¶

from conan import ConanFile

def mynumber():
    return 42

class PyReq(ConanFile):
    name = "pyreq"
    version = "1.0"
    package_type = "python-require"

test_package/conanfile.py¶

from conan import ConanFile

class Tool(ConanFile):

    # Literal "tested_reference_str", Conan will dynamically replace it
    python_requires = "tested_reference_str"

    def test(self):
        pyreq = self.python_requires["pyreq"].module
        mynumber = pyreq.mynumber()
        self.output.info("{}!!!".format(mynumber))

从 Conan 2.1 开始，python_requires = "tested_reference_str" 是必需的。自动注入 python_requires 而没有此声明已被弃用，并且将在未来版本中删除。

请注意，test_package/conanfile.py 不需要任何类型的 python_requires 声明，这是自动且隐式完成的。现在我们可以使用以下命令创建和测试它

$ conan create .
...
pyreq/0.1 (test package): 42!!!

对 package_id 的影响¶

python_requires 将影响使用这些依赖项的**消费者包**的 package_id。默认情况下，策略是 minor_mode，这意味着

对 **revision** 的 **patch** 版本的更改不会影响包 ID。因此，依赖于 "pyreq/1.2.3" 或 "pyreq/1.2.4" 将导致相同的包 ID（两者都将被映射到 "pyreq/1.2.Z" 在哈希计算中）。如果您想更改通用代码，但又不希望消费者受到影响或触发依赖项的重新构建，请增加 patch 版本。
对 **minor** 版本进行的更改将产生不同的包 ID。因此，如果您依赖于 "pyreq/1.2.3"，并将版本升级到 "pyreq/1.3.0"，那么您需要构建使用该新 python-require 的新二进制文件。如果您希望确保需要此 python-require 的包使用代码中的这些更改进行构建，请增加 minor 或 major 版本。

在大多数情况下，使用版本范围 python_requires = "pyreq/[>=1.0 <2.0]" 是正确的方法，因为这意味着不包含 **major** 版本更新，因为它们需要消费者本身进行更改。然后，可以发布 pyreq/2.0 的新 major 版本，并让消费者逐步更改他们的要求为 python_requires = "pyreq/[>=2.0 <3.0]"，修复配方，并在不破坏整个项目的情况下继续前进。

与常规 requires 一样，可以使用 core.package_id:default_python_mode 配置自定义默认值。

也可以使用 package_id() 方法自定义每个包的 python_requires 的影响

from conan import ConanFile

class Pkg(ConanFile):
    python_requires ="pyreq/[>=1.0]"
    def package_id(self):
        self.info.python_requires.patch_mode()

python_requires 的解析¶

在使用 python_requires 时，需要考虑一些重要事项

Python require 配方由解释器加载一次，并且对所有消费者都是通用的。不要在 python_requires 配方中使用任何全局状态。
Python requires 对消费者是私有的。它们不是传递性的。不同的消费者可以需要相同 python-require 的不同版本。由于是私有的，因此无法从下游覆盖它们。
python_requires 不能使用常规 requires 或 tool_requires。拥有 requirements()（类似方法）可以被配方继承是可能的并且允许的，但是 python_requires 类本身不能使用它们。
python_requires 不能被“别名”。
python_requires 可以使用 native python import 导入其他 python 文件，只要这些文件与配方一起导出即可。
python_requires 也可以用作可编辑的包。
python_requires 在 lockfile 中被锁定，以保证可重现性，就像其他 requires 和 tool_requires 被锁定的方式一样。

注意

最佳实践

即使 python-requires 可以传递地 python_requires 其他 python-requires 配方，但强烈不建议这样做。多层继承和重用可能会变得非常复杂且难以管理，建议保持层次结构扁平。
不要尝试将 Python 继承与 python_requires_extend 继承机制混合，它们不兼容并且可能会破坏。
不要为 python-requires 使用多重继承