Skip to content

bpo-40592: shutil.which will not return None anymore if ; is the last char in PATHEXT #20088

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.

Sign up for GitHub

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
merged 15 commits into from
Oct 23, 2020
Merged

bpo-40592: shutil.which will not return None anymore if ; is the last char in PATHEXT #20088

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
2981e84
shutil.which will not return None anymore for empty str in PATHEXT
May 14, 2020
9df7b99
📜🤖 Added by blurb_it.
blurb-it[bot] May 14, 2020
6dd9574
Defaulted missing PATHEX env to cmd defaults
May 14, 2020
65b2847
Merge branch 'master' of github.com:python/cpython into fix-shutil-wh…
May 14, 2020
49284d9
Merge branch 'fix-shutil-which-windows' of github.com:peanut-lord/cpy…
May 14, 2020
9eb17bb
Changed os.chmod from 'S_IXUSR' to 'S_IXUSR | S_IWUSR'
May 15, 2020
e6a9c2c
Added comment to explain the _WIN_DEFAULT_PATHEXT properly
May 15, 2020
4966956
Updated change description
peanutlord May 19, 2020
cdb179e
Adjusted list comprehension to adhere line length
May 19, 2020
01efb42
Removed chown from unittest
May 19, 2020
fc87309
Empty PATHEXT () will now also be defaulted to _WIN_DEFAULT_PATHEXT
Oct 21, 2020
6af00e7
When no extension is found, we return a list with the command
Oct 21, 2020
ee618eb
Revert "When no extension is found, we return a list with the command"
Oct 21, 2020
77de5b8
Merge branch 'master' of github.com:python/cpython into fix-shutil-wh…
Oct 22, 2020
6c66dfc
Switched to from support to os_helper in unittest
Oct 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion Lib/shutil.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
_USE_CP_SENDFILE = hasattr(os, "sendfile") and sys.platform.startswith("linux")
_HAS_FCOPYFILE = posix and hasattr(posix, "_fcopyfile") # macOS

# CMD defaults in Windows 10
_WIN_DEFAULT_PATHEXT = ".COM;.EXE;.BAT;.CMD;.VBS;.JS;.WS;.MSC"

__all__ = ["copyfileobj", "copyfile", "copymode", "copystat", "copy", "copy2",
"copytree", "move", "rmtree", "Error", "SpecialFileError",
"ExecError", "make_archive", "get_archive_formats",
Expand Down Expand Up @@ -1415,7 +1418,9 @@ def which(cmd, mode=os.F_OK | os.X_OK, path=None):
path.insert(0, curdir)

# PATHEXT is necessary to check on Windows.
pathext = os.environ.get("PATHEXT", "").split(os.pathsep)
pathext_source = os.getenv("PATHEXT") or _WIN_DEFAULT_PATHEXT
pathext = [ext for ext in pathext_source.split(os.pathsep) if ext]

if use_bytes:
pathext = [os.fsencode(ext) for ext in pathext]
# See if the given file matches any of the expected path extensions.
Expand Down
17 changes: 17 additions & 0 deletions Lib/test/test_shutil.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1849,6 +1849,23 @@ def test_pathext(self):
rv = shutil.which(program, path=self.temp_dir)
self.assertEqual(rv, temp_filexyz.name)

# Issue 40592: See https://bugs.python.org/issue40592
@unittest.skipUnless(sys.platform == "win32", 'test specific to Windows')
def test_pathext_with_empty_str(self):
ext = ".xyz"
temp_filexyz = tempfile.NamedTemporaryFile(dir=self.temp_dir,
prefix="Tmp2", suffix=ext)
self.addCleanup(temp_filexyz.close)

# strip path and extension
program = os.path.basename(temp_filexyz.name)
program = os.path.splitext(program)[0]

with os_helper.EnvironmentVarGuard() as env:
env['PATHEXT'] = f"{ext};" # note the ;
rv = shutil.which(program, path=self.temp_dir)
self.assertEqual(rv, temp_filexyz.name)


class TestWhichBytes(TestWhich):
def setUp(self):
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Library/2020-05-14-16-01-34.bpo-40592.Cmk855.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
:func:`shutil.which` now ignores empty entries in :envvar:`PATHEXT` instead of treating them as a match.