Python 依赖项¶

简介¶

python_requires 功能是不同配方之间共享文件和代码的一种非常方便的方式。Python 依赖项是一种特殊的配方，它不创建包，而仅仅是为了被其他配方重用。

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

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 依赖项也可以使用版本范围，如果这些 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 ，并且需要告诉 Conan 在属性 python_requires_extend 中使用哪些基类。在这里，我们的配方将继承自 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 ，这意味着

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

在大多数情况下，使用版本范围 python_requires = "pyreq/[>=1.0 <2.0]" 是正确的方法，因为这意味着**主要**版本的提升不包括在内，因为它们需要使用者本身进行更改。然后可以发布 pyreq/2.0 的新主要版本，并让使用者逐渐将其需求更改为 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 依赖项配方由解释器仅加载一次，并且对所有使用者都是通用的。请勿在 python_requires 配方中使用任何全局状态。
Python 依赖项对使用者是私有的。它们不是传递性的。不同的使用者可以要求相同 python-require 的不同版本。作为私有依赖项，它们无法以任何方式从下游覆盖。
python_requires 本身不能使用常规 requires 或 tool_requires 。拥有 requirements() （以及类似方法）供配方继承是可行且允许的，但 python_requires 类本身不能使用它们。
python_requires 不能“别名化”。
python_requires 可以使用原生 Python import 导入其他 Python 文件，只要这些文件与配方一起导出即可。
python_requires 也可以用作可编辑包。
python_requires 在锁定文件中被锁定，以保证可重复性，就像其他 requires 和 tool_requires 被锁定一样。

注意

最佳实践

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