traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix #15148. Make the shutil.which docstring more thorough

This commit is contained in:
Brian Curtin 2012-06-22 22:48:06 -05:00
parent dbbc0c8bb3
commit 2193536e79
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Lib/shutil.py
View File

@ -973,7 +973,9 @@ def get_terminal_size(fallback=(80, 24)):
def which(cmd, mode=os.F_OK | os.X_OK, path=None):
"""Given a command, mode, and a path string, return the path which
conforms to the given mode on the path."""
conforms to the given mode on the PATH, or None if there is no such file.
`mode` defaults to os.F_OK | os.X_OK. `path` defaults to the result of
os.environ.get("PATH"), or can be overridden with a custom search path."""
# Check that a given file can be accessed with the correct mode.
# Additionally check that `file` is not a directory, as on Windows
# directories pass the os.access check.