From 201017df308266c7d5ed20181e6d0ffa5832e3e9 Mon Sep 17 00:00:00 2001 From: Claude Paroz Date: Tue, 21 Aug 2018 15:28:51 +0200 Subject: [PATCH] Fixed #29654 -- Made text truncation an ellipsis character instead of three dots. Thanks Sudhanshu Mishra for the initial patch and Tim Graham for the review. --- django/contrib/admin/widgets.py | 2 +- django/template/defaultfilters.py | 4 +-- django/utils/html.py | 4 +-- django/utils/text.py | 7 ++-- docs/ref/templates/builtins.txt | 16 +++++----- docs/releases/2.2.txt | 6 ++++ tests/migrations/test_commands.py | 2 +- .../filter_tests/test_truncatechars.py | 4 +-- .../filter_tests/test_truncatechars_html.py | 12 +++---- .../filter_tests/test_truncatewords.py | 8 ++--- .../filter_tests/test_truncatewords_html.py | 8 ++--- .../filter_tests/test_urlizetrunc.py | 18 +++++------ .../syntax_tests/test_filter_syntax.py | 2 +- tests/utils_tests/test_text.py | 32 +++++++++---------- 14 files changed, 65 insertions(+), 60 deletions(-) diff --git a/django/contrib/admin/widgets.py b/django/contrib/admin/widgets.py index 32a1900cb1..c5cde4b14d 100644 --- a/django/contrib/admin/widgets.py +++ b/django/contrib/admin/widgets.py @@ -193,7 +193,7 @@ class ForeignKeyRawIdWidget(forms.TextInput): except NoReverseMatch: url = '' # Admin not registered for target model. - return Truncator(obj).words(14, truncate='...'), url + return Truncator(obj).words(14), url class ManyToManyRawIdWidget(ForeignKeyRawIdWidget): diff --git a/django/template/defaultfilters.py b/django/template/defaultfilters.py index 400ce7ceb5..1479da8788 100644 --- a/django/template/defaultfilters.py +++ b/django/template/defaultfilters.py @@ -280,7 +280,7 @@ def truncatewords(value, arg): length = int(arg) except ValueError: # Invalid literal for int(). return value # Fail silently. - return Truncator(value).words(length, truncate=' ...') + return Truncator(value).words(length, truncate=' …') @register.filter(is_safe=True) @@ -294,7 +294,7 @@ def truncatewords_html(value, arg): length = int(arg) except ValueError: # invalid literal for int() return value # Fail silently. - return Truncator(value).words(length, html=True, truncate=' ...') + return Truncator(value).words(length, html=True, truncate=' …') @register.filter(is_safe=False) diff --git a/django/utils/html.py b/django/utils/html.py index c5035e3b23..72719cdd2d 100644 --- a/django/utils/html.py +++ b/django/utils/html.py @@ -245,7 +245,7 @@ def urlize(text, trim_url_limit=None, nofollow=False, autoescape=False): leading punctuation (opening parens) and it'll still do the right thing. If trim_url_limit is not None, truncate the URLs in the link text longer - than this limit to trim_url_limit-3 characters and append an ellipsis. + than this limit to trim_url_limit - 1 characters and append an ellipsis. If nofollow is True, give the links a rel="nofollow" attribute. @@ -256,7 +256,7 @@ def urlize(text, trim_url_limit=None, nofollow=False, autoescape=False): def trim_url(x, limit=trim_url_limit): if limit is None or len(x) <= limit: return x - return '%s...' % x[:max(0, limit - 3)] + return '%s…' % x[:max(0, limit - 1)] def unescape(text, trail): """ diff --git a/django/utils/text.py b/django/utils/text.py index e980f7170f..0e41cac493 100644 --- a/django/utils/text.py +++ b/django/utils/text.py @@ -64,7 +64,7 @@ class Truncator(SimpleLazyObject): if truncate is None: truncate = pgettext( 'String to return when truncating text', - '%(truncated_text)s...') + '%(truncated_text)s…') if '%(truncated_text)s' in truncate: return truncate % {'truncated_text': text} # The truncation text didn't contain the %(truncated_text)s string @@ -81,8 +81,7 @@ class Truncator(SimpleLazyObject): of characters. `truncate` specifies what should be used to notify that the string has - been truncated, defaulting to a translatable string of an ellipsis - (...). + been truncated, defaulting to a translatable string of an ellipsis. """ self._setup() length = int(num) @@ -123,7 +122,7 @@ class Truncator(SimpleLazyObject): """ Truncate a string after a certain number of words. `truncate` specifies what should be used to notify that the string has been truncated, - defaulting to ellipsis (...). + defaulting to ellipsis. """ self._setup() length = int(num) diff --git a/docs/ref/templates/builtins.txt b/docs/ref/templates/builtins.txt index 0d2ba1b08a..e5507e3714 100644 --- a/docs/ref/templates/builtins.txt +++ b/docs/ref/templates/builtins.txt @@ -2265,15 +2265,15 @@ If ``value`` is ``"my FIRST post"``, the output will be ``"My First Post"``. ----------------- Truncates a string if it is longer than the specified number of characters. -Truncated strings will end with a translatable ellipsis sequence ("..."). +Truncated strings will end with a translatable ellipsis character ("…"). **Argument:** Number of characters to truncate to For example:: - {{ value|truncatechars:9 }} + {{ value|truncatechars:7 }} -If ``value`` is ``"Joel is a slug"``, the output will be ``"Joel i..."``. +If ``value`` is ``"Joel is a slug"``, the output will be ``"Joel i…"``. .. templatefilter:: truncatechars_html @@ -2286,10 +2286,10 @@ are closed immediately after the truncation. For example:: - {{ value|truncatechars_html:9 }} + {{ value|truncatechars_html:7 }} If ``value`` is ``"

Joel is a slug

"``, the output will be -``"

Joel i...

"``. +``"

Joel i…

"``. Newlines in the HTML content will be preserved. @@ -2306,7 +2306,7 @@ For example:: {{ value|truncatewords:2 }} -If ``value`` is ``"Joel is a slug"``, the output will be ``"Joel is ..."``. +If ``value`` is ``"Joel is a slug"``, the output will be ``"Joel is …"``. Newlines within the string will be removed. @@ -2327,7 +2327,7 @@ For example:: {{ value|truncatewords_html:2 }} If ``value`` is ``"

Joel is a slug

"``, the output will be -``"

Joel is ...

"``. +``"

Joel is …

"``. Newlines in the HTML content will be preserved. @@ -2454,7 +2454,7 @@ For example:: If ``value`` is ``"Check out www.djangoproject.com"``, the output would be ``'Check out www.djangopr...'``. +rel="nofollow">www.djangoproj…'``. As with urlize_, this filter should only be applied to plain text. diff --git a/docs/releases/2.2.txt b/docs/releases/2.2.txt index 307a2b6a06..4ca3bb9662 100644 --- a/docs/releases/2.2.txt +++ b/docs/releases/2.2.txt @@ -273,6 +273,12 @@ Miscellaneous * The return value of :func:`django.utils.text.slugify` is no longer marked as HTML safe. +* The default truncation character used by the :tfilter:`urlizetrunc`, + :tfilter:`truncatechars`, :tfilter:`truncatechars_html`, + :tfilter:`truncatewords`, and :tfilter:`truncatewords_html` template filters + is now the real ellipsis character (``…``) instead of 3 dots. You may have to + adapt some test output comparisons. + .. _deprecated-features-2.2: Features deprecated in 2.2 diff --git a/tests/migrations/test_commands.py b/tests/migrations/test_commands.py index 3bc37b6c15..c216b10e68 100644 --- a/tests/migrations/test_commands.py +++ b/tests/migrations/test_commands.py @@ -346,7 +346,7 @@ class MigrateTests(MigrationTestBase): self.assertEqual( 'Planned operations:\n' 'migrations.0004_fourth\n' - ' Raw SQL operation -> SELECT * FROM migrations_author W...\n', + ' Raw SQL operation -> SELECT * FROM migrations_author WHE…\n', out.getvalue() ) # Migrate to the fourth migration. diff --git a/tests/template_tests/filter_tests/test_truncatechars.py b/tests/template_tests/filter_tests/test_truncatechars.py index 81083c3b9c..89d48fd1cf 100644 --- a/tests/template_tests/filter_tests/test_truncatechars.py +++ b/tests/template_tests/filter_tests/test_truncatechars.py @@ -5,10 +5,10 @@ from ..utils import setup class TruncatecharsTests(SimpleTestCase): - @setup({'truncatechars01': '{{ a|truncatechars:5 }}'}) + @setup({'truncatechars01': '{{ a|truncatechars:3 }}'}) def test_truncatechars01(self): output = self.engine.render_to_string('truncatechars01', {'a': 'Testing, testing'}) - self.assertEqual(output, 'Te...') + self.assertEqual(output, 'Te…') @setup({'truncatechars02': '{{ a|truncatechars:7 }}'}) def test_truncatechars02(self): diff --git a/tests/template_tests/filter_tests/test_truncatechars_html.py b/tests/template_tests/filter_tests/test_truncatechars_html.py index 77e41a74ac..4948e6534e 100644 --- a/tests/template_tests/filter_tests/test_truncatechars_html.py +++ b/tests/template_tests/filter_tests/test_truncatechars_html.py @@ -5,18 +5,18 @@ from django.test import SimpleTestCase class FunctionTests(SimpleTestCase): def test_truncate_zero(self): - self.assertEqual(truncatechars_html('

one two - three
four five

', 0), '...') + self.assertEqual(truncatechars_html('

one two - three
four five

', 0), '…') def test_truncate(self): self.assertEqual( - truncatechars_html('

one two - three
four five

', 6), - '

one...

', + truncatechars_html('

one two - three
four five

', 4), + '

one…

', ) def test_truncate2(self): self.assertEqual( - truncatechars_html('

one two - three
four five

', 11), - '

one two ...

', + truncatechars_html('

one two - three
four five

', 9), + '

one two …

', ) def test_truncate3(self): @@ -26,7 +26,7 @@ class FunctionTests(SimpleTestCase): ) def test_truncate_unicode(self): - self.assertEqual(truncatechars_html('\xc5ngstr\xf6m was here', 5), '\xc5n...') + self.assertEqual(truncatechars_html('\xc5ngstr\xf6m was here', 3), '\xc5n…') def test_truncate_something(self): self.assertEqual(truncatechars_html('abc', 3), 'abc') diff --git a/tests/template_tests/filter_tests/test_truncatewords.py b/tests/template_tests/filter_tests/test_truncatewords.py index 4941e736fd..636cd55fd5 100644 --- a/tests/template_tests/filter_tests/test_truncatewords.py +++ b/tests/template_tests/filter_tests/test_truncatewords.py @@ -14,25 +14,25 @@ class TruncatewordsTests(SimpleTestCase): output = self.engine.render_to_string( 'truncatewords01', {'a': 'alpha & bravo', 'b': mark_safe('alpha & bravo')} ) - self.assertEqual(output, 'alpha & ... alpha & ...') + self.assertEqual(output, 'alpha & … alpha & …') @setup({'truncatewords02': '{{ a|truncatewords:"2" }} {{ b|truncatewords:"2"}}'}) def test_truncatewords02(self): output = self.engine.render_to_string( 'truncatewords02', {'a': 'alpha & bravo', 'b': mark_safe('alpha & bravo')} ) - self.assertEqual(output, 'alpha & ... alpha & ...') + self.assertEqual(output, 'alpha & … alpha & …') class FunctionTests(SimpleTestCase): def test_truncate(self): - self.assertEqual(truncatewords('A sentence with a few words in it', 1), 'A ...') + self.assertEqual(truncatewords('A sentence with a few words in it', 1), 'A …') def test_truncate2(self): self.assertEqual( truncatewords('A sentence with a few words in it', 5), - 'A sentence with a few ...', + 'A sentence with a few …', ) def test_overtruncate(self): diff --git a/tests/template_tests/filter_tests/test_truncatewords_html.py b/tests/template_tests/filter_tests/test_truncatewords_html.py index 2db4b3f926..5daeef6cf3 100644 --- a/tests/template_tests/filter_tests/test_truncatewords_html.py +++ b/tests/template_tests/filter_tests/test_truncatewords_html.py @@ -10,13 +10,13 @@ class FunctionTests(SimpleTestCase): def test_truncate(self): self.assertEqual( truncatewords_html('

one two - three
four five

', 2), - '

one two ...

', + '

one two …

', ) def test_truncate2(self): self.assertEqual( truncatewords_html('

one two - three
four five

', 4), - '

one two - three
four ...

', + '

one two - three
four …

', ) def test_truncate3(self): @@ -32,12 +32,12 @@ class FunctionTests(SimpleTestCase): ) def test_truncate_unicode(self): - self.assertEqual(truncatewords_html('\xc5ngstr\xf6m was here', 1), '\xc5ngstr\xf6m ...') + self.assertEqual(truncatewords_html('\xc5ngstr\xf6m was here', 1), '\xc5ngstr\xf6m …') def test_truncate_complex(self): self.assertEqual( truncatewords_html('Buenos días! ¿Cómo está?', 3), - 'Buenos días! ¿Cómo ...', + 'Buenos días! ¿Cómo …', ) def test_invalid_arg(self): diff --git a/tests/template_tests/filter_tests/test_urlizetrunc.py b/tests/template_tests/filter_tests/test_urlizetrunc.py index 18a5336c86..e37e277212 100644 --- a/tests/template_tests/filter_tests/test_urlizetrunc.py +++ b/tests/template_tests/filter_tests/test_urlizetrunc.py @@ -20,8 +20,8 @@ class UrlizetruncTests(SimpleTestCase): ) self.assertEqual( output, - '"Unsafe" http:... ' - '"Safe" http:...' + '"Unsafe" http://… ' + '"Safe" http://…' ) @setup({'urlizetrunc02': '{{ a|urlizetrunc:"8" }} {{ b|urlizetrunc:"8" }}'}) @@ -35,8 +35,8 @@ class UrlizetruncTests(SimpleTestCase): ) self.assertEqual( output, - '"Unsafe" http:... ' - '"Safe" http:...' + '"Unsafe" http://… ' + '"Safe" http://…' ) @@ -55,13 +55,13 @@ class FunctionTests(SimpleTestCase): self.assertEqual( urlizetrunc(uri, 30), '' - 'http://31characteruri.com/t...', + 'http://31characteruri.com/tes…', ) self.assertEqual( - urlizetrunc(uri, 2), + urlizetrunc(uri, 1), '...', + ' rel="nofollow">…', ) def test_overtruncate(self): @@ -74,7 +74,7 @@ class FunctionTests(SimpleTestCase): self.assertEqual( urlizetrunc('http://www.google.co.uk/search?hl=en&q=some+long+url&btnG=Search&meta=', 20), 'http://www.google...', + 'meta=" rel="nofollow">http://www.google.c…', ) def test_non_string_input(self): @@ -89,5 +89,5 @@ class FunctionTests(SimpleTestCase): def test_autoescape_off(self): self.assertEqual( urlizetrunc('foobarbuz', 9, autoescape=False), - 'foogoogle... ">barbuz', + 'foogoogle.c… ">barbuz', ) diff --git a/tests/template_tests/syntax_tests/test_filter_syntax.py b/tests/template_tests/syntax_tests/test_filter_syntax.py index f6f2857df8..1d37163d60 100644 --- a/tests/template_tests/syntax_tests/test_filter_syntax.py +++ b/tests/template_tests/syntax_tests/test_filter_syntax.py @@ -168,7 +168,7 @@ class FilterSyntaxTests(SimpleTestCase): Numbers as filter arguments should work """ output = self.engine.render_to_string('filter-syntax19', {"var": "hello world"}) - self.assertEqual(output, "hello ...") + self.assertEqual(output, "hello …") @setup({'filter-syntax20': '{{ ""|default_if_none:"was none" }}'}) def test_filter_syntax20(self): diff --git a/tests/utils_tests/test_text.py b/tests/utils_tests/test_text.py index 5e12391116..daa028a0f7 100644 --- a/tests/utils_tests/test_text.py +++ b/tests/utils_tests/test_text.py @@ -56,22 +56,22 @@ class TestUtilsText(SimpleTestCase): def test_truncate_chars(self): truncator = text.Truncator('The quick brown fox jumped over the lazy dog.') self.assertEqual('The quick brown fox jumped over the lazy dog.', truncator.chars(100)), - self.assertEqual('The quick brown fox ...', truncator.chars(23)), + self.assertEqual('The quick brown fox …', truncator.chars(21)), self.assertEqual('The quick brown fo.....', truncator.chars(23, '.....')), nfc = text.Truncator('o\xfco\xfco\xfco\xfc') nfd = text.Truncator('ou\u0308ou\u0308ou\u0308ou\u0308') self.assertEqual('oüoüoüoü', nfc.chars(8)) self.assertEqual('oüoüoüoü', nfd.chars(8)) - self.assertEqual('oü...', nfc.chars(5)) - self.assertEqual('oü...', nfd.chars(5)) + self.assertEqual('oü…', nfc.chars(3)) + self.assertEqual('oü…', nfd.chars(3)) # Ensure the final length is calculated correctly when there are # combining characters with no precomposed form, and that combining # characters are not split up. truncator = text.Truncator('-B\u030AB\u030A----8') - self.assertEqual('-B\u030A...', truncator.chars(5)) - self.assertEqual('-B\u030AB\u030A-...', truncator.chars(7)) + self.assertEqual('-B\u030A…', truncator.chars(3)) + self.assertEqual('-B\u030AB\u030A-…', truncator.chars(5)) self.assertEqual('-B\u030AB\u030A----8', truncator.chars(8)) # Ensure the length of the end text is correctly calculated when it @@ -82,18 +82,18 @@ class TestUtilsText(SimpleTestCase): # Make a best effort to shorten to the desired length, but requesting # a length shorter than the ellipsis shouldn't break - self.assertEqual('...', text.Truncator('asdf').chars(1)) + self.assertEqual('…', text.Truncator('asdf').chars(0)) # lazy strings are handled correctly - self.assertEqual(text.Truncator(lazystr('The quick brown fox')).chars(12), 'The quick...') + self.assertEqual(text.Truncator(lazystr('The quick brown fox')).chars(10), 'The quick…') def test_truncate_words(self): truncator = text.Truncator('The quick brown fox jumped over the lazy dog.') self.assertEqual('The quick brown fox jumped over the lazy dog.', truncator.words(10)) - self.assertEqual('The quick brown fox...', truncator.words(4)) + self.assertEqual('The quick brown fox…', truncator.words(4)) self.assertEqual('The quick brown fox[snip]', truncator.words(4, '[snip]')) # lazy strings are handled correctly truncator = text.Truncator(lazystr('The quick brown fox jumped over the lazy dog.')) - self.assertEqual('The quick brown fox...', truncator.words(4)) + self.assertEqual('The quick brown fox…', truncator.words(4)) def test_truncate_html_words(self): truncator = text.Truncator( @@ -104,7 +104,7 @@ class TestUtilsText(SimpleTestCase): truncator.words(10, html=True) ) self.assertEqual( - '

The quick brown fox...

', + '

The quick brown fox…

', truncator.words(4, html=True) ) self.assertEqual( @@ -121,21 +121,21 @@ class TestUtilsText(SimpleTestCase): '

The quick brown fox jumped over the lazy dog.

' ) self.assertEqual( - '

The quick brown...

', - truncator.words(3, '...', html=True) + '

The quick brown…

', + truncator.words(3, html=True) ) # Test self-closing tags truncator = text.Truncator('
The
quick brown fox jumped over the lazy dog.') - self.assertEqual('
The
quick brown...', truncator.words(3, '...', html=True)) + self.assertEqual('
The
quick brown…', truncator.words(3, html=True)) truncator = text.Truncator('
The
quick brown fox jumped over the lazy dog.') - self.assertEqual('
The
quick brown...', truncator.words(3, '...', html=True)) + self.assertEqual('
The
quick brown…', truncator.words(3, html=True)) # Test html entities truncator = text.Truncator('Buenos días! ¿Cómo está?') - self.assertEqual('Buenos días! ¿Cómo...', truncator.words(3, '...', html=True)) + self.assertEqual('Buenos días! ¿Cómo…', truncator.words(3, html=True)) truncator = text.Truncator('

I <3 python, what about you?

') - self.assertEqual('

I <3 python...

', truncator.words(3, '...', html=True)) + self.assertEqual('

I <3 python…

', truncator.words(3, html=True)) re_tag_catastrophic_test = ('' truncator = text.Truncator(re_tag_catastrophic_test)