Skip to content

[3.13] gh-136437: Document some os.path functions as requiring pos-only (GH-136812) #136945

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 1 commit into from
Jul 21, 2025
Merged

[3.13] gh-136437: Document some os.path functions as requiring pos-only (GH-136812) #136945

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 8 additions & 8 deletions Doc/library/os.path.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ the :mod:`glob` module.)
Accepts a :term:`path-like object`.


.. function:: basename(path)
.. function:: basename(path, /)

Return the base name of pathname *path*. This is the second element of the
pair returned by passing *path* to the function :func:`split`. Note that
Expand Down Expand Up @@ -237,7 +237,7 @@ the :mod:`glob` module.)
Accepts a :term:`path-like object`.


.. function:: isabs(path)
.. function:: isabs(path, /)

Return ``True`` if *path* is an absolute pathname. On Unix, that means it
begins with a slash, on Windows that it begins with two (back)slashes, or a
Expand All @@ -261,7 +261,7 @@ the :mod:`glob` module.)
Accepts a :term:`path-like object`.


.. function:: isdir(path)
.. function:: isdir(path, /)

Return ``True`` if *path* is an :func:`existing <exists>` directory. This
follows symbolic links, so both :func:`islink` and :func:`isdir` can be true
Expand Down Expand Up @@ -372,7 +372,7 @@ the :mod:`glob` module.)
Accepts a :term:`path-like object` for *path* and *paths*.


.. function:: normcase(path)
.. function:: normcase(path, /)

Normalize the case of a pathname. On Windows, convert all characters in the
pathname to lowercase, and also convert forward slashes to backward slashes.
Expand Down Expand Up @@ -509,7 +509,7 @@ the :mod:`glob` module.)
Added Windows support.


.. function:: split(path)
.. function:: split(path, /)

Split the pathname *path* into a pair, ``(head, tail)`` where *tail* is the
last pathname component and *head* is everything leading up to that. The
Expand All @@ -525,7 +525,7 @@ the :mod:`glob` module.)
Accepts a :term:`path-like object`.


.. function:: splitdrive(path)
.. function:: splitdrive(path, /)

Split the pathname *path* into a pair ``(drive, tail)`` where *drive* is either
a mount point or the empty string. On systems which do not use drive
Expand All @@ -550,7 +550,7 @@ the :mod:`glob` module.)
Accepts a :term:`path-like object`.


.. function:: splitroot(path)
.. function:: splitroot(path, /)

Split the pathname *path* into a 3-item tuple ``(drive, root, tail)`` where
*drive* is a device name or mount point, *root* is a string of separators
Expand Down Expand Up @@ -583,7 +583,7 @@ the :mod:`glob` module.)
.. versionadded:: 3.12


.. function:: splitext(path)
.. function:: splitext(path, /)

Split the pathname *path* into a pair ``(root, ext)`` such that ``root + ext ==
path``, and the extension, *ext*, is empty or begins with a period and contains at
Expand Down
Loading