]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Add additional pointers to pathlib's mapping to os.path functions (GH-94828)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 15 Jul 2022 22:16:45 +0000 (15:16 -0700)
committerGitHub <noreply@github.com>
Fri, 15 Jul 2022 22:16:45 +0000 (15:16 -0700)
* Add additional pointers to pathlib's mapping to os.path functions

os.path.splitext has a somewhat quirky signature since it mixes the path and filename components but I wanted the documentation to mention `PurePath.stem` as the natural counterpart to `PurePath.suffix` for the common use of `os.path.splitext` to turn "file.py" into "file" and "py".

Technically this could have some discussion of how to handle the parent directory hierarchy but that seems a bit out of keeping with the spirit of this table so I omitted mentioning `PurePath.parents` here.

* Update Doc/library/pathlib.rst

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 3789c635772fbdeb5d0fc32aa811fd6b1d935a60)

Co-authored-by: Chris Adams <chris@improbable.org>
Doc/library/pathlib.rst

index cb25cc92c2c4aee8b0730efe1d006c4149bf684b..f969b1104f089089fa5c3a84aec5d6effa4c1031 100644 (file)
@@ -1300,7 +1300,8 @@ Below is a table mapping various :mod:`os` functions to their corresponding
 :func:`os.path.basename`               :data:`PurePath.name`
 :func:`os.path.dirname`                :data:`PurePath.parent`
 :func:`os.path.samefile`               :meth:`Path.samefile`
-:func:`os.path.splitext`               :data:`PurePath.suffix`
+:func:`os.path.splitext`               :data:`PurePath.stem` and
+                                       :data:`PurePath.suffix`
 ====================================   ==============================
 
 .. rubric:: Footnotes