bpo-3530: Add advice on when to correctly use fix_missing_locations in the AST docs (GH-17172)

miss-islington · isidentical · web-flow · commit ef0af30e507a · 2020-01-12T12:44:33.000-08:00
Co-authored-by: Pablo Galindo <Pablogsal@gmail.com> (cherry picked from commit 6680f4a) Co-authored-by: Batuhan Taşkaya <47358913+isidentical@users.noreply.github.com>
diff --git a/Doc/library/ast.rst b/Doc/library/ast.rst
@@ -300,7 +300,7 @@ and classes for traversing abstract syntax trees:
       class RewriteName(NodeTransformer):
 
           def visit_Name(self, node):
-              return copy_location(Subscript(
+              return Subscript(
                   value=Name(id='data', ctx=Load()),
                   slice=Index(value=Constant(value=node.id)),
                   ctx=node.ctx
@@ -314,6 +314,14 @@ and classes for traversing abstract syntax trees:
    statement nodes), the visitor may also return a list of nodes rather than
    just a single node.
 
+   If :class:`NodeTransformer` introduces new nodes (that weren't part of
+   original tree) without giving them location information (such as
+   :attr:`lineno`), :func:`fix_missing_locations` should be called with
+   the new sub-tree to recalculate the location information::
+
+      tree = ast.parse('foo', mode='eval')
+      new_tree = fix_missing_locations(RewriteName().visit(tree))
+
    Usually you use the transformer like this::
 
       node = YourTransformer().visit(node)
diff --git a/Misc/NEWS.d/next/Documentation/2019-11-17-11-53-10.bpo-3530.8zFUMc.rst b/Misc/NEWS.d/next/Documentation/2019-11-17-11-53-10.bpo-3530.8zFUMc.rst
@@ -0,0 +1,2 @@
+In the :mod:`ast` module documentation, fix a misleading ``NodeTransformer`` example and add
+advice on when to use the ``fix_missing_locations`` function.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	+In the :mod:`ast` module documentation, fix a misleading ``NodeTransformer`` example and add
	`2`	+advice on when to use the ``fix_missing_locations`` function.