fix: Fix dedent for attributes docstrings

Issue mkdocstrings#225: mkdocstrings/mkdocstrings#225

Author: pawamoy

Diff for: src/pytkdocs/parsers/attributes.py

@@ -88,7 +88,7 @@ def get_pairs(nodes):
 def get_module_or_class_attributes(nodes):
     result = {}
     for assignment, string_node in get_pairs(nodes):
-        string = dedent(string_node.s) if string_node else None
+        string = inspect.cleandoc(string_node.s) if string_node else None
         if isinstance(assignment, ast.Assign):
             names = []
             for target in assignment.targets:
@@ -164,7 +164,7 @@ def get_instance_attributes(func):
         if not names or (string is None and annotation is None):
             continue
 
-        docstring = dedent(string.s) if string else None
+        docstring = inspect.cleandoc(string.s) if string else None
         for name in names:
             result[name] = {"annotation": annotation, "docstring": docstring}
 

Diff for: tests/fixtures/parsing/attributes.py

@@ -166,6 +166,10 @@ class E:
 
     both_class_and_instance_attribute: Optional[bool] = None
 
+    DEDENT = 0
+    """This docstring starts immediately (no blank line).
+    Use `inspect.cleandoc` instead of `textwrap.dedent`."""
+
     def __init__(self):
         """
         Init doctring.
@@ -216,6 +220,10 @@ def __init__(self):
         self.c.non_self_attribute2: int = 0
         """Non self attribute 2."""
 
+        self.dedent = 0
+        """This docstring starts immediately (no blank line).
+        Use `inspect.cleandoc` instead of `textwrap.dedent`."""
+
 
 if True:
     IN_IF: bytes = b""
@@ -258,3 +266,8 @@ class MarshmallowSchema(Schema):
 
 
 OK, WARNING, CRITICAL, UNKNOWN = 0, 0, 0, 0
+
+if True:
+    DEDENT = 0
+    """This docstring starts immediately (no blank line).
+    Use `inspect.cleandoc` instead of `textwrap.dedent`."""

Diff for: tests/test_parsers/test_attributes.py

@@ -75,6 +75,9 @@ def test_pick_up_attribute_in_try_except(self):
         assert "IN_FINALLY" in self.attributes
         assert self.attributes["IN_FINALLY"]["docstring"] == "In finally."
 
+    def test_docstring_is_correctly_dedented(self):
+        assert "\n    " not in self.attributes["DEDENT"]["docstring"]
+
 
 class TestClassAttributes:
     """Test the parser for module attributes."""
@@ -88,6 +91,9 @@ def test_pick_up_attribute_in_class(self):
         assert "IN_CLASS" in self.attributes
         assert self.attributes["IN_CLASS"]["docstring"] == "In class."
 
+    def test_docstring_is_correctly_dedented(self):
+        assert "\n    " not in self.attributes["DEDENT"]["docstring"]
+
 
 class TestInstanceAttributes:
     """Test the parser for module attributes."""
@@ -114,6 +120,9 @@ def test_do_not_pick_up_subscript_attribute(self):
         assert "d.subscript" not in self.attributes
         assert "subscript" not in self.attributes
 
+    def test_docstring_is_correctly_dedented(self):
+        assert "\n    " not in self.attributes["dedent"]["docstring"]
+
 
 class TestPydanticFields:
     """Test the parser for module attributes."""