Repository navigation
Expand file tree
/
Copy pathcpython.py
More file actions
398 lines (329 loc) · 16.2 KB
/
Copy pathcpython.py
File metadata and controls
398 lines (329 loc) · 16.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
import configparser
import datetime
import os
import re
import runez
import yaml
from runez.pyenv import Version
from portable_python import LOG, patch_file, patch_folder, PPG, PythonBuilder
from portable_python.external.tkinter import TkInter
from portable_python.external.xcpython import Bdb, Bzip2, Gdbm, LibFFI, Openssl, Readline, Sqlite, Uuid, Xz, Zlib
from portable_python.inspector import LibAutoCorrect, PythonInspector
# https://github.com/docker-library/python/issues/160
PGO_TESTS = """
-m test.regrtest --pgo test_array test_base64 test_binascii test_binhex test_binop test_bytes test_c_locale_coercion
test_class test_cmath test_codecs test_compile test_complex test_csv test_decimal test_dict test_float test_fstring
test_hashlib test_io test_iter test_json test_long test_math test_memoryview test_pickle test_re test_set test_slice
test_struct test_threading test_time test_traceback test_unicode
"""
def represented_yaml(key_value_pairs):
"""
Yaml representation for given key/value pairs
Parameters
----------
key_value_pairs : iterable
Key/value pairs to represent
Returns
-------
str
Yaml representation
"""
content = [yaml.safe_dump(runez.serialize.json_sanitized({x: y}), width=140) for x, y in key_value_pairs]
return runez.joined(content, delimiter="\n")
# noinspection PyPep8Naming
class Cpython(PythonBuilder):
"""
Build CPython binaries
See https://docs.python.org/3/using/configure.html
"""
xenv_CFLAGS_NODIST = "-Wno-unused-command-line-argument"
def build_information(self):
"""
Build information to store in manifest.
`None` or empty values are "naturally" omitted by the fact we use `runez.joined()` and `runez.flattened()`,
which have a default parameter `keep_empty=False`.
Yields
------
(str, dict)
"""
yield (
"cpython",
{
"prefix": self.setup.prefix,
"source": self.url,
"static": runez.joined(self.modules.selected) or None,
"target": PPG.target,
"version": self.version,
},
)
yield "configure-args", runez.joined(runez.short(x) for x in self.c_configure_args())
compiled_by = os.environ.get("PP_ORIGIN") or PPG.config.get_value("compiled-by")
bc = self.setup.build_context
yield (
"compilation-info",
{
"compiled-by": compiled_by or "https://pypi.org/project/portable-python/",
"date": datetime.datetime.now(tz=datetime.timezone.utc).strftime("%Y-%m-%d %H:%M:%S %Z"),
"host-platform": runez.SYS_INFO.platform_info,
"ldd-version": PythonInspector.tool_version("ldd"),
"portable-python-version": runez.get_version(__package__),
"special-context": bc.isolate_usr_local and bc,
},
)
additional = PPG.config.get_value("manifest", "additional-info")
if additional:
res = {}
for k, v in additional.items():
if isinstance(v, str) and v.startswith("$"):
# Expand environment variables
v = os.environ.get(v[1:])
res[k] = v
yield "additional-info", res
@classmethod
def candidate_modules(cls):
return [LibFFI, Zlib, Xz, Bzip2, Readline, Openssl, Sqlite, Bdb, Gdbm, Uuid, TkInter]
@property
def url(self):
"""Url of source tarball"""
if PPG.config.get_value("cpython-use-github"):
return f"https://github.com/python/cpython/archive/refs/tags/v{self.version}.tar.gz"
return f"https://www.python.org/ftp/python/{self.version.main}/Python-{self.version}.tar.xz"
def xenv_LDFLAGS_NODIST(self):
yield f"-L{self.deps_lib}"
if PPG.target.is_linux:
yield "-Wl,-z,origin"
# rpath intentionally long to give 'patchelf' some room
yield f"-Wl,-rpath={self.c_configure_prefix}/lib:{self.c_configure_prefix}/lib64"
def has_configure_opt(self, name, *variants):
opts = self.c_configure_args_from_config
if opts:
variants = runez.flattened(variants)
if not variants:
return any(x.startswith(name) for x in opts)
specs = [name]
specs.extend("%s=%s" % (name, x) for x in variants)
return any(x in specs for x in opts)
@runez.cached_property
def c_configure_args_from_config(self):
return runez.flattened(PPG.config.get_value("cpython-configure"))
def c_configure_args(self):
configured = self.c_configure_args_from_config
if configured:
yield from configured
if self.active_module(Openssl):
if self.version >= "3.7" and not self.has_configure_opt("--with-openssl"):
yield f"--with-openssl={self.deps}"
if not self.has_configure_opt("--with-system-ffi"):
if self.active_module(LibFFI):
yield f"LIBFFI_INCLUDEDIR={self.deps_lib}"
yield "--with-system-ffi=no"
else:
yield "--with-system-ffi"
if self.version >= "3.10" and not self.has_configure_opt("--disable-test-modules"):
yield "--disable-test-modules"
if not self.has_configure_opt("--with-dbmliborder"):
db_order = [
self.is_usable_module(Gdbm) and "gdbm",
self.is_usable_module(Bdb) and "bdb",
PPG.find_telltale("{include}/ndbm.h") and "ndbm",
]
db_order = runez.joined(db_order, delimiter=":")
if db_order:
yield f"--with-dbmliborder={db_order}"
tkinter = self.active_module(TkInter)
if tkinter:
# TODO: this doesn't seem to be enough, on macos cpython's ./configure still picks up the shared macos tcl/tk libs
version = Version(tkinter.version)
yield f"--with-tcltk-includes=-I{self.deps}/include"
yield f"--with-tcltk-libs=-L{self.deps_lib} -ltcl{version.mm} -ltk{version.mm}"
@runez.cached_property
def prefix_lib_folder(self):
"""Path to <prefix>/lib/pythonM.m folder"""
return self.install_folder / f"lib/python{self.version.mm}"
@runez.cached_property
def prefix_config_folder(self):
"""Path to <prefix>/lib/pythonM.m/config-M.m-<platform>/ folder"""
for path in runez.ls_dir(self.prefix_lib_folder):
if path.is_dir() and path.name.startswith("config-"):
return path
def _prepare(self):
super()._prepare()
if PPG.target.is_macos:
# Avoid pollution of static builds via /usr/local on macOS
rx = re.compile(r"^(Doc|Grammar|Lib|Misc|Modules|PC|Tools|msi|.*\.(md|html|man|pro|rst))$")
patch_folder(self.m_src_build, r"/usr/local\b", self.deps.as_posix(), ignore=rx)
setup_py = self.m_src_build / "setup.py"
if setup_py.exists():
# Special edge case in macosx_sdk_specified() where /usr/local is fine...
x = "startswith({q}/usr/{q}) and not path.startswith({q}{p}{q})"
special_case = x.replace("(", r"\(").replace(")", r"\)").format(q="['\"]", p=self.deps)
restored = x.format(q="'", p="/usr/local")
patch_file(setup_py, special_case, restored)
# Only doable on macOS: patch -install_name so produced exes/libs use a relative path
install_name = "-Wl,-install_name,@executable_path/.."
patch_folder(self.m_src_build, r"-Wl,-install_name,\$\(prefix\)", install_name)
def _do_linux_compile(self):
self.run_configure("./configure", self.c_configure_args(), prefix=self.c_configure_prefix)
make_args = []
if self.version < "3.8":
pgo_tests = runez.joined(runez.flattened(PGO_TESTS, split=True))
make_args.append(f"PROFILE_TASK={pgo_tests}")
self.run_make(*make_args)
self.run_make("install", f"DESTDIR={self.destdir}")
def _finalize(self):
is_shared = self.setup.prefix or self.has_configure_opt("--enable-shared", "yes")
if is_shared:
lib_auto_correct = LibAutoCorrect(self.c_configure_prefix, self.install_folder, ppp_marker=self.setup.folders.ppp_marker)
lib_auto_correct.run()
PPG.config.cleanup_configured_globs("Pass 1", self, "cpython-clean-1st-pass")
PPG.config.symlink_duplicates(self.install_folder)
validation_script = PPG.config.resolved_path("cpython-validate-script")
if validation_script:
LOG.info("Exercising configured validation script: %s" % runez.short(validation_script))
self.run_python(validation_script)
additional = PPG.config.get_value("cpython-additional-packages")
if additional:
# Config wants additional packages installed, ensure that `pip` is installed first
if "--with-ensurepip=no" not in self.c_configure_args_from_config:
cmd = ["-mensurepip"]
if "--with-ensurepip=install" not in self.c_configure_args_from_config:
cmd.append("--upgrade")
self.run_python(cmd)
self.run_python("-mpip", "install", *runez.flattened(additional))
runez.abort_if(not runez.DRYRUN and not self.bin_python, f"Can't find bin/python in {self.bin_folder}")
PPG.config.ensure_main_file_symlinks(self)
if not self.setup.prefix:
self._relativize_sysconfig()
self._relativize_shebangs()
self._validate_venv_module()
if PPG.config.get_value("cpython-compile-all"):
self.run_python("-mcompileall", "-q", self.install_folder / "lib")
if self.prefix_config_folder:
# When --enable-shared is specified, cpython build does not produce 'lib/libpython*.a'
# Add it if build was not configured to clean up 'self.prefix_config_folder'
actual_static = self.prefix_config_folder / f"libpython{self.version.mm}.a"
symlink_static = self.install_folder / f"lib/libpython{self.version.mm}.a"
if actual_static.exists() and not symlink_static.exists():
runez.symlink(actual_static, symlink_static)
info_path = PPG.config.get_value("manifest", "build-info")
if info_path:
contents = represented_yaml(self.build_information())
runez.write(self.install_folder / info_path, contents)
info_path = PPG.config.get_value("manifest", "inspection-report")
if info_path:
with runez.colors.ActivateColors(enable=False):
py_inspector = PythonInspector(self.install_folder, modules="all")
contents = "%s\n" % py_inspector.represented(verbose=True)
runez.write(self.install_folder / info_path, contents)
PPG.config.cleanup_configured_globs("Pass 2", self, "cpython-clean-2nd-pass", "cpython-clean")
self._apply_pep668()
py_inspector = PythonInspector(self.install_folder)
print(py_inspector.represented())
problem = py_inspector.full_so_report.get_problem(portable=not is_shared)
runez.abort_if(problem and self.setup.x_debug != "direct-finalize", "Build failed: %s" % problem)
def _apply_pep668(self):
"""
Apply PEP 668, if configured.
Additionally:
- Delete bin/pip* if they exist
- mark `site-packages/` as read-only if it exists, this will force any '-mpip install' to imply `--user`.
"""
content = PPG.config.get_value("cpython-pep668-externally-managed")
if not content:
return
runez.abort_if(not content.get("Error"), "Mis-configured 'cpython-pep668-externally-managed', expecting an 'Error' key")
PPG.config.cleanup_globs("PEP 668", self, "bin/pip*")
externally_managed = self.prefix_lib_folder / "EXTERNALLY-MANAGED"
if not runez.log.hdry(f"write {runez.short(externally_managed)}"):
config = configparser.ConfigParser()
config["externally-managed"] = content
with open(externally_managed, "w") as fh:
config.write(fh)
def _relativize_shebangs(self):
"""Autocorrect shebangs in bin/ folder, making them relative to the location of the python executable"""
for folder in (self.bin_folder, self.prefix_config_folder):
for path in runez.ls_dir(folder):
if path != self.bin_python and runez.is_executable(path) and not path.is_symlink():
self._relativize_shebang_file(path)
def _relativize_sysconfig(self):
"""
Autocorrect pkgconfig and sysconfig to use relative paths
See https://manpages.debian.org/stretch/pkg-config/pkg-config.1.en.html#PKG-CONFIG_DERIVED_VARIABLES
"""
patch_folder(self.install_folder / "lib/pkgconfig", f"prefix={self.c_configure_prefix}", "prefix=${pcfiledir}/../..")
sys_cfg = self._find_sys_cfg()
if sys_cfg:
rs = RelSysConf(sys_cfg, self.c_configure_prefix)
runez.write(sys_cfg, rs.text)
def _validate_venv_creation(self, copies=False):
folder = "venv"
args = ["-mvenv"]
if copies:
args.append("--copies")
folder += "-copies"
folder = self.setup.folders.build_folder / "test-venvs" / folder
self.run_python(*args, folder)
self._do_run(folder / "bin/pip", "--version")
def _validate_venv_module(self):
"""Verify that the freshly compiled python can create venvs without issue"""
check_venvs = PPG.config.get_value("cpython-check-venvs")
if check_venvs:
if check_venvs in ("venv", "all"):
self._validate_venv_creation(copies=False)
if check_venvs in ("copies", "all"):
self._validate_venv_creation(copies=True)
def _find_sys_cfg(self):
if self.prefix_config_folder:
for path in runez.ls_dir(self.prefix_config_folder.parent):
if path.name.startswith("_sysconfigdata"):
return path
def _relativize_shebang_file(self, path):
lines = []
with open(path) as fh:
try:
for line in fh:
if lines:
# Only modify the first line
lines.append(line)
continue
if not line.startswith("#!") or "bin/python" not in line:
# Not a shebang, or not a python shebang
return
rel_location = os.path.relpath(self.bin_python, path.parent)
lines.append("#!/bin/sh\n")
lines.append('"exec" "$(dirname $0)/%s" "$0" "$@"\n' % rel_location)
lines.append("# -*- coding: utf-8 -*-\n")
except UnicodeError:
return
if lines:
LOG.info("Auto-corrected shebang for %s" % runez.short(path))
with open(path, "w") as fh:
for line in lines:
fh.write(line)
class RelSysConf:
"""Make _sysconfigdata report paths (eg: prefix) relative to its current location"""
def __init__(self, path, prefix):
self.path = path
self.prefix = prefix
self.rx_marker = re.compile(r"^build_time_vars\s*=.*")
self.rx_strings = re.compile(r"(['\"])([^'\"]+)(['\"])")
self.text = "\n".join(self._process_file())
def _process_file(self):
for line in runez.readlines(self.path):
if self.rx_marker.match(line):
yield "prefix = __file__.rpartition('/')[0].rpartition('/')[0].rpartition('/')[0]"
if self.prefix in line:
line = "".join(self._relativize(line))
yield line
def _relativize(self, line):
start = 0
for m in self.rx_strings.finditer(line):
yield line[start : m.start(0)]
start = m.end(0)
content = m.group(2)
if self.prefix in content:
quote = m.group(1)
yield "f%s%s%s" % (quote, content.replace(self.prefix, "{prefix}"), quote)
else:
yield m.group(0)
yield line[start:]