Towards fixing the Py2 bug in numpy#163

Author: jnothman

numpydoc/docscrape_sphinx.py

@@ -7,6 +7,7 @@
 import pydoc
 import collections
 import os
+import locale
 
 from jinja2 import FileSystemLoader
 from jinja2.sandbox import SandboxedEnvironment
@@ -146,6 +147,9 @@ def _process_param(self, param, desc, fake_autosummary):
                 or inspect.isgetsetdescriptor(param_obj)):
             param_obj = None
         obj_doc = pydoc.getdoc(param_obj)
+        if isinstance(obj_doc, bytes):
+            # reverse the encoding performed in getdoc
+            obj_doc = obj_doc.decode(locale.getpreferredencoding())
 
         if not (param_obj and obj_doc):
             return display_param, desc

numpydoc/tests/test_docscrape.py

@@ -829,6 +829,27 @@ def test_unicode():
     assert isinstance(doc['Summary'][0], str)
     assert doc['Summary'][0] == 'öäöäöäöäöåååå'
 
+    class UnicodeProperty(object):
+        """Class with Attribute having its own non-ascii docstring
+
+        Attributes
+        ----------
+        testattr : None
+            Description here is overwritten
+        testattr2 : None
+            Description here is overwritten
+        """
+        @property
+        def testattr(self):
+            """öäöäöäöäöåååå"""
+
+        @property
+        def testattr2(self):
+            u"""öäöäöäöäöåååå"""
+
+    doc = SphinxClassDoc(UnicodeProperty)
+    assert isinstance(str(doc), str)
+
 
 def test_plot_examples():
     cfg = dict(use_plots=True)