source()¶

source() 方法可用于检索从源代码构建软件包所需的源代码，并在必要时将补丁应用于此类源代码。当从源代码构建软件包时，例如使用 conan create 或 conan install --build=pkg* 时，将调用它，但如果正在使用软件包预编译的二进制文件，则不会调用它。这意味着如果存在预编译的二进制文件，则不会下载源代码。

source() 方法可以实现不同的策略来检索源代码

获取第三方库的源代码
- 使用 Git(self).clone() 克隆 Git 仓库
- 执行 download() + unzip() 或组合的 get() （内部执行下载 + 解压缩）来下载 tarball、tgz 或 zip 存档。
从其仓库中获取自身的源代码，其坐标已在 export() 方法的 conandata.yml 文件中捕获。这是用于管理软件包源代码的策略，其中 conanfile.py 位于软件包本身中，但由于某种原因，我们不想将源代码放入 recipe 中（例如不分发我们的源代码，但能够分发我们的软件包二进制文件）。

source() 方法在 self.source_folder 中执行，当前工作目录将等于该文件夹（其值从 layout() 方法派生）。

source() 实现可以使用方便的 get() 助手，或使用其自己的机制或其他 Conan 助手来完成此任务，例如

import os
import shutil

from conan import ConanFile
from conan.tools.files import download, unzip, check_sha1


class PocoConan(ConanFile):
    name = "poco"
    version = "1.6.0"

    def source(self):
        zip_name = f"poco-{self.version}-release.zip"
        # Immutable source .zip
        download(self, f"https://github.com/pocoproject/poco/archive/poco-{self.version}-release.zip", zip_name)
        # Recommended practice, always check hashes of downloaded files
        check_sha1(self, zip_name, "8d87812ce591ced8ce3a022beec1df1c8b2fac87")
        unzip(self, zip_name)
        shutil.move(f"poco-poco-{self.version}-release", "poco")
        os.unlink(zip_name)

重要提示

请阅读 conan.tools.files.unzip() 中关于 Python 3.14 破坏性更改和新的 tar 存档提取过滤器的说明。

在 source() 方法中可以（并且应该）完成对下载的源代码应用补丁，如果这些补丁适用于所有可能的配置。如下所述，不可能在 source() 方法中引入条件。如果补丁是文件形式，则必须将这些补丁与 recipe 一起导出，以便在触发从源代码构建时可以使用它们。

可以使用以下方法应用补丁：

您自己的或 git 补丁实用程序
Conan 内置的 patch() 实用程序，用于显式地逐个应用补丁
应用 apply_conandata_patches() Conan 实用程序，以自动应用在 conandata.yml 文件中定义的遵循某些约定的所有补丁。

Source 缓存¶

一旦调用了 source() 方法，其结果将被缓存并在任何从源代码构建中重复使用，用于任何配置。这意味着从 source() 方法检索源代码应完全独立于配置。不可能在 settings 上实现条件，并且通常，任何尝试将任何条件逻辑应用于 source() 方法都是错误的。

def source(self):
    if self.settings.compiler == "gcc":  # ERROR, will raise
        # download some source

尝试通过使用其他机制来绕过 Conan 异常，例如

def source(self):
    # Might work, but NOT recommended, try to avoid as much as possible
    if platform.system() == "Windows":
        # download something
    else:
        # download something different

如果不进行任何交叉构建，并且不在不同的操作系统中重新收集源代码，则可能看起来可以工作，但否则可能会出现问题。

为了完全安全，如果不同的配置需要不同的源代码，建议的方法是在 build() 方法中有条件地检索该代码。

强制检索源代码¶

当在用户文件夹中使用 recipe 时，很容易调用 source() 方法并强制检索源代码，这将在同一用户文件夹中根据 layout() 定义完成

$ conan source .

使用 tools.build:download_source=True 配置，可以调用 source() 方法并强制在缓存中检索源代码，用于所有或某些依赖项，即使它们不是从源代码构建的。例如

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

将计算依赖关系图，然后为图中的所有“主机”软件包调用 source() 方法（由于默认配置是“主机”配置，如果您也想要“构建”上下文 tool_requires 的源代码，您可以使用 -c:b tools.build:download_source=True）。可以从 json 格式的输出中收集所有源文件夹，或者自动化收集所有源，可以使用 deployer。

同样，可以通过传递配置来检索其他 create 和 install 命令中软件包的源代码。最后，由于配置也可以按软件包定义，使用 -c mypkg*:tools.build:download_source=True 将仅检索与 mypkg* 模式匹配的软件包的源代码。

请注意，tools.build:download_source=True 对处于可编辑模式的软件包没有任何影响。在这种情况下下载源代码很容易覆盖和破坏开发人员对该代码的本地更改。conan source 命令必须在可编辑模式下的软件包上使用，才能下载源代码。

注意

最佳实践

source() 方法对于所有配置都应该是相同的，它不能受任何配置的条件限制。
source() 方法应检索不可变的源代码。使用某些分支名称、HEAD 或 URL 不是不可变的并且正在被覆盖的 tarball 是一种不良做法，并且会导致软件包损坏。使用 Git 提交、冻结的 Git 发布标签或固定的和版本化的发布 tarball 是预期的输入。
默认情况下，应用补丁应在 source() 方法中完成，除非补丁是某个配置独有的，在这种情况下，它们可以在 build() 方法中应用。
source() 方法不应访问或操作 self.source_folder 之外的其他文件夹中的文件。所有“导出”的文件在调用它之前都会复制到 self.source_folder。

另请参阅

有关更多信息，请参阅关于管理 recipe 源代码的教程。