从所有依赖项复制源代码¶

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

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

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

注意

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

查找部署器¶

在本例中，部署器位于与我们的示例 conanfile 相同的目录中，但如部署器参考中所示，Conan 将按顺序在几个额外位置查找指定的部署器，即

绝对路径
相对于 cwd
在 [CONAN_HOME]/extensions/deployers 文件夹中
内置部署器

运行它¶

对于我们的示例，我们有一个简单的食谱，将 zlib 和 mcap 都列为依赖项。借助 tools.build:download_source=True 配置，我们可以强制调用其 source() 方法，这将确保即使不需要执行构建也能获得源代码。

现在，您应该能够在任何给定食谱的 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() 方法，并将其依赖项图和输出文件夹路径作为参数。它迭代我们食谱的所有依赖项，并将每个源文件复制到 dependencies_sources 下的各自文件夹中，使用 conan.tools.copy。

注意

如果您将此部署器用作您自己的示例，请记住 tools.build:download_source=True 是必需的，以便为依赖项定义 dep.folders.source_folder。如果没有此配置，对于那些不需要从源代码构建的依赖项或那些不需要构建的命令（例如 conan graph）来说，该变量将不会被定义。

注意

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