Skip to content

[3.10] bpo-35183: Add typical examples to os.path.splitext docs (GH-27286) #27563

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.

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
Aug 2, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 26 additions & 7 deletions Doc/library/os.path.rst
Original file line number Diff line number Diff line change
Expand Up @@ -470,12 +470,16 @@ the :mod:`glob` module.)
On Windows, splits a pathname into drive/UNC sharepoint and relative path.

If the path contains a drive letter, drive will contain everything
up to and including the colon.
e.g. ``splitdrive("c:/dir")`` returns ``("c:", "/dir")``
up to and including the colon::

>>> splitdrive("c:/dir")
("c:", "/dir")

If the path contains a UNC path, drive will contain the host name
and share, up to but not including the fourth separator.
e.g. ``splitdrive("//host/computer/dir")`` returns ``("//host/computer", "/dir")``
and share, up to but not including the fourth separator::

>>> splitdrive("//host/computer/dir")
("//host/computer", "/dir")

.. versionchanged:: 3.6
Accepts a :term:`path-like object`.
Expand All @@ -484,9 +488,24 @@ the :mod:`glob` module.)
.. function:: splitext(path)

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
period. Leading periods on the basename are ignored; ``splitext('.cshrc')``
returns ``('.cshrc', '')``.
path``, and the extension, *ext*, is empty or begins with a period and contains at
most one period.

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
Accepts a :term:`path-like object`.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add typical examples to os.path.splitext docs