23662696415

Committed 27 Mar 2026 06:58PM UTC coverage: 63.382% (-0.3%) from 63.661%

Build # 23662696415

Build Type

Pull #3280

github

Committed by

web-flow

Commit Message

Merge 3f887fd7c into d15f056e6

Pull Request Pull Request #3280: Add support for prebuilt wheels

Coverage Stats

1821 of 3143 branches covered (57.94%)

Branch coverage included in aggregate %.

47 of 103 new or added lines in 4 files covered. (45.63%)

3 existing lines in 2 files now uncovered.

5319 of 8122 relevant lines covered (65.49%)

5.23 hits per line

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

83.7

/pythonforandroid/recipes/hostpython3/__init__.py

import sh
import os

from multiprocessing import cpu_count
from pathlib import Path
from os.path import join

from packaging.version import Version
from pythonforandroid.logger import shprint
from pythonforandroid.recipe import Recipe
from pythonforandroid.util import (
    BuildInterruptingException,
    current_directory,
    ensure_dir,
)
from pythonforandroid.prerequisites import OpenSSLPrerequisite

HOSTPYTHON_VERSION_UNSET_MESSAGE = (
    'The hostpython recipe must have set version'
)

SETUP_DIST_NOT_FIND_MESSAGE = (
    'Could not find Setup.dist or Setup in Python build'
)


class HostPython3Recipe(Recipe):
    '''
    The hostpython3's recipe.

    .. versionchanged:: 2019.10.06.post0
        Refactored from deleted class ``python.HostPythonRecipe`` into here.

    .. versionchanged:: 0.6.0
        Refactored into  the new class
        :class:`~pythonforandroid.python.HostPythonRecipe`
    '''

    version = '3.14.2'

    url = 'https://github.com/python/cpython/archive/refs/tags/v{version}.tar.gz'
    '''The default url to download our host python recipe. This url will
    change depending on the python version set in attribute :attr:`version`.'''

    build_subdir = 'native-build'
    '''Specify the sub build directory for the hostpython3 recipe. Defaults
    to ``native-build``.'''

    patches = ["fix_ensurepip.patch"]

    # apply version guard
    def download(self):
        python_recipe = Recipe.get_recipe("python3", self.ctx)
        if python_recipe.version != self.version:
            raise BuildInterruptingException(
                f"python3 should have same version as hostpython3, {python_recipe.version} != {self.version}"
            )
        super().download()

    @property
    def _exe_name(self):
        '''
        Returns the name of the python executable depending on the version.
        '''
        if not self.version:
            raise BuildInterruptingException(HOSTPYTHON_VERSION_UNSET_MESSAGE)
        return f'python{self.version.split(".")[0]}'

    @property
    def python_exe(self):
        '''Returns the full path of the hostpython executable.'''
        return join(self.get_path_to_python(), self._exe_name)

    def get_recipe_env(self, arch=None):
        env = os.environ.copy()
        openssl_prereq = OpenSSLPrerequisite()
        if env.get("PKG_CONFIG_PATH", ""):
            env["PKG_CONFIG_PATH"] = os.pathsep.join(
                [openssl_prereq.pkg_config_location, env["PKG_CONFIG_PATH"]]
            )
        else:
            env["PKG_CONFIG_PATH"] = openssl_prereq.pkg_config_location
        return env

    def should_build(self, arch):
        if Path(self.python_exe).exists():
            # no need to build, but we must set hostpython for our Context
            self.ctx.hostpython = self.python_exe
            return False
        return True

    def get_build_container_dir(self, arch=None):
        choices = self.check_recipe_choices()
        dir_name = '-'.join([self.name] + choices)
        return join(self.ctx.build_dir, 'other_builds', dir_name, 'desktop')

    def get_build_dir(self, arch=None):
        '''
        .. note:: Unlike other recipes, the hostpython build dir doesn't
            depend on the target arch
        '''
        return join(self.get_build_container_dir(), self.name)

    def get_path_to_python(self):
        return join(self.get_build_dir(), self.build_subdir)

    @property
    def site_root(self):
        return join(self.get_path_to_python(), "root")

    @property
    def site_bin(self):
        return join(self.site_root, self.site_dir, "bin")

    @property
    def local_bin(self):
        return join(self.site_root, "usr/local/bin/")

    @property
    def site_dir(self):
        p_version = Version(self.version)
        return join(
            self.site_root,
            f"usr/local/lib/python{p_version.major}.{p_version.minor}/site-packages/"
        )

    @property
    def _pip(self):
        return join(self.local_bin, "pip3")

    @property
    def pip(self):
        return sh.Command(self._pip)

    def fix_pip_shebangs(self):

        if not os.path.exists(self.local_bin):
            return

        for filename in os.listdir(self.local_bin):
            if not filename.startswith("pip"):
                continue

            pip_path = os.path.join(self.local_bin, filename)

            with open(pip_path, "rb") as file:
                file_lines = file.read().splitlines()

            file_lines[0] = f"#!{self.python_exe}".encode()

            with open(pip_path, "wb") as file:
                file.write(b"\n".join(file_lines) + b"\n")

    def build_arch(self, arch):
        env = self.get_recipe_env(arch)

        recipe_build_dir = self.get_build_dir(arch.arch)

        # Create a subdirectory to actually perform the build
        build_dir = join(recipe_build_dir, self.build_subdir)
        ensure_dir(build_dir)

        # Configure the build
        build_configured = False
        with current_directory(build_dir):
            if not Path('config.status').exists():
                shprint(sh.Command(join(recipe_build_dir, 'configure')), _env=env)
                build_configured = True

        with current_directory(recipe_build_dir):
            # Create the Setup file. This copying from Setup.dist is
            # the normal and expected procedure before Python 3.8, but
            # after this the file with default options is already named "Setup"
            setup_dist_location = join('Modules', 'Setup.dist')
            if Path(setup_dist_location).exists():
                shprint(sh.cp, setup_dist_location,
                        join(build_dir, 'Modules', 'Setup'))
            else:
                # Check the expected file does exist
                setup_location = join('Modules', 'Setup')
                if not Path(setup_location).exists():
                    raise BuildInterruptingException(
                        SETUP_DIST_NOT_FIND_MESSAGE
                    )

            shprint(sh.make, '-j', str(cpu_count()), '-C', build_dir, _env=env)

            # make a copy of the python executable giving it the name we want,
            # because we got different python's executable names depending on
            # the fs being case-insensitive (Mac OS X, Cygwin...) or
            # case-sensitive (linux)...so this way we will have an unique name
            # for our hostpython, regarding the used fs
            for exe_name in ['python.exe', 'python']:
                exe = join(self.get_path_to_python(), exe_name)
                if Path(exe).is_file():
                    shprint(sh.cp, exe, self.python_exe)
                    break

        ensure_dir(self.site_root)
        self.ctx.hostpython = self.python_exe

        if build_configured:

            shprint(
                sh.Command(self.python_exe), "-m", "ensurepip", "--root", self.site_root, "-U",
                _env={"HOME": "/tmp", "PATH": self.local_bin}
            )
            self.fix_pip_shebangs()


recipe = HostPython3Recipe()

1	import sh	8 ✔
2	import os	8 ✔
3
4	from multiprocessing import cpu_count	8 ✔
5	from pathlib import Path	8 ✔
6	from os.path import join	8 ✔
7
8	from packaging.version import Version	8 ✔
9	from pythonforandroid.logger import shprint	8 ✔
10	from pythonforandroid.recipe import Recipe	8 ✔
11	from pythonforandroid.util import (	8 ✔
12	BuildInterruptingException,
13	current_directory,
14	ensure_dir,
15	)
16	from pythonforandroid.prerequisites import OpenSSLPrerequisite	8 ✔
17
18	HOSTPYTHON_VERSION_UNSET_MESSAGE = (	8 ✔
19	'The hostpython recipe must have set version'
20	)
21
22	SETUP_DIST_NOT_FIND_MESSAGE = (	8 ✔
23	'Could not find Setup.dist or Setup in Python build'
24	)
25
26
27	class HostPython3Recipe(Recipe):	8 ✔
28	'''
29	The hostpython3's recipe.
30
31	.. versionchanged:: 2019.10.06.post0
32	Refactored from deleted class ``python.HostPythonRecipe`` into here.
33
34	.. versionchanged:: 0.6.0
35	Refactored into the new class
36	:class:`~pythonforandroid.python.HostPythonRecipe`
37	'''
38
39	version = '3.14.2'	8 ✔
40
41	url = 'https://github.com/python/cpython/archive/refs/tags/v{version}.tar.gz'	8 ✔
42	'''The default url to download our host python recipe. This url will	6 ✔
43	change depending on the python version set in attribute :attr:`version`.'''
44
45	build_subdir = 'native-build'	8 ✔
46	'''Specify the sub build directory for the hostpython3 recipe. Defaults	6 ✔
47	to ``native-build``.'''
48
49	patches = ["fix_ensurepip.patch"]	8 ✔
50
51	# apply version guard
52	def download(self):	8 ✔
NEW 53	python_recipe = Recipe.get_recipe("python3", self.ctx)	×
NEW 54	if python_recipe.version != self.version:	×
NEW 55	raise BuildInterruptingException(	×
56	f"python3 should have same version as hostpython3, {python_recipe.version} != {self.version}"
57	)
NEW 58	super().download()	×
59
60	@property	8 ✔
61	def _exe_name(self):	8 ✔
62	'''
63	Returns the name of the python executable depending on the version.
64	'''
65	if not self.version:	8 ✔
66	raise BuildInterruptingException(HOSTPYTHON_VERSION_UNSET_MESSAGE)	8 ✔
67	return f'python{self.version.split(".")[0]}'	8 ✔
68
69	@property	8 ✔
70	def python_exe(self):	8 ✔
71	'''Returns the full path of the hostpython executable.'''
72	return join(self.get_path_to_python(), self._exe_name)	8 ✔
73
74	def get_recipe_env(self, arch=None):	8 ✔
75	env = os.environ.copy()	8 ✔
76	openssl_prereq = OpenSSLPrerequisite()	8 ✔
77	if env.get("PKG_CONFIG_PATH", ""):	8 !
78	env["PKG_CONFIG_PATH"] = os.pathsep.join(	8 ✔
79	[openssl_prereq.pkg_config_location, env["PKG_CONFIG_PATH"]]
80	)
81	else:
82	env["PKG_CONFIG_PATH"] = openssl_prereq.pkg_config_location	×
83	return env	8 ✔
84
85	def should_build(self, arch):	8 ✔
86	if Path(self.python_exe).exists():	8 ✔
87	# no need to build, but we must set hostpython for our Context
88	self.ctx.hostpython = self.python_exe	8 ✔
89	return False	8 ✔
90	return True	8 ✔
91
92	def get_build_container_dir(self, arch=None):	8 ✔
93	choices = self.check_recipe_choices()	8 ✔
94	dir_name = '-'.join([self.name] + choices)	8 ✔
95	return join(self.ctx.build_dir, 'other_builds', dir_name, 'desktop')	8 ✔
96
97	def get_build_dir(self, arch=None):	8 ✔
98	'''
99	.. note:: Unlike other recipes, the hostpython build dir doesn't
100	depend on the target arch
101	'''
102	return join(self.get_build_container_dir(), self.name)	8 ✔
103
104	def get_path_to_python(self):	8 ✔
105	return join(self.get_build_dir(), self.build_subdir)	8 ✔
106
107	@property	8 ✔
108	def site_root(self):	8 ✔
109	return join(self.get_path_to_python(), "root")	8 ✔
110
111	@property	8 ✔
112	def site_bin(self):	8 ✔
113	return join(self.site_root, self.site_dir, "bin")	8 ✔
114
115	@property	8 ✔
116	def local_bin(self):	8 ✔
117	return join(self.site_root, "usr/local/bin/")	8 ✔
118
119	@property	8 ✔
120	def site_dir(self):	8 ✔
121	p_version = Version(self.version)	8 ✔
122	return join(	8 ✔
123	self.site_root,
124	f"usr/local/lib/python{p_version.major}.{p_version.minor}/site-packages/"
125	)
126
127	@property	8 ✔
128	def _pip(self):	8 ✔
129	return join(self.local_bin, "pip3")	×
130
131	@property	8 ✔
132	def pip(self):	8 ✔
133	return sh.Command(self._pip)	×
134
135	def fix_pip_shebangs(self):	8 ✔
136
137	if not os.path.exists(self.local_bin):	8 !
138	return	8 ✔
139
140	for filename in os.listdir(self.local_bin):	×
141	if not filename.startswith("pip"):	×
142	continue	×
143
144	pip_path = os.path.join(self.local_bin, filename)	×
145
146	with open(pip_path, "rb") as file:	×
147	file_lines = file.read().splitlines()	×
148
149	file_lines[0] = f"#!{self.python_exe}".encode()	×
150
151	with open(pip_path, "wb") as file:	×
152	file.write(b"\n".join(file_lines) + b"\n")	×
153
154	def build_arch(self, arch):	8 ✔
155	env = self.get_recipe_env(arch)	8 ✔
156
157	recipe_build_dir = self.get_build_dir(arch.arch)	8 ✔
158
159	# Create a subdirectory to actually perform the build
160	build_dir = join(recipe_build_dir, self.build_subdir)	8 ✔
161	ensure_dir(build_dir)	8 ✔
162
163	# Configure the build
164	build_configured = False	8 ✔
165	with current_directory(build_dir):	8 ✔
166	if not Path('config.status').exists():	8 ✔
167	shprint(sh.Command(join(recipe_build_dir, 'configure')), _env=env)	8 ✔
168	build_configured = True	8 ✔
169
170	with current_directory(recipe_build_dir):	8 ✔
171	# Create the Setup file. This copying from Setup.dist is
172	# the normal and expected procedure before Python 3.8, but
173	# after this the file with default options is already named "Setup"
174	setup_dist_location = join('Modules', 'Setup.dist')	8 ✔
175	if Path(setup_dist_location).exists():	8 ✔
176	shprint(sh.cp, setup_dist_location,	8 ✔
177	join(build_dir, 'Modules', 'Setup'))
178	else:
179	# Check the expected file does exist
180	setup_location = join('Modules', 'Setup')	8 ✔
181	if not Path(setup_location).exists():	8 ✔
182	raise BuildInterruptingException(	8 ✔
183	SETUP_DIST_NOT_FIND_MESSAGE
184	)
185
186	shprint(sh.make, '-j', str(cpu_count()), '-C', build_dir, _env=env)	8 ✔
187
188	# make a copy of the python executable giving it the name we want,
189	# because we got different python's executable names depending on
190	# the fs being case-insensitive (Mac OS X, Cygwin...) or
191	# case-sensitive (linux)...so this way we will have an unique name
192	# for our hostpython, regarding the used fs
193	for exe_name in ['python.exe', 'python']:	8 !
194	exe = join(self.get_path_to_python(), exe_name)	8 ✔
195	if Path(exe).is_file():	8 !
196	shprint(sh.cp, exe, self.python_exe)	8 ✔
197	break	8 ✔
198
199	ensure_dir(self.site_root)	8 ✔
200	self.ctx.hostpython = self.python_exe	8 ✔
201
202	if build_configured:	8 ✔
203
204	shprint(	8 ✔
205	sh.Command(self.python_exe), "-m", "ensurepip", "--root", self.site_root, "-U",
206	_env={"HOME": "/tmp", "PATH": self.local_bin}
207	)
208	self.fix_pip_shebangs()	8 ✔
209
210
211	recipe = HostPython3Recipe()	8 ✔

kivy / python-for-android / 23662696415

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

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