def __new__(cls, name, bases, dct):

if name != 'Recipe':

if 'url' in dct:

dct['_url'] = dct.pop('url')

if 'version' in dct:

dct['_version'] = dct.pop('version')

_url = None

'''The address from which the recipe may be downloaded. This is not

_download_headers = None

'''Add additional headers used when downloading the package, typically

_version = None

'''A string giving the version of the software the recipe describes,

md5sum = None

'''The md5sum of the source from the :attr:`url`. Non-essential, but

sha512sum = None

'''The sha512sum of the source from the :attr:`url`. Non-essential, but

blake2bsum = None

'''The blake2bsum of the source from the :attr:`url`. Non-essential, but

depends = []

'''A list containing the names of any recipes that this recipe depends on.

conflicts = []

'''A list containing the names of any recipes that are known to be

opt_depends = []

'''A list of optional dependencies, that must be built before this

patches = []

'''A list of patches to apply to the source. Values can be either a string

python_depends = []

'''A list of pure-Python packages that this package requires. These

archs = ['armeabi'] # Not currently implemented properly

built_libraries = {}

"""Each recipe that builds a system library (e.g.:libffi, openssl, etc...)

need_stl_shared = False

'''Some libraries or python packages may need the c++_shared in APK.

stl_lib_name = 'c++_shared'

'''

min_ndk_api_support = 20

'''

def get_stl_library(self, arch):

return join(

arch.ndk_lib_dir,

'lib{name}.so'.format(name=self.stl_lib_name),

)

def install_stl_lib(self, arch):

if not self.ctx.has_lib(

arch.arch, 'lib{name}.so'.format(name=self.stl_lib_name)

):

self.install_libs(arch, self.get_stl_library(arch))

@property

def version(self):

key = 'VERSION_' + self.name

return environ.get(key, self._version)

@property

def url(self):

key = 'URL_' + self.name

return environ.get(key, self._url)

@property

def versioned_url(self):

'''A property returning the url of the recipe with ``{version}``

if self.url is None:

return None

return self.url.format(version=self.version)

@property

def download_headers(self):

key = "DOWNLOAD_HEADERS_" + self.name

env_headers = environ.get(key)

if env_headers:

try:

return [tuple(h) for h in json.loads(env_headers)]

except Exception as ex:

raise ValueError(f'Invalid Download headers for {key} - must be JSON formatted as [["header1","foo"],["header2","bar"]]: {ex}')

return environ.get(key, self._download_headers)

def download_file(self, url, target, cwd=None):

"""

if not url:

return

info('Downloading {} from {}'.format(self.name, url))

if cwd:

target = join(cwd, target)

parsed_url = urlparse(url)

if parsed_url.scheme in ('http', 'https'):

def report_hook(index, blksize, size):

if size <= 0:

progression = '{0} bytes'.format(index * blksize)

else:

progression = '{0:.2f}%'.format(

index * blksize * 100. / float(size))

if "CI" not in environ:

stdout.write('- Download {}\r'.format(progression))

stdout.flush()

if exists(target):

unlink(target)

# Download item with multiple attempts (for bad connections):

attempts = 0

seconds = 1

while True:

try:

# jqueryui.com returns a 403 w/ the default user agent

# Mozilla/5.0 does not handle redirection for liblzma

url_opener.addheaders = [('User-agent', 'Wget/1.0')]

if self.download_headers:

url_opener.addheaders += self.download_headers

urlretrieve(url, target, report_hook)

except OSError as e:

attempts += 1

if attempts >= 5:

raise

stdout.write('Download failed: {}; retrying in {} second(s)...'.format(e, seconds))

time.sleep(seconds)

seconds *= 2

continue

finally:

url_opener.addheaders = url_orig_headers

break

return target

elif parsed_url.scheme in ('git', 'git+file', 'git+ssh', 'git+http', 'git+https'):

if not isdir(target):

if url.startswith('git+'):

url = url[4:]

# if 'version' is specified, do a shallow clone

if self.version:

ensure_dir(target)

with current_directory(target):

shprint(sh.git, 'init')

shprint(sh.git, 'remote', 'add', 'origin', url)

else:

shprint(sh.git, 'clone', '--recursive', url, target)

with current_directory(target):

if self.version:

shprint(sh.git, 'fetch', '--tags', '--depth', '1')

shprint(sh.git, 'checkout', self.version)

branch = sh.git('branch', '--show-current')

if branch:

shprint(sh.git, 'pull')

shprint(sh.git, 'pull', '--recurse-submodules')

shprint(sh.git, 'submodule', 'update', '--recursive', '--init', '--depth', '1')

return target

def apply_patch(self, filename, arch, build_dir=None):

"""

info("Applying patch {}".format(filename))

build_dir = build_dir if build_dir else self.get_build_dir(arch)

filename = join(self.get_recipe_dir(), filename)

shprint(sh.patch, "-t", "-d", build_dir, "-p1",

"-i", filename, _tail=10)

def copy_file(self, filename, dest):

info("Copy {} to {}".format(filename, dest))

filename = join(self.get_recipe_dir(), filename)

dest = join(self.build_dir, dest)

shutil.copy(filename, dest)

def append_file(self, filename, dest):

info("Append {} to {}".format(filename, dest))

filename = join(self.get_recipe_dir(), filename)

dest = join(self.build_dir, dest)

with open(filename, "rb") as fd:

data = fd.read()

with open(dest, "ab") as fd:

fd.write(data)

@property

def name(self):

'''The name of the recipe, the same as the folder containing it.'''

modname = self.__class__.__module__

return modname.split(".", 2)[-1]

@property

def filtered_archs(self):

'''Return archs of self.ctx that are valid build archs

result = []

for arch in self.ctx.archs:

if not self.archs or (arch.arch in self.archs):

result.append(arch)

return result

def check_recipe_choices(self):

'''Checks what recipes are being built to see which of the alternative

recipes = []

built_recipes = self.ctx.recipe_build_order

for recipe in self.depends:

if isinstance(recipe, (tuple, list)):

for alternative in recipe:

if alternative in built_recipes:

recipes.append(alternative)

break

for recipe in self.opt_depends:

if recipe in built_recipes:

recipes.append(recipe)

return sorted(recipes)

def get_opt_depends_in_list(self, recipes):

'''Given a list of recipe names, returns those that are also in

return [recipe for recipe in recipes if recipe in self.opt_depends]

def get_build_container_dir(self, arch):

'''Given the arch name, returns the directory where it will be

dir_name = self.get_dir_name()

return join(self.ctx.build_dir, 'other_builds',

dir_name, '{}__ndk_target_{}'.format(arch, self.ctx.ndk_api))

def get_dir_name(self):

choices = self.check_recipe_choices()

dir_name = '-'.join([self.name] + choices)

return dir_name

def get_build_dir(self, arch):

'''Given the arch name, returns the directory where the

return join(self.get_build_container_dir(arch), self.name)

def get_recipe_dir(self):

"""

if self.ctx.local_recipes is not None:

local_recipe_dir = join(self.ctx.local_recipes, self.name)

if exists(local_recipe_dir):

return local_recipe_dir

return join(self.ctx.root_dir, 'recipes', self.name)

# Public Recipe API to be subclassed if needed

def download_if_necessary(self):

if self.ctx.ndk_api < self.min_ndk_api_support:

error(f"In order to build '{self.name}', you must set minimum ndk api (minapi) to `{self.min_ndk_api_support}`.\n")

exit(1)

info_main('Downloading {}'.format(self.name))

user_dir = environ.get('P4A_{}_DIR'.format(self.name.lower()))

if user_dir is not None:

info('P4A_{}_DIR is set, skipping download for {}'.format(

self.name, self.name))

return

self.download()

def download(self):

if self.url is None:

info('Skipping {} download as no URL is set'.format(self.name))

return

url = self.versioned_url

expected_digests = {}

for alg in set(hashlib.algorithms_guaranteed) | set(('md5', 'sha512', 'blake2b')):

expected_digest = getattr(self, alg + 'sum') if hasattr(self, alg + 'sum') else None

ma = match(u'^(.+)#' + alg + u'=([0-9a-f]{32,})$', url)

if ma: # fragmented URL?

if expected_digest:

raise ValueError(

('Received {}sum from both the {} recipe '

'and its url').format(alg, self.name))

url = ma.group(1)

expected_digest = ma.group(2)

if expected_digest:

expected_digests[alg] = expected_digest

ensure_dir(join(self.ctx.packages_path, self.name))

with current_directory(join(self.ctx.packages_path, self.name)):

filename = shprint(sh.basename, url).stdout[:-1].decode('utf-8')

do_download = True

marker_filename = '.mark-{}'.format(filename)

if exists(filename) and isfile(filename):

if not exists(marker_filename):

shprint(sh.rm, filename)

else:

for alg, expected_digest in expected_digests.items():

current_digest = algsum(alg, filename)

if current_digest != expected_digest:

debug('* Generated {}sum: {}'.format(alg,

current_digest))

debug('* Expected {}sum: {}'.format(alg,

expected_digest))

raise ValueError(

('Generated {0}sum does not match expected {0}sum '

'for {1} recipe').format(alg, self.name))

do_download = False

# If we got this far, we will download

if do_download:

debug('Downloading {} from {}'.format(self.name, url))

shprint(sh.rm, '-f', marker_filename)

self.download_file(self.versioned_url, filename)

touch(marker_filename)

if exists(filename) and isfile(filename):

for alg, expected_digest in expected_digests.items():

current_digest = algsum(alg, filename)

if current_digest != expected_digest:

debug('* Generated {}sum: {}'.format(alg,

current_digest))

debug('* Expected {}sum: {}'.format(alg,

expected_digest))

raise ValueError(

('Generated {0}sum does not match expected {0}sum '

'for {1} recipe').format(alg, self.name))

else:

info('{} download already cached, skipping'.format(self.name))

def unpack(self, arch):

info_main('Unpacking {} for {}'.format(self.name, arch))

build_dir = self.get_build_container_dir(arch)

user_dir = environ.get('P4A_{}_DIR'.format(self.name.lower()))

if user_dir is not None:

info('P4A_{}_DIR exists, symlinking instead'.format(

self.name.lower()))

if exists(self.get_build_dir(arch)):

return

rmdir(build_dir)

ensure_dir(build_dir)

shprint(sh.cp, '-a', user_dir, self.get_build_dir(arch))

return

if self.url is None:

info('Skipping {} unpack as no URL is set'.format(self.name))

return

filename = shprint(

sh.basename, self.versioned_url).stdout[:-1].decode('utf-8')

ma = match(u'^(.+)#[a-z0-9_]{3,}=([0-9a-f]{32,})$', filename)

if ma: # fragmented URL?

filename = ma.group(1)

with current_directory(build_dir):

directory_name = self.get_build_dir(arch)

if not exists(directory_name) or not isdir(directory_name):

extraction_filename = join(

self.ctx.packages_path, self.name, filename)

if isfile(extraction_filename):

if extraction_filename.endswith(('.zip', '.whl')):

try:

sh.unzip(extraction_filename)

except (sh.ErrorReturnCode_1, sh.ErrorReturnCode_2):

# return code 1 means unzipping had

# warnings but did complete,

# apparently happens sometimes with

# github zips

pass

fileh = zipfile.ZipFile(extraction_filename, 'r')

root_directory = fileh.filelist[0].filename.split('/')[0]

if root_directory != basename(directory_name):

move(root_directory, directory_name)

elif extraction_filename.endswith(

('.tar.gz', '.tgz', '.tar.bz2', '.tbz2', '.tar.xz', '.txz')):

sh.tar('xf', extraction_filename)

root_directory = sh.tar('tf', extraction_filename).split('\n')[0].split('/')[0]

if root_directory != basename(directory_name):

move(root_directory, directory_name)

else:

raise Exception(

'Could not extract {} download, it must be .zip, '

'.tar.gz or .tar.bz2 or .tar.xz'.format(extraction_filename))

elif isdir(extraction_filename):

ensure_dir(directory_name)

for entry in listdir(extraction_filename):

# Previously we filtered out the .git folder, but during the build process for some recipes

# (e.g. when version is parsed by `setuptools_scm`) that may be needed.

shprint(sh.cp, '-R',

join(extraction_filename, entry),

directory_name)

else:

raise Exception(

'Given path is neither a file nor a directory: {}'

.format(extraction_filename))

else:

info('{} is already unpacked, skipping'.format(self.name))

def get_recipe_env(self, arch=None, with_flags_in_cc=True):

"""Return the env specialized for the recipe

if arch is None:

arch = self.filtered_archs[0]

env = arch.get_env(with_flags_in_cc=with_flags_in_cc)

for proxy_key in ['HTTP_PROXY', 'http_proxy', 'HTTPS_PROXY', 'https_proxy']:

if proxy_key in environ:

env[proxy_key] = environ[proxy_key]

return env

def prebuild_arch(self, arch):

'''Run any pre-build tasks for the Recipe. By default, this checks if

prebuild = "prebuild_{}".format(arch.arch.replace('-', '_'))

if hasattr(self, prebuild):

getattr(self, prebuild)()

else:

info('{} has no {}, skipping'.format(self.name, prebuild))

def is_patched(self, arch):

build_dir = self.get_build_dir(arch.arch)

return exists(join(build_dir, '.patched'))

def apply_patches(self, arch, build_dir=None):

'''Apply any patches for the Recipe.

if self.patches:

info_main('Applying patches for {}[{}]'

.format(self.name, arch.arch))

if self.is_patched(arch):

info_main('{} already patched, skipping'.format(self.name))

return

build_dir = build_dir if build_dir else self.get_build_dir(arch.arch)

for patch in self.patches:

if isinstance(patch, (tuple, list)):

patch, patch_check = patch

if not patch_check(arch=arch, recipe=self):

continue

self.apply_patch(

patch.format(version=self.version, arch=arch.arch),

arch.arch, build_dir=build_dir)

touch(join(build_dir, '.patched'))

def should_build(self, arch):

'''Should perform any necessary test and return True only if it needs

if self.built_libraries:

return not all(

exists(lib) for lib in self.get_libraries(arch.arch)

)

return True

def build_arch(self, arch):

'''Run any build tasks for the Recipe. By default, this checks if

build = "build_{}".format(arch.arch)

if hasattr(self, build):

getattr(self, build)()

def install_libraries(self, arch):

'''This method is always called after `build_arch`. In case that we

if not self.built_libraries:

return

shared_libs = [

lib for lib in self.get_libraries(arch) if lib.endswith(".so")

]

self.install_libs(arch, *shared_libs)

def postbuild_arch(self, arch):

'''Run any post-build tasks for the Recipe. By default, this checks if

postbuild = "postbuild_{}".format(arch.arch)

if hasattr(self, postbuild):

getattr(self, postbuild)()

if self.need_stl_shared:

self.install_stl_lib(arch)

def prepare_build_dir(self, arch):

'''Copies the recipe data into a build dir for the given arch. By

self.unpack(arch)

def clean_build(self, arch=None):

'''Deletes all the build information of the recipe.

if arch is None:

base_dir = join(self.ctx.build_dir, 'other_builds', self.name)

else:

base_dir = self.get_build_container_dir(arch)

dirs = glob.glob(base_dir + '-*')

if exists(base_dir):

dirs.append(base_dir)

if not dirs:

warning('Attempted to clean build for {} but found no existing '

'build dirs'.format(self.name))

for directory in dirs:

rmdir(directory)

# Delete any Python distributions to ensure the recipe build

# doesn't persist in site-packages

rmdir(self.ctx.python_installs_dir)

def install_libs(self, arch, *libs):

libs_dir = self.ctx.get_libs_dir(arch.arch)

if not libs:

warning('install_libs called with no libraries to install!')

return

args = libs + (libs_dir,)

shprint(sh.cp, *args)

def has_libs(self, arch, *libs):

return all(map(lambda lib: self.ctx.has_lib(arch.arch, lib), libs))

def get_libraries(self, arch_name, in_context=False):

"""Return the full path of the library depending on the architecture.

recipe_libs = set()

if not self.built_libraries:

return recipe_libs

for lib, rel_path in self.built_libraries.items():

if not in_context:

abs_path = join(self.get_build_dir(arch_name), rel_path, lib)

if rel_path in {".", "", None}:

abs_path = join(self.get_build_dir(arch_name), lib)

else:

abs_path = join(self.ctx.get_libs_dir(arch_name), lib)

recipe_libs.add(abs_path)

return recipe_libs

@classmethod

def recipe_dirs(cls, ctx):

recipe_dirs = []

if ctx.local_recipes is not None:

recipe_dirs.append(realpath(ctx.local_recipes))

if ctx.storage_dir:

recipe_dirs.append(join(ctx.storage_dir, 'recipes'))

recipe_dirs.append(join(ctx.root_dir, "recipes"))

return recipe_dirs

@classmethod

def list_recipes(cls, ctx):

forbidden_dirs = ('__pycache__', )

for recipes_dir in cls.recipe_dirs(ctx):

if recipes_dir and exists(recipes_dir):

for name in listdir(recipes_dir):

if name in forbidden_dirs:

continue

fn = join(recipes_dir, name)

if isdir(fn):

yield name

@classmethod

def get_recipe(cls, name, ctx):

'''Returns the Recipe with the given name, if it exists.'''

name = name.lower()

if not hasattr(cls, "recipes"):

cls.recipes = {}

if name in cls.recipes:

return cls.recipes[name]

recipe_file = None

for recipes_dir in cls.recipe_dirs(ctx):

if not exists(recipes_dir):

continue

# Find matching folder (may differ in case):

for subfolder in listdir(recipes_dir):

if subfolder.lower() == name:

recipe_file = join(recipes_dir, subfolder, '__init__.py')

if exists(recipe_file):

name = subfolder # adapt to actual spelling

break

recipe_file = None

if recipe_file is not None:

break

else:

raise ValueError('Recipe does not exist: {}'.format(name))

mod = import_recipe('pythonforandroid.recipes.{}'.format(name), recipe_file)

if len(logger.handlers) > 1:

logger.removeHandler(logger.handlers[1])

recipe = mod.recipe

recipe.ctx = ctx

cls.recipes[name.lower()] = recipe

'''Recipe mixin class that will automatically unpack files included in

src_filename = None

def prepare_build_dir(self, arch):

if self.src_filename is None:

raise BuildInterruptingException(

'IncludedFilesBehaviour failed: no src_filename specified')

rmdir(self.get_build_dir(arch))

shprint(sh.cp, '-a', join(self.get_recipe_dir(), self.src_filename),

'''A recipe class for recipes built in an Android project jni dir with

dir_name = None # The name of the recipe build folder in the jni dir

def get_build_container_dir(self, arch):

return self.get_jni_dir()

def get_build_dir(self, arch):

if self.dir_name is None:

raise ValueError('{} recipe doesn\'t define a dir_name, but '

'this is necessary'.format(self.name))

return join(self.get_build_container_dir(arch), self.dir_name)

def get_jni_dir(self):

return join(self.ctx.bootstrap.build_dir, 'jni')

def get_recipe_env(self, arch=None, with_flags_in_cc=True, with_python=False):

env = super().get_recipe_env(arch, with_flags_in_cc)

if not with_python:

return env

env['PYTHON_INCLUDE_ROOT'] = self.ctx.python_recipe.include_root(arch.arch)

env['PYTHON_LINK_ROOT'] = self.ctx.python_recipe.link_root(arch.arch)

env['EXTRA_LDLIBS'] = ' -lpython{}'.format(

self.ctx.python_recipe.link_version)

'''A recipe class for any NDK project not included in the bootstrap.'''

generated_libraries = []

def should_build(self, arch):

lib_dir = self.get_lib_dir(arch)

for lib in self.generated_libraries:

if not exists(join(lib_dir, lib)):

return True

return False

def get_lib_dir(self, arch):

return join(self.get_build_dir(arch.arch), 'obj', 'local', arch.arch)

def get_jni_dir(self, arch):

return join(self.get_build_dir(arch.arch), 'jni')

def build_arch(self, arch, *extra_args):

super().build_arch(arch)

env = self.get_recipe_env(arch)

with current_directory(self.get_build_dir(arch.arch)):

shprint(

sh.Command(join(self.ctx.ndk_dir, "ndk-build")),

'V=1',

"-j",

str(cpu_count()),

'NDK_DEBUG=' + ("1" if self.ctx.build_as_debuggable else "0"),

'APP_PLATFORM=android-' + str(self.ctx.ndk_api),

'APP_ABI=' + arch.arch,

*extra_args, _env=env

site_packages_name = None

'''The name of the module's folder when installed in the Python

call_hostpython_via_targetpython = True

'''If True, tries to install the module using the hostpython binary

install_in_hostpython = False

'''If True, additionally installs the module in the hostpython build

install_in_targetpython = True

'''If True, installs the module in the targetpython installation dir.

setup_extra_args = []

'''List of extra arguments to pass to setup.py'''

depends = ['python3']

'''

hostpython_prerequisites = ['setuptools']

'''List of hostpython packages required to build a recipe'''

_host_recipe = None

def __init__(self, *args, **kwargs):

super().__init__(*args, **kwargs)

if 'python3' not in self.depends:

# We ensure here that the recipe depends on python even it overrode

# `depends`. We only do this if it doesn't already depend on any

# python, since some recipes intentionally don't depend on/work

# with all python variants

depends = self.depends

depends.append('python3')

depends = list(set(depends))

self.depends = depends

def prebuild_arch(self, arch):

self._host_recipe = Recipe.get_recipe("hostpython3", self.ctx)

return super().prebuild_arch(arch)

def clean_build(self, arch=None):

super().clean_build(arch=arch)

name = self.folder_name

python_install_dirs = glob.glob(join(self.ctx.python_installs_dir, '*'))

for python_install in python_install_dirs:

site_packages_dir = glob.glob(join(python_install, 'lib', 'python*',

'site-packages'))

if site_packages_dir:

build_dir = join(site_packages_dir[0], name)

if exists(build_dir):

info('Deleted {}'.format(build_dir))

rmdir(build_dir)

@property

def real_hostpython_location(self):

host_name = 'host{}'.format(self.ctx.python_recipe.name)

if host_name == 'hostpython3':

return self._host_recipe.python_exe

else:

python_recipe = self.ctx.python_recipe

return 'python{}'.format(python_recipe.version)

@property

def hostpython_location(self):

if not self.call_hostpython_via_targetpython:

return self.real_hostpython_location

return self.ctx.hostpython

@property

def folder_name(self):

'''The name of the build folders containing this recipe.'''

name = self.site_packages_name

if name is None:

name = self.name

return name

def patch_shebang(self, _file, original_bin):

_file_des = open(_file, "r")

try:

data = _file_des.readlines()

except UnicodeDecodeError:

return

if "#!" in (line := data[0]):

if line.split("#!")[-1].strip() == original_bin:

return

info(f"Fixing shebang for '{_file}'")

data.pop(0)

data.insert(0, "#!" + original_bin + "\n")

_file_des.close()

_file_des = open(_file, "w")

_file_des.write("".join(data))

_file_des.close()

def patch_shebangs(self, path, original_bin):

if not isdir(path):

warning(f"Shebang patch skipped: '{path}' does not exist.")

return

# set correct shebang

for file in listdir(path):

_file = join(path, file)

self.patch_shebang(_file, original_bin)

def get_recipe_env(self, arch=None, with_flags_in_cc=True):

if self._host_recipe is None:

self._host_recipe = Recipe.get_recipe("hostpython3", self.ctx)

env = super().get_recipe_env(arch, with_flags_in_cc)

# Set the LANG, this isn't usually important but is a better default

# as it occasionally matters how Python e.g. reads files

env['LANG'] = "en_GB.UTF-8"

# Binaries made by packages installed by pip

self.patch_shebangs(self._host_recipe.local_bin, self.real_hostpython_location)

env["PATH"] = self._host_recipe.local_bin + ":" + self._host_recipe.site_bin + ":" + env["PATH"]

host_env = self.get_hostrecipe_env(arch)

env['PYTHONPATH'] = host_env["PYTHONPATH"]

if not self.call_hostpython_via_targetpython:

env['CFLAGS'] += ' -I{}'.format(

self.ctx.python_recipe.include_root(arch.arch)

)

env['LDFLAGS'] += ' -L{} -lpython{}'.format(

self.ctx.python_recipe.link_root(arch.arch),

self.ctx.python_recipe.link_version,

)

return env

def should_build(self, arch):

name = self.folder_name