blob: 2b965434ef461674946645e665a9266ae8aa1d67 [file] [log] [blame]
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001/*
Batuhan Taskaya02a16032020-10-10 20:14:59 +03002 * This file exposes PyAST_Validate interface to check the integrity
3 * of the given abstract syntax tree (potentially constructed manually).
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00004 */
5#include "Python.h"
Victor Stinner94faa072021-03-23 20:47:40 +01006#include "pycore_ast.h" // asdl_stmt_seq
Serhiy Storchakaface87c2021-04-25 13:38:00 +03007#include "pycore_pystate.h" // _PyThreadState_GET()
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00008
9#include <assert.h>
Serhiy Storchaka58159ef2019-01-12 09:46:50 +020010
Serhiy Storchakaface87c2021-04-25 13:38:00 +030011struct validator {
12 int recursion_depth; /* current recursion depth */
13 int recursion_limit; /* recursion limit */
14};
15
16static int validate_stmts(struct validator *, asdl_stmt_seq *);
17static int validate_exprs(struct validator *, asdl_expr_seq*, expr_context_ty, int);
Pablo Galindoa5634c42020-09-16 19:42:00 +010018static int _validate_nonempty_seq(asdl_seq *, const char *, const char *);
Serhiy Storchakaface87c2021-04-25 13:38:00 +030019static int validate_stmt(struct validator *, stmt_ty);
20static int validate_expr(struct validator *, expr_ty, expr_context_ty);
Benjamin Peterson832bfe22011-08-09 16:15:04 -050021
22static int
Batuhan Taskaya68874a82020-06-06 15:44:16 +030023validate_name(PyObject *name)
24{
25 assert(PyUnicode_Check(name));
26 static const char * const forbidden[] = {
27 "None",
28 "True",
29 "False",
30 NULL
31 };
32 for (int i = 0; forbidden[i] != NULL; i++) {
33 if (_PyUnicode_EqualToASCIIString(name, forbidden[i])) {
34 PyErr_Format(PyExc_ValueError, "Name node can't be used with '%s' constant", forbidden[i]);
35 return 0;
36 }
37 }
38 return 1;
39}
40
41static int
Serhiy Storchakaface87c2021-04-25 13:38:00 +030042validate_comprehension(struct validator *state, asdl_comprehension_seq *gens)
Benjamin Peterson832bfe22011-08-09 16:15:04 -050043{
Victor Stinner4d73ae72018-11-22 14:45:16 +010044 Py_ssize_t i;
Benjamin Peterson832bfe22011-08-09 16:15:04 -050045 if (!asdl_seq_LEN(gens)) {
46 PyErr_SetString(PyExc_ValueError, "comprehension with no generators");
47 return 0;
48 }
49 for (i = 0; i < asdl_seq_LEN(gens); i++) {
50 comprehension_ty comp = asdl_seq_GET(gens, i);
Serhiy Storchakaface87c2021-04-25 13:38:00 +030051 if (!validate_expr(state, comp->target, Store) ||
52 !validate_expr(state, comp->iter, Load) ||
53 !validate_exprs(state, comp->ifs, Load, 0))
Benjamin Peterson832bfe22011-08-09 16:15:04 -050054 return 0;
55 }
56 return 1;
57}
58
59static int
Serhiy Storchakaface87c2021-04-25 13:38:00 +030060validate_keywords(struct validator *state, asdl_keyword_seq *keywords)
Benjamin Peterson832bfe22011-08-09 16:15:04 -050061{
Victor Stinner4d73ae72018-11-22 14:45:16 +010062 Py_ssize_t i;
Benjamin Peterson832bfe22011-08-09 16:15:04 -050063 for (i = 0; i < asdl_seq_LEN(keywords); i++)
Serhiy Storchakaface87c2021-04-25 13:38:00 +030064 if (!validate_expr(state, (asdl_seq_GET(keywords, i))->value, Load))
Benjamin Peterson832bfe22011-08-09 16:15:04 -050065 return 0;
66 return 1;
67}
68
69static int
Serhiy Storchakaface87c2021-04-25 13:38:00 +030070validate_args(struct validator *state, asdl_arg_seq *args)
Benjamin Peterson832bfe22011-08-09 16:15:04 -050071{
Victor Stinner4d73ae72018-11-22 14:45:16 +010072 Py_ssize_t i;
Benjamin Peterson832bfe22011-08-09 16:15:04 -050073 for (i = 0; i < asdl_seq_LEN(args); i++) {
74 arg_ty arg = asdl_seq_GET(args, i);
Serhiy Storchakaface87c2021-04-25 13:38:00 +030075 if (arg->annotation && !validate_expr(state, arg->annotation, Load))
Benjamin Peterson832bfe22011-08-09 16:15:04 -050076 return 0;
77 }
78 return 1;
79}
80
81static const char *
82expr_context_name(expr_context_ty ctx)
83{
84 switch (ctx) {
85 case Load:
86 return "Load";
87 case Store:
88 return "Store";
89 case Del:
90 return "Del";
Benjamin Peterson832bfe22011-08-09 16:15:04 -050091 default:
Barry Warsawb2e57942017-09-14 18:13:16 -070092 Py_UNREACHABLE();
Benjamin Peterson832bfe22011-08-09 16:15:04 -050093 }
94}
95
96static int
Serhiy Storchakaface87c2021-04-25 13:38:00 +030097validate_arguments(struct validator *state, arguments_ty args)
Benjamin Peterson832bfe22011-08-09 16:15:04 -050098{
Serhiy Storchakaface87c2021-04-25 13:38:00 +030099 if (!validate_args(state, args->posonlyargs) || !validate_args(state, args->args)) {
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500100 return 0;
Pablo Galindo8c77b8c2019-04-29 13:36:57 +0100101 }
Benjamin Petersoncda75be2013-03-18 10:48:58 -0700102 if (args->vararg && args->vararg->annotation
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300103 && !validate_expr(state, args->vararg->annotation, Load)) {
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500104 return 0;
105 }
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300106 if (!validate_args(state, args->kwonlyargs))
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500107 return 0;
Victor Stinner0c39b1b2015-03-18 15:02:06 +0100108 if (args->kwarg && args->kwarg->annotation
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300109 && !validate_expr(state, args->kwarg->annotation, Load)) {
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500110 return 0;
111 }
Pablo Galindo2f58a842019-05-31 14:09:49 +0100112 if (asdl_seq_LEN(args->defaults) > asdl_seq_LEN(args->posonlyargs) + asdl_seq_LEN(args->args)) {
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500113 PyErr_SetString(PyExc_ValueError, "more positional defaults than args on arguments");
114 return 0;
115 }
116 if (asdl_seq_LEN(args->kw_defaults) != asdl_seq_LEN(args->kwonlyargs)) {
117 PyErr_SetString(PyExc_ValueError, "length of kwonlyargs is not the same as "
118 "kw_defaults on arguments");
119 return 0;
120 }
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300121 return validate_exprs(state, args->defaults, Load, 0) && validate_exprs(state, args->kw_defaults, Load, 1);
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500122}
123
124static int
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300125validate_constant(struct validator *state, PyObject *value)
Victor Stinnerf2c1aa12016-01-26 00:40:57 +0100126{
127 if (value == Py_None || value == Py_Ellipsis)
128 return 1;
129
130 if (PyLong_CheckExact(value)
131 || PyFloat_CheckExact(value)
132 || PyComplex_CheckExact(value)
133 || PyBool_Check(value)
134 || PyUnicode_CheckExact(value)
135 || PyBytes_CheckExact(value))
136 return 1;
137
138 if (PyTuple_CheckExact(value) || PyFrozenSet_CheckExact(value)) {
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300139 if (++state->recursion_depth > state->recursion_limit) {
140 PyErr_SetString(PyExc_RecursionError,
141 "maximum recursion depth exceeded during compilation");
142 return 0;
143 }
Victor Stinnerf2c1aa12016-01-26 00:40:57 +0100144
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300145 PyObject *it = PyObject_GetIter(value);
Victor Stinnerf2c1aa12016-01-26 00:40:57 +0100146 if (it == NULL)
147 return 0;
148
149 while (1) {
150 PyObject *item = PyIter_Next(it);
151 if (item == NULL) {
152 if (PyErr_Occurred()) {
153 Py_DECREF(it);
154 return 0;
155 }
156 break;
157 }
158
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300159 if (!validate_constant(state, item)) {
Victor Stinnerf2c1aa12016-01-26 00:40:57 +0100160 Py_DECREF(it);
Victor Stinner726f6902016-01-27 00:11:47 +0100161 Py_DECREF(item);
Victor Stinnerf2c1aa12016-01-26 00:40:57 +0100162 return 0;
163 }
Victor Stinner726f6902016-01-27 00:11:47 +0100164 Py_DECREF(item);
Victor Stinnerf2c1aa12016-01-26 00:40:57 +0100165 }
166
167 Py_DECREF(it);
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300168 --state->recursion_depth;
Victor Stinnerf2c1aa12016-01-26 00:40:57 +0100169 return 1;
170 }
171
Batuhan TaÅŸkaya0ac59f92020-03-19 14:32:28 +0300172 if (!PyErr_Occurred()) {
173 PyErr_Format(PyExc_TypeError,
174 "got an invalid type in Constant: %s",
175 _PyType_Name(Py_TYPE(value)));
176 }
Victor Stinnerf2c1aa12016-01-26 00:40:57 +0100177 return 0;
178}
179
180static int
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300181validate_expr(struct validator *state, expr_ty exp, expr_context_ty ctx)
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500182{
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300183 int ret;
184 if (++state->recursion_depth > state->recursion_limit) {
185 PyErr_SetString(PyExc_RecursionError,
186 "maximum recursion depth exceeded during compilation");
187 return 0;
188 }
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500189 int check_ctx = 1;
190 expr_context_ty actual_ctx;
191
192 /* First check expression context. */
193 switch (exp->kind) {
194 case Attribute_kind:
195 actual_ctx = exp->v.Attribute.ctx;
196 break;
197 case Subscript_kind:
198 actual_ctx = exp->v.Subscript.ctx;
199 break;
200 case Starred_kind:
201 actual_ctx = exp->v.Starred.ctx;
202 break;
203 case Name_kind:
Batuhan Taskaya68874a82020-06-06 15:44:16 +0300204 if (!validate_name(exp->v.Name.id)) {
205 return 0;
206 }
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500207 actual_ctx = exp->v.Name.ctx;
208 break;
209 case List_kind:
210 actual_ctx = exp->v.List.ctx;
211 break;
212 case Tuple_kind:
213 actual_ctx = exp->v.Tuple.ctx;
214 break;
215 default:
216 if (ctx != Load) {
217 PyErr_Format(PyExc_ValueError, "expression which can't be "
218 "assigned to in %s context", expr_context_name(ctx));
219 return 0;
220 }
221 check_ctx = 0;
Victor Stinner0c39b1b2015-03-18 15:02:06 +0100222 /* set actual_ctx to prevent gcc warning */
223 actual_ctx = 0;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500224 }
225 if (check_ctx && actual_ctx != ctx) {
226 PyErr_Format(PyExc_ValueError, "expression must have %s context but has %s instead",
227 expr_context_name(ctx), expr_context_name(actual_ctx));
228 return 0;
229 }
230
231 /* Now validate expression. */
232 switch (exp->kind) {
233 case BoolOp_kind:
234 if (asdl_seq_LEN(exp->v.BoolOp.values) < 2) {
235 PyErr_SetString(PyExc_ValueError, "BoolOp with less than 2 values");
236 return 0;
237 }
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300238 ret = validate_exprs(state, exp->v.BoolOp.values, Load, 0);
239 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500240 case BinOp_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300241 ret = validate_expr(state, exp->v.BinOp.left, Load) &&
242 validate_expr(state, exp->v.BinOp.right, Load);
243 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500244 case UnaryOp_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300245 ret = validate_expr(state, exp->v.UnaryOp.operand, Load);
246 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500247 case Lambda_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300248 ret = validate_arguments(state, exp->v.Lambda.args) &&
249 validate_expr(state, exp->v.Lambda.body, Load);
250 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500251 case IfExp_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300252 ret = validate_expr(state, exp->v.IfExp.test, Load) &&
253 validate_expr(state, exp->v.IfExp.body, Load) &&
254 validate_expr(state, exp->v.IfExp.orelse, Load);
255 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500256 case Dict_kind:
257 if (asdl_seq_LEN(exp->v.Dict.keys) != asdl_seq_LEN(exp->v.Dict.values)) {
258 PyErr_SetString(PyExc_ValueError,
259 "Dict doesn't have the same number of keys as values");
260 return 0;
261 }
Yury Selivanovb3d53132015-09-01 16:10:49 -0400262 /* null_ok=1 for keys expressions to allow dict unpacking to work in
263 dict literals, i.e. ``{**{a:b}}`` */
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300264 ret = validate_exprs(state, exp->v.Dict.keys, Load, /*null_ok=*/ 1) &&
265 validate_exprs(state, exp->v.Dict.values, Load, /*null_ok=*/ 0);
266 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500267 case Set_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300268 ret = validate_exprs(state, exp->v.Set.elts, Load, 0);
269 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500270#define COMP(NAME) \
271 case NAME ## _kind: \
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300272 ret = validate_comprehension(state, exp->v.NAME.generators) && \
273 validate_expr(state, exp->v.NAME.elt, Load); \
274 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500275 COMP(ListComp)
276 COMP(SetComp)
277 COMP(GeneratorExp)
278#undef COMP
279 case DictComp_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300280 ret = validate_comprehension(state, exp->v.DictComp.generators) &&
281 validate_expr(state, exp->v.DictComp.key, Load) &&
282 validate_expr(state, exp->v.DictComp.value, Load);
283 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500284 case Yield_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300285 ret = !exp->v.Yield.value || validate_expr(state, exp->v.Yield.value, Load);
286 break;
Benjamin Peterson527c6222012-01-14 08:58:23 -0500287 case YieldFrom_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300288 ret = validate_expr(state, exp->v.YieldFrom.value, Load);
289 break;
Yury Selivanov75445082015-05-11 22:57:16 -0400290 case Await_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300291 ret = validate_expr(state, exp->v.Await.value, Load);
292 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500293 case Compare_kind:
294 if (!asdl_seq_LEN(exp->v.Compare.comparators)) {
295 PyErr_SetString(PyExc_ValueError, "Compare with no comparators");
296 return 0;
297 }
298 if (asdl_seq_LEN(exp->v.Compare.comparators) !=
299 asdl_seq_LEN(exp->v.Compare.ops)) {
300 PyErr_SetString(PyExc_ValueError, "Compare has a different number "
301 "of comparators and operands");
302 return 0;
303 }
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300304 ret = validate_exprs(state, exp->v.Compare.comparators, Load, 0) &&
305 validate_expr(state, exp->v.Compare.left, Load);
306 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500307 case Call_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300308 ret = validate_expr(state, exp->v.Call.func, Load) &&
309 validate_exprs(state, exp->v.Call.args, Load, 0) &&
310 validate_keywords(state, exp->v.Call.keywords);
311 break;
Victor Stinnerf2c1aa12016-01-26 00:40:57 +0100312 case Constant_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300313 if (!validate_constant(state, exp->v.Constant.value)) {
Victor Stinnerf2c1aa12016-01-26 00:40:57 +0100314 return 0;
315 }
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300316 ret = 1;
317 break;
Eric V. Smith235a6f02015-09-19 14:51:32 -0400318 case JoinedStr_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300319 ret = validate_exprs(state, exp->v.JoinedStr.values, Load, 0);
320 break;
Eric V. Smith235a6f02015-09-19 14:51:32 -0400321 case FormattedValue_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300322 if (validate_expr(state, exp->v.FormattedValue.value, Load) == 0)
Eric V. Smith235a6f02015-09-19 14:51:32 -0400323 return 0;
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300324 if (exp->v.FormattedValue.format_spec) {
325 ret = validate_expr(state, exp->v.FormattedValue.format_spec, Load);
326 break;
327 }
328 ret = 1;
329 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500330 case Attribute_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300331 ret = validate_expr(state, exp->v.Attribute.value, Load);
332 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500333 case Subscript_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300334 ret = validate_expr(state, exp->v.Subscript.slice, Load) &&
335 validate_expr(state, exp->v.Subscript.value, Load);
336 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500337 case Starred_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300338 ret = validate_expr(state, exp->v.Starred.value, ctx);
339 break;
Serhiy Storchaka13d52c22020-03-10 18:52:34 +0200340 case Slice_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300341 ret = (!exp->v.Slice.lower || validate_expr(state, exp->v.Slice.lower, Load)) &&
342 (!exp->v.Slice.upper || validate_expr(state, exp->v.Slice.upper, Load)) &&
343 (!exp->v.Slice.step || validate_expr(state, exp->v.Slice.step, Load));
344 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500345 case List_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300346 ret = validate_exprs(state, exp->v.List.elts, ctx, 0);
347 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500348 case Tuple_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300349 ret = validate_exprs(state, exp->v.Tuple.elts, ctx, 0);
350 break;
Pablo Galindo0c9258a2019-03-18 13:51:53 +0000351 case NamedExpr_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300352 ret = validate_expr(state, exp->v.NamedExpr.value, Load);
353 break;
Brandt Bucher145bf262021-02-26 14:51:55 -0800354 case MatchAs_kind:
355 PyErr_SetString(PyExc_ValueError,
356 "MatchAs is only valid in match_case patterns");
357 return 0;
358 case MatchOr_kind:
359 PyErr_SetString(PyExc_ValueError,
360 "MatchOr is only valid in match_case patterns");
361 return 0;
Serhiy Storchaka3f228112018-09-27 17:42:37 +0300362 /* This last case doesn't have any checking. */
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500363 case Name_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300364 ret = 1;
365 break;
366 default:
367 PyErr_SetString(PyExc_SystemError, "unexpected expression");
368 return 0;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500369 }
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300370 state->recursion_depth--;
371 return ret;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500372}
373
374static int
Brandt Bucher145bf262021-02-26 14:51:55 -0800375validate_pattern(expr_ty p)
376{
377 // Coming soon (thanks Batuhan)!
378 return 1;
379}
380
381static int
Pablo Galindoa5634c42020-09-16 19:42:00 +0100382_validate_nonempty_seq(asdl_seq *seq, const char *what, const char *owner)
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500383{
384 if (asdl_seq_LEN(seq))
385 return 1;
386 PyErr_Format(PyExc_ValueError, "empty %s on %s", what, owner);
387 return 0;
388}
Pablo Galindoa5634c42020-09-16 19:42:00 +0100389#define validate_nonempty_seq(seq, what, owner) _validate_nonempty_seq((asdl_seq*)seq, what, owner)
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500390
391static int
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300392validate_assignlist(struct validator *state, asdl_expr_seq *targets, expr_context_ty ctx)
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500393{
394 return validate_nonempty_seq(targets, "targets", ctx == Del ? "Delete" : "Assign") &&
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300395 validate_exprs(state, targets, ctx, 0);
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500396}
397
398static int
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300399validate_body(struct validator *state, asdl_stmt_seq *body, const char *owner)
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500400{
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300401 return validate_nonempty_seq(body, "body", owner) && validate_stmts(state, body);
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500402}
403
404static int
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300405validate_stmt(struct validator *state, stmt_ty stmt)
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500406{
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300407 int ret;
Victor Stinner4d73ae72018-11-22 14:45:16 +0100408 Py_ssize_t i;
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300409 if (++state->recursion_depth > state->recursion_limit) {
410 PyErr_SetString(PyExc_RecursionError,
411 "maximum recursion depth exceeded during compilation");
412 return 0;
413 }
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500414 switch (stmt->kind) {
415 case FunctionDef_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300416 ret = validate_body(state, stmt->v.FunctionDef.body, "FunctionDef") &&
417 validate_arguments(state, stmt->v.FunctionDef.args) &&
418 validate_exprs(state, stmt->v.FunctionDef.decorator_list, Load, 0) &&
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500419 (!stmt->v.FunctionDef.returns ||
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300420 validate_expr(state, stmt->v.FunctionDef.returns, Load));
421 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500422 case ClassDef_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300423 ret = validate_body(state, stmt->v.ClassDef.body, "ClassDef") &&
424 validate_exprs(state, stmt->v.ClassDef.bases, Load, 0) &&
425 validate_keywords(state, stmt->v.ClassDef.keywords) &&
426 validate_exprs(state, stmt->v.ClassDef.decorator_list, Load, 0);
427 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500428 case Return_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300429 ret = !stmt->v.Return.value || validate_expr(state, stmt->v.Return.value, Load);
430 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500431 case Delete_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300432 ret = validate_assignlist(state, stmt->v.Delete.targets, Del);
433 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500434 case Assign_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300435 ret = validate_assignlist(state, stmt->v.Assign.targets, Store) &&
436 validate_expr(state, stmt->v.Assign.value, Load);
437 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500438 case AugAssign_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300439 ret = validate_expr(state, stmt->v.AugAssign.target, Store) &&
440 validate_expr(state, stmt->v.AugAssign.value, Load);
441 break;
Yury Selivanovf8cb8a12016-09-08 20:50:03 -0700442 case AnnAssign_kind:
443 if (stmt->v.AnnAssign.target->kind != Name_kind &&
444 stmt->v.AnnAssign.simple) {
445 PyErr_SetString(PyExc_TypeError,
446 "AnnAssign with simple non-Name target");
447 return 0;
448 }
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300449 ret = validate_expr(state, stmt->v.AnnAssign.target, Store) &&
Yury Selivanovf8cb8a12016-09-08 20:50:03 -0700450 (!stmt->v.AnnAssign.value ||
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300451 validate_expr(state, stmt->v.AnnAssign.value, Load)) &&
452 validate_expr(state, stmt->v.AnnAssign.annotation, Load);
453 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500454 case For_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300455 ret = validate_expr(state, stmt->v.For.target, Store) &&
456 validate_expr(state, stmt->v.For.iter, Load) &&
457 validate_body(state, stmt->v.For.body, "For") &&
458 validate_stmts(state, stmt->v.For.orelse);
459 break;
Yury Selivanov75445082015-05-11 22:57:16 -0400460 case AsyncFor_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300461 ret = validate_expr(state, stmt->v.AsyncFor.target, Store) &&
462 validate_expr(state, stmt->v.AsyncFor.iter, Load) &&
463 validate_body(state, stmt->v.AsyncFor.body, "AsyncFor") &&
464 validate_stmts(state, stmt->v.AsyncFor.orelse);
465 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500466 case While_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300467 ret = validate_expr(state, stmt->v.While.test, Load) &&
468 validate_body(state, stmt->v.While.body, "While") &&
469 validate_stmts(state, stmt->v.While.orelse);
470 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500471 case If_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300472 ret = validate_expr(state, stmt->v.If.test, Load) &&
473 validate_body(state, stmt->v.If.body, "If") &&
474 validate_stmts(state, stmt->v.If.orelse);
475 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500476 case With_kind:
477 if (!validate_nonempty_seq(stmt->v.With.items, "items", "With"))
478 return 0;
479 for (i = 0; i < asdl_seq_LEN(stmt->v.With.items); i++) {
480 withitem_ty item = asdl_seq_GET(stmt->v.With.items, i);
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300481 if (!validate_expr(state, item->context_expr, Load) ||
482 (item->optional_vars && !validate_expr(state, item->optional_vars, Store)))
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500483 return 0;
484 }
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300485 ret = validate_body(state, stmt->v.With.body, "With");
486 break;
Yury Selivanov75445082015-05-11 22:57:16 -0400487 case AsyncWith_kind:
488 if (!validate_nonempty_seq(stmt->v.AsyncWith.items, "items", "AsyncWith"))
489 return 0;
490 for (i = 0; i < asdl_seq_LEN(stmt->v.AsyncWith.items); i++) {
491 withitem_ty item = asdl_seq_GET(stmt->v.AsyncWith.items, i);
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300492 if (!validate_expr(state, item->context_expr, Load) ||
493 (item->optional_vars && !validate_expr(state, item->optional_vars, Store)))
Yury Selivanov75445082015-05-11 22:57:16 -0400494 return 0;
495 }
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300496 ret = validate_body(state, stmt->v.AsyncWith.body, "AsyncWith");
497 break;
Brandt Bucher145bf262021-02-26 14:51:55 -0800498 case Match_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300499 if (!validate_expr(state, stmt->v.Match.subject, Load)
Brandt Bucher145bf262021-02-26 14:51:55 -0800500 || !validate_nonempty_seq(stmt->v.Match.cases, "cases", "Match")) {
501 return 0;
502 }
503 for (i = 0; i < asdl_seq_LEN(stmt->v.Match.cases); i++) {
504 match_case_ty m = asdl_seq_GET(stmt->v.Match.cases, i);
505 if (!validate_pattern(m->pattern)
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300506 || (m->guard && !validate_expr(state, m->guard, Load))
507 || !validate_body(state, m->body, "match_case")) {
Brandt Bucher145bf262021-02-26 14:51:55 -0800508 return 0;
509 }
510 }
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300511 ret = 1;
512 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500513 case Raise_kind:
514 if (stmt->v.Raise.exc) {
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300515 ret = validate_expr(state, stmt->v.Raise.exc, Load) &&
516 (!stmt->v.Raise.cause || validate_expr(state, stmt->v.Raise.cause, Load));
517 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500518 }
519 if (stmt->v.Raise.cause) {
520 PyErr_SetString(PyExc_ValueError, "Raise with cause but no exception");
521 return 0;
522 }
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300523 ret = 1;
524 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500525 case Try_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300526 if (!validate_body(state, stmt->v.Try.body, "Try"))
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500527 return 0;
528 if (!asdl_seq_LEN(stmt->v.Try.handlers) &&
529 !asdl_seq_LEN(stmt->v.Try.finalbody)) {
530 PyErr_SetString(PyExc_ValueError, "Try has neither except handlers nor finalbody");
531 return 0;
532 }
533 if (!asdl_seq_LEN(stmt->v.Try.handlers) &&
534 asdl_seq_LEN(stmt->v.Try.orelse)) {
535 PyErr_SetString(PyExc_ValueError, "Try has orelse but no except handlers");
536 return 0;
537 }
538 for (i = 0; i < asdl_seq_LEN(stmt->v.Try.handlers); i++) {
539 excepthandler_ty handler = asdl_seq_GET(stmt->v.Try.handlers, i);
540 if ((handler->v.ExceptHandler.type &&
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300541 !validate_expr(state, handler->v.ExceptHandler.type, Load)) ||
542 !validate_body(state, handler->v.ExceptHandler.body, "ExceptHandler"))
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500543 return 0;
544 }
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300545 ret = (!asdl_seq_LEN(stmt->v.Try.finalbody) ||
546 validate_stmts(state, stmt->v.Try.finalbody)) &&
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500547 (!asdl_seq_LEN(stmt->v.Try.orelse) ||
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300548 validate_stmts(state, stmt->v.Try.orelse));
549 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500550 case Assert_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300551 ret = validate_expr(state, stmt->v.Assert.test, Load) &&
552 (!stmt->v.Assert.msg || validate_expr(state, stmt->v.Assert.msg, Load));
553 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500554 case Import_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300555 ret = validate_nonempty_seq(stmt->v.Import.names, "names", "Import");
556 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500557 case ImportFrom_kind:
Serhiy Storchakafbd15232016-06-27 21:39:12 +0300558 if (stmt->v.ImportFrom.level < 0) {
559 PyErr_SetString(PyExc_ValueError, "Negative ImportFrom level");
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500560 return 0;
561 }
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300562 ret = validate_nonempty_seq(stmt->v.ImportFrom.names, "names", "ImportFrom");
563 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500564 case Global_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300565 ret = validate_nonempty_seq(stmt->v.Global.names, "names", "Global");
566 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500567 case Nonlocal_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300568 ret = validate_nonempty_seq(stmt->v.Nonlocal.names, "names", "Nonlocal");
569 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500570 case Expr_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300571 ret = validate_expr(state, stmt->v.Expr.value, Load);
572 break;
Yury Selivanov75445082015-05-11 22:57:16 -0400573 case AsyncFunctionDef_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300574 ret = validate_body(state, stmt->v.AsyncFunctionDef.body, "AsyncFunctionDef") &&
575 validate_arguments(state, stmt->v.AsyncFunctionDef.args) &&
576 validate_exprs(state, stmt->v.AsyncFunctionDef.decorator_list, Load, 0) &&
Yury Selivanov75445082015-05-11 22:57:16 -0400577 (!stmt->v.AsyncFunctionDef.returns ||
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300578 validate_expr(state, stmt->v.AsyncFunctionDef.returns, Load));
579 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500580 case Pass_kind:
581 case Break_kind:
582 case Continue_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300583 ret = 1;
584 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500585 default:
586 PyErr_SetString(PyExc_SystemError, "unexpected statement");
587 return 0;
588 }
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300589 state->recursion_depth--;
590 return ret;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500591}
592
593static int
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300594validate_stmts(struct validator *state, asdl_stmt_seq *seq)
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500595{
Victor Stinner4d73ae72018-11-22 14:45:16 +0100596 Py_ssize_t i;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500597 for (i = 0; i < asdl_seq_LEN(seq); i++) {
598 stmt_ty stmt = asdl_seq_GET(seq, i);
599 if (stmt) {
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300600 if (!validate_stmt(state, stmt))
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500601 return 0;
602 }
603 else {
604 PyErr_SetString(PyExc_ValueError,
605 "None disallowed in statement list");
606 return 0;
607 }
608 }
609 return 1;
610}
611
612static int
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300613validate_exprs(struct validator *state, asdl_expr_seq *exprs, expr_context_ty ctx, int null_ok)
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500614{
Victor Stinner4d73ae72018-11-22 14:45:16 +0100615 Py_ssize_t i;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500616 for (i = 0; i < asdl_seq_LEN(exprs); i++) {
617 expr_ty expr = asdl_seq_GET(exprs, i);
618 if (expr) {
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300619 if (!validate_expr(state, expr, ctx))
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500620 return 0;
621 }
622 else if (!null_ok) {
623 PyErr_SetString(PyExc_ValueError,
624 "None disallowed in expression list");
625 return 0;
626 }
Victor Stinner0c39b1b2015-03-18 15:02:06 +0100627
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500628 }
629 return 1;
630}
631
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300632/* See comments in symtable.c. */
633#define COMPILER_STACK_FRAME_SCALE 3
634
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500635int
Victor Stinnereec8e612021-03-18 14:57:49 +0100636_PyAST_Validate(mod_ty mod)
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500637{
638 int res = 0;
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300639 struct validator state;
640 PyThreadState *tstate;
641 int recursion_limit = Py_GetRecursionLimit();
642 int starting_recursion_depth;
643
644 /* Setup recursion depth check counters */
645 tstate = _PyThreadState_GET();
646 if (!tstate) {
647 return 0;
648 }
649 /* Be careful here to prevent overflow. */
650 starting_recursion_depth = (tstate->recursion_depth < INT_MAX / COMPILER_STACK_FRAME_SCALE) ?
651 tstate->recursion_depth * COMPILER_STACK_FRAME_SCALE : tstate->recursion_depth;
652 state.recursion_depth = starting_recursion_depth;
653 state.recursion_limit = (recursion_limit < INT_MAX / COMPILER_STACK_FRAME_SCALE) ?
654 recursion_limit * COMPILER_STACK_FRAME_SCALE : recursion_limit;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500655
656 switch (mod->kind) {
657 case Module_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300658 res = validate_stmts(&state, mod->v.Module.body);
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500659 break;
660 case Interactive_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300661 res = validate_stmts(&state, mod->v.Interactive.body);
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500662 break;
663 case Expression_kind:
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300664 res = validate_expr(&state, mod->v.Expression.body, Load);
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500665 break;
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500666 default:
667 PyErr_SetString(PyExc_SystemError, "impossible module node");
668 res = 0;
669 break;
670 }
Serhiy Storchakaface87c2021-04-25 13:38:00 +0300671
672 /* Check that the recursion depth counting balanced correctly */
673 if (res && state.recursion_depth != starting_recursion_depth) {
674 PyErr_Format(PyExc_SystemError,
675 "AST validator recursion depth mismatch (before=%d, after=%d)",
676 starting_recursion_depth, state.recursion_depth);
677 return 0;
678 }
Benjamin Peterson832bfe22011-08-09 16:15:04 -0500679 return res;
680}
681
Serhiy Storchaka143ce5c2018-05-30 10:56:16 +0300682PyObject *
Pablo Galindoa5634c42020-09-16 19:42:00 +0100683_PyAST_GetDocString(asdl_stmt_seq *body)
Serhiy Storchaka143ce5c2018-05-30 10:56:16 +0300684{
685 if (!asdl_seq_LEN(body)) {
686 return NULL;
687 }
Batuhan Taskaya02a16032020-10-10 20:14:59 +0300688 stmt_ty st = asdl_seq_GET(body, 0);
Serhiy Storchaka143ce5c2018-05-30 10:56:16 +0300689 if (st->kind != Expr_kind) {
690 return NULL;
691 }
692 expr_ty e = st->v.Expr.value;
Serhiy Storchaka143ce5c2018-05-30 10:56:16 +0300693 if (e->kind == Constant_kind && PyUnicode_CheckExact(e->v.Constant.value)) {
694 return e->v.Constant.value;
695 }
696 return NULL;
697}