Thanks to visit codestin.com
Credit goes to github.com

Skip to content

bpo-38131: Improve messages when generating AST nodes from objects wi… #17715

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

bpo-38131: Improve messages when generating AST nodes from objects wi… #17715

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5b70313
bpo-38131: Improve messages when generating AST nodes from objects wi…
isidentical May 14, 2020
8f2bdbb
Apply suggestions regarding error message
isidentical May 17, 2020
ab69850
use single quotes
isidentical May 17, 2020
3594ff2
Merge branch 'main' into bpo-38131
serhiy-storchaka Dec 13, 2023
082f29c
Change formatting.
serhiy-storchaka Dec 13, 2023
2594ff6
Merge branch 'main' into bpo-38131
serhiy-storchaka Dec 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion Lib/test/test_ast.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -956,7 +956,7 @@ def test_invalid_identifier(self):
ast.fix_missing_locations(m)
with self.assertRaises(TypeError) as cm:
compile(m, "<test>", "exec")
self.assertIn("identifier must be of type str", str(cm.exception))
self.assertIn("expecting a string object", str(cm.exception))

def test_invalid_constant(self):
for invalid_constant in int, (1, 2, int), frozenset((1, 2, int)):
Expand Down Expand Up @@ -1178,6 +1178,31 @@ def test_none_checks(self) -> None:
for node, attr, source in tests:
self.assert_none_check(node, attr, source)

def test_required_field_messages(self):
binop = ast.BinOp(
left=ast.Constant(value=2),
right=ast.Constant(value=2),
op=ast.Add(),
)
expr_without_position = ast.Expression(body=binop)
expr_with_wrong_body = ast.Expression(body=[binop])

with self.assertRaisesRegex(TypeError, "required field") as cm:
compile(expr_without_position, "<test>", "eval")
with self.assertRaisesRegex(
TypeError,
"field 'body' was expecting node of type 'expr', got 'list'",
):
compile(expr_with_wrong_body, "<test>", "eval")

constant = ast.parse("u'test'", mode="eval")
constant.body.kind = 0xFF
with self.assertRaisesRegex(
TypeError, "field 'kind' was expecting a string or bytes object"
):
compile(constant, "<test>", "eval")


class ASTHelpers_Test(unittest.TestCase):
maxDiff = None

Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Core and Builtins/2019-12-27-19-20-33.bpo-38131.J5fv54.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Produce more meaningful messages when compiling AST objects with wrong field
values. Patch by Batuhan Taskaya.
53 changes: 35 additions & 18 deletions Parser/asdl_c.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,7 @@ def visitField(self, sum):

class Obj2ModPrototypeVisitor(PickleVisitor):
def visitProduct(self, prod, name):
code = "static int obj2ast_%s(struct ast_state *state, PyObject* obj, %s* out, PyArena* arena);"
code = "static int obj2ast_%s(struct ast_state *state, PyObject* obj, %s* out, const char* field, PyArena* arena);"
self.emit(code % (name, get_c_type(name)), 0)

visitSum = visitProduct
Expand All @@ -504,7 +504,7 @@ def recursive_call(self, node, level):
def funcHeader(self, name):
ctype = get_c_type(name)
self.emit("int", 0)
self.emit("obj2ast_%s(struct ast_state *state, PyObject* obj, %s* out, PyArena* arena)" % (name, ctype), 0)
self.emit("obj2ast_%s(struct ast_state *state, PyObject* obj, %s* out, const char* field, PyArena* arena)" % (name, ctype), 0)
self.emit("{", 0)
self.emit("int isinstance;", 1)
self.emit("", 0)
Expand Down Expand Up @@ -540,6 +540,18 @@ def simpleSum(self, sum, name):
def buildArgs(self, fields):
return ", ".join(fields + ["arena"])

def typeCheck(self, name):
self.emit("tp = state->%s_type;" % name, 1)
self.emit("isinstance = PyObject_IsInstance(obj, tp);", 1)
self.emit("if (isinstance == -1) {", 1)
self.emit("return 1;", 2)
self.emit("}", 1)
self.emit("if (!isinstance && field != NULL) {", 1)
error = "field '%%s' was expecting node of type '%s', got '%%s'" % name
self.emit("PyErr_Format(PyExc_TypeError, \"%s\", field, _PyType_Name(Py_TYPE(obj)));" % error, 2, reflow=False)
self.emit("return 1;", 2)
self.emit("}", 1)

def complexSum(self, sum, name):
self.funcHeader(name)
self.emit("PyObject *tmp = NULL;", 1)
Expand All @@ -552,6 +564,7 @@ def complexSum(self, sum, name):
self.emit("*out = NULL;", 2)
self.emit("return 0;", 2)
self.emit("}", 1)
self.typeCheck(name)
for a in sum.attributes:
self.visitField(a, name, sum=sum, depth=1)
for t in sum.types:
Expand Down Expand Up @@ -586,7 +599,7 @@ def visitSum(self, sum, name):
def visitProduct(self, prod, name):
ctype = get_c_type(name)
self.emit("int", 0)
self.emit("obj2ast_%s(struct ast_state *state, PyObject* obj, %s* out, PyArena* arena)" % (name, ctype), 0)
self.emit("obj2ast_%s(struct ast_state *state, PyObject* obj, %s* out, const char* field, PyArena* arena)" % (name, ctype), 0)
self.emit("{", 0)
self.emit("PyObject* tmp = NULL;", 1)
for f in prod.fields:
Expand Down Expand Up @@ -687,8 +700,8 @@ def visitField(self, field, name, sum=None, prod=None, depth=0):
self.emit("%s val;" % ctype, depth+2)
self.emit("PyObject *tmp2 = Py_NewRef(PyList_GET_ITEM(tmp, i));", depth+2)
with self.recursive_call(name, depth+2):
self.emit("res = obj2ast_%s(state, tmp2, &val, arena);" %
field.type, depth+2, reflow=False)
self.emit("res = obj2ast_%s(state, tmp2, &val, \"%s\", arena);" %
(field.type, field.name), depth+2, reflow=False)
self.emit("Py_DECREF(tmp2);", depth+2)
self.emit("if (res != 0) goto failed;", depth+2)
self.emit("if (len != PyList_GET_SIZE(tmp)) {", depth+2)
Expand All @@ -702,8 +715,8 @@ def visitField(self, field, name, sum=None, prod=None, depth=0):
self.emit("}", depth+1)
else:
with self.recursive_call(name, depth+1):
self.emit("res = obj2ast_%s(state, tmp, &%s, arena);" %
(field.type, field.name), depth+1)
self.emit("res = obj2ast_%s(state, tmp, &%s, \"%s\", arena);" %
(field.type, field.name, field.name), depth+1)
self.emit("if (res != 0) goto failed;", depth+1)

self.emit("Py_CLEAR(tmp);", depth+1)
Expand Down Expand Up @@ -1022,7 +1035,9 @@ def visitModule(self, mod):

/* Conversion Python -> AST */

static int obj2ast_object(struct ast_state *Py_UNUSED(state), PyObject* obj, PyObject** out, PyArena* arena)
static int obj2ast_object(struct ast_state *Py_UNUSED(state), PyObject* obj,
PyObject** out,
const char* Py_UNUSED(field), PyArena* arena)
{
if (obj == Py_None)
obj = NULL;
Expand All @@ -1039,7 +1054,9 @@ def visitModule(self, mod):
return 0;
}

static int obj2ast_constant(struct ast_state *Py_UNUSED(state), PyObject* obj, PyObject** out, PyArena* arena)
static int obj2ast_constant(struct ast_state *Py_UNUSED(state), PyObject* obj,
PyObject** out,
const char* Py_UNUSED(field), PyArena* arena)
{
if (_PyArena_AddPyObject(arena, obj) < 0) {
*out = NULL;
Expand All @@ -1049,29 +1066,29 @@ def visitModule(self, mod):
return 0;
}

static int obj2ast_identifier(struct ast_state *state, PyObject* obj, PyObject** out, PyArena* arena)
static int obj2ast_identifier(struct ast_state *state, PyObject* obj, PyObject** out, const char* field, PyArena* arena)
{
if (!PyUnicode_CheckExact(obj) && obj != Py_None) {
PyErr_SetString(PyExc_TypeError, "AST identifier must be of type str");
PyErr_Format(PyExc_TypeError, "field '%s' was expecting a string object", field);
return -1;
}
return obj2ast_object(state, obj, out, arena);
return obj2ast_object(state, obj, out, field, arena);
}

static int obj2ast_string(struct ast_state *state, PyObject* obj, PyObject** out, PyArena* arena)
static int obj2ast_string(struct ast_state *state, PyObject* obj, PyObject** out, const char* field, PyArena* arena)
{
if (!PyUnicode_CheckExact(obj) && !PyBytes_CheckExact(obj)) {
PyErr_SetString(PyExc_TypeError, "AST string must be of type str");
PyErr_Format(PyExc_TypeError, "field '%s' was expecting a string or bytes object", field);
return -1;
}
return obj2ast_object(state, obj, out, arena);
return obj2ast_object(state, obj, out, field, arena);
}

static int obj2ast_int(struct ast_state* Py_UNUSED(state), PyObject* obj, int* out, PyArena* arena)
static int obj2ast_int(struct ast_state* Py_UNUSED(state), PyObject* obj, int* out, const char* field, PyArena* arena)
{
int i;
if (!PyLong_Check(obj)) {
PyErr_Format(PyExc_ValueError, "invalid integer value: %R", obj);
PyErr_Format(PyExc_ValueError, "field \\"%s\\" got an invalid integer value: %R", field, obj);
return -1;
}

Expand Down Expand Up @@ -1443,7 +1460,7 @@ class PartingShots(StaticVisitor):
}

mod_ty res = NULL;
if (obj2ast_mod(state, ast, &res, arena) != 0)
if (obj2ast_mod(state, ast, &res, NULL, arena) != 0)
return NULL;
else
return res;
Expand Down
Loading