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

#444582: fix example and rewrap docs a bit.

This commit is contained in:
Georg Brandl 2012-06-24 17:37:07 +02:00
parent 4168764c1a
commit 4a7e25f4df
1 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
Doc/library/shutil.rst
View File

@ -268,31 +268,32 @@ Directory and files operations
.. versionadded:: 3.3
.. function:: which(cmd, mode=os.F_OK | os.X_OK, path=None)
Return the path to an executable which would be run if the given *cmd*
was called. If no *cmd* would be called, return ``None``.
Return the path to an executable which would be run if the given *cmd* was
called. If no *cmd* would be called, return ``None``.
*mode* is a permission mask passed a to :func:`os.access`, by default
determining if the file exists and executable.
When no *path* is specified, the results of :func:`os.environ` are
used, returning either the "PATH" value or a fallback of :attr:`os.defpath`.
When no *path* is specified, the results of :func:`os.environ` are used,
returning either the "PATH" value or a fallback of :attr:`os.defpath`.
On Windows, the current directory is always prepended to the *path*
whether or not you use the default or provide your own, which
is the behavior the command shell uses when finding executables.
Additionaly, when finding the *cmd* in the *path*, the
``PATHEXT`` environment variable is checked. For example, if you
call ``shutil.which("python")``, :func:`which` will search
``PATHEXT`` to know that it should look for ``python.exe`` within
the *path* directories.
On Windows, the current directory is always prepended to the *path* whether
or not you use the default or provide your own, which is the behavior the
command shell uses when finding executables. Additionaly, when finding the
*cmd* in the *path*, the ``PATHEXT`` environment variable is checked. For
example, if you call ``shutil.which("python")``, :func:`which` will search
``PATHEXT`` to know that it should look for ``python.exe`` within the *path*
directories. For example, on Windows::
>>> print(shutil.which("python"))
>>> shutil.which("python")
'c:\\python33\\python.exe'
.. versionadded:: 3.3
.. exception:: Error
This exception collects exceptions that are raised during a multi-file