Skip to content

Commit

Permalink
pythongh-121332: Make AST node constructor check _attributes instead …
Browse files Browse the repository at this point in the history
…of hardcoding attributes
  • Loading branch information
JelleZijlstra committed Jul 3, 2024
1 parent 84512c0 commit e0167cd
Show file tree
Hide file tree
Showing 4 changed files with 65 additions and 28 deletions.
12 changes: 12 additions & 0 deletions Lib/test/test_ast.py
Original file line number Diff line number Diff line change
Expand Up @@ -2978,6 +2978,18 @@ class FieldsAndTypes(ast.AST):
obj = FieldsAndTypes(a=1)
self.assertEqual(obj.a, 1)

def test_custom_attributes(self):
class MyAttrs(ast.AST):
_attributes = ("a", "b")

obj = MyAttrs(a=1, b=2)
self.assertEqual(obj.a, 1)
self.assertEqual(obj.b, 2)

with self.assertWarnsRegex(DeprecationWarning,
r"MyAttrs.__init__ got an unexpected keyword argument 'c'."):
obj = MyAttrs(c=3)

def test_fields_and_types_no_default(self):
class FieldsAndTypesNoDefault(ast.AST):
_fields = ('a',)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Fix constructor of :mod:`ast` nodes with custom ``_attributes``. Previously,
passing custom attributes would raise a :py:exc:`DeprecationWarning`. Patch
by Jelle Zijlstra.
39 changes: 25 additions & 14 deletions Parser/asdl_c.py
Original file line number Diff line number Diff line change
Expand Up @@ -880,7 +880,7 @@ def visitModule(self, mod):
Py_ssize_t i, numfields = 0;
int res = -1;
PyObject *key, *value, *fields, *remaining_fields = NULL;
PyObject *key, *value, *fields, *attributes = NULL, *remaining_fields = NULL;
if (PyObject_GetOptionalAttr((PyObject*)Py_TYPE(self), state->_fields, &fields) < 0) {
goto cleanup;
}
Expand Down Expand Up @@ -947,22 +947,32 @@ def visitModule(self, mod):
goto cleanup;
}
}
else if (
PyUnicode_CompareWithASCIIString(key, "lineno") != 0 &&
PyUnicode_CompareWithASCIIString(key, "col_offset") != 0 &&
PyUnicode_CompareWithASCIIString(key, "end_lineno") != 0 &&
PyUnicode_CompareWithASCIIString(key, "end_col_offset") != 0
) {
if (PyErr_WarnFormat(
PyExc_DeprecationWarning, 1,
"%.400s.__init__ got an unexpected keyword argument '%U'. "
"Support for arbitrary keyword arguments is deprecated "
"and will be removed in Python 3.15.",
Py_TYPE(self)->tp_name, key
) < 0) {
else {
// Lazily initialize "attributes"
if (attributes == NULL) {
attributes = PyObject_GetAttr((PyObject*)Py_TYPE(self), state->_attributes);
if (attributes == NULL) {
res = -1;
goto cleanup;
}
}
int contains = PySequence_Contains(attributes, key);
if (contains == -1) {
res = -1;
goto cleanup;
}
else if (contains == 0) {
if (PyErr_WarnFormat(
PyExc_DeprecationWarning, 1,
"%.400s.__init__ got an unexpected keyword argument '%U'. "
"Support for arbitrary keyword arguments is deprecated "
"and will be removed in Python 3.15.",
Py_TYPE(self)->tp_name, key
) < 0) {
res = -1;
goto cleanup;
}
}
}
res = PyObject_SetAttr(self, key, value);
if (res < 0) {
Expand Down Expand Up @@ -1045,6 +1055,7 @@ def visitModule(self, mod):
Py_DECREF(field_types);
}
cleanup:
Py_XDECREF(attributes);
Py_XDECREF(fields);
Py_XDECREF(remaining_fields);
return res;
Expand Down
39 changes: 25 additions & 14 deletions Python/Python-ast.c

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit e0167cd

Please sign in to comment.