/
patches.py
107 lines (88 loc) · 4.11 KB
/
patches.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
import logging
import patch_ng
from conans.errors import ConanException
try:
from collections.abc import Iterable
except ImportError:
from collections import Iterable
class PatchLogHandler(logging.Handler):
def __init__(self, conanfile, patch_file):
logging.Handler.__init__(self, logging.DEBUG)
self._output = conanfile.output
self.patchname = patch_file or "patch_ng"
def emit(self, record):
logstr = self.format(record)
if record.levelno == logging.WARN:
self._output.warn("%s: %s" % (self.patchname, logstr))
else:
self._output.info("%s: %s" % (self.patchname, logstr))
def 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 base_path directory or current dir if None
:param base_path: Base path where the patch should be applied.
:param patch_file: Patch file that should be applied.
:param patch_string: Patch string that should be applied.
:param strip: Number of folders to be stripped from the path.
:param output: Stream object.
:param fuzz: Should accept fuzzy patches.
:param kwargs: Extra parameters that can be added and will contribute to output information
"""
patch_type = kwargs.get('patch_type')
patch_description = kwargs.get('patch_description')
if patch_type or patch_description:
patch_type_str = ' ({})'.format(patch_type) if patch_type else ''
patch_description_str = ': {}'.format(patch_description) if patch_description else ''
conanfile.output.info('Apply patch{}{}'.format(patch_type_str, patch_description_str))
patchlog = logging.getLogger("patch_ng")
patchlog.handlers = []
patchlog.addHandler(PatchLogHandler(conanfile, patch_file))
if patch_file:
patchset = patch_ng.fromfile(patch_file)
else:
patchset = patch_ng.fromstring(patch_string.encode())
if not patchset:
raise ConanException("Failed to parse patch: %s" % (patch_file if patch_file else "string"))
if not patchset.apply(root=base_path, strip=strip, fuzz=fuzz):
raise ConanException("Failed to apply patch: %s" % patch_file)
def 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.
Example of 'conandata.yml' without versions defined:
```
patches:
- patch_file: "patches/0001-buildflatbuffers-cmake.patch"
base_path: "source_subfolder"
- patch_file: "patches/0002-implicit-copy-constructor.patch"
base_path: "source_subfolder"
patch_type: backport
patch_source: https://github.com/google/flatbuffers/pull/5650
patch_description: Needed to build with modern clang compilers (adapted to 1.11.0 tagged sources).
```
Example of 'conandata.yml' with different patches for different versions:
```
patches:
"1.11.0":
- patch_file: "patches/0001-buildflatbuffers-cmake.patch"
base_path: "source_subfolder"
- patch_file: "patches/0002-implicit-copy-constructor.patch"
base_path: "source_subfolder"
patch_type: backport
patch_source: https://github.com/google/flatbuffers/pull/5650
patch_description: Needed to build with modern clang compilers (adapted to 1.11.0 tagged sources).
"1.12.0":
- patch_file: "patches/0001-buildflatbuffers-cmake.patch"
base_path: "source_subfolder"
```
"""
patches = conanfile.conan_data.get('patches')
if isinstance(patches, dict):
assert conanfile.version, "Can only be applied if conanfile.version is already defined"
entries = patches.get(conanfile.version, [])
for it in entries:
patch(conanfile, **it)
elif isinstance(patches, Iterable):
for it in patches:
patch(conanfile, **it)