stubtest: Fix wrong assumption about relative path #12282
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
Description:
`run_stubtest` creates temp directory and prepend `sys.path` with
relative path (dot `.`) wrongly assuming that the dot will be
resolved to absolute path on *every* import attempt.
But in Python dot(`.`) in sys.path is actually resolved by
PathFinder and cached in `sys.path_importer_cache` like:
```
sys.path_importer_cache['.']
FileFinder('/somepath/.')
```
later calls for `find_module` return None and import of
`test_module` fails.
This resulted in only the first test in stubtest's suite passed in
non-pytest-xdist environments.
This issue was hidden with bug or feature in pytest-xdist < 2.3.0:
pytest-dev/pytest-xdist#421
It was fixed in pytest-xdist 2.3.0:
pytest-dev/pytest-xdist#667
- sys.path for pytest-xdist < 2.3.0
`'.', 'project_path', ''`
- sys.path for pytest-xdist >= 2.3.0 or without xdist
`'.', 'project_path'`
Fix:
In Python for denoting cwd the empty path `''` can be used as a
special case, but for readability `sys.path` is prepended with
resolved absolute path of temp directory. Also it's essential to
restore back `sys.path` after a test to not break subsequent tests.
Fixes: python#11019
Signed-off-by: Stanislav Levin <[email protected]>
|
According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉 |
hauntsaninja
approved these changes
Mar 4, 2022
hauntsaninja
pushed a commit
to hauntsaninja/mypy
that referenced
this pull request
Mar 4, 2022
Basically a follow up to python#12282
hauntsaninja
added a commit
that referenced
this pull request
Mar 4, 2022
Basically a follow up to #12282 Co-authored-by: hauntsaninja <>
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.
Have you read the Contributing Guidelines?
yes
Description
Fixes #11019
run_stubtestcreates temp directory and prependsys.pathwith relative path (dot.) wrongly assuming that the dot will be resolved to absolute path on every import attempt.But in Python dot(
.) in sys.path is actually resolved by PathFinder and cached insys.path_importer_cachelike:later calls for
find_modulereturn None and import oftest_modulefails. This resulted in only the first test in stubtest's suite passed in non-pytest-xdist environments.This issue was hidden with bug or feature in pytest-xdist < 2.3.0:
pytest-dev/pytest-xdist#421
It was fixed in pytest-xdist 2.3.0:
pytest-dev/pytest-xdist#667
sys.path for pytest-xdist < 2.3.0
'.', 'project_path', ''sys.path for pytest-xdist >= 2.3.0 or without xdist
'.', 'project_path'Proposed fix
In Python for denoting cwd the empty path
''can be used as a special case, but for readabilitysys.pathis prepended with resolved absolute path of temp directory. Also it's essential to restore backsys.pathafter a test to not break subsequent tests.