Merge pull request bpython#656 from bpython/fix-653

sebastinas · web-flow · commit f4f05b2b7852 · 2016-11-19T11:18:06.000+01:00
fix weird boto docstrings
diff --git a/bpython/curtsiesfrontend/replpainter.py b/bpython/curtsiesfrontend/replpainter.py
@@ -74,7 +74,7 @@ def matches_lines(rows, columns, matches, current, config, format):
                                       if m != current
                                       else highlight_color(
                                           m.ljust(max_match_width))
-                                      for m in matches[i:i+words_wide])
+                                      for m in matches[i:i + words_wide])
                      for i in range(0, len(matches), words_wide)]
 
     logger.debug('match: %r' % current)
@@ -161,6 +161,12 @@ def formatted_argspec(funcprops, arg_pos, columns, config):
 
 
 def formatted_docstring(docstring, columns, config):
+    if isinstance(docstring, bytes):
+        docstring = docstring.decode('utf8')
+    elif isinstance(docstring, str if py3 else unicode):
+        pass
+    else:
+        return []
     color = func_for_letter(config.color_scheme['comment'])
     return sum(([color(x) for x in (display_linize(line, columns) if line else
                                     fmtstr(''))]
@@ -211,7 +217,7 @@ def paint_last_events(rows, columns, names, config):
         return fsarray([])
     width = min(max(len(name) for name in names), columns - 2)
     output_lines = []
-    output_lines.append(config.left_top_corner+config.top_border * width +
+    output_lines.append(config.left_top_corner + config.top_border * width +
                         config.right_top_corner)
     for name in reversed(names[max(0, len(names) - (rows - 2)):]):
         output_lines.append(config.left_border + name[:width].center(width) +
diff --git a/bpython/test/test_curtsies_painting.py b/bpython/test/test_curtsies_painting.py
@@ -1,8 +1,9 @@
 # coding: utf8
 from __future__ import unicode_literals
 import itertools
-import string
 import os
+import pydoc
+import string
 import sys
 from contextlib import contextmanager
 
@@ -136,6 +137,43 @@ def test_formatted_docstring(self):
                             'Also has side effects'])
         self.assertFSArraysEqualIgnoringFormatting(actual, expected)
 
+    def test_unicode_docstrings(self):
+        "A bit of a special case in Python 2"
+        # issue 653
+
+        def foo():
+            u"åß∂ƒ"
+
+        actual = replpainter.formatted_docstring(
+                     foo.__doc__, 40, config=setup_config())
+        expected = fsarray([u'åß∂ƒ'])
+        self.assertFSArraysEqualIgnoringFormatting(actual, expected)
+
+    def test_nonsense_docstrings(self):
+        for docstring in [123, {}, [], ]:
+            try:
+                replpainter.formatted_docstring(
+                    docstring, 40, config=setup_config())
+            except Exception:
+                self.fail('bad docstring caused crash: {!r}'.format(docstring))
+
+    def test_weird_boto_docstrings(self):
+        # Boto does something like this.
+        # botocore: botocore/docs/docstring.py
+        class WeirdDocstring(str):
+            # a mighty hack. See botocore/docs/docstring.py
+            def expandtabs(self, tabsize=8):
+                return u'asdfåß∂ƒ'.expandtabs(tabsize)
+
+        def foo():
+            pass
+
+        foo.__doc__ = WeirdDocstring()
+        wd = pydoc.getdoc(foo)
+        actual = replpainter.formatted_docstring(wd, 40, config=setup_config())
+        expected = fsarray([u'asdfåß∂ƒ'])
+        self.assertFSArraysEqualIgnoringFormatting(actual, expected)
+
     def test_paint_lasts_events(self):
         actual = replpainter.paint_last_events(4, 100, ['a', 'b', 'c'],
                                                config=setup_config())
