mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-12-23 09:19:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

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

Browse source 
(cherry picked from commit aa0894b379)

Co-authored-by: Jake Stockwin <jake.stockwin@optimorlabs.com>
This commit is contained in:
Miss Islington (bot) 2021-08-02 11:08:10 -07:00 • committed by GitHub
parent 77a96da556
commit e0d599fa48
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 27 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -458,12 +458,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`.
@ -472,9 +476,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`.

1
Misc/NEWS.d/next/Documentation/2021-07-22-08-28-03.bpo-35183.p9BWTB.rst Normal file
View file

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