bpo-35183: Add typical examples to os.path.splitext docs (GH-27286)

This commit is contained in:
Jake Stockwin 2021-08-02 18:01:53 +01:00 committed by GitHub
parent d382bde220
commit aa0894b379
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 27 additions and 7 deletions

View File

@ -470,12 +470,16 @@ the :mod:`glob` module.)
On Windows, splits a pathname into drive/UNC sharepoint and relative path. On Windows, splits a pathname into drive/UNC sharepoint and relative path.
If the path contains a drive letter, drive will contain everything If the path contains a drive letter, drive will contain everything
up to and including the colon. up to and including the colon::
e.g. ``splitdrive("c:/dir")`` returns ``("c:", "/dir")``
>>> splitdrive("c:/dir")
("c:", "/dir")
If the path contains a UNC path, drive will contain the host name If the path contains a UNC path, drive will contain the host name
and share, up to but not including the fourth separator. and share, up to but not including the fourth separator::
e.g. ``splitdrive("//host/computer/dir")`` returns ``("//host/computer", "/dir")``
>>> splitdrive("//host/computer/dir")
("//host/computer", "/dir")
.. versionchanged:: 3.6 .. versionchanged:: 3.6
Accepts a :term:`path-like object`. Accepts a :term:`path-like object`.
@ -484,9 +488,24 @@ the :mod:`glob` module.)
.. 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 *ext* is empty or begins with a period and contains at most one path``, and the extension, *ext*, is empty or begins with a period and contains at
period. Leading periods on the basename are ignored; ``splitext('.cshrc')`` most one period.
returns ``('.cshrc', '')``.
If the path contains no extension, *ext* will be ``''``::
>>> splitext('bar')
('bar', '')
If the path contains an extension, then *ext* will be set to this extension,
including the leading period. Note that previous periods will be ignored::
>>> splitext('foo.bar.exe')
('foo.bar', '.exe')
Leading periods on the basename are ignored::
>>> splitext('.cshrc')
('.cshrc', '')
.. versionchanged:: 3.6 .. versionchanged:: 3.6
Accepts a :term:`path-like object`. Accepts a :term:`path-like object`.

View File

@ -0,0 +1 @@
Add typical examples to os.path.splitext docs