复制所有依赖项的源文件¶

请先克隆源代码以重新创建此项目。您可以在 GitHub 的 examples2 仓库中找到它们。

$ git clone https://github.com/conan-io/examples2.git
$ cd examples2/examples/extensions/deployers/sources

在此示例中，我们将了解如何创建和使用自定义部署器。此部署器会复制您的所有依赖项的源文件，并将其放入一个指定的输出文件夹中。

注意

为了更好地理解此示例，强烈建议您事先阅读部署器参考。

定位部署器¶

在此示例中，部署器与我们的 conanfile 示例位于同一目录中，但正如部署器参考中所述，Conan 将按顺序在以下几个额外位置查找指定的部署器：

绝对路径
相对于当前工作目录
在 [CONAN_HOME]/extensions/deployers 文件夹中
内置部署器

运行它¶

对于我们的示例，我们有一个简单的 recipe，它将 zlib 和 mcap 都列为要求。借助 tools.build:download_source=True 配置，我们可以强制调用其 source() 方法，这将确保即使无需执行构建，源文件也可用。

现在，您应该能够在任何给定 recipe 的 conan install 和 conan graph 命令中使用新的部署器

$ conan graph info . -c tools.build:download_source=True --deployer=sources_deploy

检查命令输出，我们可以看到它将我们的直接依赖项 zlib 和 mcap 的源文件，以及我们的传递依赖项 zstd 和 lz4 的源文件复制到 dependencies_sources 文件夹中。完成此操作后，可以进行额外的预处理以实现更具体的需求。

请注意，您可以传递 --deployer-folder 参数来更改部署器的基本输出路径。

代码导览¶

source_deploy.py 文件包含以下代码：

sources_deploy.py¶

from conan.tools.files import copy
import os


def deploy(graph, output_folder, **kwargs):
    # Note the kwargs argument is mandatory to be robust against future changes.
    for name, dep in graph.root.conanfile.dependencies.items():
        if dep.folders is None or dep.folders.source_folder is None:
            raise ConanException(f"Sources missing for {name} dependency.\n"
                                  "This deployer needs the sources of every dependency present to work, either building from source, "
                                  "or by using the 'tools.build:download_source' conf.")
        copy(graph.root.conanfile, "*", dep.folders.source_folder, os.path.join(output_folder, "dependency_sources", str(dep)))

deploy()¶

Conan 调用 deploy() 方法，该方法会获取依赖图和输出文件夹路径作为参数。它遍历我们 recipe 的所有依赖项，并使用 conan.tools.copy 将每个源文件复制到 dependencies_sources 下各自的文件夹中。

注意

如果您将此部署器作为您自己的示例，请记住 tools.build:download_source=True 是必要的，这样才能为依赖项定义 dep.folders.source_folder。如果没有此配置，对于那些不需要从源文件构建的依赖项，以及那些不需要构建的命令（例如 conan graph），所述变量将不会被定义。

注意

如果您的自定义部署器需要访问完整的依赖图，包括可能被跳过的库，请使用 tools.graph:skip_binaries=False 配置。这对于收集例如图表中所有许可证非常有用。