Kaydet (Commit) 8bea200b authored tarafından Serhiy Storchaka's avatar Serhiy Storchaka

Issue #16957: shutil.which() no longer searches a bare file name in the

current directory on Unix and no longer searches a relative file path with
a directory part in PATH directories.  Patch by Thomas Kluyver.
üst 564e4d8d
...@@ -1077,10 +1077,13 @@ def which(cmd, mode=os.F_OK | os.X_OK, path=None): ...@@ -1077,10 +1077,13 @@ def which(cmd, mode=os.F_OK | os.X_OK, path=None):
return (os.path.exists(fn) and os.access(fn, mode) return (os.path.exists(fn) and os.access(fn, mode)
and not os.path.isdir(fn)) and not os.path.isdir(fn))
# Short circuit. If we're given a full path which matches the mode # If we're given a path with a directory part, look it up directly rather
# and it exists, we're done here. # than referring to PATH directories. This includes checking relative to the
if _access_check(cmd, mode): # current directory, e.g. ./script
return cmd if os.path.dirname(cmd):
if _access_check(cmd, mode):
return cmd
return None
path = (path or os.environ.get("PATH", os.defpath)).split(os.pathsep) path = (path or os.environ.get("PATH", os.defpath)).split(os.pathsep)
......
...@@ -1285,11 +1285,36 @@ class TestWhich(unittest.TestCase): ...@@ -1285,11 +1285,36 @@ class TestWhich(unittest.TestCase):
rv = shutil.which(self.file, path=self.dir) rv = shutil.which(self.file, path=self.dir)
self.assertEqual(rv, self.temp_file.name) self.assertEqual(rv, self.temp_file.name)
def test_full_path_short_circuit(self): def test_absolute_cmd(self):
# When given the fully qualified path to an executable that exists, # When given the fully qualified path to an executable that exists,
# it should be returned. # it should be returned.
rv = shutil.which(self.temp_file.name, path=self.temp_dir) rv = shutil.which(self.temp_file.name, path=self.temp_dir)
self.assertEqual(self.temp_file.name, rv) self.assertEqual(rv, self.temp_file.name)
def test_relative_cmd(self):
# When given the relative path with a directory part to an executable
# that exists, it should be returned.
base_dir, tail_dir = os.path.split(self.dir)
relpath = os.path.join(tail_dir, self.file)
with support.temp_cwd(path=base_dir):
rv = shutil.which(relpath, path=self.temp_dir)
self.assertEqual(rv, relpath)
# But it shouldn't be searched in PATH directories (issue #16957).
with support.temp_cwd(path=self.dir):
rv = shutil.which(relpath, path=base_dir)
self.assertIsNone(rv)
def test_cwd(self):
# Issue #16957
base_dir = os.path.dirname(self.dir)
with support.temp_cwd(path=self.dir):
rv = shutil.which(self.file, path=base_dir)
if sys.platform == "win32":
# Windows: current directory implicitly on PATH
self.assertEqual(rv, os.path.join(os.curdir, self.file))
else:
# Other platforms: shouldn't match in the current directory.
self.assertIsNone(rv)
def test_non_matching_mode(self): def test_non_matching_mode(self):
# Set the file read-only and ask for writeable files. # Set the file read-only and ask for writeable files.
...@@ -1297,15 +1322,11 @@ class TestWhich(unittest.TestCase): ...@@ -1297,15 +1322,11 @@ class TestWhich(unittest.TestCase):
rv = shutil.which(self.file, path=self.dir, mode=os.W_OK) rv = shutil.which(self.file, path=self.dir, mode=os.W_OK)
self.assertIsNone(rv) self.assertIsNone(rv)
def test_relative(self): def test_relative_path(self):
old_cwd = os.getcwd()
base_dir, tail_dir = os.path.split(self.dir) base_dir, tail_dir = os.path.split(self.dir)
os.chdir(base_dir) with support.temp_cwd(path=base_dir):
try:
rv = shutil.which(self.file, path=tail_dir) rv = shutil.which(self.file, path=tail_dir)
self.assertEqual(rv, os.path.join(tail_dir, self.file)) self.assertEqual(rv, os.path.join(tail_dir, self.file))
finally:
os.chdir(old_cwd)
def test_nonexistent_file(self): def test_nonexistent_file(self):
# Return None when no matching executable file is found on the path. # Return None when no matching executable file is found on the path.
......
...@@ -150,6 +150,10 @@ Core and Builtins ...@@ -150,6 +150,10 @@ Core and Builtins
Library Library
------- -------
- Issue #16957: shutil.which() no longer searches a bare file name in the
current directory on Unix and no longer searches a relative file path with
a directory part in PATH directories. Patch by Thomas Kluyver.
- Issue #1159051: GzipFile now raises EOFError when reading a corrupted file - Issue #1159051: GzipFile now raises EOFError when reading a corrupted file
with truncated header or footer. with truncated header or footer.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment