Do not use doc attribute internally (#1433)

Co-authored-by: Marc Mueller <[email protected]>

Author: DanielNoord

astroid/interpreter/objectmodel.py

@@ -163,7 +163,10 @@ def attr___name__(self):
 
     @property
     def attr___doc__(self):
-        return node_classes.Const(value=self._instance.doc, parent=self._instance)
+        return node_classes.Const(
+            value=getattr(self._instance.doc_node, "value", None),
+            parent=self._instance,
+        )
 
     @property
     def attr___file__(self):
@@ -209,7 +212,10 @@ def attr___name__(self):
 
     @property
     def attr___doc__(self):
-        return node_classes.Const(value=self._instance.doc, parent=self._instance)
+        return node_classes.Const(
+            value=getattr(self._instance.doc_node, "value", None),
+            parent=self._instance,
+        )
 
     @property
     def attr___qualname__(self):
@@ -332,13 +338,18 @@ def infer_call_result(self, caller, context=None):
                 # class where it will be bound.
                 new_func = func.__class__(
                     name=func.name,
-                    doc=func.doc,
                     lineno=func.lineno,
                     col_offset=func.col_offset,
                     parent=func.parent,
                 )
                 # pylint: disable=no-member
-                new_func.postinit(func.args, func.body, func.decorators, func.returns)
+                new_func.postinit(
+                    func.args,
+                    func.body,
+                    func.decorators,
+                    func.returns,
+                    doc_node=func.doc_node,
+                )
 
                 # Build a proper bound method that points to our newly built function.
                 proxy = bases.UnboundMethod(new_func)
@@ -424,7 +435,7 @@ def attr___qualname__(self):
 
     @property
     def attr___doc__(self):
-        return node_classes.Const(self._instance.doc)
+        return node_classes.Const(getattr(self._instance.doc_node, "value", None))
 
     @property
     def attr___mro__(self):
@@ -584,7 +595,8 @@ def attr___name__(self):
     @property
     def attr___doc__(self):
         return node_classes.Const(
-            value=self._instance.parent.doc, parent=self._instance
+            value=getattr(self._instance.parent.doc_node, "value", None),
+            parent=self._instance,
         )
 
 
@@ -620,7 +632,7 @@ def attr___module__(self):
 
     @property
     def attr___doc__(self):
-        return node_classes.Const(self._instance.doc)
+        return node_classes.Const(getattr(self._instance.doc_node, "value", None))
 
     @property
     def attr___dict__(self):

astroid/nodes/node_ng.py

@@ -763,6 +763,9 @@ def _repr_node(node, result, done, cur_indent="", depth=1):
                 result.append("\n")
                 result.append(cur_indent)
                 for field in fields[:-1]:
+                    # TODO: Remove this after removal of the 'doc' attribute
+                    if field == "doc":
+                        continue
                     result.append(f"{field}=")
                     _repr_tree(getattr(node, field), result, done, cur_indent, depth)
                     result.append(",\n")

astroid/raw_building.py

@@ -118,7 +118,14 @@ def build_module(name: str, doc: Optional[str] = None) -> nodes.Module:
 
 def build_class(name, basenames=(), doc=None):
     """create and initialize an astroid ClassDef node"""
-    node = nodes.ClassDef(name, doc)
+    node = nodes.ClassDef(name)
+    node.postinit(
+        bases=[],
+        body=[],
+        decorators=None,
+        doc_node=nodes.Const(value=doc) if doc else None,
+    )
+    # TODO: Use the actual postinit method instead of appending manually
     for base in basenames:
         basenode = nodes.Name(name=base)
         node.bases.append(basenode)

tests/unittest_scoped_nodes.py

@@ -968,10 +968,8 @@ def test_cls_special_attributes_1(self) -> None:
             )
             with pytest.warns(DeprecationWarning) as records:
                 self.assertEqual(cls.getattr("__doc__")[0].value, cls.doc)
-                # TODO: This should be 1 once we update the use of 'doc' internally
-                assert len(records) == 2
-            # TODO: The doc_node attribute needs to be set in the raw_building process
-            # self.assertEqual(cls.getattr("__doc__")[0].value, cls.doc_node.value)
+                assert len(records) == 1
+            self.assertEqual(cls.getattr("__doc__")[0].value, cls.doc_node.value)
             self.assertEqual(len(cls.getattr("__module__")), 4)
             self.assertEqual(len(cls.getattr("__dict__")), 1)
             self.assertEqual(len(cls.getattr("__mro__")), 1)