diff options
| author |   Hong Xu <hong@topbug.net> | 2021-01-20 02:20:00 -0800 |
|---|---|---|
| committer |   GitHub <noreply@github.com> | 2021-01-20 11:20:00 +0100 |
| commit | 1459fed92c4bf6bb0d18a4c5637e8f1d8662bed5 (patch) | |
| tree | 5c7893a2fc854ddf632d971324563d1e855fa334 /Doc | |
| parent | bpo-42005: profile and cProfile catch BrokenPipeError (GH-22643) (diff) | |
| download | cpython-1459fed92c4bf6bb0d18a4c5637e8f1d8662bed5.tar.gz cpython-1459fed92c4bf6bb0d18a4c5637e8f1d8662bed5.tar.bz2 cpython-1459fed92c4bf6bb0d18a4c5637e8f1d8662bed5.zip | |
Doc: os.path.abspath and Path.resolve are also different (GH-23276)
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/pathlib.rst | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst index 2bbf3aad619..ac96de334b3 100644 --- a/Doc/library/pathlib.rst +++ b/Doc/library/pathlib.rst @@ -1195,14 +1195,15 @@ Below is a table mapping various :mod:`os` functions to their corresponding .. note:: - Although :func:`os.path.relpath` and :meth:`PurePath.relative_to` have some - overlapping use-cases, their semantics differ enough to warrant not - considering them equivalent. + Not all pairs of functions/methods below are equivalent. Some of them, + despite having some overlapping use-cases, have different semantics. They + include :func:`os.path.abspath` and :meth:`Path.resolve`, + :func:`os.path.relpath` and :meth:`PurePath.relative_to`. ==================================== ============================== -os and os.path pathlib +:mod:`os` and :mod:`os.path` :mod:`pathlib` ==================================== ============================== -:func:`os.path.abspath` :meth:`Path.resolve` +:func:`os.path.abspath` :meth:`Path.resolve` [#]_ :func:`os.chmod` :meth:`Path.chmod` :func:`os.mkdir` :meth:`Path.mkdir` :func:`os.makedirs` :meth:`Path.mkdir` @@ -1221,6 +1222,7 @@ os and os.path pathlib :func:`os.link` :meth:`Path.link_to` :func:`os.symlink` :meth:`Path.symlink_to` :func:`os.readlink` :meth:`Path.readlink` +:func:`os.path.relpath` :meth:`Path.relative_to` [#]_ :func:`os.stat` :meth:`Path.stat`, :meth:`Path.owner`, :meth:`Path.group` @@ -1231,3 +1233,8 @@ os and os.path pathlib :func:`os.path.samefile` :meth:`Path.samefile` :func:`os.path.splitext` :data:`PurePath.suffix` ==================================== ============================== + +.. rubric:: Footnotes + +.. [#] :func:`os.path.abspath` does not resolve symbolic links while :meth:`Path.resolve` does. +.. [#] :meth:`Path.relative_to` requires ``self`` to be the subpath of the argument, but :func:`os.path.relpath` does not. |