Replace deprecated load_module with exec_module
#498
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FollowTheProcess
changed the title
load_moduleload_module
theacodes
changed the title
load_moduleload_module with exec_module
theacodes
approved these changes
Oct 8, 2021
fkiraly
added a commit
to sktime/skbase
that referenced
this pull request
Oct 4, 2023
`load_module` is deprecated and will be replaced by `exec_module` in python 3.12, this PR addresses that. The fix is highly nontrivial - the crucial line was `imported_mod = module.load_module()` for a `module: SourceFileLoader`, which had to be replaced by the equivalent four (!) lines ```python spec = importlib.util.spec_from_file_location(module.name, module.path) imported_mod = importlib.util.module_from_spec(spec) # these two are also crucial due to the side effects loader = spec.loader loader.exec_module(imported_mod) ``` The deprecation message raised by `load_module` is highly unhelpful, and I had to reverse engineer this from a very helpful PR in `nox`, wntrblm/nox#498
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #494
This was a bit of a nightmare! 😬 this implementation is by no means perfect and it took a great deal of trial and error as well as at least a few days off my lifespan!
A brief summary of what I've done and how I got here (not all of this is in the PR commit history):
load_modulesuggests replacing withexec_module. However, nox needs the module to be passed around andexec_modulereturnsNoneso this was a non-starter.importlib.import_moduleas this will return theModuleType. This appeared to work when using nox at the command line but every test that uses one of the demo noxfiles in thetests/resources/kept failing with aModuleNotFounderror. I tried various things to fix this such as making theresourcesdir a valid package, manually changing directories in the tests, trying to resolve relative to absolute imports etc. All to no avail!This still gave me some grief as mypy wouldn't recognise the
exec_modulemethod despite its use in the exact same way as the example in the link, so I had to# type ignorethat and I had some difficulty with ensuring coverage. You'll notice a single# pragma: no coverfor one of the guard statements as I just couldn't figure out how to mock it out properly for tests.I think if we could get
importlib.import_moduleto work here this would be by far the cleanest solution, but as I said I couldn't get it to pass the tests, it kept importing the project's noxfile, not the ones undertests/resourceswhich was very weird!