source()¶

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

source() 方法可以实现不同的源代码获取策略

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

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() 方法中引入条件语句。如果补丁以文件形式存在，则必须将这些补丁与配方一起导出，以便在触发从源代码构建时可以使用它们。

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

您自己的或 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

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

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

强制获取源¶

当在用户文件夹中使用配方时，很容易调用 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 对处于 editable 模式的包没有任何影响。在这种情况下下载源代码很容易覆盖并破坏开发人员对该代码的本地更改。必须在 editable 模式的包上使用 conan source 命令来下载源代码。

注意

最佳实践

source() 方法应适用于所有配置，它不能依赖于任何配置。
source() 方法应获取不可变源。使用某些分支名称、HEAD 或 URL 不可变且正在被覆盖的 tarball 是一种不良实践，将导致包损坏。使用 Git 提交、冻结的 Git 发布标签或固定且版本化的发布 tarball 是预期的输入。
默认情况下，应在 source() 方法中应用补丁，除非补丁是某个配置专用的，在这种情况下可以在 build() 方法中应用。
source() 方法不应访问或操作 self.source_folder 以外文件夹中的文件。所有“导出”的文件在调用此方法之前都会复制到 self.source_folder。

另请参阅

有关更多信息，请参阅关于管理配方源的教程。