homepage

This issue tracker has been migrated to GitHub , and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Improve str.expandtabs() doc
Type: Stage: resolved
Components: Documentation Versions: Python 3.3, Python 3.4, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: asolano, docs@python, eli.bendersky, ezio.melotti, ned.deily, python-dev, roger.serwy
Priority: normal Keywords: patch

Created on 2013年04月08日 23:26 by asolano, last changed 2022年04月11日 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
issue17670_doc.patch ned.deily, 2013年04月09日 23:05 review
issue17670_doc_rev_1.patch ned.deily, 2013年04月15日 21:02 review
issue17670_doc_rev_2.patch ned.deily, 2013年04月21日 01:04 review
Messages (12)
msg186358 - (view) Author: Alfredo Solano Martínez (asolano) Date: 2013年04月08日 23:26
I stumbled upon this by chance. Is the following behaviour by design?
>>> s = 'a\tb'
>>> s.expandtabs(1) == s.expandtabs(2)
True
In fact:
>>> s.expandtabs(1)
'a b' # 1 space
>>> s.expandtabs(2)
'a b' # 1 space
>>> s.expandtabs(3)
'a b' # 2 spaces
>>> s.expandtabs(4)
'a b' # 3 spaces
It seems to be an off-by-one difference from 2 onwards. 
Tested with python versions 2.7.4, 3.2.4 and 3.3.1 on a Linux x86_64 machine.
msg186363 - (view) Author: Ned Deily (ned.deily) * (Python committer) Date: 2013年04月09日 00:49
Yes, the behavior is by design. I think you are misunderstanding how exandtabs() works. The "tabsize" argument indicates the number of columns each tab position occupies. So, with a tabsize of 4, the tab positions occur every four columns; the tab positions are where the characters immediately following the tab character start. Perhaps this example will make the behavior clearer:
>>> '1\t2'.expandtabs(4)
'1 2'
>>> '12\t3'.expandtabs(4)
'12 3'
>>> '123\t4'.expandtabs(4)
'123 4'
msg186389 - (view) Author: Alfredo Solano Martínez (asolano) Date: 2013年04月09日 08:54
It does, thank you. Maybe hat example could be added to the docuentation?
msg186469 - (view) Author: Ned Deily (ned.deily) * (Python committer) Date: 2013年04月09日 23:05
That's a good point. Here's a patch for the documentation with a simplified example:
 >>> '01\t456\t89'.expandtabs(4)
 '01 456 89'
What do others think: is an example useful and, if so, this example?
msg186544 - (view) Author: Roger Serwy (roger.serwy) * (Python committer) Date: 2013年04月11日 04:26
LGTM.
msg186690 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2013年04月13日 03:16
I agree the doc could be clearer and Ned's example is very good. However I'd go one step forward and add a further elaboration of how the method works. This is the current doc (in default branch):
 Return a copy of the string where all tab characters are replaced by zero or more spaces, depending on the current column and the given tab size. The column number is reset to zero after each newline occurring in the string. If tabsize is not given, a tab size of 8 characters is assumed. This doesn’t understand other non-printing characters or escape sequences.
I'd say this (note new second sentence):
 Return a copy of the string where all tab characters are replaced by zero or more spaces, depending on the current column and the given tab size. Every time a \t char appears in the string, the text before it gets padded with spaces until the next tab position is reached. The column number is reset to zero after each newline occurring in the string. If tabsize is not given, a tab size of 8 characters is assumed. This doesn’t understand other non-printing characters or escape sequences.
And then follow with Ned's example.
msg186746 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2013年04月13日 16:19
"This doesn’t understand other non-printing characters or escape sequences."
This might also be improved. Does it mean that all characters are considered having len(c) == 1, even if they are not printable or escape sequence (and which escape sequences? \f, \v?)?
Adding an example with tabsize=8 might also help, but it might not be necessary if the wording is improved as Eli suggested.
msg187031 - (view) Author: Ned Deily (ned.deily) * (Python committer) Date: 2013年04月15日 21:02
Thanks for the suggested. Here's a revised wording and a slightly more legible example:
 Return a copy of the string where all tab characters are replaced by zero or
 more spaces, depending on the current tab column and the given tab size.
 Starting at the first character of the string, the tab column is set to
 zero. Whenever a tab character (``\t``) is encountered, space characters
 are inserted as needed until the next tab position is reached and the tab
 column is set to that tab position; the tab character itself is not copied.
 Whenever a newline character (``\n`` or ``\r``) is encountered, it is copied
 and the tab column is reset to zero. Any other character is copied unchanged
 and the tab column is incremented by one regardless of how it may be
 represented when printed. If *tabsize* is not given, a tab size of 8
 characters is assumed.
 >>> '012\t4\t89'.expandtabs(4)
 '012 4 89'
msg187041 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2013年04月16日 01:16
It's better, although the distinction between "tab column" and "tab position" is not entirely clear.
msg187479 - (view) Author: Ned Deily (ned.deily) * (Python committer) Date: 2013年04月21日 00:58
Another round based on comments. I also just noticed that the current doc incorrectly claims that tabs are replaced by *zero* or more spaces.
 Return a copy of the string where all tab characters are replaced by one or
 more spaces, depending on the current column and the given tab size. Tab
 positions occur every *tabsize* characters (default is 8, giving tab
 positions at columns 0, 8, 16 and so on). To expand the string, the current
 column is set to zero and the string is examined character by character. If
 the character is a tab (``\t``), one or more space characters are inserted
 in the result until the current column is equal to the next tab position.
 (The tab character itself is not copied.) If the character is a newline
 (``\n``) or return (``\r``), it is copied and the current column is reset to
 zero. Any other character is copied unchanged and the current column is
 incremented by one regardless of how the character is represented when
 printed.
 >>> '01\t012\t0123\t01234'.expandtabs()
 '01 012 0123 01234'
 >>> '01\t012\t0123\t01234'.expandtabs(4)
 '01 012 0123 01234'
msg187503 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2013年04月21日 13:42
LGTM!
msg187520 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2013年04月21日 20:07
New changeset 6a02d2af814f by Ned Deily in branch '2.7':
Issue #17670: Provide an example of expandtabs() usage.
http://hg.python.org/cpython/rev/6a02d2af814f
New changeset 5b6ccab52a4d by Ned Deily in branch '3.3':
Issue #17670: Provide an example of expandtabs() usage.
http://hg.python.org/cpython/rev/5b6ccab52a4d
New changeset 1a6cb6d8591a by Ned Deily in branch 'default':
Issue #17670: merge from 3.3
http://hg.python.org/cpython/rev/1a6cb6d8591a 
History
Date User Action Args
2022年04月11日 14:57:44adminsetgithub: 61870
2013年04月21日 20:08:57ned.deilysetstatus: open -> closed
type: enhancement ->
resolution: fixed
stage: commit review -> resolved
2013年04月21日 20:07:55python-devsetnosy: + python-dev
messages: + msg187520
2013年04月21日 13:42:30eli.benderskysetmessages: + msg187503
2013年04月21日 01:04:30ned.deilysetfiles: + issue17670_doc_rev_2.patch
2013年04月21日 00:58:54ned.deilysetmessages: + msg187479
2013年04月16日 01:16:48eli.benderskysetmessages: + msg187041
2013年04月15日 21:02:03ned.deilysetfiles: + issue17670_doc_rev_1.patch

messages: + msg187031
2013年04月13日 16:19:10ezio.melottisettype: enhancement

messages: + msg186746
nosy: + ezio.melotti
2013年04月13日 03:16:39eli.benderskysetnosy: + eli.bendersky
messages: + msg186690
2013年04月12日 19:17:25terry.reedysettitle: expandtabs() weirdness -> Improve str.expandtabs() doc
2013年04月11日 04:26:00roger.serwysetnosy: + roger.serwy

messages: + msg186544
stage: patch review -> commit review
2013年04月09日 23:05:58ned.deilysetstatus: closed -> open
files: + issue17670_doc.patch


assignee: docs@python
type: behavior -> (no value)
keywords: + patch
stage: resolved -> patch review
versions: + Python 3.4
nosy: + docs@python
messages: + msg186469
components: + Documentation, - Library (Lib)
resolution: works for me -> (no value)
2013年04月09日 08:54:17asolanosetmessages: + msg186389
2013年04月09日 00:49:53ned.deilysetstatus: open -> closed

title: expandabs() weirdness -> expandtabs() weirdness
nosy: + ned.deily

messages: + msg186363
resolution: works for me
stage: resolved
2013年04月08日 23:26:31asolanocreate

AltStyle によって変換されたページ (->オリジナル) /