Skip to content

Commit

Permalink
[3.13] Doc: Improve documentation for the path argument in ``shut…
Browse files Browse the repository at this point in the history
…il.which()`` (GH-124494) (#124497)

Doc: Improve documentation for the ``path`` argument in ``shutil.which()`` (GH-124494)
(cherry picked from commit 0d38409)

Co-authored-by: Tom Most <[email protected]>
  • Loading branch information
miss-islington and twm authored Sep 26, 2024
1 parent c5d0972 commit 5b7d4ce
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions Doc/library/shutil.rst
Original file line number Diff line number Diff line change
Expand Up @@ -449,9 +449,10 @@ Directory and files operations
*mode* is a permission mask passed to :func:`os.access`, by default
determining if the file exists and is executable.

*path* is a "``PATH`` string" specifying the lookup directory list. When no
*path* is specified, the results of :func:`os.environ` are used, returning
either the "PATH" value or a fallback of :data:`os.defpath`.
*path* is a "``PATH`` string" specifying the directories to look in,
delimited by :data:`os.pathsep`. When no *path* is specified, the
:envvar:`PATH` environment variable is read from :data:`os.environ`,
falling back to :data:`os.defpath` if it is not set.

On Windows, the current directory is prepended to the *path* if *mode* does
not include ``os.X_OK``. When the *mode* does include ``os.X_OK``, the
Expand All @@ -460,9 +461,9 @@ Directory and files operations
consulting the current working directory for executables: set the environment
variable ``NoDefaultCurrentDirectoryInExePath``.

Also on Windows, the ``PATHEXT`` variable is used to resolve commands
that may not already include an extension. For example, if you call
``shutil.which("python")``, :func:`which` will search ``PATHEXT``
Also on Windows, the :envvar:`PATHEXT` environment variable is used to
resolve commands that may not already include an extension. 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::

Expand Down

0 comments on commit 5b7d4ce

Please sign in to comment.