No longer pass doc to various node constructors (#1451)

Author: DanielNoord

astroid/builder.py

@@ -280,7 +280,7 @@ def delayed_assattr(self, node):
 
 
 def build_namespace_package_module(name: str, path: List[str]) -> nodes.Module:
-    return nodes.Module(name, doc="", path=path, package=True)
+    return nodes.Module(name, path=path, package=True)
 
 
 def parse(code, module_name="", path=None, apply_transforms=True):

astroid/raw_building.py

@@ -110,9 +110,11 @@ def attach_import_node(node, modname, membername):
 
 def build_module(name: str, doc: Optional[str] = None) -> nodes.Module:
     """create and initialize an astroid Module node"""
-    node = nodes.Module(name, doc, pure_python=False)
-    node.package = False
-    node.parent = None
+    node = nodes.Module(name, pure_python=False, package=False)
+    node.postinit(
+        body=[],
+        doc_node=nodes.Const(value=doc) if doc else None,
+    )
     return node
 
 
@@ -135,13 +137,13 @@ def build_function(
     args: Optional[List[str]] = None,
     posonlyargs: Optional[List[str]] = None,
     defaults=None,
-    doc=None,
+    doc: Optional[str] = None,
     kwonlyargs: Optional[List[str]] = None,
 ) -> nodes.FunctionDef:
     """create and initialize an astroid FunctionDef node"""
     # first argument is now a list of decorators
-    func = nodes.FunctionDef(name, doc)
-    func.args = argsnode = nodes.Arguments(parent=func)
+    func = nodes.FunctionDef(name)
+    argsnode = nodes.Arguments(parent=func)
     argsnode.postinit(
         args=[nodes.AssignName(name=arg, parent=argsnode) for arg in args or ()],
         defaults=[],
@@ -154,6 +156,11 @@ def build_function(
             nodes.AssignName(name=arg, parent=argsnode) for arg in posonlyargs or ()
         ],
     )
+    func.postinit(
+        args=argsnode,
+        body=[],
+        doc_node=nodes.Const(value=doc) if doc else None,
+    )
     for default in defaults or ():
         argsnode.defaults.append(nodes.const_factory(default))
         argsnode.defaults[-1].parent = argsnode

astroid/rebuilder.py

@@ -116,10 +116,8 @@ def __init__(
             self._parser_module = parser_module
         self._module = self._parser_module.module
 
-    def _get_doc(
-        self, node: T_Doc
-    ) -> Tuple[T_Doc, Optional["ast.Constant | ast.Str"], Optional[str]]:
-        """Return the doc ast node and the actual docstring."""
+    def _get_doc(self, node: T_Doc) -> Tuple[T_Doc, Optional["ast.Constant | ast.Str"]]:
+        """Return the doc ast node."""
         try:
             if node.body and isinstance(node.body[0], self._module.Expr):
                 first_value = node.body[0].value
@@ -129,16 +127,15 @@ def _get_doc(
                     and isinstance(first_value.value, str)
                 ):
                     doc_ast_node = first_value
-                    doc = first_value.value if PY38_PLUS else first_value.s
                     node.body = node.body[1:]
                     # The ast parser of python < 3.8 sets col_offset of multi-line strings to -1
                     # as it is unable to determine the value correctly. We reset this to None.
                     if doc_ast_node.col_offset == -1:
                         doc_ast_node.col_offset = None
-                    return node, doc_ast_node, doc
+                    return node, doc_ast_node
         except IndexError:
             pass  # ast built from scratch
-        return node, None, None
+        return node, None
 
     def _get_context(
         self,
@@ -298,10 +295,9 @@ def visit_module(
 
         Note: Method not called by 'visit'
         """
-        node, doc_ast_node, doc = self._get_doc(node)
+        node, doc_ast_node = self._get_doc(node)
         newnode = nodes.Module(
             name=modname,
-            doc=doc,
             file=modpath,
             path=[modpath],
             package=package,
@@ -1296,10 +1292,9 @@ def visit_classdef(
         self, node: "ast.ClassDef", parent: NodeNG, newstyle: bool = True
     ) -> nodes.ClassDef:
         """visit a ClassDef node to become astroid"""
-        node, doc_ast_node, doc = self._get_doc(node)
+        node, doc_ast_node = self._get_doc(node)
         newnode = nodes.ClassDef(
             name=node.name,
-            doc=doc,
             lineno=node.lineno,
             col_offset=node.col_offset,
             # end_lineno and end_col_offset added in 3.8
@@ -1604,7 +1599,7 @@ def _visit_functiondef(
     ) -> T_Function:
         """visit an FunctionDef node to become astroid"""
         self._global_names.append({})
-        node, doc_ast_node, doc = self._get_doc(node)
+        node, doc_ast_node = self._get_doc(node)
 
         lineno = node.lineno
         if PY38_PLUS and node.decorator_list:
@@ -1619,7 +1614,6 @@ def _visit_functiondef(
 
         newnode = cls(
             name=node.name,
-            doc=doc,
             lineno=lineno,
             col_offset=node.col_offset,
             # end_lineno and end_col_offset added in 3.8

doc/extending.rst

@@ -95,7 +95,6 @@ Instantiating a new node might look as in::
 
     new_node = FunctionDef(
         name='my_new_function',
-        doc='the docstring of this function',
         lineno=3,
         col_offset=0,
         parent=the_parent_of_this_function,
@@ -104,6 +103,7 @@ Instantiating a new node might look as in::
         args=args,
         body=body,
         returns=returns,
+        doc_node=nodes.Const(value='the docstring of this function'),
     )