mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-12-11 03:20:01 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

gh-136437: Document some os.path functions as requiring pos-only (#136812)

Browse source
This commit is contained in:
sobolevn 2025-07-21 21:01:43 +03:00 • committed by GitHub
parent a10960699a
commit b5428bb0e7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

16
Doc/library/os.path.rst
View file

@ -64,7 +64,7 @@ the :mod:`glob` module.)
Accepts a :term:`path-like object`. 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 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 pair returned by passing *path* to the function :func:`split`. Note that
@ -237,7 +237,7 @@ the :mod:`glob` module.)
Accepts a :term:`path-like object`. 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 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 begins with a slash, on Windows that it begins with two (back)slashes, or a
@ -261,7 +261,7 @@ the :mod:`glob` module.)
Accepts a :term:`path-like object`. Accepts a :term:`path-like object`.
.. function:: isdir(path) .. function:: isdir(path, /)
Return ``True`` if *path* is an :func:`existing <exists>` directory. This Return ``True`` if *path* is an :func:`existing <exists>` directory. This
follows symbolic links, so both :func:`islink` and :func:`isdir` can be true follows symbolic links, so both :func:`islink` and :func:`isdir` can be true
@ -372,7 +372,7 @@ the :mod:`glob` module.)
Accepts a :term:`path-like object` for *path* and *paths*. 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 Normalize the case of a pathname. On Windows, convert all characters in the
pathname to lowercase, and also convert forward slashes to backward slashes. pathname to lowercase, and also convert forward slashes to backward slashes.
@ -509,7 +509,7 @@ the :mod:`glob` module.)
Added Windows support. Added Windows support.
.. function:: split(path) .. function:: split(path, /)
Split the pathname *path* into a pair, ``(head, tail)`` where *tail* is the 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 last pathname component and *head* is everything leading up to that. The
@ -525,7 +525,7 @@ the :mod:`glob` module.)
Accepts a :term:`path-like object`. 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 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 a mount point or the empty string. On systems which do not use drive
@ -550,7 +550,7 @@ the :mod:`glob` module.)
Accepts a :term:`path-like object`. 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 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 *drive* is a device name or mount point, *root* is a string of separators
@ -583,7 +583,7 @@ the :mod:`glob` module.)
.. versionadded:: 3.12 .. versionadded:: 3.12
.. function:: splitext(path) .. function:: splitext(path, /)
Split the pathname *path* into a pair ``(root, ext)`` such that ``root + ext == 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 path``, and the extension, *ext*, is empty or begins with a period and contains at