bpo-43244: Remove the PyAST_Validate() function (GH-24911)

vstinner · web-flow · commit eec8e61992fb · 2021-03-18T14:57:49.000+01:00
Remove the PyAST_Validate() function. It is no longer possible to build a AST object (mod_ty type) with the public C API. The function was already excluded from the limited C API (PEP 384). Rename PyAST_Validate() function to _PyAST_Validate(), move it to the internal C API, and don't export it anymore (replace PyAPI_FUNC with extern). The function was added in bpo-12575 by the commit 832bfe2.
diff --git a/Doc/whatsnew/3.10.rst b/Doc/whatsnew/3.10.rst
@@ -1353,3 +1353,8 @@ Removed
   Python already implicitly installs signal handlers: see
   :c:member:`PyConfig.install_signal_handlers`.
   (Contributed by Victor Stinner in :issue:`41713`.)
+
+* Remove the ``PyAST_Validate()`` function. It is no longer possible to build a
+  AST object (``mod_ty`` type) with the public C API. The function was already
+  excluded from the limited C API (:pep:`384`).
+  (Contributed by Victor Stinner in :issue:`43244`.)
diff --git a/Include/ast.h b/Include/ast.h
@@ -7,8 +7,6 @@ extern "C" {
 
 #include "Python-ast.h"   /* mod_ty */
 
-PyAPI_FUNC(int) PyAST_Validate(mod_ty);
-
 #ifdef __cplusplus
 }
 #endif
diff --git a/Include/internal/pycore_ast.h b/Include/internal/pycore_ast.h
@@ -10,6 +10,8 @@ extern "C" {
 
 #include "Python-ast.h"           // expr_ty
 
+extern int _PyAST_Validate(mod_ty);
+
 /* _PyAST_ExprAsUnicode is defined in ast_unparse.c */
 extern PyObject* _PyAST_ExprAsUnicode(expr_ty);
 
diff --git a/Misc/NEWS.d/next/C API/2021-03-17-23-20-07.bpo-43244.diyn2C.rst b/Misc/NEWS.d/next/C API/2021-03-17-23-20-07.bpo-43244.diyn2C.rst
@@ -0,0 +1,3 @@
+Remove the ``PyAST_Validate()`` function. It is no longer possible to build a
+AST object (``mod_ty`` type) with the public C API. The function was already
+excluded from the limited C API (:pep:`384`). Patch by Victor Stinner.
diff --git a/Parser/pegen.c b/Parser/pegen.c
@@ -1,4 +1,5 @@
 #include <Python.h>
+#include "pycore_ast.h"           // _PyAST_Validate()
 #include <errcode.h>
 #include "tokenizer.h"
 
@@ -1271,7 +1272,7 @@ _PyPegen_run_parser(Parser *p)
         p->start_rule == Py_file_input ||
         p->start_rule == Py_eval_input)
     {
-        if (!PyAST_Validate(res)) {
+        if (!_PyAST_Validate(res)) {
             return NULL;
         }
     }
diff --git a/Python/ast.c b/Python/ast.c
@@ -551,7 +551,7 @@ validate_exprs(asdl_expr_seq *exprs, expr_context_ty ctx, int null_ok)
 }
 
 int
-PyAST_Validate(mod_ty mod)
+_PyAST_Validate(mod_ty mod)
 {
     int res = 0;
 
diff --git a/Python/bltinmodule.c b/Python/bltinmodule.c
@@ -4,6 +4,7 @@
 #include <ctype.h>
 #include "ast.h"
 #undef Yield   /* undefine macro conflicting with <winbase.h> */
+#include "pycore_ast.h"           // _PyAST_Validate()
 #include "pycore_object.h"        // _Py_AddToAllObjects()
 #include "pycore_pyerrors.h"      // _PyErr_NoMemory()
 #include "pycore_pystate.h"       // _PyThreadState_GET()
@@ -835,7 +836,7 @@ builtin_compile_impl(PyObject *module, PyObject *source, PyObject *filename,
                 PyArena_Free(arena);
                 goto error;
             }
-            if (!PyAST_Validate(mod)) {
+            if (!_PyAST_Validate(mod)) {
                 PyArena_Free(arena);
                 goto error;
             }

Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,6 @@ extern "C" {`
`7`	`7`
`8`	`8`	`#include "Python-ast.h" /* mod_ty */`
`9`	`9`
`10`		`-PyAPI_FUNC(int) PyAST_Validate(mod_ty);`
`11`		`-`
`12`	`10`	`#ifdef __cplusplus`
`13`	`11`	`}`
`14`	`12`	`#endif`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+Remove the ``PyAST_Validate()`` function. It is no longer possible to build a
	`2`	+AST object (``mod_ty`` type) with the public C API. The function was already
	`3`	+excluded from the limited C API (:pep:`384`). Patch by Victor Stinner.
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`#include <Python.h>`
	`2`	`+#include "pycore_ast.h" // _PyAST_Validate()`
`2`	`3`	`#include <errcode.h>`
`3`	`4`	`#include "tokenizer.h"`
`4`	`5`
`@@ -1271,7 +1272,7 @@ _PyPegen_run_parser(Parser *p)`
`1271`	`1272`	`p->start_rule == Py_file_input \|\|`
`1272`	`1273`	`p->start_rule == Py_eval_input)`
`1273`	`1274`	`{`
`1274`		`- if (!PyAST_Validate(res)) {`
	`1275`	`+ if (!_PyAST_Validate(res)) {`
`1275`	`1276`	`return NULL;`
`1276`	`1277`	`}`
`1277`	`1278`	`}`
Original file line number	Diff line number	Diff line change
`@@ -551,7 +551,7 @@ validate_exprs(asdl_expr_seq *exprs, expr_context_ty ctx, int null_ok)`
`551`	`551`	`}`
`552`	`552`
`553`	`553`	`int`
`554`		`-PyAST_Validate(mod_ty mod)`
	`554`	`+_PyAST_Validate(mod_ty mod)`
`555`	`555`	`{`
`556`	`556`	`int res = 0;`
`557`	`557`