{{ message }}
-
-
Notifications
You must be signed in to change notification settings - Fork 35.4k
Expand file tree
/
Copy pathcheck_extension_modules.py
More file actions
562 lines (489 loc) · 19.9 KB
/
Copy pathcheck_extension_modules.py
File metadata and controls
562 lines (489 loc) · 19.9 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
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
"""Check extension modules
The script checks shared and built-in extension modules. It verifies that the
modules have been built and that they can be imported successfully. Missing
modules and failed imports are reported to the user. Shared extension
files are renamed on failed import.
Module information is parsed from several sources:
- core modules hard-coded in Modules/config.c.in
- Windows-specific modules that are hard-coded in PC/config.c
- MODULE_{name}_STATE entries in Makefile (provided through sysconfig)
- Various makesetup files:
- $(srcdir)/Modules/Setup
- Modules/Setup.[local|bootstrap|stdlib] files, which are generated
from $(srcdir)/Modules/Setup.*.in files
See --help for more information
"""
from __future__ import annotations
import _imp
import argparse
import enum
import json
import logging
import os
import pathlib
import pprint
import re
import sys
import sysconfig
import warnings
from collections.abc import Iterable
from importlib._bootstrap import ( # type: ignore[attr-defined]
_load as bootstrap_load,
)
from importlib.machinery import (
BuiltinImporter,
ExtensionFileLoader,
ModuleSpec,
)
from importlib.util import spec_from_file_location, spec_from_loader
from typing import NamedTuple
SRC_DIR = pathlib.Path(__file__).parent.parent.parent
# core modules, hard-coded in Modules/config.h.in
CORE_MODULES = {
"_ast",
"_imp",
"_string",
"_tokenize",
"_warnings",
"builtins",
"gc",
"marshal",
"sys",
}
# Windows-only modules
WINDOWS_MODULES = {
"_overlapped",
"_testconsole",
"_winapi",
"_wmi",
"msvcrt",
"nt",
"winreg",
"winsound",
}
logger = logging.getLogger(__name__)
parser = argparse.ArgumentParser(
prog="check_extension_modules",
description=__doc__,
formatter_class=argparse.RawDescriptionHelpFormatter,
)
parser.add_argument(
"--verbose",
action="store_true",
help="Verbose, report builtin, shared, and unavailable modules",
)
parser.add_argument(
"--debug",
action="store_true",
help="Enable debug logging",
)
parser.add_argument(
"--strict",
action=argparse.BooleanOptionalAction,
help=(
"Strict check, fail when a module is missing or fails to import"
"(default: no, unless env var PYTHONSTRICTEXTENSIONBUILD is set)"
),
default=bool(os.environ.get("PYTHONSTRICTEXTENSIONBUILD")),
)
parser.add_argument(
"--cross-compiling",
action=argparse.BooleanOptionalAction,
help=(
"Use cross-compiling checks "
"(default: no, unless env var _PYTHON_HOST_PLATFORM is set)."
),
default="_PYTHON_HOST_PLATFORM" in os.environ,
)
parser.add_argument(
"--list-module-names",
action="store_true",
help="Print a list of module names to stdout and exit",
)
parser.add_argument(
"--generate-missing-stdlib-info",
action="store_true",
help="Generate file with stdlib module info",
)
parser.add_argument(
"--with-missing-stdlib-config",
metavar="CONFIG_FILE",
help="Path to JSON config file with custom missing module messages",
)
@enum.unique
class ModuleState(enum.Enum):
# Makefile state "yes"
BUILTIN = "builtin"
SHARED = "shared"
DISABLED = "disabled"
MISSING = "missing"
NA = "n/a"
# disabled by Setup / makesetup rule
DISABLED_SETUP = "disabled_setup"
def __bool__(self) -> bool:
return self.value in {"builtin", "shared"}
class ModuleInfo(NamedTuple):
name: str
state: ModuleState
class ModuleChecker:
pybuilddir_txt = "pybuilddir.txt"
setup_files = (
# see end of configure.ac
pathlib.Path("Modules/Setup.local"),
pathlib.Path("Modules/Setup.stdlib"),
pathlib.Path("Modules/Setup.bootstrap"),
SRC_DIR / "Modules/Setup",
)
def __init__(self, cross_compiling: bool = False, strict: bool = False):
self.cross_compiling = cross_compiling
self.strict_extensions_build = strict
self.ext_suffix = sysconfig.get_config_var("EXT_SUFFIX")
self.platform = sysconfig.get_platform()
self.builddir = self.get_builddir()
self.modules = self.get_modules()
self.builtin_ok: list[ModuleInfo] = []
self.shared_ok: list[ModuleInfo] = []
self.failed_on_import: list[ModuleInfo] = []
self.missing: list[ModuleInfo] = []
self.disabled_configure: list[ModuleInfo] = []
self.disabled_setup: list[ModuleInfo] = []
self.notavailable: list[ModuleInfo] = []
def check(self) -> None:
if not hasattr(_imp, 'create_dynamic'):
logger.warning(
('Dynamic extensions not supported '
'(HAVE_DYNAMIC_LOADING not defined)'),
)
for modinfo in self.modules:
logger.debug("Checking '%s' (%s)", modinfo.name, self.get_location(modinfo))
if modinfo.state == ModuleState.DISABLED:
self.disabled_configure.append(modinfo)
elif modinfo.state == ModuleState.DISABLED_SETUP:
self.disabled_setup.append(modinfo)
elif modinfo.state == ModuleState.MISSING:
self.missing.append(modinfo)
elif modinfo.state == ModuleState.NA:
self.notavailable.append(modinfo)
else:
try:
if self.cross_compiling:
self.check_module_cross(modinfo)
else:
self.check_module_import(modinfo)
except (ImportError, FileNotFoundError):
self.rename_module(modinfo)
self.failed_on_import.append(modinfo)
else:
if modinfo.state == ModuleState.BUILTIN:
self.builtin_ok.append(modinfo)
else:
assert modinfo.state == ModuleState.SHARED
self.shared_ok.append(modinfo)
def summary(self, *, verbose: bool = False) -> None:
longest = max([len(e.name) for e in self.modules], default=0)
def print_three_column(modinfos: list[ModuleInfo]) -> None:
names = [modinfo.name for modinfo in modinfos]
names.sort(key=str.lower)
# guarantee zip() doesn't drop anything
while len(names) % 3:
names.append("")
for l, m, r in zip(names[::3], names[1::3], names[2::3]): # noqa: E741
print("%-*s %-*s %-*s" % (longest, l, longest, m, longest, r))
if verbose and self.builtin_ok:
print("The following *built-in* modules have been successfully built:")
print_three_column(self.builtin_ok)
print()
if verbose and self.shared_ok:
print("The following *shared* modules have been successfully built:")
print_three_column(self.shared_ok)
print()
if self.disabled_configure:
print("The following modules are *disabled* in configure script:")
print_three_column(self.disabled_configure)
print()
if self.disabled_setup:
print("The following modules are *disabled* in Modules/Setup files:")
print_three_column(self.disabled_setup)
print()
if verbose and self.notavailable:
print(
f"The following modules are not available on platform '{self.platform}':"
)
print_three_column(self.notavailable)
print()
if self.missing:
print("The necessary bits to build these optional modules were not found:")
print_three_column(self.missing)
print("To find the necessary bits, look in configure.ac and config.log.")
print()
if self.failed_on_import:
print(
"Following modules built successfully "
"but were removed because they could not be imported:"
)
print_three_column(self.failed_on_import)
print()
if any(
modinfo.name == "_ssl" for modinfo in self.missing + self.failed_on_import
):
print("Could not build the ssl module!")
print("Python requires a OpenSSL 1.1.1 or newer")
if sysconfig.get_config_var("OPENSSL_LDFLAGS"):
print("Custom linker flags may require --with-openssl-rpath=auto")
print()
disabled = len(self.disabled_configure) + len(self.disabled_setup)
print(
f"Checked {len(self.modules)} modules ("
f"{len(self.builtin_ok)} built-in, "
f"{len(self.shared_ok)} shared, "
f"{len(self.notavailable)} n/a on {self.platform}, "
f"{disabled} disabled, "
f"{len(self.missing)} missing, "
f"{len(self.failed_on_import)} failed on import)"
)
def check_strict_build(self) -> None:
"""Fail if modules are missing and it's a strict build"""
if self.strict_extensions_build and (self.failed_on_import or self.missing):
raise RuntimeError("Failed to build some stdlib modules")
def list_module_names(self, *, all: bool = False) -> set[str]:
names = {modinfo.name for modinfo in self.modules}
if all:
names.update(WINDOWS_MODULES)
return names
def generate_missing_stdlib_info(self, config_path: str | None = None) -> None:
config_messages = {}
if config_path:
try:
with open(config_path, encoding='utf-8') as f:
config_messages = json.load(f)
except (FileNotFoundError, json.JSONDecodeError) as e:
raise RuntimeError(f"Failed to load missing stdlib config {config_path!r}") from e
messages = {}
for name in WINDOWS_MODULES:
messages[name] = f"Unsupported platform for Windows-only standard library module {name!r}"
for modinfo in self.modules:
if modinfo.state in (ModuleState.DISABLED, ModuleState.DISABLED_SETUP):
messages[modinfo.name] = f"Standard library module disabled during build {modinfo.name!r} was not found"
elif modinfo.state == ModuleState.NA:
messages[modinfo.name] = f"Unsupported platform for standard library module {modinfo.name!r}"
messages.update(config_messages)
content = f'''\
# Standard library information used by the traceback module for more informative
# ModuleNotFound error messages.
# Generated by check_extension_modules.py
_MISSING_STDLIB_MODULE_MESSAGES = {pprint.pformat(messages)}
'''
output_path = self.builddir / "_missing_stdlib_info.py"
with open(output_path, "w", encoding="utf-8") as f:
f.write(content)
def get_builddir(self) -> pathlib.Path:
try:
with open(self.pybuilddir_txt, encoding="utf-8") as f:
builddir = f.read()
except FileNotFoundError:
logger.error("%s must be run from the top build directory", __file__)
raise
builddir_path = pathlib.Path(builddir)
logger.debug("%s: %s", self.pybuilddir_txt, builddir_path)
return builddir_path
def get_modules(self) -> list[ModuleInfo]:
"""Get module info from sysconfig and Modules/Setup* files"""
seen = set()
modules = []
# parsing order is important, first entry wins
for modinfo in self.get_core_modules():
modules.append(modinfo)
seen.add(modinfo.name)
for setup_file in self.setup_files:
for modinfo in self.parse_setup_file(setup_file):
if modinfo.name not in seen:
modules.append(modinfo)
seen.add(modinfo.name)
for modinfo in self.get_sysconfig_modules():
if modinfo.name not in seen:
modules.append(modinfo)
seen.add(modinfo.name)
logger.debug("Found %i modules in total", len(modules))
modules.sort()
return modules
def get_core_modules(self) -> Iterable[ModuleInfo]:
"""Get hard-coded core modules"""
for name in CORE_MODULES:
modinfo = ModuleInfo(name, ModuleState.BUILTIN)
logger.debug("Found core module %s", modinfo)
yield modinfo
def get_sysconfig_modules(self) -> Iterable[ModuleInfo]:
"""Get modules defined in Makefile through sysconfig
MODBUILT_NAMES: modules in *static* block
MODSHARED_NAMES: modules in *shared* block
MODDISABLED_NAMES: modules in *disabled* block
"""
moddisabled = set(sysconfig.get_config_var("MODDISABLED_NAMES").split())
if self.cross_compiling:
modbuiltin = set(sysconfig.get_config_var("MODBUILT_NAMES").split())
else:
modbuiltin = set(sys.builtin_module_names)
for key, value in sysconfig.get_config_vars().items():
if not key.startswith("MODULE_") or not key.endswith("_STATE"):
continue
if value not in {"yes", "disabled", "missing", "n/a"}:
raise ValueError(f"Unsupported value '{value}' for {key}")
modname = key[7:-6].lower()
if modname in moddisabled:
# Setup "*disabled*" rule
state = ModuleState.DISABLED_SETUP
elif value in {"disabled", "missing", "n/a"}:
state = ModuleState(value)
elif modname in modbuiltin:
assert value == "yes"
state = ModuleState.BUILTIN
else:
assert value == "yes"
state = ModuleState.SHARED
modinfo = ModuleInfo(modname, state)
logger.debug("Found %s in Makefile", modinfo)
yield modinfo
def parse_setup_file(self, setup_file: pathlib.Path) -> Iterable[ModuleInfo]:
"""Parse a Modules/Setup file"""
assign_var = re.compile(r"^\w+=") # EGG_SPAM=foo
# default to static module
state = ModuleState.BUILTIN
logger.debug("Parsing Setup file %s", setup_file)
with open(setup_file, encoding="utf-8") as f:
for line in f:
line = line.strip()
if not line or line.startswith("#") or assign_var.match(line):
continue
match line.split():
case ["*shared*"]:
state = ModuleState.SHARED
case ["*static*"]:
state = ModuleState.BUILTIN
case ["*disabled*"]:
state = ModuleState.DISABLED
case ["*noconfig*"]:
continue
case [*items]:
if state == ModuleState.DISABLED:
# *disabled* can disable multiple modules per line
for item in items:
modinfo = ModuleInfo(item, state)
logger.debug("Found %s in %s", modinfo, setup_file)
yield modinfo
elif state in {ModuleState.SHARED, ModuleState.BUILTIN}:
# *shared* and *static*, first item is the name of the module.
modinfo = ModuleInfo(items[0], state)
logger.debug("Found %s in %s", modinfo, setup_file)
yield modinfo
def get_spec(self, modinfo: ModuleInfo) -> ModuleSpec:
"""Get ModuleSpec for builtin or extension module"""
if modinfo.state == ModuleState.SHARED:
mod_location = self.get_location(modinfo)
assert mod_location is not None
location = os.fspath(mod_location)
loader = ExtensionFileLoader(modinfo.name, location)
spec = spec_from_file_location(modinfo.name, location, loader=loader)
assert spec is not None
return spec
elif modinfo.state == ModuleState.BUILTIN:
spec = spec_from_loader(modinfo.name, loader=BuiltinImporter)
assert spec is not None
return spec
else:
raise ValueError(modinfo)
def get_location(self, modinfo: ModuleInfo) -> pathlib.Path | None:
"""Get shared library location in build directory"""
if modinfo.state == ModuleState.SHARED:
return self.builddir / f"{modinfo.name}{self.ext_suffix}"
else:
return None
def _check_file(self, modinfo: ModuleInfo, spec: ModuleSpec) -> None:
"""Check that the module file is present and not empty"""
if spec.loader is BuiltinImporter: # type: ignore[comparison-overlap]
return # type: ignore[unreachable]
try:
assert spec.origin is not None
st = os.stat(spec.origin)
except FileNotFoundError:
logger.error("%s (%s) is missing", modinfo.name, spec.origin)
raise
if not st.st_size:
raise ImportError(f"{spec.origin} is an empty file")
def check_module_import(self, modinfo: ModuleInfo) -> None:
"""Attempt to import module and report errors"""
spec = self.get_spec(modinfo)
self._check_file(modinfo, spec)
try:
with warnings.catch_warnings():
# ignore deprecation warning from deprecated modules
warnings.simplefilter("ignore", DeprecationWarning)
bootstrap_load(spec)
except ImportError as e:
logger.error("%s failed to import: %s", modinfo.name, e)
raise
except Exception:
if not hasattr(_imp, 'create_dynamic'):
logger.warning("Dynamic extension '%s' ignored", modinfo.name)
return
logger.exception("Importing extension '%s' failed!", modinfo.name)
raise
def check_module_cross(self, modinfo: ModuleInfo) -> None:
"""Sanity check for cross compiling"""
spec = self.get_spec(modinfo)
self._check_file(modinfo, spec)
def rename_module(self, modinfo: ModuleInfo) -> None:
"""Rename module file"""
if modinfo.state == ModuleState.BUILTIN:
logger.error("Cannot mark builtin module '%s' as failed!", modinfo.name)
return
failed_name = f"{modinfo.name}_failed{self.ext_suffix}"
builddir_path = self.get_location(modinfo)
assert builddir_path is not None
if builddir_path.is_symlink():
symlink = builddir_path
module_path = builddir_path.resolve().relative_to(os.getcwd())
failed_path = module_path.parent / failed_name
else:
symlink = None
module_path = builddir_path
failed_path = self.builddir / failed_name
# remove old failed file
failed_path.unlink(missing_ok=True)
# remove symlink
if symlink is not None:
symlink.unlink(missing_ok=True)
# rename shared extension file
try:
module_path.rename(failed_path)
except FileNotFoundError:
logger.debug("Shared extension file '%s' does not exist.", module_path)
else:
logger.debug("Rename '%s' -> '%s'", module_path, failed_path)
def main() -> None:
args = parser.parse_args()
if args.debug:
args.verbose = True
logging.basicConfig(
level=logging.DEBUG if args.debug else logging.INFO,
format="[%(levelname)s] %(message)s",
)
checker = ModuleChecker(
cross_compiling=args.cross_compiling,
strict=args.strict,
)
if args.list_module_names:
names = checker.list_module_names(all=True)
for name in sorted(names):
print(name)
elif args.generate_missing_stdlib_info:
checker.check()
checker.generate_missing_stdlib_info(args.with_missing_stdlib_config)
else:
checker.check()
checker.summary(verbose=args.verbose)
try:
checker.check_strict_build()
except RuntimeError as e:
parser.exit(1, f"\nError: {e}\n")
if __name__ == "__main__":
main()
You can’t perform that action at this time.