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() 方法中检索源应该完全独立于配置。不可能在 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

如果在不进行任何交叉构建并且不在不同的 OS 中重新收集源的情况下，可能看起来可以工作，但在其他情况下可能会有问题。

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

强制检索源¶

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

$ conan source .

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

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

将计算依赖关系图，然后为图中的所有 “host” 包调用 source() 方法（因为默认情况下配置是 “host” 配置，如果您也想要 “build” 上下文 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 源的教程。