languages/cpython
languages/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython synced 2024-09-22 01:58:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix the default placeholder in textwrap.shorten() to be " [...]".

Browse source 
For some reason I forgot to do it before committing the patch in issue #18585.
This commit is contained in:
Antoine Pitrou 2013-08-16 22:31:12 +02:00
parent 05eafa887b
commit c593056744
3 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
Doc/library/textwrap.rst
View file

@ -40,7 +40,7 @@ functions should be good enough; otherwise, you should use an instance of
:func:`wrap`.
.. function:: shorten(text, width=70, *, placeholder=" (...)")
.. function:: shorten(text, width=70, *, placeholder=" [...]")
Collapse and truncate the given text to fit in the given width.
@ -51,7 +51,7 @@ functions should be good enough; otherwise, you should use an instance of
>>> textwrap.shorten("Hello world!", width=12)
'Hello world!'
>>> textwrap.shorten("Hello world!", width=11)
'Hello (...)'
'Hello [...]'
>>> textwrap.shorten("Hello world", width=10, placeholder="...")
'Hello...'
@ -268,7 +268,7 @@ hyphenated words; only then will long words be broken if necessary, unless
containing the wrapped paragraph.
.. function:: shorten(text, *, placeholder=" (...)")
.. function:: shorten(text, *, placeholder=" [...]")
Collapse and truncate the given text to fit in :attr:`width`
characters.

12
Lib/test/test_textwrap.py
View file

@ -786,11 +786,11 @@ def test_simple(self):
# Simple case: just words, spaces, and a bit of punctuation
text = "Hello there, how are you this fine day? I'm glad to hear it!"
self.check_shorten(text, 18, "Hello there, (...)")
self.check_shorten(text, 18, "Hello there, [...]")
self.check_shorten(text, len(text), text)
self.check_shorten(text, len(text) - 1,
"Hello there, how are you this fine day? "
"I'm glad to (...)")
"I'm glad to [...]")
def test_placeholder(self):
text = "Hello there, how are you this fine day? I'm glad to hear it!"
@ -816,13 +816,13 @@ def test_whitespace(self):
"breaks and tabs too.")
self.check_shorten(text, 61,
"This is a paragraph that already has line "
"breaks and (...)")
"breaks and [...]")
self.check_shorten("hello world! ", 12, "hello world!")
self.check_shorten("hello world! ", 11, "hello (...)")
self.check_shorten("hello world! ", 11, "hello [...]")
# The leading space is trimmed from the placeholder
# (it would be ugly otherwise).
self.check_shorten("hello world! ", 10, "(...)")
self.check_shorten("hello world! ", 10, "[...]")
def test_width_too_small_for_placeholder(self):
wrapper = TextWrapper(width=8)
@ -831,7 +831,7 @@ def test_width_too_small_for_placeholder(self):
wrapper.shorten("x" * 20, placeholder="(.......)")
def test_first_word_too_long_but_placeholder_fits(self):
self.check_shorten("Helloo", 5, "(...)")
self.check_shorten("Helloo", 5, "[...]")
if __name__ == '__main__':

4
Lib/textwrap.py
View file

@ -19,7 +19,7 @@
# since 0xa0 is not in range(128).
_whitespace = '\t\n\x0b\x0c\r '
_default_placeholder = ' (...)'
_default_placeholder = ' [...]'
class TextWrapper:
"""
@ -376,7 +376,7 @@ def shorten(text, width, *, placeholder=_default_placeholder, **kwargs):
>>> textwrap.shorten("Hello world!", width=12)
'Hello world!'
>>> textwrap.shorten("Hello world!", width=11)
'Hello (...)'
'Hello [...]'
"""
w = TextWrapper(width=width, **kwargs)
return w.shorten(text, placeholder=placeholder)