mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-26 18:29:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Doc: os.path.abspath and Path.resolve are also different (GH-23276)

Browse source
This commit is contained in:
Hong Xu 2021-01-20 02:20:00 -08:00 • committed by GitHub
parent 3554fa4abe
commit 1459fed92c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

17
Doc/library/pathlib.rst
View file

@ -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.