Skip to content

GH-121462: pathlib docs: improve table of corresponding os/os.path functions #121465

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 27, 2024
Merged

GH-121462: pathlib docs: improve table of corresponding os/os.path functions #121465

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
187cf8f
GH-121462: pathlib docs: improve table of corresponding os/os.path fu…
barneygale Jul 7, 2024
43a7a34
Add rubric.
barneygale Jul 7, 2024
cd96328
Fix table borders
barneygale Jul 7, 2024
ae75b23
Merge branch 'main' into gh-121462
barneygale Jul 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 51 additions & 36 deletions Doc/library/pathlib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1828,39 +1828,54 @@ Corresponding tools
Below is a table mapping various :mod:`os` functions to their corresponding
:class:`PurePath`/:class:`Path` equivalent.

==================================== ==============================
:mod:`os` and :mod:`os.path` :mod:`pathlib`
==================================== ==============================
:func:`os.path.abspath` :meth:`Path.absolute`
:func:`os.path.realpath` :meth:`Path.resolve`
:func:`os.chmod` :meth:`Path.chmod`
:func:`os.mkdir` :meth:`Path.mkdir`
:func:`os.makedirs` :meth:`Path.mkdir`
:func:`os.rename` :meth:`Path.rename`
:func:`os.replace` :meth:`Path.replace`
:func:`os.rmdir` :meth:`Path.rmdir`
:func:`os.remove`, :func:`os.unlink` :meth:`Path.unlink`
:func:`os.getcwd` :func:`Path.cwd`
:func:`os.path.exists` :meth:`Path.exists`
:func:`os.path.expanduser` :meth:`Path.expanduser` and
:meth:`Path.home`
:func:`os.listdir` :meth:`Path.iterdir`
:func:`os.walk` :meth:`Path.walk`
:func:`os.path.isdir` :meth:`Path.is_dir`
:func:`os.path.isfile` :meth:`Path.is_file`
:func:`os.path.islink` :meth:`Path.is_symlink`
:func:`os.link` :meth:`Path.hardlink_to`
:func:`os.symlink` :meth:`Path.symlink_to`
:func:`os.readlink` :meth:`Path.readlink`
:func:`os.path.relpath` :meth:`PurePath.relative_to`
:func:`os.stat` :meth:`Path.stat`,
:meth:`Path.owner`,
:meth:`Path.group`
:func:`os.path.isabs` :meth:`PurePath.is_absolute`
:func:`os.path.join` :func:`PurePath.joinpath`
:func:`os.path.basename` :attr:`PurePath.name`
:func:`os.path.dirname` :attr:`PurePath.parent`
:func:`os.path.samefile` :meth:`Path.samefile`
:func:`os.path.splitext` :attr:`PurePath.stem` and
:attr:`PurePath.suffix`
==================================== ==============================
===================================== ==============================================
:mod:`os` and :mod:`os.path` :mod:`pathlib`
===================================== ==============================================
:func:`os.path.dirname` :attr:`PurePath.parent`
:func:`os.path.basename` :attr:`PurePath.name`
:func:`os.path.splitext` :attr:`PurePath.stem`, :attr:`PurePath.suffix`
:func:`os.path.join` :meth:`PurePath.joinpath`
:func:`os.path.isabs` :meth:`PurePath.is_absolute`
:func:`os.path.relpath` :meth:`PurePath.relative_to` [1]_
:func:`os.path.expanduser` :meth:`Path.expanduser` [2]_
:func:`os.path.realpath` :meth:`Path.resolve`
:func:`os.path.abspath` :meth:`Path.absolute` [3]_
:func:`os.path.exists` :meth:`Path.exists`
:func:`os.path.isfile` :meth:`Path.is_file`
:func:`os.path.isdir` :meth:`Path.is_dir`
:func:`os.path.islink` :meth:`Path.is_symlink`
:func:`os.path.isjunction` :meth:`Path.is_junction`
:func:`os.path.ismount` :meth:`Path.is_mount`
:func:`os.path.samefile` :meth:`Path.samefile`
:func:`os.getcwd` :meth:`Path.cwd`
:func:`os.stat` :meth:`Path.stat`
:func:`os.lstat` :meth:`Path.lstat`
:func:`os.listdir` :meth:`Path.iterdir`
:func:`os.walk` :meth:`Path.walk` [4]_
:func:`os.mkdir`, :func:`os.makedirs` :meth:`Path.mkdir`
:func:`os.link` :meth:`Path.hardlink_to`
:func:`os.symlink` :meth:`Path.symlink_to`
:func:`os.readlink` :meth:`Path.readlink`
:func:`os.rename` :meth:`Path.rename`
:func:`os.replace` :meth:`Path.replace`
:func:`os.remove`, :func:`os.unlink` :meth:`Path.unlink`
:func:`os.rmdir` :meth:`Path.rmdir`
:func:`os.chmod` :meth:`Path.chmod`
:func:`os.lchmod` :meth:`Path.lchmod`
===================================== ==============================================

.. rubric:: Footnotes

.. [1] :func:`os.path.relpath` calls :func:`~os.path.abspath` to make paths
absolute and remove "``..``" parts, whereas :meth:`PurePath.relative_to`
is a lexical operation that raises :exc:`ValueError` when its inputs'
anchors differ (e.g. if one path is absolute and the other relative.)
.. [2] :func:`os.path.expanduser` returns the path unchanged if the home
directory can't be resolved, whereas :meth:`Path.expanduser` raises
:exc:`RuntimeError`.
.. [3] :func:`os.path.abspath` removes "``..``" components without resolving
symlinks, which may change the meaning of the path, whereas
:meth:`Path.absolute` leaves any "``..``" components in the path.
.. [4] :func:`os.walk` always follows symlinks when categorizing paths into
*dirnames* and *filenames*, whereas :meth:`Path.walk` categorizes all
symlinks into *filenames* when *follow_symlinks* is false (the default.)
Loading