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

将计算依赖图，然后为图中所有“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。

另请参阅

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