bpo-15221: Update os.path.is*() documentation (GH-5185) (GH-5186)

`os.path.is*()` can return False if the file can't be accessed.
The behaviour is documented in details in `os.path.exists()`.
Link to `os.path.exists()` from `os.path.is*()`.
(cherry picked from commit b3dd18d403)
This commit is contained in:
Miss Islington (bot) 2018-01-14 21:44:49 -08:00 committed by Mariatta
parent cf4cd4bccb
commit bb80645d06

View file

@ -246,8 +246,9 @@ the :mod:`glob` module.)
.. function:: isfile(path) .. function:: isfile(path)
Return ``True`` if *path* is an existing regular file. This follows symbolic Return ``True`` if *path* is an :func:`existing <exists>` regular file.
links, so both :func:`islink` and :func:`isfile` can be true for the same path. This follows symbolic links, so both :func:`islink` and :func:`isfile` can
be true for the same path.
.. versionchanged:: 3.6 .. versionchanged:: 3.6
Accepts a :term:`path-like object`. Accepts a :term:`path-like object`.
@ -255,8 +256,9 @@ the :mod:`glob` module.)
.. function:: isdir(path) .. function:: isdir(path)
Return ``True`` if *path* is an existing directory. This follows symbolic Return ``True`` if *path* is an :func:`existing <exists>` directory. This
links, so both :func:`islink` and :func:`isdir` can be true for the same path. follows symbolic links, so both :func:`islink` and :func:`isdir` can be true
for the same path.
.. versionchanged:: 3.6 .. versionchanged:: 3.6
Accepts a :term:`path-like object`. Accepts a :term:`path-like object`.
@ -264,8 +266,9 @@ the :mod:`glob` module.)
.. function:: islink(path) .. function:: islink(path)
Return ``True`` if *path* refers to a directory entry that is a symbolic link. Return ``True`` if *path* refers to an :func:`existing <exists>` directory
Always ``False`` if symbolic links are not supported by the Python runtime. entry that is a symbolic link. Always ``False`` if symbolic links are not
supported by the Python runtime.
.. versionchanged:: 3.6 .. versionchanged:: 3.6
Accepts a :term:`path-like object`. Accepts a :term:`path-like object`.