Skip to content

bpo-21736: Set __file__ on frozen stdlib modules. #28656

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

ericsnowcurrently
Copy link
Member

@ericsnowcurrently ericsnowcurrently commented Sep 30, 2021

Currently frozen modules do not have __file__ set. In their spec, origin is set to "frozen" and they are marked as not having a location. (Similarly, for frozen packages __path__ is set to an empty list.) However, for frozen stdlib modules we are able to extrapolate __file__ as long as we can determine the stdlib directory at runtime. (We now do so since gh-28586.) Having __file__ set is helpful for a number of reasons. Likewise, having a non-empty __path__ means we can import submodules of a frozen package from the filesystem (e.g. we could partially freeze the encodings module).

This change sets __file__ (and adds to __path__) for frozen stdlib modules. It uses sys._stdlibdir (from gh-28586) and the frozen module alias information (from gh-28655). All that work is done in FrozenImporter (in Lib/importlib/_bootstrap.py). Also, if a frozen module is imported before importlib is bootstrapped (during interpreter initialization) then we fix up that module and its spec during the importlib bootstrapping step (i.e. imporlib._bootstrap._setup()) to match what gets set by FrozenImporter, including setting the file info (if the stdlib dir is known). To facilitate this, modules imported using PyImport_ImportFrozenModule() have __origname__ set using the frozen module alias info. __origname__ is popped off during importlib bootstrap.

(To be clear, even with this PR the new code to set __file__ during fixups in imporlib._bootstrap._setup() doesn't actually get triggered yet. This is because sys._stdlibdir hasn't been set yet in interpreter initialization at the point importlib is bootstrapped. However, we do fix up such modules at that point to otherwise match the result of importing through FrozenImporter, just not the __file__ and __path__ parts. Doing so will require changes in the order in which things happen during interpreter initialization. That can be addressed separately. Once it is, the file-related fixup code from this PR will kick in.)

Here are things this PR does not do:

  • set __file__ for non-stdlib modules (no way of knowing the parent dir)
  • set __file__ if the stdlib dir is not known (nor assume the expense of finding it)
  • relatedly, set __file__ if the stdlib is in a zip file
  • verify that the filename set to __file__ actually exists (too expensive)
  • update __path__ for frozen packages that alias a non-package (since there is no package dir)

Other things this PR skips, but we may do later:

  • set __file__ on modules imported using PyImport_ImportFrozenModule()
  • set co_filename when we unmarshal the frozen code object while importing the module (e.g. in FrozenImporter.exec_module()) -- this would allow tracebacks to show source lines
  • implement FrozenImporter.get_filename() and FrozenImporter.get_source()

https://bugs.python.org/issue21736

@bedevere-bot
Copy link

🤖 New build scheduled with the buildbot fleet by @ericsnowcurrently for commit 36112c1ec211049084cdc2b5010c11c08939ac28 🤖

If you want to schedule another build, you need to add the ":hammer: test-with-buildbots" label again.

@ericsnowcurrently ericsnowcurrently added the 🔨 test-with-buildbots Test PR w/ buildbots; report in status section label Oct 1, 2021
@bedevere-bot bedevere-bot removed the 🔨 test-with-buildbots Test PR w/ buildbots; report in status section label Oct 1, 2021
@ericsnowcurrently ericsnowcurrently force-pushed the frozen-modules-__file__ branch 2 times, most recently from 7934888 to 1d6ff36 Compare October 2, 2021 01:40
@ericsnowcurrently ericsnowcurrently added the 🔨 test-with-buildbots Test PR w/ buildbots; report in status section label Oct 4, 2021
@bedevere-bot
Copy link

🤖 New build scheduled with the buildbot fleet by @ericsnowcurrently for commit 1d6ff3632519080ca20b69832545ec0ba1496af5 🤖

If you want to schedule another build, you need to add the ":hammer: test-with-buildbots" label again.

@bedevere-bot bedevere-bot removed the 🔨 test-with-buildbots Test PR w/ buildbots; report in status section label Oct 4, 2021
@ericsnowcurrently ericsnowcurrently marked this pull request as ready for review October 5, 2021 19:30
@ericsnowcurrently ericsnowcurrently added the 🔨 test-with-buildbots Test PR w/ buildbots; report in status section label Oct 5, 2021
@bedevere-bot
Copy link

🤖 New build scheduled with the buildbot fleet by @ericsnowcurrently for commit 79c1035 🤖

If you want to schedule another build, you need to add the ":hammer: test-with-buildbots" label again.

@bedevere-bot bedevere-bot removed the 🔨 test-with-buildbots Test PR w/ buildbots; report in status section label Oct 5, 2021
@ericsnowcurrently ericsnowcurrently requested review from warsaw and removed request for brettcannon October 6, 2021 18:53
@ericsnowcurrently ericsnowcurrently merged commit 79cf20e into python:main Oct 14, 2021
@ericsnowcurrently ericsnowcurrently deleted the frozen-modules-__file__ branch October 14, 2021 21:32
@gpshead
Copy link
Member

gpshead commented Oct 18, 2021

This appears to have caused https://bugs.python.org/issue45506 - out of tree builds can't pass several tests.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants