Ticket #6799: ellipsis-330.3.diff

django/utils/text.py

@@ -37 +37 @@
     return u''.join(_generator())
 wrap = allow_lazy(wrap, unicode)
 
-def truncate_words(s, num):
-    "Truncates a string after a certain number of words."
+def truncate_words(s, num, end_text='...'):
+    """Truncates a string after a certain number of words. Takes an optional argument of what
+    should be used to notify that the string has been truncated, defaults to ellipsis (...)"""
     s = force_unicode(s)
     length = int(num)
     words = s.split()
     if len(words) > length:
         words = words[:length]
-        if not words[-1].endswith('...'):
-            words.append('...')
+        if not words[-1].endswith(end_text):
+            words.append(end_text)
     return u' '.join(words)
 truncate_words = allow_lazy(truncate_words, unicode)
 
-def truncate_html_words(s, num):
+def truncate_html_words(s, num, end_text='...'):
     """
     Truncates html to a certain number of words (not counting tags and
     comments). Closes opened tags if they were correctly closed in the given
-    html.
+    html. Takes an optional argument of what should be used to notify that
+    the string has been truncated, defaults to ellipsis (...)
     """
     s = force_unicode(s)
     length = int(num)
@@ -104 +106 @@
     if words <= length:
         # Don't try to close tags if we don't need to truncate
         return s
-    out = s[:ellipsis_pos] + ' ...'
+    out = s[:ellipsis_pos] + ' ' + end_text
     # Close any tags still open
     for tag in open_tags:
         out += '</%s>' % tag

tests/regressiontests/utils/tests.py

@@ -9 +9 @@
 import timesince
 import datastructures
 import itercompat
+import text
 from decorators import DecoratorFromMiddlewareTests
 
 # We need this because "datastructures" uses sorted() and the tests are run in
@@ -23 +24 @@
     'timesince': timesince,
     'datastructures': datastructures,
     'itercompat': itercompat,
+    'text': text,
 }
 
 class TestUtilsHtml(TestCase):

tests/regressiontests/utils/text.py

@@ +1 @@
+"""
+### Tests for the utils text library
+
+>>> from django.utils.text import *
+
+# Check the truncate_words function
+>>> truncate_words(u'The quick brown fox jumped over the lazy dog.', 10)
+u'The quick brown fox jumped over the lazy dog....'
+
+>>> truncate_words('The quick brown fox jumped over the lazy dog.', 4)
+u'The quick brown fox ...'
+
+>>> truncate_words('The quick brown fox jumped over the lazy dog.', 4, '....')
+u'The quick brown fox ....'
+
+>>> truncate_html_words('<p><strong><em>The quick brown fox jumped over the lazy dog.</em></strong></p>', 10)
+u'<p><strong><em>The quick brown fox jumped over the lazy dog.</em></strong></p>'
+
+>>> truncate_html_words('<p><strong><em>The quick brown fox jumped over the lazy dog.</em></strong></p>', 4)
+u'<p><strong><em>The quick brown fox ...</em></strong></p>'
+
+>>> truncate_html_words('<p><strong><em>The quick brown fox jumped over the lazy dog.</em></strong></p>', 4, '....')
+u'<p><strong><em>The quick brown fox ....</em></strong></p>'
+
+"""