]> granicus.if.org Git - python/commitdiff
Fix #15148. Make the shutil.which docstring more thorough
authorBrian Curtin <brian@python.org>
Sat, 23 Jun 2012 03:48:06 +0000 (22:48 -0500)
committerBrian Curtin <brian@python.org>
Sat, 23 Jun 2012 03:48:06 +0000 (22:48 -0500)
Lib/shutil.py

index f375a5b22059b88fd381b05a6a85aae5cd31321b..82d3f09154b1a071d5d422a6124febfc8dbc8bb4 100644 (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.