gh-146310: Fix ensurepip to treat empty WHEEL_PKG_DIR as unset#146357
Open
kimimgo wants to merge 2 commits intopython:mainfrom
Open
gh-146310: Fix ensurepip to treat empty WHEEL_PKG_DIR as unset#146357kimimgo wants to merge 2 commits intopython:mainfrom
kimimgo wants to merge 2 commits intopython:mainfrom
Conversation
Path('') resolves to CWD, so an empty WHEEL_PKG_DIR string caused
ensurepip to search the current working directory for wheel files.
Add a truthiness check to treat empty strings the same as None.
vstinner
reviewed
Mar 24, 2026
Lib/ensurepip/__init__.py
Outdated
| # installs wheel packages in the /usr/share/python-wheels/ directory and don't | ||
| # install the ensurepip._bundled package. | ||
| if (_pkg_dir := sysconfig.get_config_var('WHEEL_PKG_DIR')) is not None: | ||
| if (_pkg_dir := sysconfig.get_config_var('WHEEL_PKG_DIR')) is not None and _pkg_dir: |
Member
There was a problem hiding this comment.
You may write it as:
Suggested change
| if (_pkg_dir := sysconfig.get_config_var('WHEEL_PKG_DIR')) is not None and _pkg_dir: | |
| _pkg_dir = sysconfig.get_config_var('WHEEL_PKG_DIR') | |
| if _pkg_dir: |
Lib/test/test_ensurepip.py
Outdated
| # An empty WHEEL_PKG_DIR converts to Path('.') which would | ||
| # incorrectly search the current working directory. | ||
| with unittest.mock.patch.object(ensurepip, '_WHEEL_PKG_DIR', None): | ||
| self.assertIsNone(ensurepip._find_wheel_pkg_dir_pip()) |
Member
There was a problem hiding this comment.
This test is not directly related to the fix. I suggest a different test:
def test_wheel_pkg_dir_none(self):
for value in ('', None):
with unittest.mock.patch('sysconfig.get_config_var',
return_value=value) as get_config_var:
module = import_helper.import_fresh_module('ensurepip')
self.assertIsNone(module._WHEEL_PKG_DIR)
get_config_var.assert_called_once_with('WHEEL_PKG_DIR')with from test.support import import_helper at top level.
| @@ -0,0 +1,2 @@ | |||
| Fix :mod:`ensurepip` to treat an empty string ``WHEEL_PKG_DIR`` as unset, | |||
| preventing it from searching the current working directory for wheel files. | |||
Member
There was a problem hiding this comment.
This NEWS entry sounds too technical. I suggest to describe instead the old behavior:
The :mod:`ensurepip` module no longer looks for `pip-*.whl` wheel packages in the current directory.
Per @vstinner: - Simplify to 'if _pkg_dir:' instead of walrus + is not None - Replace mock-based test with import_fresh_module for both '' and None - Reword NEWS to describe old behavior instead of fix
Author
|
Thanks @vstinner! Updated all three points:
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Fixes #146310
Path('')resolves to the current working directory (PosixPath('.')), so whenWHEEL_PKG_DIRis an empty string (notNone),ensurepipsearches CWD for wheel files. This can cause unexpected behavior or crashes if CWD contains files matchingpip-*.whl.Changes
Lib/ensurepip/__init__.py: Add truthiness check so empty strings are treated the same asNoneLib/test/test_ensurepip.py: Add test verifying emptyWHEEL_PKG_DIRdoes not search CWDBefore/After