conan.tools.files patches

conan.tools.files.patch()

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

Applies a diff from file (patch_file) or string (patch_string) in the conanfile.source_folder directory. The folder containing the sources can be customized with the self.folders attribute in the layout(self) method.

  • Parameters:

    • conanfile – the current recipe, always pass ‘self’

    • base_path – The path is a relative path to conanfile.export_sources_folder unless an absolute path is provided.

    • patch_file – Patch file that should be applied. The path is relative to the conanfile.source_folder unless an absolute path is provided.

    • patch_string – Patch string that should be applied.

    • strip – Number of folders to be stripped from the path.

    • fuzz – Should accept fuzzy patches.

    • kwargs – Extra parameters that can be added and will contribute to output information

Usage:

  1. from conan.tools.files import patch
  3. def build(self):
  4.     for it in self.conan_data.get("patches", {}).get(self.version, []):
  5.         patch(self, **it)

conan.tools.files.apply_conandata_patches()

apply_conandata_patches(conanfile)

Applies patches stored in conanfile.conan_data (read from conandata.yml file). It will apply all the patches under patches entry that matches the given conanfile.version. If versions are not defined in conandata.yml it will apply all the patches directly under patches keyword.

The key entries will be passed as kwargs to the patch function.

Usage:

  1. from conan.tools.files import apply_conandata_patches
  3. def build(self):
  4.     apply_conandata_patches(self)

Examples of conandata.yml:

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

With different patches for different versions:

  1. patches:
  2.   "1.11.0":
  3.     - patch_file: "patches/0001-buildflatbuffers-cmake.patch"
  4.     - patch_file: "patches/0002-implicit-copy-constructor.patch"
  5.       base_path: "subfolder"
  6.       patch_type: backport
  7.       patch_source: https://github.com/google/flatbuffers/pull/5650
  8.       patch_description: Needed to build with modern clang compilers.
  9.   "1.12.0":
  10.     - patch_file: "patches/0001-buildflatbuffers-cmake.patch"
  11.     - patch_string: |
  12.         --- a/tests/misc-test.c
  13.         +++ b/tests/misc-test.c
  14.         @@ -1232,6 +1292,8 @@ main (int argc, char **argv)
  15.               g_test_add_func ("/misc/pause-cancel", do_pause_cancel_test);
  16.               g_test_add_data_func ("/misc/stealing/async", GINT_TO_POINTER (FALSE), do_stealing_test);
  17.               g_test_add_data_func ("/misc/stealing/sync", GINT_TO_POINTER (TRUE), do_stealing_test);
  18.         +     g_test_add_func ("/misc/response/informational/content-length", do_response_informational_content_length_test);
  19.         +
  21.         ret = g_test_run ();
  22.     - patch_file: "patches/0003-fix-content-length-calculation.patch"

For each patch, a patch_file, a patch_string or a patch_user field must be provided. The first two are automatically applied by apply_conandata_patches(), while patch_user are ignored, and must be handled by the user directly in the conanfile.py recipe.

conan.tools.files.export_conandata_patches()

export_conandata_patches(conanfile)

Exports patches stored in ‘conanfile.conan_data’ (read from ‘conandata.yml’ file). It will export all the patches under ‘patches’ entry that matches the given ‘conanfile.version’. If versions are not defined in ‘conandata.yml’ it will export all the patches directly under ‘patches’ keyword.

Example of conandata.yml without versions defined:

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