conan.tools.files 补丁¶

conan.tools.files.patch()¶

patch(conanfile, base_path=None, patch_file=None, patch_string=None, strip=0, fuzz=False, **kwargs)¶

在 conanfile.source_folder 目录中从文件 (patch_file) 或字符串 (patch_string) 应用差异。包含源文件的文件夹可以使用 layout(self) 方法中的 self.folders 属性进行自定义。

参数:

conanfile – 当前 recipe，始终传递 ‘self’
base_path – 路径是相对于 conanfile.export_sources_folder 的相对路径，除非提供了绝对路径。
patch_file – 应应用的补丁文件。路径是相对于 conanfile.source_folder 的相对路径，除非提供了绝对路径。
patch_string – 应应用的补丁字符串。
strip – 从路径中剥离的文件夹数量。
fuzz – 是否应接受模糊补丁。
kwargs – 可以添加的额外参数，将有助于输出信息

用法

from conan.tools.files import patch

def build(self):
    for it in self.conan_data.get("patches", {}).get(self.version, []):
        patch(self, **it)

conan.tools.files.apply_conandata_patches()¶

apply_conandata_patches(conanfile)¶

应用存储在 conanfile.conan_data (从 conandata.yml 文件读取) 中的补丁。它将应用与给定 conanfile.version 匹配的 patches 条目下的所有补丁。如果 conandata.yml 中未定义版本，它将直接应用 patches 关键字下的所有补丁。

关键条目将作为 kwargs 传递给 patch 函数。

用法

from conan.tools.files import apply_conandata_patches

def build(self):
    apply_conandata_patches(self)

conandata.yml 的示例

patches:
- patch_file: "patches/0001-buildflatbuffers-cmake.patch"
- patch_file: "patches/0002-implicit-copy-constructor.patch"
  base_path: "subfolder"
  patch_type: backport
  patch_source: https://github.com/google/flatbuffers/pull/5650
  patch_description: Needed to build with modern clang compilers.

针对不同版本的不同补丁

patches:
  "1.11.0":
    - patch_file: "patches/0001-buildflatbuffers-cmake.patch"
    - patch_file: "patches/0002-implicit-copy-constructor.patch"
      base_path: "subfolder"
      patch_type: backport
      patch_source: https://github.com/google/flatbuffers/pull/5650
      patch_description: Needed to build with modern clang compilers.
  "1.12.0":
    - patch_file: "patches/0001-buildflatbuffers-cmake.patch"
    - patch_string: |
        --- a/tests/misc-test.c
        +++ b/tests/misc-test.c
        @@ -1232,6 +1292,8 @@ main (int argc, char **argv)
              g_test_add_func ("/misc/pause-cancel", do_pause_cancel_test);
              g_test_add_data_func ("/misc/stealing/async", GINT_TO_POINTER (FALSE), do_stealing_test);
              g_test_add_data_func ("/misc/stealing/sync", GINT_TO_POINTER (TRUE), do_stealing_test);
        +     g_test_add_func ("/misc/response/informational/content-length", do_response_informational_content_length_test);
        +

        ret = g_test_run ();
    - patch_file: "patches/0003-fix-content-length-calculation.patch"

对于每个补丁，必须提供 patch_file、patch_string 或 patch_user 字段。前两个由 apply_conandata_patches() 自动应用，而 patch_user 将被忽略，并且必须由用户直接在 conanfile.py recipe 中处理。

conan.tools.files.export_conandata_patches()¶

export_conandata_patches(conanfile)¶: 导出存储在 ‘conanfile.conan_data’ (从 ‘conandata.yml’ 文件读取) 中的补丁。它将导出与给定 ‘conanfile.version’ 匹配的 ‘patches’ 条目下的所有补丁。如果 ‘conandata.yml’ 中未定义版本，它将直接导出 ‘patches’ 关键字下的所有补丁。

没有定义版本的 conandata.yml 示例

from conan.tools.files import export_conandata_patches
def export_sources(self):
    export_conandata_patches(self)

core.sources.patch:extra_path¶

警告

此功能为实验性功能，可能会有破坏性更改。有关更多信息，请参阅 Conan 稳定性部分。

export_conandata_patches() 工具可以在包创建时使用 core.sources.patch:extra_path 核心配置自动从外部路径注入补丁。

这意味着 conan-center-index 仓库中的 conan create 命令可以注入和应用补丁，而无需将补丁放在同一仓库中，也无需修改 conandata.yml 文件。

core.sources.patch:extra_path 配置应指向一个文件夹，其中包含所有可能包的所有可能的额外补丁，并按包名称结构化，遵循与 conan-center-index 仓库相同的约定

extra_folder
    pkgname1
       conandata.yml
       patches
          mypatch.path
    pkgname2
       ...

conandata.yml 也应遵循相同的结构

patches:
    "1.0":
        - patch_file: "patches/mypatch.patch"

注意

在安装任意依赖项 (conan install --build=xxx) 时，无法将补丁应用于它们，因为可能注入的补丁是包的“source”标识的一部分，并且必须在其 recipe 修订版本中表示。缓存或远程服务器中已存在的包已导出其文件并计算了 recipe 修订版本，因此在不违反包的标识 (以及因此的可重现性和可追溯性) 的情况下，无法在此处应用补丁。结论是，core.sources.patch:extra_path 只能在 conan create 时起作用。