mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-24 11:44:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

bpo-45020: Fix some corner cases for frozen module generation. (gh-28538)

Browse source 
This also includes some cleanup in preparation for a PR to make the "make all" output less noisy.

https://bugs.python.org/issue45020
This commit is contained in:
Eric Snow 2021-09-24 14:35:47 -06:00 • committed by GitHub
parent bfe26bbad7
commit 7c801e0fa6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 130 additions and 69 deletions
Download patch file Download diff file Expand all files Collapse all files

79
Makefile.pre.in
View file

@ -736,25 +736,54 @@ Programs/_testembed: Programs/_testembed.o $(LIBRARY_DEPS)
############################################################################ ############################################################################
# frozen modules (including importlib) # frozen modules (including importlib)
# FROZEN_FILES_* are auto-generated by Tools/scripts/freeze_modules.py.
FROZEN_FILES_IN = \
Lib/importlib/_bootstrap.py \
Lib/importlib/_bootstrap_external.py \
Lib/zipimport.py \
Lib/abc.py \
Lib/codecs.py \
Lib/io.py \
Lib/_collections_abc.py \
Lib/_sitebuiltins.py \
Lib/genericpath.py \
Lib/ntpath.py \
Lib/posixpath.py \
Lib/os.py \
Lib/site.py \
Lib/stat.py \
Lib/__hello__.py
# End FROZEN_FILES_IN
FROZEN_FILES_OUT = \
Python/frozen_modules/importlib._bootstrap.h \
Python/frozen_modules/importlib._bootstrap_external.h \
Python/frozen_modules/zipimport.h \
Python/frozen_modules/abc.h \
Python/frozen_modules/codecs.h \
Python/frozen_modules/io.h \
Python/frozen_modules/_collections_abc.h \
Python/frozen_modules/_sitebuiltins.h \
Python/frozen_modules/genericpath.h \
Python/frozen_modules/ntpath.h \
Python/frozen_modules/posixpath.h \
Python/frozen_modules/os.h \
Python/frozen_modules/site.h \
Python/frozen_modules/stat.h \
Python/frozen_modules/__hello__.h
# End FROZEN_FILES_OUT
Programs/_freeze_module.o: Programs/_freeze_module.c Makefile Programs/_freeze_module.o: Programs/_freeze_module.c Makefile
Programs/_freeze_module: Programs/_freeze_module.o $(LIBRARY_OBJS_OMIT_FROZEN) Programs/_freeze_module: Programs/_freeze_module.o $(LIBRARY_OBJS_OMIT_FROZEN)
$(LINKCC) $(PY_CORE_LDFLAGS) -o $@ Programs/_freeze_module.o $(LIBRARY_OBJS_OMIT_FROZEN) $(LIBS) $(MODLIBS) $(SYSLIBS) $(LINKCC) $(PY_CORE_LDFLAGS) -o $@ Programs/_freeze_module.o $(LIBRARY_OBJS_OMIT_FROZEN) $(LIBS) $(MODLIBS) $(SYSLIBS)
Tools/scripts/freeze_modules.py: Programs/_freeze_module
.PHONY: regen-frozen
regen-frozen: Tools/scripts/freeze_modules.py $(FROZEN_FILES)
$(PYTHON_FOR_REGEN) $(srcdir)/Tools/scripts/freeze_modules.py
@echo "The Makefile was updated, you may need to re-run make."
# BEGIN: freezing modules # BEGIN: freezing modules
Python/frozen_modules/importlib__bootstrap.h: Programs/_freeze_module Lib/importlib/_bootstrap.py Python/frozen_modules/importlib._bootstrap.h: Programs/_freeze_module Lib/importlib/_bootstrap.py
Programs/_freeze_module importlib._bootstrap $(srcdir)/Lib/importlib/_bootstrap.py $(srcdir)/Python/frozen_modules/importlib__bootstrap.h Programs/_freeze_module importlib._bootstrap $(srcdir)/Lib/importlib/_bootstrap.py $(srcdir)/Python/frozen_modules/importlib._bootstrap.h
Python/frozen_modules/importlib__bootstrap_external.h: Programs/_freeze_module Lib/importlib/_bootstrap_external.py Python/frozen_modules/importlib._bootstrap_external.h: Programs/_freeze_module Lib/importlib/_bootstrap_external.py
Programs/_freeze_module importlib._bootstrap_external $(srcdir)/Lib/importlib/_bootstrap_external.py $(srcdir)/Python/frozen_modules/importlib__bootstrap_external.h Programs/_freeze_module importlib._bootstrap_external $(srcdir)/Lib/importlib/_bootstrap_external.py $(srcdir)/Python/frozen_modules/importlib._bootstrap_external.h
Python/frozen_modules/zipimport.h: Programs/_freeze_module Lib/zipimport.py Python/frozen_modules/zipimport.h: Programs/_freeze_module Lib/zipimport.py
Programs/_freeze_module zipimport $(srcdir)/Lib/zipimport.py $(srcdir)/Python/frozen_modules/zipimport.h Programs/_freeze_module zipimport $(srcdir)/Lib/zipimport.py $(srcdir)/Python/frozen_modules/zipimport.h
@ -797,6 +826,13 @@ Python/frozen_modules/__hello__.h: Programs/_freeze_module Lib/__hello__.py
# END: freezing modules # END: freezing modules
Tools/scripts/freeze_modules.py: Programs/_freeze_module
.PHONY: regen-frozen
regen-frozen: Tools/scripts/freeze_modules.py $(FROZEN_FILES_IN)
$(PYTHON_FOR_REGEN) $(srcdir)/Tools/scripts/freeze_modules.py
@echo "The Makefile was updated, you may need to re-run make."
# We keep this renamed target around for folks with muscle memory. # We keep this renamed target around for folks with muscle memory.
.PHONY: regen-importlib .PHONY: regen-importlib
regen-importlib: regen-frozen regen-importlib: regen-frozen
@ -1026,26 +1062,7 @@ regen-opcode-targets:
Python/ceval.o: $(srcdir)/Python/opcode_targets.h $(srcdir)/Python/ceval_gil.h \ Python/ceval.o: $(srcdir)/Python/opcode_targets.h $(srcdir)/Python/ceval_gil.h \
$(srcdir)/Python/condvar.h $(srcdir)/Python/condvar.h
# FROZEN_FILES is auto-generated by Tools/scripts/freeze_modules.py. Python/frozen.o: $(FROZEN_FILES_OUT)
FROZEN_FILES = \
Python/frozen_modules/importlib__bootstrap.h \
Python/frozen_modules/importlib__bootstrap_external.h \
Python/frozen_modules/zipimport.h \
Python/frozen_modules/abc.h \
Python/frozen_modules/codecs.h \
Python/frozen_modules/io.h \
Python/frozen_modules/_collections_abc.h \
Python/frozen_modules/_sitebuiltins.h \
Python/frozen_modules/genericpath.h \
Python/frozen_modules/ntpath.h \
Python/frozen_modules/posixpath.h \
Python/frozen_modules/os.h \
Python/frozen_modules/site.h \
Python/frozen_modules/stat.h \
Python/frozen_modules/__hello__.h
# End FROZEN_FILES
Python/frozen.o: $(FROZEN_FILES)
# Generate DTrace probe macros, then rename them (PYTHON_ -> PyDTrace_) to # Generate DTrace probe macros, then rename them (PYTHON_ -> PyDTrace_) to
# follow our naming conventions. dtrace(1) uses the output filename to generate # follow our naming conventions. dtrace(1) uses the output filename to generate

8
PCbuild/_freeze_module.vcxproj
View file

@ -232,13 +232,13 @@
<!-- BEGIN frozen modules --> <!-- BEGIN frozen modules -->
<None Include="..\Lib\importlib\_bootstrap.py"> <None Include="..\Lib\importlib\_bootstrap.py">
<ModName>importlib._bootstrap</ModName> <ModName>importlib._bootstrap</ModName>
<IntFile>$(IntDir)importlib__bootstrap.g.h</IntFile> <IntFile>$(IntDir)importlib._bootstrap.g.h</IntFile>
<OutFile>$(PySourcePath)Python\frozen_modules\importlib__bootstrap.h</OutFile> <OutFile>$(PySourcePath)Python\frozen_modules\importlib._bootstrap.h</OutFile>
</None> </None>
<None Include="..\Lib\importlib\_bootstrap_external.py"> <None Include="..\Lib\importlib\_bootstrap_external.py">
<ModName>importlib._bootstrap_external</ModName> <ModName>importlib._bootstrap_external</ModName>
<IntFile>$(IntDir)importlib__bootstrap_external.g.h</IntFile> <IntFile>$(IntDir)importlib._bootstrap_external.g.h</IntFile>
<OutFile>$(PySourcePath)Python\frozen_modules\importlib__bootstrap_external.h</OutFile> <OutFile>$(PySourcePath)Python\frozen_modules\importlib._bootstrap_external.h</OutFile>
</None> </None>
<None Include="..\Lib\zipimport.py"> <None Include="..\Lib\zipimport.py">
<ModName>zipimport</ModName> <ModName>zipimport</ModName>

4
Python/frozen.c
View file

@ -38,8 +38,8 @@
#include "Python.h" #include "Python.h"
/* Includes for frozen modules: */ /* Includes for frozen modules: */
#include "frozen_modules/importlib__bootstrap.h" #include "frozen_modules/importlib._bootstrap.h"
#include "frozen_modules/importlib__bootstrap_external.h" #include "frozen_modules/importlib._bootstrap_external.h"
#include "frozen_modules/zipimport.h" #include "frozen_modules/zipimport.h"
#include "frozen_modules/abc.h" #include "frozen_modules/abc.h"
#include "frozen_modules/codecs.h" #include "frozen_modules/codecs.h"

58
Tools/scripts/freeze_modules.py
View file

@ -11,8 +11,9 @@ import posixpath
import subprocess import subprocess
import sys import sys
import textwrap import textwrap
import time
from update_file import updating_file_with_tmpfile from update_file import updating_file_with_tmpfile, update_file_with_tmpfile
ROOT_DIR = os.path.dirname(os.path.dirname(os.path.dirname(__file__))) ROOT_DIR = os.path.dirname(os.path.dirname(os.path.dirname(__file__)))
@ -272,7 +273,7 @@ def resolve_frozen_file(frozenid, destdir=MODULES_DIR):
except AttributeError: except AttributeError:
raise ValueError(f'unsupported frozenid {frozenid!r}') raise ValueError(f'unsupported frozenid {frozenid!r}')
# We use a consistent naming convention for all frozen modules. # We use a consistent naming convention for all frozen modules.
frozenfile = frozenid.replace('.', '_') + '.h' frozenfile = f'{frozenid}.h'
if not destdir: if not destdir:
return frozenfile return frozenfile
return os.path.join(destdir, frozenfile) return os.path.join(destdir, frozenfile)
@ -542,6 +543,7 @@ def regen_frozen(modules):
def regen_makefile(modules): def regen_makefile(modules):
pyfiles = []
frozenfiles = [] frozenfiles = []
rules = [''] rules = ['']
for src in _iter_sources(modules): for src in _iter_sources(modules):
@ -549,14 +551,16 @@ def regen_makefile(modules):
frozenfiles.append(f'\t\t{header} \\') frozenfiles.append(f'\t\t{header} \\')
pyfile = relpath_for_posix_display(src.pyfile, ROOT_DIR) pyfile = relpath_for_posix_display(src.pyfile, ROOT_DIR)
# Note that we freeze the module to the target .h file pyfiles.append(f'\t\t{pyfile} \\')
# instead of going through an intermediate file like we used to.
rules.append(f'{header}: Programs/_freeze_module {pyfile}')
rules.append(
(f'\tPrograms/_freeze_module {src.frozenid} '
f'$(srcdir)/{pyfile} $(srcdir)/{header}'))
rules.append('')
freeze = (f'Programs/_freeze_module {src.frozenid} '
f'$(srcdir)/{pyfile} $(srcdir)/{header}')
rules.extend([
f'{header}: Programs/_freeze_module {pyfile}',
f'\t{freeze}',
'',
])
pyfiles[-1] = pyfiles[-1].rstrip(" \\")
frozenfiles[-1] = frozenfiles[-1].rstrip(" \\") frozenfiles[-1] = frozenfiles[-1].rstrip(" \\")
print(f'# Updating {os.path.relpath(MAKEFILE)}') print(f'# Updating {os.path.relpath(MAKEFILE)}')
@ -564,8 +568,15 @@ def regen_makefile(modules):
lines = infile.readlines() lines = infile.readlines()
lines = replace_block( lines = replace_block(
lines, lines,
"FROZEN_FILES =", "FROZEN_FILES_IN =",
"# End FROZEN_FILES", "# End FROZEN_FILES_IN",
pyfiles,
MAKEFILE,
)
lines = replace_block(
lines,
"FROZEN_FILES_OUT =",
"# End FROZEN_FILES_OUT",
frozenfiles, frozenfiles,
MAKEFILE, MAKEFILE,
) )
@ -625,13 +636,15 @@ def regen_pcbuild(modules):
def freeze_module(modname, pyfile=None, destdir=MODULES_DIR): def freeze_module(modname, pyfile=None, destdir=MODULES_DIR):
"""Generate the frozen module .h file for the given module.""" """Generate the frozen module .h file for the given module."""
tmpsuffix = f'.{int(time.time())}'
for modname, pyfile, ispkg in resolve_modules(modname, pyfile): for modname, pyfile, ispkg in resolve_modules(modname, pyfile):
frozenfile = resolve_frozen_file(modname, destdir) frozenfile = resolve_frozen_file(modname, destdir)
_freeze_module(modname, pyfile, frozenfile) _freeze_module(modname, pyfile, frozenfile, tmpsuffix)
def _freeze_module(frozenid, pyfile, frozenfile): def _freeze_module(frozenid, pyfile, frozenfile, tmpsuffix):
tmpfile = frozenfile + '.new' tmpfile = f'{frozenfile}.{int(time.time())}'
print(tmpfile)
argv = [TOOL, frozenid, pyfile, tmpfile] argv = [TOOL, frozenid, pyfile, tmpfile]
print('#', ' '.join(os.path.relpath(a) for a in argv), flush=True) print('#', ' '.join(os.path.relpath(a) for a in argv), flush=True)
@ -642,7 +655,7 @@ def _freeze_module(frozenid, pyfile, frozenfile):
sys.exit(f'ERROR: missing {TOOL}; you need to run "make regen-frozen"') sys.exit(f'ERROR: missing {TOOL}; you need to run "make regen-frozen"')
raise # re-raise raise # re-raise
os.replace(tmpfile, frozenfile) update_file_with_tmpfile(frozenfile, tmpfile, create=True)
####################################### #######################################
@ -652,16 +665,19 @@ def main():
# Expand the raw specs, preserving order. # Expand the raw specs, preserving order.
modules = list(parse_frozen_specs(destdir=MODULES_DIR)) modules = list(parse_frozen_specs(destdir=MODULES_DIR))
# Freeze the target modules.
for src in _iter_sources(modules):
_freeze_module(src.frozenid, src.pyfile, src.frozenfile)
# Regen build-related files. # Regen build-related files.
regen_manifest(modules)
regen_frozen(modules)
regen_makefile(modules) regen_makefile(modules)
regen_pcbuild(modules) regen_pcbuild(modules)
# Freeze the target modules.
tmpsuffix = f'.{int(time.time())}'
for src in _iter_sources(modules):
_freeze_module(src.frozenid, src.pyfile, src.frozenfile, tmpsuffix)
# Regen files dependent of frozen file details.
regen_frozen(modules)
regen_manifest(modules)
if __name__ == '__main__': if __name__ == '__main__':
argv = sys.argv[1:] argv = sys.argv[1:]

50
Tools/scripts/update_file.py
View file

@ -46,19 +46,47 @@ def updating_file_with_tmpfile(filename, tmpfile=None):
update_file_with_tmpfile(filename, tmpfile) update_file_with_tmpfile(filename, tmpfile)
def update_file_with_tmpfile(filename, tmpfile): def update_file_with_tmpfile(filename, tmpfile, *, create=False):
with open(filename, 'rb') as f: try:
old_contents = f.read() targetfile = open(filename, 'rb')
with open(tmpfile, 'rb') as f: except FileNotFoundError:
new_contents = f.read() if not create:
if old_contents != new_contents: raise # re-raise
outcome = 'created'
os.replace(tmpfile, filename) os.replace(tmpfile, filename)
else: else:
os.unlink(tmpfile) with targetfile:
old_contents = targetfile.read()
with open(tmpfile, 'rb') as f:
new_contents = f.read()
# Now compare!
if old_contents != new_contents:
outcome = 'updated'
os.replace(tmpfile, filename)
else:
outcome = 'same'
os.unlink(tmpfile)
return outcome
if __name__ == '__main__': if __name__ == '__main__':
if len(sys.argv) != 3: import argparse
print("Usage: %s <path to be updated> <path with new contents>" % (sys.argv[0],)) parser = argparse.ArgumentParser()
sys.exit(1) parser.add_argument('--create', action='store_true')
update_file_with_tmpfile(sys.argv[1], sys.argv[2]) parser.add_argument('--exitcode', action='store_true')
parser.add_argument('filename', help='path to be updated')
parser.add_argument('tmpfile', help='path with new contents')
args = parser.parse_args()
kwargs = vars(args)
setexitcode = kwargs.pop('exitcode')
outcome = update_file_with_tmpfile(**kwargs)
if setexitcode:
if outcome == 'same':
sys.exit(0)
elif outcome == 'updated':
sys.exit(1)
elif outcome == 'created':
sys.exit(2)
else:
raise NotImplementedError