Merge pull request #419 from yen223/fix-docstring-whitespace

Fix docstring whitespace

Author: syrusakbary

graphene/types/enum.py

@@ -3,6 +3,7 @@
 import six
 
 from ..utils.is_base_type import is_base_type
+from ..utils.trim_docstring import trim_docstring
 from .options import Options
 from .unmountedtype import UnmountedType
 
@@ -23,7 +24,7 @@ def __new__(cls, name, bases, attrs):
         options = Options(
             attrs.pop('Meta', None),
             name=name,
-            description=attrs.get('__doc__'),
+            description=trim_docstring(attrs.get('__doc__')),
             enum=None,
         )
         if not options.enum:

graphene/types/inputobjecttype.py

@@ -1,6 +1,7 @@
 import six
 
 from ..utils.is_base_type import is_base_type
+from ..utils.trim_docstring import trim_docstring
 from .abstracttype import AbstractTypeMeta
 from .inputfield import InputField
 from .options import Options
@@ -19,7 +20,7 @@ def __new__(cls, name, bases, attrs):
         options = Options(
             attrs.pop('Meta', None),
             name=name,
-            description=attrs.get('__doc__'),
+            description=trim_docstring(attrs.get('__doc__')),
             local_fields=None,
         )
 

graphene/types/interface.py

@@ -1,6 +1,7 @@
 import six
 
 from ..utils.is_base_type import is_base_type
+from ..utils.trim_docstring import trim_docstring
 from .abstracttype import AbstractTypeMeta
 from .field import Field
 from .options import Options
@@ -18,7 +19,7 @@ def __new__(cls, name, bases, attrs):
         options = Options(
             attrs.pop('Meta', None),
             name=name,
-            description=attrs.get('__doc__'),
+            description=trim_docstring(attrs.get('__doc__')),
             local_fields=None,
         )
 

graphene/types/objecttype.py

@@ -3,6 +3,7 @@
 import six
 
 from ..utils.is_base_type import is_base_type
+from ..utils.trim_docstring import trim_docstring
 from .abstracttype import AbstractTypeMeta
 from .field import Field
 from .interface import Interface
@@ -22,7 +23,7 @@ def __new__(cls, name, bases, attrs):
         options = _meta or Options(
             attrs.pop('Meta', None),
             name=name,
-            description=attrs.get('__doc__'),
+            description=trim_docstring(attrs.get('__doc__')),
             interfaces=(),
             local_fields=OrderedDict(),
         )

graphene/types/scalars.py

@@ -1,9 +1,9 @@
 import six
-
 from graphql.language.ast import (BooleanValue, FloatValue, IntValue,
                                   StringValue)
 
 from ..utils.is_base_type import is_base_type
+from ..utils.trim_docstring import trim_docstring
 from .options import Options
 from .unmountedtype import UnmountedType
 
@@ -19,7 +19,7 @@ def __new__(cls, name, bases, attrs):
         options = Options(
             attrs.pop('Meta', None),
             name=name,
-            description=attrs.get('__doc__'),
+            description=trim_docstring(attrs.get('__doc__')),
         )
 
         return type.__new__(cls, name, bases, dict(attrs, _meta=options))

graphene/types/tests/test_objecttype.py

@@ -173,3 +173,14 @@ def test_objecttype_container_benchmark(benchmark):
     @benchmark
     def create_objecttype():
         Container(field1='field1', field2='field2')
+
+
+def test_generate_objecttype_description():
+    class MyObjectType(ObjectType):
+        '''
+        Documentation
+
+        Documentation line 2
+        '''
+
+    assert MyObjectType._meta.description == "Documentation\n\nDocumentation line 2"

graphene/types/union.py

@@ -1,6 +1,7 @@
 import six
 
 from ..utils.is_base_type import is_base_type
+from ..utils.trim_docstring import trim_docstring
 from .options import Options
 from .unmountedtype import UnmountedType
 
@@ -16,7 +17,7 @@ def __new__(cls, name, bases, attrs):
         options = Options(
             attrs.pop('Meta', None),
             name=name,
-            description=attrs.get('__doc__'),
+            description=trim_docstring(attrs.get('__doc__')),
             types=(),
         )
 

graphene/utils/tests/test_trim_docstring.py

@@ -0,0 +1,21 @@
+from ..trim_docstring import trim_docstring
+
+
+def test_trim_docstring():
+    class WellDocumentedObject(object):
+        """
+        This object is very well-documented. It has multiple lines in its
+        description.
+
+        Multiple paragraphs too
+        """
+        pass
+
+    assert (trim_docstring(WellDocumentedObject.__doc__) ==
+        "This object is very well-documented. It has multiple lines in its\n"
+        "description.\n\nMultiple paragraphs too")
+
+    class UndocumentedObject(object):
+        pass
+
+    assert trim_docstring(UndocumentedObject.__doc__) is None

graphene/utils/trim_docstring.py

@@ -0,0 +1,9 @@
+import inspect
+
+
+def trim_docstring(docstring):
+    # Cleans up whitespaces from an indented docstring
+    #
+    # See https://www.python.org/dev/peps/pep-0257/
+    # and https://docs.python.org/2/library/inspect.html#inspect.cleandoc
+    return inspect.cleandoc(docstring) if docstring else None