Repository navigation
gh-141276: Avoid compiling zipimport source in get_filename - #153799
harjothkhara wants to merge 3 commits into
Conversation
|
This fixes the duplicated SyntaxWarning from #141276, could someone take a look? |
itamaro
left a comment
There was a problem hiding this comment.
the fix generally looks good to me, thanks for the PR!
see inline comments regarding skipping wasted source load.
a few additional requests:
- this is an observable behavior change, which needs to be called out in the NEWS.
the semantic change - previously, py files with syntax errors in zip would raise from find_spec() and get_filename(). after this change, find_spec() and get_filename() would succeed, and only exec_module() would raise.
while this sounds like a significant behavior change, I think it's acceptable and even desirable, because it brings zipimport in line with the standard filesystem based finder/loader - but it does warrant more explicit coverage in NEWS.
this also makes it somewhat risky to backport, so I'd like @serhiy-storchaka's opinion here as well.
- I'd like to see a few more test cases covering the expected behavior, and preventing unintended future regressions, especially around the subtler corners.
a test that with a py with SyntaxError. assert that find_spec() and get_filename() succeed and return expected spec / filename, and exec_module() raises SyntaxError.
perhaps also have a test that calls get_filename() directly and asserts no warnings.
I see testBadMagic/testBadMTime already cover stale/bad-magic .pyc falling back to .py. could you add:
- valid
.pyc+.pywith a syntax error → spec picks the.pycand import succeeds - package
__init__.pywith a syntax error + a valid sibling module of the same name → origin is__init__.pyand exec raisesSyntaxError(no fallthrough to the module)
| if not compile_source: | ||
| return None, ispackage, modpath |
There was a problem hiding this comment.
not needed with the suggestion above
| if not compile_source: | |
| return None, ispackage, modpath |
| Fix duplicate :exc:`SyntaxWarning` messages when importing source modules | ||
| from ZIP archives. |
There was a problem hiding this comment.
some prose you could use here:
zipimporter.get_filename() and find_spec() no longer compile source modules; a SyntaxError in a zipped source module is now raised when the module is executed, matching the behavior of filesystem-based loaders.
|
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
Move the compile_source=False early return above the archive read, so get_filename() no longer decompresses source it immediately discards. Also update the NEWS entry with itamaro's suggested wording and add tests covering the deferred-SyntaxError behavior: find_spec()/ get_filename() succeed and get_filename() emits no warnings for a module with a syntax error, a valid .pyc still wins over a bad sibling .py, and a package's __init__.py error doesn't fall through to a same-named sibling module.
itamaro
left a comment
There was a problem hiding this comment.
thanks for making the requested changes!
please don't forget to follow the bot instructions about commenting on the PR once you've made the requested changes (it's needed so the bot updates PR labels and makes it show up in review queues again, otherwise it's more likely to go unnoticed).
we also need to update the docs (Doc/library/zipimport.rst) to match the modified get_filename behavior (raises when "module couldn't be found", not when "module couldn't be imported".
| ``zipimporter.get_filename()`` and ``find_spec()`` no longer compile source | ||
| modules; a :exc:`SyntaxError` in a zipped source module is now raised when the | ||
| module is executed, matching the behavior of filesystem-based loaders. |
There was a problem hiding this comment.
The new NEWS entry is now missing the original bugfix description
| ``zipimporter.get_filename()`` and ``find_spec()`` no longer compile source | |
| modules; a :exc:`SyntaxError` in a zipped source module is now raised when the | |
| module is executed, matching the behavior of filesystem-based loaders. | |
| Fix duplicate :exc:`SyntaxWarning` messages when importing source modules | |
| from ZIP archives. :meth:`zipimport.zipimporter.get_filename`, and therefore | |
| :meth:`~zipimport.zipimporter.find_spec`, no longer compile source modules. | |
| A :exc:`SyntaxError` in a zipped source module is now raised when the module | |
| is executed rather than when it is found, matching the behavior of | |
| filesystem-based loaders. |
| # bad magic number or non-matching mtime | ||
| # in byte code, try next | ||
| continue | ||
| modpath = toc_entry[0] |
There was a problem hiding this comment.
nit (pre-existing), but worth doing since you're here -- the second modpath = toc_entry[0] is redundant and can be removed
| # 'fullname'. | ||
| def _get_module_code(self, fullname): | ||
| # Get the code object associated with the module specified by 'fullname'. | ||
| # If compile_source is false, return None for source code without compiling it. |
There was a problem hiding this comment.
nit
| # If compile_source is false, return None for source code without compiling it. | |
| # If compile_source is false, return None for source code without reading or compiling it. |
| Return the filename for the specified module or raise ZipImportError | ||
| if it couldn't be imported. |
There was a problem hiding this comment.
the documented contract is now inaccurate
| Return the filename for the specified module or raise ZipImportError | |
| if it couldn't be found. |
There was a problem hiding this comment.
GitHub looks buggy, at least in how it's rendering this suggested change for me.
the only change I made was s/imported/found/ on the second line
Summary
Root cause
zipimporter.get_filename()called_get_module_code(), which compiled source while import machinery was creating the module spec. Module execution then compiled the same source again.Tests
./python.exe -m test test_zipimport -m test_syntax_warning -m testBadMagic -m testBadMTime./python.exe -m test test_zipimportRefs #141276
Duplicate-work check
No open or merged pull request referencing #141276 was found before submission.
AI assistance
OpenAI Codex assisted with investigation, implementation, testing, and review.