• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

kivy / python-for-android / 18733541003

23 Oct 2025 12:18AM UTC coverage: 58.823% (+0.03%) from 58.795%
18733541003

Pull #3242

github

web-flow
Merge fbdf8c2e3 into 96112666e
Pull Request #3242: Remove distutils

1075 of 2436 branches covered (44.13%)

Branch coverage included in aggregate %.

5 of 10 new or added lines in 3 files covered. (50.0%)

14 existing lines in 1 file now uncovered.

5042 of 7963 relevant lines covered (63.32%)

5.05 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

44.86
/pythonforandroid/recipe.py
1
from os.path import basename, dirname, exists, isdir, isfile, join, realpath, split
8✔
2
import glob
8✔
3
import hashlib
8✔
4
import json
8✔
5
from re import match
8✔
6

7
import sh
8✔
8
import shutil
8✔
9
import fnmatch
8✔
10
import zipfile
8✔
11
import urllib.request
8✔
12
from urllib.request import urlretrieve
8✔
13
from os import listdir, unlink, environ, curdir, walk
8✔
14
from sys import stdout
8✔
15
from multiprocessing import cpu_count
8✔
16
import time
8✔
17
try:
8✔
18
    from urlparse import urlparse
8✔
19
except ImportError:
8✔
20
    from urllib.parse import urlparse
8✔
21

22
import packaging.version
8✔
23

24
from pythonforandroid.logger import (
8✔
25
    logger, info, warning, debug, shprint, info_main, error)
26
from pythonforandroid.util import (
8✔
27
    current_directory, ensure_dir, BuildInterruptingException, rmdir, move,
28
    touch, patch_wheel_setuptools_logging)
29
from pythonforandroid.util import load_source as import_recipe
8✔
30

31

32
url_opener = urllib.request.build_opener()
8✔
33
url_orig_headers = url_opener.addheaders
8✔
34
urllib.request.install_opener(url_opener)
8✔
35

36

37
class RecipeMeta(type):
8✔
38
    def __new__(cls, name, bases, dct):
8✔
39
        if name != 'Recipe':
8✔
40
            if 'url' in dct:
8✔
41
                dct['_url'] = dct.pop('url')
8✔
42
            if 'version' in dct:
8✔
43
                dct['_version'] = dct.pop('version')
8✔
44

45
        return super().__new__(cls, name, bases, dct)
8✔
46

47

48
class Recipe(metaclass=RecipeMeta):
8✔
49
    _url = None
8✔
50
    '''The address from which the recipe may be downloaded. This is not
6✔
51
    essential, it may be omitted if the source is available some other
52
    way, such as via the :class:`IncludedFilesBehaviour` mixin.
53

54
    If the url includes the version, you may (and probably should)
55
    replace this with ``{version}``, which will automatically be
56
    replaced by the :attr:`version` string during download.
57

58
    .. note:: Methods marked (internal) are used internally and you
59
              probably don't need to call them, but they are available
60
              if you want.
61
    '''
62

63
    _download_headers = None
8✔
64
    '''Add additional headers used when downloading the package, typically
6✔
65
    for authorization purposes.
66

67
    Specified as an array of tuples:
68
    [("header1", "foo"), ("header2", "bar")]
69

70
    When specifying as an environment variable (DOWNLOAD_HEADER_my-package-name), use a JSON formatted fragement:
71
    [["header1","foo"],["header2", "bar"]]
72

73
    For example, when downloading from a private
74
    github repository, you can specify the following:
75
    [('Authorization', 'token <your personal access token>'), ('Accept', 'application/vnd.github+json')]
76
    '''
77

78
    _version = None
8✔
79
    '''A string giving the version of the software the recipe describes,
6✔
80
    e.g. ``2.0.3`` or ``master``.'''
81

82
    md5sum = None
8✔
83
    '''The md5sum of the source from the :attr:`url`. Non-essential, but
6✔
84
    you should try to include this, it is used to check that the download
85
    finished correctly.
86
    '''
87

88
    sha512sum = None
8✔
89
    '''The sha512sum of the source from the :attr:`url`. Non-essential, but
6✔
90
    you should try to include this, it is used to check that the download
91
    finished correctly.
92
    '''
93

94
    blake2bsum = None
8✔
95
    '''The blake2bsum of the source from the :attr:`url`. Non-essential, but
6✔
96
    you should try to include this, it is used to check that the download
97
    finished correctly.
98
    '''
99

100
    depends = []
8✔
101
    '''A list containing the names of any recipes that this recipe depends on.
6✔
102
    '''
103

104
    conflicts = []
8✔
105
    '''A list containing the names of any recipes that are known to be
6✔
106
    incompatible with this one.'''
107

108
    opt_depends = []
8✔
109
    '''A list of optional dependencies, that must be built before this
6✔
110
    recipe if they are built at all, but whose presence is not essential.'''
111

112
    patches = []
8✔
113
    '''A list of patches to apply to the source. Values can be either a string
6✔
114
    referring to the patch file relative to the recipe dir, or a tuple of the
115
    string patch file and a callable, which will receive the kwargs `arch` and
116
    `recipe`, which should return True if the patch should be applied.'''
117

118
    python_depends = []
8✔
119
    '''A list of pure-Python packages that this package requires. These
6✔
120
    packages will NOT be available at build time, but will be added to the
121
    list of pure-Python packages to install via pip. If you need these packages
122
    at build time, you must create a recipe.'''
123

124
    archs = ['armeabi']  # Not currently implemented properly
8✔
125

126
    built_libraries = {}
8✔
127
    """Each recipe that builds a system library (e.g.:libffi, openssl, etc...)
6✔
128
    should contain a dict holding the relevant information of the library. The
129
    keys should be the generated libraries and the values the relative path of
130
    the library inside his build folder. This dict will be used to perform
131
    different operations:
132

133
        - copy the library into the right location, depending on if it's shared
134
          or static)
135
        - check if we have to rebuild the library
136

137
    Here an example of how it would look like for `libffi` recipe:
138

139
        - `built_libraries = {'libffi.so': '.libs'}`
140

141
    .. note:: in case that the built library resides in recipe's build
142
              directory, you can set the following values for the relative
143
              path: `'.', None or ''`
144
    """
145

146
    need_stl_shared = False
8✔
147
    '''Some libraries or python packages may need the c++_shared in APK.
6✔
148
    We can automatically do this for any recipe if we set this property to
149
    `True`'''
150

151
    stl_lib_name = 'c++_shared'
8✔
152
    '''
6✔
153
    The default STL shared lib to use: `c++_shared`.
154

155
    .. note:: Android NDK version > 17 only supports 'c++_shared', because
156
        starting from NDK r18 the `gnustl_shared` lib has been deprecated.
157
    '''
158

159
    min_ndk_api_support = 20
8✔
160
    '''
6✔
161
    Minimum ndk api recipe will support.
162
    '''
163

164
    def get_stl_library(self, arch):
8✔
165
        return join(
8✔
166
            arch.ndk_lib_dir,
167
            'lib{name}.so'.format(name=self.stl_lib_name),
168
        )
169

170
    def install_stl_lib(self, arch):
8✔
171
        if not self.ctx.has_lib(
8!
172
            arch.arch, 'lib{name}.so'.format(name=self.stl_lib_name)
173
        ):
174
            self.install_libs(arch, self.get_stl_library(arch))
8✔
175

176
    @property
8✔
177
    def version(self):
8✔
178
        key = 'VERSION_' + self.name
8✔
179
        return environ.get(key, self._version)
8✔
180

181
    @property
8✔
182
    def url(self):
8✔
183
        key = 'URL_' + self.name
8✔
184
        return environ.get(key, self._url)
8✔
185

186
    @property
8✔
187
    def versioned_url(self):
8✔
188
        '''A property returning the url of the recipe with ``{version}``
189
        replaced by the :attr:`url`. If accessing the url, you should use this
190
        property, *not* access the url directly.'''
191
        if self.url is None:
8!
192
            return None
×
193
        return self.url.format(version=self.version)
8✔
194

195
    @property
8✔
196
    def download_headers(self):
8✔
197
        key = "DOWNLOAD_HEADERS_" + self.name
8✔
198
        env_headers = environ.get(key)
8✔
199
        if env_headers:
8✔
200
            try:
8✔
201
                return [tuple(h) for h in json.loads(env_headers)]
8✔
202
            except Exception as ex:
×
203
                raise ValueError(f'Invalid Download headers for {key} - must be JSON formatted as [["header1","foo"],["header2","bar"]]: {ex}')
×
204

205
        return environ.get(key, self._download_headers)
8✔
206

207
    def download_file(self, url, target, cwd=None):
8✔
208
        """
209
        (internal) Download an ``url`` to a ``target``.
210
        """
211
        if not url:
8!
212
            return
×
213

214
        info('Downloading {} from {}'.format(self.name, url))
8✔
215

216
        if cwd:
8!
217
            target = join(cwd, target)
×
218

219
        parsed_url = urlparse(url)
8✔
220
        if parsed_url.scheme in ('http', 'https'):
8!
221
            def report_hook(index, blksize, size):
8✔
222
                if size <= 0:
×
223
                    progression = '{0} bytes'.format(index * blksize)
×
224
                else:
225
                    progression = '{0:.2f}%'.format(
×
226
                        index * blksize * 100. / float(size))
227
                if "CI" not in environ:
×
228
                    stdout.write('- Download {}\r'.format(progression))
×
229
                    stdout.flush()
×
230

231
            if exists(target):
8!
232
                unlink(target)
×
233

234
            # Download item with multiple attempts (for bad connections):
235
            attempts = 0
8✔
236
            seconds = 1
8✔
237
            while True:
6✔
238
                try:
8✔
239
                    # jqueryui.com returns a 403 w/ the default user agent
240
                    # Mozilla/5.0 does not handle redirection for liblzma
241
                    url_opener.addheaders = [('User-agent', 'Wget/1.0')]
8✔
242
                    if self.download_headers:
8!
243
                        url_opener.addheaders += self.download_headers
×
244
                    urlretrieve(url, target, report_hook)
8✔
245
                except OSError as e:
8✔
246
                    attempts += 1
8✔
247
                    if attempts >= 5:
8✔
248
                        raise
8✔
249
                    stdout.write('Download failed: {}; retrying in {} second(s)...'.format(e, seconds))
8✔
250
                    time.sleep(seconds)
8✔
251
                    seconds *= 2
8✔
252
                    continue
8✔
253
                finally:
254
                    url_opener.addheaders = url_orig_headers
8✔
255
                break
8✔
256
            return target
8✔
257
        elif parsed_url.scheme in ('git', 'git+file', 'git+ssh', 'git+http', 'git+https'):
×
258
            if not isdir(target):
×
259
                if url.startswith('git+'):
×
260
                    url = url[4:]
×
261
                # if 'version' is specified, do a shallow clone
262
                if self.version:
×
263
                    ensure_dir(target)
×
264
                    with current_directory(target):
×
265
                        shprint(sh.git, 'init')
×
266
                        shprint(sh.git, 'remote', 'add', 'origin', url)
×
267
                else:
268
                    shprint(sh.git, 'clone', '--recursive', url, target)
×
269
            with current_directory(target):
×
270
                if self.version:
×
271
                    shprint(sh.git, 'fetch', '--tags', '--depth', '1')
×
272
                    shprint(sh.git, 'checkout', self.version)
×
273
                branch = sh.git('branch', '--show-current')
×
274
                if branch:
×
275
                    shprint(sh.git, 'pull')
×
276
                    shprint(sh.git, 'pull', '--recurse-submodules')
×
277
                shprint(sh.git, 'submodule', 'update', '--recursive', '--init', '--depth', '1')
×
278
            return target
×
279

280
    def apply_patch(self, filename, arch, build_dir=None):
8✔
281
        """
282
        Apply a patch from the current recipe directory into the current
283
        build directory.
284

285
        .. versionchanged:: 0.6.0
286
            Add ability to apply patch from any dir via kwarg `build_dir`'''
287
        """
288
        info("Applying patch {}".format(filename))
8✔
289
        build_dir = build_dir if build_dir else self.get_build_dir(arch)
8✔
290
        filename = join(self.get_recipe_dir(), filename)
8✔
291
        shprint(sh.patch, "-t", "-d", build_dir, "-p1",
8✔
292
                "-i", filename, _tail=10)
293

294
    def copy_file(self, filename, dest):
8✔
295
        info("Copy {} to {}".format(filename, dest))
×
296
        filename = join(self.get_recipe_dir(), filename)
×
297
        dest = join(self.build_dir, dest)
×
298
        shutil.copy(filename, dest)
×
299

300
    def append_file(self, filename, dest):
8✔
301
        info("Append {} to {}".format(filename, dest))
×
302
        filename = join(self.get_recipe_dir(), filename)
×
303
        dest = join(self.build_dir, dest)
×
304
        with open(filename, "rb") as fd:
×
305
            data = fd.read()
×
306
        with open(dest, "ab") as fd:
×
307
            fd.write(data)
×
308

309
    @property
8✔
310
    def name(self):
8✔
311
        '''The name of the recipe, the same as the folder containing it.'''
312
        modname = self.__class__.__module__
8✔
313
        return modname.split(".", 2)[-1]
8✔
314

315
    @property
8✔
316
    def filtered_archs(self):
8✔
317
        '''Return archs of self.ctx that are valid build archs
318
        for the Recipe.'''
319
        result = []
×
320
        for arch in self.ctx.archs:
×
321
            if not self.archs or (arch.arch in self.archs):
×
322
                result.append(arch)
×
323
        return result
×
324

325
    def check_recipe_choices(self):
8✔
326
        '''Checks what recipes are being built to see which of the alternative
327
        and optional dependencies are being used,
328
        and returns a list of these.'''
329
        recipes = []
8✔
330
        built_recipes = self.ctx.recipe_build_order
8✔
331
        for recipe in self.depends:
8✔
332
            if isinstance(recipe, (tuple, list)):
8!
333
                for alternative in recipe:
×
334
                    if alternative in built_recipes:
×
335
                        recipes.append(alternative)
×
336
                        break
×
337
        for recipe in self.opt_depends:
8✔
338
            if recipe in built_recipes:
8!
339
                recipes.append(recipe)
×
340
        return sorted(recipes)
8✔
341

342
    def get_opt_depends_in_list(self, recipes):
8✔
343
        '''Given a list of recipe names, returns those that are also in
344
        self.opt_depends.
345
        '''
346
        return [recipe for recipe in recipes if recipe in self.opt_depends]
8✔
347

348
    def get_build_container_dir(self, arch):
8✔
349
        '''Given the arch name, returns the directory where it will be
350
        built.
351

352
        This returns a different directory depending on what
353
        alternative or optional dependencies are being built.
354
        '''
355
        dir_name = self.get_dir_name()
8✔
356
        return join(self.ctx.build_dir, 'other_builds',
8✔
357
                    dir_name, '{}__ndk_target_{}'.format(arch, self.ctx.ndk_api))
358

359
    def get_dir_name(self):
8✔
360
        choices = self.check_recipe_choices()
8✔
361
        dir_name = '-'.join([self.name] + choices)
8✔
362
        return dir_name
8✔
363

364
    def get_build_dir(self, arch):
8✔
365
        '''Given the arch name, returns the directory where the
366
        downloaded/copied package will be built.'''
367

368
        return join(self.get_build_container_dir(arch), self.name)
8✔
369

370
    def get_recipe_dir(self):
8✔
371
        """
372
        Returns the local recipe directory or defaults to the core recipe
373
        directory.
374
        """
375
        if self.ctx.local_recipes is not None:
8!
376
            local_recipe_dir = join(self.ctx.local_recipes, self.name)
×
377
            if exists(local_recipe_dir):
×
378
                return local_recipe_dir
×
379
        return join(self.ctx.root_dir, 'recipes', self.name)
8✔
380

381
    # Public Recipe API to be subclassed if needed
382

383
    def download_if_necessary(self):
8✔
384
        if self.ctx.ndk_api < self.min_ndk_api_support:
8!
385
            error(f"In order to build '{self.name}', you must set minimum ndk api (minapi) to `{self.min_ndk_api_support}`.\n")
×
386
            exit(1)
×
387
        info_main('Downloading {}'.format(self.name))
8✔
388
        user_dir = environ.get('P4A_{}_DIR'.format(self.name.lower()))
8✔
389
        if user_dir is not None:
8✔
390
            info('P4A_{}_DIR is set, skipping download for {}'.format(
8✔
391
                self.name, self.name))
392
            return
8✔
393
        self.download()
8✔
394

395
    def download(self):
8✔
396
        if self.url is None:
8✔
397
            info('Skipping {} download as no URL is set'.format(self.name))
8✔
398
            return
8✔
399

400
        url = self.versioned_url
8✔
401
        expected_digests = {}
8✔
402
        for alg in set(hashlib.algorithms_guaranteed) | set(('md5', 'sha512', 'blake2b')):
8✔
403
            expected_digest = getattr(self, alg + 'sum') if hasattr(self, alg + 'sum') else None
8✔
404
            ma = match(u'^(.+)#' + alg + u'=([0-9a-f]{32,})$', url)
8✔
405
            if ma:                # fragmented URL?
8!
406
                if expected_digest:
×
407
                    raise ValueError(
×
408
                        ('Received {}sum from both the {} recipe '
409
                         'and its url').format(alg, self.name))
410
                url = ma.group(1)
×
411
                expected_digest = ma.group(2)
×
412
            if expected_digest:
8!
413
                expected_digests[alg] = expected_digest
×
414

415
        ensure_dir(join(self.ctx.packages_path, self.name))
8✔
416

417
        with current_directory(join(self.ctx.packages_path, self.name)):
8✔
418
            filename = shprint(sh.basename, url).stdout[:-1].decode('utf-8')
8✔
419

420
            do_download = True
8✔
421
            marker_filename = '.mark-{}'.format(filename)
8✔
422
            if exists(filename) and isfile(filename):
8!
423
                if not exists(marker_filename):
×
424
                    shprint(sh.rm, filename)
×
425
                else:
426
                    for alg, expected_digest in expected_digests.items():
×
427
                        current_digest = algsum(alg, filename)
×
428
                        if current_digest != expected_digest:
×
429
                            debug('* Generated {}sum: {}'.format(alg,
×
430
                                                                 current_digest))
431
                            debug('* Expected {}sum: {}'.format(alg,
×
432
                                                                expected_digest))
433
                            raise ValueError(
×
434
                                ('Generated {0}sum does not match expected {0}sum '
435
                                 'for {1} recipe').format(alg, self.name))
436
                    do_download = False
×
437

438
            # If we got this far, we will download
439
            if do_download:
8!
440
                debug('Downloading {} from {}'.format(self.name, url))
8✔
441

442
                shprint(sh.rm, '-f', marker_filename)
8✔
443
                self.download_file(self.versioned_url, filename)
8✔
444
                touch(marker_filename)
8✔
445

446
                if exists(filename) and isfile(filename):
8!
447
                    for alg, expected_digest in expected_digests.items():
×
448
                        current_digest = algsum(alg, filename)
×
449
                        if current_digest != expected_digest:
×
450
                            debug('* Generated {}sum: {}'.format(alg,
×
451
                                                                 current_digest))
452
                            debug('* Expected {}sum: {}'.format(alg,
×
453
                                                                expected_digest))
454
                            raise ValueError(
×
455
                                ('Generated {0}sum does not match expected {0}sum '
456
                                 'for {1} recipe').format(alg, self.name))
457
            else:
458
                info('{} download already cached, skipping'.format(self.name))
×
459

460
    def unpack(self, arch):
8✔
461
        info_main('Unpacking {} for {}'.format(self.name, arch))
×
462

463
        build_dir = self.get_build_container_dir(arch)
×
464

465
        user_dir = environ.get('P4A_{}_DIR'.format(self.name.lower()))
×
466
        if user_dir is not None:
×
467
            info('P4A_{}_DIR exists, symlinking instead'.format(
×
468
                self.name.lower()))
469
            if exists(self.get_build_dir(arch)):
×
470
                return
×
471
            rmdir(build_dir)
×
472
            ensure_dir(build_dir)
×
473
            shprint(sh.cp, '-a', user_dir, self.get_build_dir(arch))
×
474
            return
×
475

476
        if self.url is None:
×
477
            info('Skipping {} unpack as no URL is set'.format(self.name))
×
478
            return
×
479

480
        filename = shprint(
×
481
            sh.basename, self.versioned_url).stdout[:-1].decode('utf-8')
482
        ma = match(u'^(.+)#[a-z0-9_]{3,}=([0-9a-f]{32,})$', filename)
×
483
        if ma:                  # fragmented URL?
×
484
            filename = ma.group(1)
×
485

486
        with current_directory(build_dir):
×
487
            directory_name = self.get_build_dir(arch)
×
488

489
            if not exists(directory_name) or not isdir(directory_name):
×
490
                extraction_filename = join(
×
491
                    self.ctx.packages_path, self.name, filename)
492
                if isfile(extraction_filename):
×
493
                    if extraction_filename.endswith(('.zip', '.whl')):
×
494
                        try:
×
495
                            sh.unzip(extraction_filename)
×
496
                        except (sh.ErrorReturnCode_1, sh.ErrorReturnCode_2):
×
497
                            # return code 1 means unzipping had
498
                            # warnings but did complete,
499
                            # apparently happens sometimes with
500
                            # github zips
501
                            pass
×
502
                        fileh = zipfile.ZipFile(extraction_filename, 'r')
×
503
                        root_directory = fileh.filelist[0].filename.split('/')[0]
×
504
                        if root_directory != basename(directory_name):
×
505
                            move(root_directory, directory_name)
×
506
                    elif extraction_filename.endswith(
×
507
                            ('.tar.gz', '.tgz', '.tar.bz2', '.tbz2', '.tar.xz', '.txz')):
508
                        sh.tar('xf', extraction_filename)
×
509
                        root_directory = sh.tar('tf', extraction_filename).split('\n')[0].split('/')[0]
×
510
                        if root_directory != basename(directory_name):
×
511
                            move(root_directory, directory_name)
×
512
                    else:
513
                        raise Exception(
×
514
                            'Could not extract {} download, it must be .zip, '
515
                            '.tar.gz or .tar.bz2 or .tar.xz'.format(extraction_filename))
516
                elif isdir(extraction_filename):
×
517
                    ensure_dir(directory_name)
×
518
                    for entry in listdir(extraction_filename):
×
519
                        # Previously we filtered out the .git folder, but during the build process for some recipes
520
                        # (e.g. when version is parsed by `setuptools_scm`) that may be needed.
521
                        shprint(sh.cp, '-R',
×
522
                                join(extraction_filename, entry),
523
                                directory_name)
524
                else:
525
                    raise Exception(
×
526
                        'Given path is neither a file nor a directory: {}'
527
                        .format(extraction_filename))
528

529
            else:
530
                info('{} is already unpacked, skipping'.format(self.name))
×
531

532
    def get_recipe_env(self, arch=None, with_flags_in_cc=True):
8✔
533
        """Return the env specialized for the recipe
534
        """
535
        if arch is None:
8!
536
            arch = self.filtered_archs[0]
×
537
        env = arch.get_env(with_flags_in_cc=with_flags_in_cc)
8✔
538
        return env
8✔
539

540
    def prebuild_arch(self, arch):
8✔
541
        '''Run any pre-build tasks for the Recipe. By default, this checks if
542
        any prebuild_archname methods exist for the archname of the current
543
        architecture, and runs them if so.'''
544
        prebuild = "prebuild_{}".format(arch.arch.replace('-', '_'))
8✔
545
        if hasattr(self, prebuild):
8!
546
            getattr(self, prebuild)()
×
547
        else:
548
            info('{} has no {}, skipping'.format(self.name, prebuild))
8✔
549

550
    def is_patched(self, arch):
8✔
551
        build_dir = self.get_build_dir(arch.arch)
×
552
        return exists(join(build_dir, '.patched'))
×
553

554
    def apply_patches(self, arch, build_dir=None):
8✔
555
        '''Apply any patches for the Recipe.
556

557
        .. versionchanged:: 0.6.0
558
            Add ability to apply patches from any dir via kwarg `build_dir`'''
559
        if self.patches:
×
560
            info_main('Applying patches for {}[{}]'
×
561
                      .format(self.name, arch.arch))
562

563
            if self.is_patched(arch):
×
564
                info_main('{} already patched, skipping'.format(self.name))
×
565
                return
×
566

567
            build_dir = build_dir if build_dir else self.get_build_dir(arch.arch)
×
568
            for patch in self.patches:
×
569
                if isinstance(patch, (tuple, list)):
×
570
                    patch, patch_check = patch
×
571
                    if not patch_check(arch=arch, recipe=self):
×
572
                        continue
×
573

574
                self.apply_patch(
×
575
                        patch.format(version=self.version, arch=arch.arch),
576
                        arch.arch, build_dir=build_dir)
577

578
            touch(join(build_dir, '.patched'))
×
579

580
    def should_build(self, arch):
8✔
581
        '''Should perform any necessary test and return True only if it needs
582
        building again. Per default we implement a library test, in case that
583
        we detect so.
584
        '''
585
        if self.built_libraries:
8!
586
            return not all(
8✔
587
                exists(lib) for lib in self.get_libraries(arch.arch)
588
            )
589
        return True
×
590

591
    def build_arch(self, arch):
8✔
592
        '''Run any build tasks for the Recipe. By default, this checks if
593
        any build_archname methods exist for the archname of the current
594
        architecture, and runs them if so.'''
595
        build = "build_{}".format(arch.arch)
×
596
        if hasattr(self, build):
×
597
            getattr(self, build)()
×
598

599
    def install_libraries(self, arch):
8✔
600
        '''This method is always called after `build_arch`. In case that we
601
        detect a library recipe, defined by the class attribute
602
        `built_libraries`, we will copy all defined libraries into the
603
        right location.
604
        '''
605
        if not self.built_libraries:
8!
606
            return
×
607
        shared_libs = [
8✔
608
            lib for lib in self.get_libraries(arch) if lib.endswith(".so")
609
        ]
610
        self.install_libs(arch, *shared_libs)
8✔
611

612
    def postbuild_arch(self, arch):
8✔
613
        '''Run any post-build tasks for the Recipe. By default, this checks if
614
        any postbuild_archname methods exist for the archname of the
615
        current architecture, and runs them if so.
616
        '''
617
        postbuild = "postbuild_{}".format(arch.arch)
8✔
618
        if hasattr(self, postbuild):
8!
619
            getattr(self, postbuild)()
×
620

621
        if self.need_stl_shared:
8!
622
            self.install_stl_lib(arch)
8✔
623

624
    def prepare_build_dir(self, arch):
8✔
625
        '''Copies the recipe data into a build dir for the given arch. By
626
        default, this unpacks a downloaded recipe. You should override
627
        it (or use a Recipe subclass with different behaviour) if you
628
        want to do something else.
629
        '''
630
        self.unpack(arch)
×
631

632
    def clean_build(self, arch=None):
8✔
633
        '''Deletes all the build information of the recipe.
634

635
        If arch is not None, only this arch dir is deleted. Otherwise
636
        (the default) all builds for all archs are deleted.
637

638
        By default, this just deletes the main build dir. If the
639
        recipe has e.g. object files biglinked, or .so files stored
640
        elsewhere, you should override this method.
641

642
        This method is intended for testing purposes, it may have
643
        strange results. Rebuild everything if this seems to happen.
644

645
        '''
646
        if arch is None:
×
647
            base_dir = join(self.ctx.build_dir, 'other_builds', self.name)
×
648
        else:
649
            base_dir = self.get_build_container_dir(arch)
×
650
        dirs = glob.glob(base_dir + '-*')
×
651
        if exists(base_dir):
×
652
            dirs.append(base_dir)
×
653
        if not dirs:
×
654
            warning('Attempted to clean build for {} but found no existing '
×
655
                    'build dirs'.format(self.name))
656

657
        for directory in dirs:
×
658
            rmdir(directory)
×
659

660
        # Delete any Python distributions to ensure the recipe build
661
        # doesn't persist in site-packages
662
        rmdir(self.ctx.python_installs_dir)
×
663

664
    def install_libs(self, arch, *libs):
8✔
665
        libs_dir = self.ctx.get_libs_dir(arch.arch)
8✔
666
        if not libs:
8!
667
            warning('install_libs called with no libraries to install!')
×
668
            return
×
669
        args = libs + (libs_dir,)
8✔
670
        shprint(sh.cp, *args)
8✔
671

672
    def has_libs(self, arch, *libs):
8✔
673
        return all(map(lambda lib: self.ctx.has_lib(arch.arch, lib), libs))
×
674

675
    def get_libraries(self, arch_name, in_context=False):
8✔
676
        """Return the full path of the library depending on the architecture.
677
        Per default, the build library path it will be returned, unless
678
        `get_libraries` has been called with kwarg `in_context` set to
679
        True.
680

681
        .. note:: this method should be used for library recipes only
682
        """
683
        recipe_libs = set()
8✔
684
        if not self.built_libraries:
8!
685
            return recipe_libs
×
686
        for lib, rel_path in self.built_libraries.items():
8✔
687
            if not in_context:
8!
688
                abs_path = join(self.get_build_dir(arch_name), rel_path, lib)
8✔
689
                if rel_path in {".", "", None}:
8✔
690
                    abs_path = join(self.get_build_dir(arch_name), lib)
8✔
691
            else:
692
                abs_path = join(self.ctx.get_libs_dir(arch_name), lib)
×
693
            recipe_libs.add(abs_path)
8✔
694
        return recipe_libs
8✔
695

696
    @classmethod
8✔
697
    def recipe_dirs(cls, ctx):
8✔
698
        recipe_dirs = []
8✔
699
        if ctx.local_recipes is not None:
8✔
700
            recipe_dirs.append(realpath(ctx.local_recipes))
8✔
701
        if ctx.storage_dir:
8✔
702
            recipe_dirs.append(join(ctx.storage_dir, 'recipes'))
8✔
703
        recipe_dirs.append(join(ctx.root_dir, "recipes"))
8✔
704
        return recipe_dirs
8✔
705

706
    @classmethod
8✔
707
    def list_recipes(cls, ctx):
8✔
708
        forbidden_dirs = ('__pycache__', )
8✔
709
        for recipes_dir in cls.recipe_dirs(ctx):
8✔
710
            if recipes_dir and exists(recipes_dir):
8✔
711
                for name in listdir(recipes_dir):
8✔
712
                    if name in forbidden_dirs:
8✔
713
                        continue
8✔
714
                    fn = join(recipes_dir, name)
8✔
715
                    if isdir(fn):
8✔
716
                        yield name
8✔
717

718
    @classmethod
8✔
719
    def get_recipe(cls, name, ctx):
8✔
720
        '''Returns the Recipe with the given name, if it exists.'''
721
        name = name.lower()
8✔
722
        if not hasattr(cls, "recipes"):
8✔
723
            cls.recipes = {}
8✔
724
        if name in cls.recipes:
8✔
725
            return cls.recipes[name]
8✔
726

727
        recipe_file = None
8✔
728
        for recipes_dir in cls.recipe_dirs(ctx):
8✔
729
            if not exists(recipes_dir):
8✔
730
                continue
8✔
731
            # Find matching folder (may differ in case):
732
            for subfolder in listdir(recipes_dir):
8✔
733
                if subfolder.lower() == name:
8✔
734
                    recipe_file = join(recipes_dir, subfolder, '__init__.py')
8✔
735
                    if exists(recipe_file):
8!
736
                        name = subfolder  # adapt to actual spelling
8✔
737
                        break
8✔
738
                    recipe_file = None
×
739
            if recipe_file is not None:
8✔
740
                break
8✔
741

742
        else:
743
            raise ValueError('Recipe does not exist: {}'.format(name))
8✔
744

745
        mod = import_recipe('pythonforandroid.recipes.{}'.format(name), recipe_file)
8✔
746
        if len(logger.handlers) > 1:
8!
747
            logger.removeHandler(logger.handlers[1])
×
748
        recipe = mod.recipe
8✔
749
        recipe.ctx = ctx
8✔
750
        cls.recipes[name.lower()] = recipe
8✔
751
        return recipe
8✔
752

753

754
class IncludedFilesBehaviour(object):
8✔
755
    '''Recipe mixin class that will automatically unpack files included in
756
    the recipe directory.'''
757
    src_filename = None
8✔
758

759
    def prepare_build_dir(self, arch):
8✔
760
        if self.src_filename is None:
×
761
            raise BuildInterruptingException(
×
762
                'IncludedFilesBehaviour failed: no src_filename specified')
763
        rmdir(self.get_build_dir(arch))
×
764
        shprint(sh.cp, '-a', join(self.get_recipe_dir(), self.src_filename),
×
765
                self.get_build_dir(arch))
766

767

768
class BootstrapNDKRecipe(Recipe):
8✔
769
    '''A recipe class for recipes built in an Android project jni dir with
770
    an Android.mk. These are not cached separately, but built in the
771
    bootstrap's own building directory.
772

773
    To build an NDK project which is not part of the bootstrap, see
774
    :class:`~pythonforandroid.recipe.NDKRecipe`.
775

776
    To link with python, call the method :meth:`get_recipe_env`
777
    with the kwarg *with_python=True*.
778
    '''
779

780
    dir_name = None  # The name of the recipe build folder in the jni dir
8✔
781

782
    def get_build_container_dir(self, arch):
8✔
783
        return self.get_jni_dir()
×
784

785
    def get_build_dir(self, arch):
8✔
786
        if self.dir_name is None:
×
787
            raise ValueError('{} recipe doesn\'t define a dir_name, but '
×
788
                             'this is necessary'.format(self.name))
789
        return join(self.get_build_container_dir(arch), self.dir_name)
×
790

791
    def get_jni_dir(self):
8✔
792
        return join(self.ctx.bootstrap.build_dir, 'jni')
8✔
793

794
    def get_recipe_env(self, arch=None, with_flags_in_cc=True, with_python=False):
8✔
795
        env = super().get_recipe_env(arch, with_flags_in_cc)
×
796
        if not with_python:
×
797
            return env
×
798

799
        env['PYTHON_INCLUDE_ROOT'] = self.ctx.python_recipe.include_root(arch.arch)
×
800
        env['PYTHON_LINK_ROOT'] = self.ctx.python_recipe.link_root(arch.arch)
×
801
        env['EXTRA_LDLIBS'] = ' -lpython{}'.format(
×
802
            self.ctx.python_recipe.link_version)
803
        return env
×
804

805

806
class NDKRecipe(Recipe):
8✔
807
    '''A recipe class for any NDK project not included in the bootstrap.'''
808

809
    generated_libraries = []
8✔
810

811
    def should_build(self, arch):
8✔
812
        lib_dir = self.get_lib_dir(arch)
×
813

814
        for lib in self.generated_libraries:
×
815
            if not exists(join(lib_dir, lib)):
×
816
                return True
×
817

818
        return False
×
819

820
    def get_lib_dir(self, arch):
8✔
821
        return join(self.get_build_dir(arch.arch), 'obj', 'local', arch.arch)
8✔
822

823
    def get_jni_dir(self, arch):
8✔
824
        return join(self.get_build_dir(arch.arch), 'jni')
×
825

826
    def build_arch(self, arch, *extra_args):
8✔
827
        super().build_arch(arch)
×
828

829
        env = self.get_recipe_env(arch)
×
830
        with current_directory(self.get_build_dir(arch.arch)):
×
831
            shprint(
×
832
                sh.Command(join(self.ctx.ndk_dir, "ndk-build")),
833
                'V=1',
834
                "-j",
835
                str(cpu_count()),
836
                'NDK_DEBUG=' + ("1" if self.ctx.build_as_debuggable else "0"),
837
                'APP_PLATFORM=android-' + str(self.ctx.ndk_api),
838
                'APP_ABI=' + arch.arch,
839
                *extra_args, _env=env
840
            )
841

842

843
class PythonRecipe(Recipe):
8✔
844
    site_packages_name = None
8✔
845
    '''The name of the module's folder when installed in the Python
6✔
846
    site-packages (e.g. for pyjnius it is 'jnius')'''
847

848
    call_hostpython_via_targetpython = True
8✔
849
    '''If True, tries to install the module using the hostpython binary
6✔
850
    copied to the target (normally arm) python build dir. However, this
851
    will fail if the module tries to import e.g. _io.so. Set this to False
852
    to call hostpython from its own build dir, installing the module in
853
    the right place via arguments to setup.py. However, this may not set
854
    the environment correctly and so False is not the default.'''
855

856
    install_in_hostpython = False
8✔
857
    '''If True, additionally installs the module in the hostpython build
6✔
858
    dir. This will make it available to other recipes if
859
    call_hostpython_via_targetpython is False.
860
    '''
861

862
    install_in_targetpython = True
8✔
863
    '''If True, installs the module in the targetpython installation dir.
6✔
864
    This is almost always what you want to do.'''
865

866
    setup_extra_args = []
8✔
867
    '''List of extra arguments to pass to setup.py'''
6✔
868

869
    depends = ['python3']
8✔
870
    '''
6✔
871
    .. note:: it's important to keep this depends as a class attribute outside
872
              `__init__` because sometimes we only initialize the class, so the
873
              `__init__` call won't be called and the deps would be missing
874
              (which breaks the dependency graph computation)
875

876
    .. warning:: don't forget to call `super().__init__()` in any recipe's
877
                 `__init__`, or otherwise it may not be ensured that it depends
878
                 on python2 or python3 which can break the dependency graph
879
    '''
880

881
    hostpython_prerequisites = []
8✔
882
    '''List of hostpython packages required to build a recipe'''
6✔
883

884
    _host_recipe = None
8✔
885

886
    def __init__(self, *args, **kwargs):
8✔
887
        super().__init__(*args, **kwargs)
8✔
888
        if 'python3' not in self.depends:
8✔
889
            # We ensure here that the recipe depends on python even it overrode
890
            # `depends`. We only do this if it doesn't already depend on any
891
            # python, since some recipes intentionally don't depend on/work
892
            # with all python variants
893
            depends = self.depends
8✔
894
            depends.append('python3')
8✔
895
            depends = list(set(depends))
8✔
896
            self.depends = depends
8✔
897

898
    def prebuild_arch(self, arch):
8✔
899
        self._host_recipe = Recipe.get_recipe("hostpython3", self.ctx)
8✔
900
        return super().prebuild_arch(arch)
8✔
901

902
    def clean_build(self, arch=None):
8✔
903
        super().clean_build(arch=arch)
×
904
        name = self.folder_name
×
905
        python_install_dirs = glob.glob(join(self.ctx.python_installs_dir, '*'))
×
906
        for python_install in python_install_dirs:
×
907
            site_packages_dir = glob.glob(join(python_install, 'lib', 'python*',
×
908
                                               'site-packages'))
909
            if site_packages_dir:
×
910
                build_dir = join(site_packages_dir[0], name)
×
911
                if exists(build_dir):
×
912
                    info('Deleted {}'.format(build_dir))
×
913
                    rmdir(build_dir)
×
914

915
    @property
8✔
916
    def real_hostpython_location(self):
8✔
917
        host_name = 'host{}'.format(self.ctx.python_recipe.name)
8✔
918
        if host_name == 'hostpython3':
8!
919
            return self._host_recipe.python_exe
8✔
920
        else:
921
            python_recipe = self.ctx.python_recipe
×
922
            return 'python{}'.format(python_recipe.version)
×
923

924
    @property
8✔
925
    def hostpython_location(self):
8✔
926
        if not self.call_hostpython_via_targetpython:
×
927
            return self.real_hostpython_location
×
928
        return self.ctx.hostpython
×
929

930
    @property
8✔
931
    def folder_name(self):
8✔
932
        '''The name of the build folders containing this recipe.'''
933
        name = self.site_packages_name
×
934
        if name is None:
×
935
            name = self.name
×
936
        return name
×
937

938
    def patch_shebang(self, _file, original_bin):
8✔
939
        _file_des = open(_file, "r")
×
940

941
        try:
×
942
            data = _file_des.readlines()
×
943
        except UnicodeDecodeError:
×
944
            return
×
945

946
        if "#!" in (line := data[0]):
×
947
            if line.split("#!")[-1].strip() == original_bin:
×
948
                return
×
949

950
            info(f"Fixing shebang for '{_file}'")
×
951
            data.pop(0)
×
952
            data.insert(0, "#!" + original_bin + "\n")
×
953
            _file_des.close()
×
954
            _file_des = open(_file, "w")
×
955
            _file_des.write("".join(data))
×
956
            _file_des.close()
×
957

958
    def patch_shebangs(self, path, original_bin):
8✔
959
        if not isdir(path):
8!
960
            warning(f"Shebang patch skipped: '{path}' does not exist.")
8✔
961
            return
8✔
962
        # set correct shebang
963
        for file in listdir(path):
×
964
            _file = join(path, file)
×
965
            self.patch_shebang(_file, original_bin)
×
966

967
    def get_recipe_env(self, arch=None, with_flags_in_cc=True):
8✔
968
        if self._host_recipe is None:
8!
969
            self._host_recipe = Recipe.get_recipe("hostpython3", self.ctx)
8✔
970

971
        env = super().get_recipe_env(arch, with_flags_in_cc)
8✔
972
        # Set the LANG, this isn't usually important but is a better default
973
        # as it occasionally matters how Python e.g. reads files
974
        env['LANG'] = "en_GB.UTF-8"
8✔
975

976
        # Binaries made by packages installed by pip
977
        self.patch_shebangs(self._host_recipe.local_bin, self.real_hostpython_location)
8✔
978
        env["PATH"] = self._host_recipe.local_bin + ":" + self._host_recipe.site_bin + ":" + env["PATH"]
8✔
979

980
        host_env = self.get_hostrecipe_env(arch)
8✔
981
        env['PYTHONPATH'] = host_env["PYTHONPATH"]
8✔
982

983
        if not self.call_hostpython_via_targetpython:
8!
984
            env['CFLAGS'] += ' -I{}'.format(
8✔
985
                self.ctx.python_recipe.include_root(arch.arch)
986
            )
987
            env['LDFLAGS'] += ' -L{} -lpython{}'.format(
8✔
988
                self.ctx.python_recipe.link_root(arch.arch),
989
                self.ctx.python_recipe.link_version,
990
            )
991

992
        return env
8✔
993

994
    def should_build(self, arch):
8✔
995
        name = self.folder_name
×
996
        if self.ctx.has_package(name, arch):
×
997
            info('Python package already exists in site-packages')
×
998
            return False
×
999
        info('{} apparently isn\'t already in site-packages'.format(name))
×
1000
        return True
×
1001

1002
    def build_arch(self, arch):
8✔
1003
        '''Install the Python module by calling setup.py install with
1004
        the target Python dir.'''
1005
        self.install_hostpython_prerequisites()
×
1006
        super().build_arch(arch)
×
1007
        self.install_python_package(arch)
×
1008

1009
    def install_python_package(self, arch, name=None, env=None, is_dir=True):
8✔
1010
        '''Automate the installation of a Python package (or a cython
1011
        package where the cython components are pre-built).'''
1012
        # arch = self.filtered_archs[0]  # old kivy-ios way
1013
        if name is None:
×
1014
            name = self.name
×
1015
        if env is None:
×
1016
            env = self.get_recipe_env(arch)
×
1017

1018
        info('Installing {} into site-packages'.format(self.name))
×
1019

1020
        hostpython = sh.Command(self.hostpython_location)
×
1021
        hpenv = env.copy()
×
1022
        with current_directory(self.get_build_dir(arch.arch)):
×
NEW
1023
            shprint(hostpython, '-m', 'pip', 'install', '.',
×
1024
                    '--compile',
1025
                    f'--root={self.ctx.get_python_install_dir(arch.arch)}',
1026
                    _env=hpenv, *self.setup_extra_args
1027
            )
1028

1029
    def get_hostrecipe_env(self, arch=None):
8✔
1030
        env = environ.copy()
8✔
1031
        _python_path = self._host_recipe.get_path_to_python()
8✔
1032
        libdir = glob.glob(join(_python_path, "build", "lib*"))
8✔
1033
        env['PYTHONPATH'] = self._host_recipe.site_dir + ":" + join(
8✔
1034
            _python_path, "Modules") + ":" + (libdir[0] if libdir else "")
1035
        return env
8✔
1036

1037
    @property
8✔
1038
    def hostpython_site_dir(self):
8✔
1039
        return join(dirname(self.real_hostpython_location), 'Lib', 'site-packages')
×
1040

1041
    def install_hostpython_package(self, arch):
8✔
1042
        env = self.get_hostrecipe_env(arch)
×
1043
        real_hostpython = sh.Command(self.real_hostpython_location)
×
NEW
1044
        shprint(real_hostpython, '-m', 'pip', 'install', '.',
×
1045
                '--compile',
1046
                '--install-lib=Lib/site-packages',
1047
                '--root={}'.format(self._host_recipe.site_root),
1048
                _env=env, *self.setup_extra_args)
1049

1050
    @property
8✔
1051
    def python_major_minor_version(self):
8✔
1052
        parsed_version = packaging.version.parse(self.ctx.python_recipe.version)
×
1053
        return f"{parsed_version.major}.{parsed_version.minor}"
×
1054

1055
    def install_hostpython_prerequisites(self, packages=None, force_upgrade=True):
8✔
1056
        if not packages:
×
1057
            packages = self.hostpython_prerequisites
×
1058

1059
        if len(packages) == 0:
×
1060
            return
×
1061

1062
        pip_options = [
×
1063
            "install",
1064
            *packages,
1065
            "--target", self._host_recipe.site_dir, "--python-version",
1066
            self.ctx.python_recipe.version,
1067
            # Don't use sources, instead wheels
1068
            "--only-binary=:all:",
1069
        ]
1070
        if force_upgrade:
×
1071
            pip_options.append("--upgrade")
×
1072
        # Use system's pip
1073
        pip_env = self.get_hostrecipe_env()
×
1074
        pip_env["HOME"] = "/tmp"
×
1075
        shprint(sh.Command(self.real_hostpython_location), "-m", "pip", *pip_options, _env=pip_env)
×
1076

1077
    def restore_hostpython_prerequisites(self, packages):
8✔
1078
        _packages = []
×
1079
        for package in packages:
×
1080
            original_version = Recipe.get_recipe(package, self.ctx).version
×
1081
            _packages.append(package + "==" + original_version)
×
1082
        self.install_hostpython_prerequisites(packages=_packages)
×
1083

1084

1085
class CompiledComponentsPythonRecipe(PythonRecipe):
8✔
1086
    pre_build_ext = False
8✔
1087

1088
    build_cmd = 'build_ext'
8✔
1089

1090
    def build_arch(self, arch):
8✔
1091
        '''Build any cython components, then install the Python module by
1092
        calling pip install with the target Python dir.
1093
        '''
1094
        Recipe.build_arch(self, arch)
×
1095
        self.install_hostpython_prerequisites()
×
1096
        self.build_compiled_components(arch)
×
1097
        self.install_python_package(arch)
×
1098

1099
    def build_compiled_components(self, arch):
8✔
1100
        info('Building compiled components in {}'.format(self.name))
×
1101

1102
        env = self.get_recipe_env(arch)
×
1103
        hostpython = sh.Command(self.hostpython_location)
×
1104
        with current_directory(self.get_build_dir(arch.arch)):
×
1105
            if self.install_in_hostpython:
×
1106
                shprint(hostpython, 'setup.py', 'clean', '--all', _env=env)
×
1107
            shprint(hostpython, 'setup.py', self.build_cmd, '-v',
×
1108
                    _env=env, *self.setup_extra_args)
1109
            build_dir = glob.glob('build/lib.*')[0]
×
1110
            shprint(sh.find, build_dir, '-name', '"*.o"', '-exec',
×
1111
                    env['STRIP'], '{}', ';', _env=env)
1112

1113
    def install_hostpython_package(self, arch):
8✔
1114
        env = self.get_hostrecipe_env(arch)
×
1115
        self.rebuild_compiled_components(arch, env)
×
1116
        super().install_hostpython_package(arch)
×
1117

1118
    def rebuild_compiled_components(self, arch, env):
8✔
1119
        info('Rebuilding compiled components in {}'.format(self.name))
×
1120

1121
        hostpython = sh.Command(self.real_hostpython_location)
×
1122
        shprint(hostpython, 'setup.py', 'clean', '--all', _env=env)
×
1123
        shprint(hostpython, 'setup.py', self.build_cmd, '-v', _env=env,
×
1124
                *self.setup_extra_args)
1125

1126

1127
class CppCompiledComponentsPythonRecipe(CompiledComponentsPythonRecipe):
8✔
1128
    """ Extensions that require the cxx-stl """
1129
    call_hostpython_via_targetpython = False
8✔
1130
    need_stl_shared = True
8✔
1131

1132

1133
class CythonRecipe(PythonRecipe):
8✔
1134
    pre_build_ext = False
8✔
1135
    cythonize = True
8✔
1136
    cython_args = []
8✔
1137
    call_hostpython_via_targetpython = False
8✔
1138

1139
    def build_arch(self, arch):
8✔
1140
        '''Build any cython components, then install the Python module by
1141
        calling pip install with the target Python dir.
1142
        '''
1143
        Recipe.build_arch(self, arch)
×
1144
        self.build_cython_components(arch)
×
1145
        self.install_python_package(arch)
×
1146

1147
    def build_cython_components(self, arch):
8✔
1148
        info('Cythonizing anything necessary in {}'.format(self.name))
×
1149

1150
        env = self.get_recipe_env(arch)
×
1151

1152
        with current_directory(self.get_build_dir(arch.arch)):
×
1153
            hostpython = sh.Command(self.ctx.hostpython)
×
1154
            shprint(hostpython, '-c', 'import sys; print(sys.path)', _env=env)
×
1155
            debug('cwd is {}'.format(realpath(curdir)))
×
1156
            info('Trying first build of {} to get cython files: this is '
×
1157
                 'expected to fail'.format(self.name))
1158

1159
            manually_cythonise = False
×
1160
            try:
×
1161
                shprint(hostpython, 'setup.py', 'build_ext', '-v', _env=env,
×
1162
                        *self.setup_extra_args)
1163
            except sh.ErrorReturnCode_1:
×
1164
                print()
×
1165
                info('{} first build failed (as expected)'.format(self.name))
×
1166
                manually_cythonise = True
×
1167

1168
            if manually_cythonise:
×
1169
                self.cythonize_build(env=env)
×
1170
                shprint(hostpython, 'setup.py', 'build_ext', '-v', _env=env,
×
1171
                        _tail=20, _critical=True, *self.setup_extra_args)
1172
            else:
1173
                info('First build appeared to complete correctly, skipping manual'
×
1174
                     'cythonising.')
1175

1176
            if not self.ctx.with_debug_symbols:
×
1177
                self.strip_object_files(arch, env)
×
1178

1179
    def strip_object_files(self, arch, env, build_dir=None):
8✔
1180
        if build_dir is None:
×
1181
            build_dir = self.get_build_dir(arch.arch)
×
1182
        with current_directory(build_dir):
×
1183
            info('Stripping object files')
×
1184
            shprint(sh.find, '.', '-iname', '*.so', '-exec',
×
1185
                    '/usr/bin/echo', '{}', ';', _env=env)
1186
            shprint(sh.find, '.', '-iname', '*.so', '-exec',
×
1187
                    env['STRIP'].split(' ')[0], '--strip-unneeded',
1188
                    # '/usr/bin/strip', '--strip-unneeded',
1189
                    '{}', ';', _env=env)
1190

1191
    def cythonize_file(self, env, build_dir, filename):
8✔
1192
        short_filename = filename
×
1193
        if filename.startswith(build_dir):
×
1194
            short_filename = filename[len(build_dir) + 1:]
×
1195
        info(u"Cythonize {}".format(short_filename))
×
1196
        cyenv = env.copy()
×
1197
        if 'CYTHONPATH' in cyenv:
×
1198
            cyenv['PYTHONPATH'] = cyenv['CYTHONPATH']
×
1199
        elif 'PYTHONPATH' in cyenv:
×
1200
            del cyenv['PYTHONPATH']
×
1201
        if 'PYTHONNOUSERSITE' in cyenv:
×
1202
            cyenv.pop('PYTHONNOUSERSITE')
×
1203
        python_command = sh.Command("python{}".format(
×
1204
            self.ctx.python_recipe.major_minor_version_string.split(".")[0]
1205
        ))
1206
        shprint(python_command, "-c"
×
1207
                "import sys; from Cython.Compiler.Main import setuptools_main; sys.exit(setuptools_main());",
1208
                filename, *self.cython_args, _env=cyenv)
1209

1210
    def cythonize_build(self, env, build_dir="."):
8✔
1211
        if not self.cythonize:
×
1212
            info('Running cython cancelled per recipe setting')
×
1213
            return
×
1214
        info('Running cython where appropriate')
×
1215
        for root, dirnames, filenames in walk("."):
×
1216
            for filename in fnmatch.filter(filenames, "*.pyx"):
×
1217
                self.cythonize_file(env, build_dir, join(root, filename))
×
1218

1219
    def get_recipe_env(self, arch, with_flags_in_cc=True):
8✔
1220
        env = super().get_recipe_env(arch, with_flags_in_cc)
×
1221
        env['LDFLAGS'] = env['LDFLAGS'] + ' -L{} '.format(
×
1222
            self.ctx.get_libs_dir(arch.arch) +
1223
            ' -L{} '.format(self.ctx.libs_dir) +
1224
            ' -L{}'.format(join(self.ctx.bootstrap.build_dir, 'obj', 'local',
1225
                                arch.arch)))
1226

1227
        env['LDSHARED'] = env['CC'] + ' -shared'
×
1228
        # shprint(sh.whereis, env['LDSHARED'], _env=env)
1229
        env['LIBLINK'] = 'NOTNONE'
×
1230
        if self.ctx.copy_libs:
×
1231
            env['COPYLIBS'] = '1'
×
1232

1233
        # Every recipe uses its own liblink path, object files are
1234
        # collected and biglinked later
1235
        liblink_path = join(self.get_build_container_dir(arch.arch),
×
1236
                            'objects_{}'.format(self.name))
1237
        env['LIBLINK_PATH'] = liblink_path
×
1238
        ensure_dir(liblink_path)
×
1239

1240
        return env
×
1241

1242

1243
class PyProjectRecipe(PythonRecipe):
8✔
1244
    """Recipe for projects which contain `pyproject.toml`"""
1245

1246
    # Extra args to pass to `python -m build ...`
1247
    extra_build_args = []
8✔
1248
    call_hostpython_via_targetpython = False
8✔
1249

1250
    def get_recipe_env(self, arch, **kwargs):
8✔
1251
        # Custom hostpython
1252
        self.ctx.python_recipe.python_exe = join(
8✔
1253
            self.ctx.python_recipe.get_build_dir(arch), "android-build", "python3")
1254
        env = super().get_recipe_env(arch, **kwargs)
8✔
1255
        build_dir = self.get_build_dir(arch)
8✔
1256
        ensure_dir(build_dir)
8✔
1257
        build_opts = join(build_dir, "build-opts.cfg")
8✔
1258

1259
        with open(build_opts, "w") as file:
8✔
1260
            file.write("[bdist_wheel]\nplat_name={}".format(
8✔
1261
                self.get_wheel_platform_tag(arch)
1262
            ))
1263
            file.close()
8✔
1264

1265
        env["DIST_EXTRA_CONFIG"] = build_opts
8✔
1266
        return env
8✔
1267

1268
    def get_wheel_platform_tag(self, arch):
8✔
1269
        return f"android_{self.ctx.ndk_api}_" + {
8✔
1270
            "armeabi-v7a": "arm",
1271
            "arm64-v8a": "aarch64",
1272
            "x86_64": "x86_64",
1273
            "x86": "i686",
1274
        }[arch.arch]
1275

1276
    def install_wheel(self, arch, built_wheels):
8✔
1277
        with patch_wheel_setuptools_logging():
×
1278
            from wheel.cli.tags import tags as wheel_tags
×
1279
            from wheel.wheelfile import WheelFile
×
1280
        _wheel = built_wheels[0]
×
1281
        built_wheel_dir = dirname(_wheel)
×
1282
        # Fix wheel platform tag
1283
        wheel_tag = wheel_tags(
×
1284
            _wheel,
1285
            platform_tags=self.get_wheel_platform_tag(arch),
1286
            remove=True,
1287
        )
1288
        selected_wheel = join(built_wheel_dir, wheel_tag)
×
1289

1290
        _dev_wheel_dir = environ.get("P4A_WHEEL_DIR", False)
×
1291
        if _dev_wheel_dir:
×
1292
            ensure_dir(_dev_wheel_dir)
×
1293
            shprint(sh.cp, selected_wheel, _dev_wheel_dir)
×
1294

1295
        info(f"Installing built wheel: {wheel_tag}")
×
1296
        destination = self.ctx.get_python_install_dir(arch.arch)
×
1297
        with WheelFile(selected_wheel) as wf:
×
1298
            for zinfo in wf.filelist:
×
1299
                wf.extract(zinfo, destination)
×
1300
            wf.close()
×
1301

1302
    def build_arch(self, arch):
8✔
1303

1304
        build_dir = self.get_build_dir(arch.arch)
×
1305
        if not (isfile(join(build_dir, "pyproject.toml")) or isfile(join(build_dir, "setup.py"))):
×
1306
            warning("Skipping build because it does not appear to be a Python project.")
×
1307
            return
×
1308

1309
        self.install_hostpython_prerequisites(
×
1310
            packages=["build[virtualenv]", "pip", "setuptools"] + self.hostpython_prerequisites
1311
        )
1312
        self.patch_shebangs(self._host_recipe.site_bin, self.real_hostpython_location)
×
1313

1314
        env = self.get_recipe_env(arch, with_flags_in_cc=True)
×
1315
        # make build dir separately
1316
        sub_build_dir = join(build_dir, "p4a_android_build")
×
1317
        ensure_dir(sub_build_dir)
×
1318
        # copy hostpython to built python to ensure correct selection of libs and includes
1319
        shprint(sh.cp, self.real_hostpython_location, self.ctx.python_recipe.python_exe)
×
1320

1321
        build_args = [
×
1322
            "-m",
1323
            "build",
1324
            "--wheel",
1325
            "--config-setting",
1326
            "builddir={}".format(sub_build_dir),
1327
        ] + self.extra_build_args
1328

1329
        built_wheels = []
×
1330
        with current_directory(build_dir):
×
1331
            shprint(
×
1332
                sh.Command(self.ctx.python_recipe.python_exe), *build_args, _env=env
1333
            )
1334
            built_wheels = [realpath(whl) for whl in glob.glob("dist/*.whl")]
×
1335
        self.install_wheel(arch, built_wheels)
×
1336

1337

1338
class MesonRecipe(PyProjectRecipe):
8✔
1339
    '''Recipe for projects which uses meson as build system'''
1340

1341
    meson_version = "1.4.0"
8✔
1342
    ninja_version = "1.11.1.1"
8✔
1343

1344
    skip_python = False
8✔
1345
    '''If true, skips all Python build and installation steps.
6✔
1346
    Useful for Meson projects written purely in C/C++ without Python bindings.'''
1347

1348
    def sanitize_flags(self, *flag_strings):
8✔
1349
        return " ".join(flag_strings).strip().split(" ")
×
1350

1351
    def get_recipe_meson_options(self, arch):
8✔
1352
        env = self.get_recipe_env(arch, with_flags_in_cc=True)
×
1353
        return {
×
1354
            "binaries": {
1355
                "c": arch.get_clang_exe(with_target=True),
1356
                "cpp": arch.get_clang_exe(with_target=True, plus_plus=True),
1357
                "ar": self.ctx.ndk.llvm_ar,
1358
                "strip": self.ctx.ndk.llvm_strip,
1359
            },
1360
            "built-in options": {
1361
                "c_args": self.sanitize_flags(env["CFLAGS"], env["CPPFLAGS"]),
1362
                "cpp_args": self.sanitize_flags(env["CXXFLAGS"], env["CPPFLAGS"]),
1363
                "c_link_args": self.sanitize_flags(env["LDFLAGS"]),
1364
                "cpp_link_args": self.sanitize_flags(env["LDFLAGS"]),
1365
                "fortran_link_args": self.sanitize_flags(env["LDFLAGS"]),
1366
            },
1367
            "properties": {
1368
                "needs_exe_wrapper": True,
1369
                "sys_root": self.ctx.ndk.sysroot
1370
            },
1371
            "host_machine": {
1372
                "cpu_family": {
1373
                    "arm64-v8a": "aarch64",
1374
                    "armeabi-v7a": "arm",
1375
                    "x86_64": "x86_64",
1376
                    "x86": "x86"
1377
                }[arch.arch],
1378
                "cpu": {
1379
                    "arm64-v8a": "aarch64",
1380
                    "armeabi-v7a": "armv7",
1381
                    "x86_64": "x86_64",
1382
                    "x86": "i686"
1383
                }[arch.arch],
1384
                "endian": "little",
1385
                "system": "android",
1386
            }
1387
        }
1388

1389
    def write_build_options(self, arch):
8✔
1390
        """Writes python dict to meson config file"""
1391
        option_data = ""
×
1392
        build_options = self.get_recipe_meson_options(arch)
×
1393
        for key in build_options.keys():
×
1394
            data_chunk = "[{}]".format(key)
×
1395
            for subkey in build_options[key].keys():
×
1396
                value = build_options[key][subkey]
×
1397
                if isinstance(value, int):
×
1398
                    value = str(value)
×
1399
                elif isinstance(value, str):
×
1400
                    value = "'{}'".format(value)
×
1401
                elif isinstance(value, bool):
×
1402
                    value = "true" if value else "false"
×
1403
                elif isinstance(value, list):
×
1404
                    value = "['" + "', '".join(value) + "']"
×
1405
                data_chunk += "\n" + subkey + " = " + value
×
1406
            option_data += data_chunk + "\n\n"
×
1407
        return option_data
×
1408

1409
    def ensure_args(self, *args):
8✔
1410
        for arg in args:
×
1411
            if arg not in self.extra_build_args:
×
1412
                self.extra_build_args.append(arg)
×
1413

1414
    def build_arch(self, arch):
8✔
1415
        cross_file = join("/tmp", "android.meson.cross")
×
1416
        info("Writing cross file at: {}".format(cross_file))
×
1417
        # write cross config file
1418
        with open(cross_file, "w") as file:
×
1419
            file.write(self.write_build_options(arch))
×
1420
            file.close()
×
1421
        # set cross file
1422
        self.ensure_args('-Csetup-args=--cross-file', '-Csetup-args={}'.format(cross_file))
×
1423
        # ensure ninja and meson
1424
        for dep in [
×
1425
            "ninja=={}".format(self.ninja_version),
1426
            "meson=={}".format(self.meson_version),
1427
        ]:
1428
            if dep not in self.hostpython_prerequisites:
×
1429
                self.hostpython_prerequisites.append(dep)
×
1430
        if not self.skip_python:
×
1431
            super().build_arch(arch)
×
1432

1433

1434
class RustCompiledComponentsRecipe(PyProjectRecipe):
8✔
1435
    # Rust toolchain codes
1436
    # https://doc.rust-lang.org/nightly/rustc/platform-support.html
1437
    RUST_ARCH_CODES = {
8✔
1438
        "arm64-v8a": "aarch64-linux-android",
1439
        "armeabi-v7a": "armv7-linux-androideabi",
1440
        "x86_64": "x86_64-linux-android",
1441
        "x86": "i686-linux-android",
1442
    }
1443

1444
    call_hostpython_via_targetpython = False
8✔
1445

1446
    def get_recipe_env(self, arch, **kwargs):
8✔
1447
        env = super().get_recipe_env(arch, **kwargs)
×
1448

1449
        # Set rust build target
1450
        build_target = self.RUST_ARCH_CODES[arch.arch]
×
1451
        cargo_linker_name = "CARGO_TARGET_{}_LINKER".format(
×
1452
            build_target.upper().replace("-", "_")
1453
        )
1454
        env["CARGO_BUILD_TARGET"] = build_target
×
1455
        env[cargo_linker_name] = join(
×
1456
            self.ctx.ndk.llvm_prebuilt_dir,
1457
            "bin",
1458
            "{}{}-clang".format(
1459
                # NDK's Clang format
1460
                build_target.replace("7", "7a")
1461
                if build_target.startswith("armv7")
1462
                else build_target,
1463
                self.ctx.ndk_api,
1464
            ),
1465
        )
1466
        realpython_dir = self.ctx.python_recipe.get_build_dir(arch.arch)
×
1467

1468
        env["RUSTFLAGS"] = "-Clink-args=-L{} -L{}".format(
×
1469
            self.ctx.get_libs_dir(arch.arch), join(realpython_dir, "android-build")
1470
        )
1471

1472
        env["PYO3_CROSS_LIB_DIR"] = realpath(glob.glob(join(
×
1473
            realpython_dir, "android-build", "build",
1474
            "lib.*{}/".format(self.python_major_minor_version),
1475
        ))[0])
1476

1477
        info_main("Ensuring rust build toolchain")
×
1478
        shprint(sh.rustup, "target", "add", build_target)
×
1479

1480
        # Add host python to PATH
1481
        env["PATH"] = ("{hostpython_dir}:{old_path}").format(
×
1482
            hostpython_dir=Recipe.get_recipe(
1483
                "hostpython3", self.ctx
1484
            ).get_path_to_python(),
1485
            old_path=env["PATH"],
1486
        )
1487
        return env
×
1488

1489
    def check_host_deps(self):
8✔
1490
        if not hasattr(sh, "rustup"):
×
1491
            error(
×
1492
                "`rustup` was not found on host system."
1493
                "Please install it using :"
1494
                "\n`curl https://sh.rustup.rs -sSf | sh`\n"
1495
            )
1496
            exit(1)
×
1497

1498
    def build_arch(self, arch):
8✔
1499
        self.check_host_deps()
×
1500
        super().build_arch(arch)
×
1501

1502

1503
class TargetPythonRecipe(Recipe):
8✔
1504
    '''Class for target python recipes. Sets ctx.python_recipe to point to
1505
    itself, so as to know later what kind of Python was built or used.'''
1506

1507
    def __init__(self, *args, **kwargs):
8✔
1508
        self._ctx = None
8✔
1509
        super().__init__(*args, **kwargs)
8✔
1510

1511
    def prebuild_arch(self, arch):
8✔
1512
        super().prebuild_arch(arch)
×
1513
        self.ctx.python_recipe = self
×
1514

1515
    def include_root(self, arch):
8✔
1516
        '''The root directory from which to include headers.'''
1517
        raise NotImplementedError('Not implemented in TargetPythonRecipe')
1518

1519
    def link_root(self):
8✔
1520
        raise NotImplementedError('Not implemented in TargetPythonRecipe')
1521

1522
    @property
8✔
1523
    def major_minor_version_string(self):
8✔
1524
        parsed_version = packaging.version.parse(self.version)
8✔
1525
        return f"{parsed_version.major}.{parsed_version.minor}"
8✔
1526

1527
    def create_python_bundle(self, dirn, arch):
8✔
1528
        """
1529
        Create a packaged python bundle in the target directory, by
1530
        copying all the modules and standard library to the right
1531
        place.
1532
        """
1533
        raise NotImplementedError('{} does not implement create_python_bundle'.format(self))
1534

1535
    def reduce_object_file_names(self, dirn):
8✔
1536
        """Recursively renames all files named XXX.cpython-...-linux-gnu.so"
1537
        to "XXX.so", i.e. removing the erroneous architecture name
1538
        coming from the local system.
1539
        """
1540
        py_so_files = shprint(sh.find, dirn, '-iname', '*.so')
8✔
1541
        filens = py_so_files.stdout.decode('utf-8').split('\n')[:-1]
8✔
1542
        for filen in filens:
8!
1543
            file_dirname, file_basename = split(filen)
×
1544
            parts = file_basename.split('.')
×
1545
            if len(parts) <= 2:
×
1546
                continue
×
1547
            # PySide6 libraries end with .abi3.so
1548
            if parts[1] == "abi3":
×
1549
                continue
×
1550
            move(filen, join(file_dirname, parts[0] + '.so'))
×
1551

1552

1553
def algsum(alg, filen):
8✔
1554
    '''Calculate the digest of a file.
1555
    '''
1556
    with open(filen, 'rb') as fileh:
×
1557
        digest = getattr(hashlib, alg)(fileh.read())
×
1558

1559
    return digest.hexdigest()
×
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc