classification
Title: os.path.splitext documentation needs typical example
Type: enhancement Stage:
Components: Documentation Versions: Python 3.6
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, shaungriffith
Priority: normal Keywords:

Created on 2018-11-07 11:49 by shaungriffith, last changed 2018-11-07 11:49 by shaungriffith.

Messages (1)
msg329414 - (view) Author: Shaun Griffith (shaungriffith) Date: 2018-11-07 11:49
As with many entries on the os.path doc page, splitext needs a typical example. Not grokking the bare minimum text, I had to actually try it in the interpreter to see what it did.

The one example that *is* there is an edge case, and does nothing to explain the normal behavior, or why this is the correct behavior for the edge case.

Here is where I tripped up:

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.

One interpretation of this is that ext is either empty, or has a period, _and nothing else_. 

Here are 2 examples for typical use:

>>> splitext('readme.txt')
('readme', '.txt')
>>> splitext('/some/long/pathname/warble.csv')
('/some/long/pathname/warble', '.csv')
History
Date User Action Args
2018-11-07 11:49:12shaungriffithcreate