Skip to content

gh-123446: Fix empty function names in TypeErrors in typeobject #123470

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

Merged
merged 4 commits into from
Aug 30, 2024
Merged

gh-123446: Fix empty function names in TypeErrors in typeobject #123470

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2411d03
gh-123446: Fix empty function names in `TypeError`s in `typeobject`
sobolevn Aug 29, 2024
d4d0070
Address review
sobolevn Aug 29, 2024
5810386
Add a test case
sobolevn Aug 29, 2024
41ac72f
Address review
sobolevn Aug 30, 2024
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
14 changes: 14 additions & 0 deletions Lib/test/test_descr.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4021,6 +4021,20 @@ def test_ipow_exception_text(self):
y = x ** 2
self.assertIn('unsupported operand type(s) for **', str(cm.exception))

def test_pow_wrapper_error_messages(self):
self.assertRaisesRegex(TypeError,
'expected 1 or 2 arguments, got 0',
int().__pow__)
self.assertRaisesRegex(TypeError,
'expected 1 or 2 arguments, got 3',
int().__pow__, 1, 2, 3)
self.assertRaisesRegex(TypeError,
'expected 1 or 2 arguments, got 0',
int().__rpow__)
self.assertRaisesRegex(TypeError,
'expected 1 or 2 arguments, got 3',
int().__rpow__, 1, 2, 3)

def test_mutable_bases(self):
# Testing mutable bases...

Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Core_and_Builtins/2024-08-29-13-18-18.gh-issue-123446.KWDrgq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Fix empty function name in :exc:`TypeError` when builtin magic methods are
used without the required args.
58 changes: 47 additions & 11 deletions Objects/typeobject.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8678,6 +8678,27 @@ check_num_args(PyObject *ob, int n)
return 0;
}

static Py_ssize_t
check_pow_args(PyObject *ob)
{
// Returns the argument count on success or `-1` on error.
int min = 1;
int max = 2;
if (!PyTuple_CheckExact(ob)) {
PyErr_SetString(PyExc_SystemError,
"PyArg_UnpackTuple() argument list is not a tuple");
return -1;
}
Py_ssize_t size = PyTuple_GET_SIZE(ob);
if (size >= min && size <= max) {
return size;
}
PyErr_Format(
PyExc_TypeError,
"expected %d or %d arguments, got %zd", min, max, PyTuple_GET_SIZE(ob));
return -1;
}

/* Generic wrappers for overloadable 'operators' such as __getitem__ */

/* There's a wrapper *function* for each distinct function typedef used
Expand Down Expand Up @@ -8759,8 +8780,15 @@ wrap_ternaryfunc(PyObject *self, PyObject *args, void *wrapped)

/* Note: This wrapper only works for __pow__() */

if (!PyArg_UnpackTuple(args, "", 1, 2, &other, &third))
Py_ssize_t size = check_pow_args(args);
if (size == -1) {
return NULL;
}
other = PyTuple_GET_ITEM(args, 0);
if (size == 2) {
third = PyTuple_GET_ITEM(args, 1);
}

return (*func)(self, other, third);
}

Expand All @@ -8771,10 +8799,17 @@ wrap_ternaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
PyObject *other;
PyObject *third = Py_None;

/* Note: This wrapper only works for __pow__() */
/* Note: This wrapper only works for __rpow__() */

if (!PyArg_UnpackTuple(args, "", 1, 2, &other, &third))
Py_ssize_t size = check_pow_args(args);
if (size == -1) {
return NULL;
}
other = PyTuple_GET_ITEM(args, 0);
if (size == 2) {
third = PyTuple_GET_ITEM(args, 1);
}
Comment on lines +8805 to +8811
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could also be moved into check_pow_args (or rather unpack_pow_args).

BTW, it is still a question whether __rpow__ and __ipow__ should support the third argument. Normally they never called with three arguments. So it may be better to leave the current PR code, it will be easier to change in future.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we can open a new issue about that. For now, we only change the error message, not any logical parts. Thanks a lot for the review! 👍


return (*func)(other, self, third);
}

Expand All @@ -8795,8 +8830,9 @@ wrap_indexargfunc(PyObject *self, PyObject *args, void *wrapped)
PyObject* o;
Py_ssize_t i;

if (!PyArg_UnpackTuple(args, "", 1, 1, &o))
if (!check_num_args(args, 1))
return NULL;
o = PyTuple_GET_ITEM(args, 0);
i = PyNumber_AsSsize_t(o, PyExc_OverflowError);
if (i == -1 && PyErr_Occurred())
return NULL;
Expand Down Expand Up @@ -8852,7 +8888,7 @@ wrap_sq_setitem(PyObject *self, PyObject *args, void *wrapped)
int res;
PyObject *arg, *value;

if (!PyArg_UnpackTuple(args, "", 2, 2, &arg, &value))
if (!PyArg_UnpackTuple(args, "__setitem__", 2, 2, &arg, &value))
return NULL;
i = getindex(self, arg);
if (i == -1 && PyErr_Occurred())
Expand Down Expand Up @@ -8908,7 +8944,7 @@ wrap_objobjargproc(PyObject *self, PyObject *args, void *wrapped)
int res;
PyObject *key, *value;

if (!PyArg_UnpackTuple(args, "", 2, 2, &key, &value))
if (!PyArg_UnpackTuple(args, "__setitem__", 2, 2, &key, &value))
return NULL;
res = (*func)(self, key, value);
if (res == -1 && PyErr_Occurred())
Expand Down Expand Up @@ -9005,7 +9041,7 @@ wrap_setattr(PyObject *self, PyObject *args, void *wrapped)
int res;
PyObject *name, *value;

if (!PyArg_UnpackTuple(args, "", 2, 2, &name, &value))
if (!PyArg_UnpackTuple(args, "__setattr__", 2, 2, &name, &value))
return NULL;
if (!hackcheck(self, func, "__setattr__"))
return NULL;
Expand Down Expand Up @@ -9115,7 +9151,7 @@ wrap_descr_get(PyObject *self, PyObject *args, void *wrapped)
PyObject *obj;
PyObject *type = NULL;

if (!PyArg_UnpackTuple(args, "", 1, 2, &obj, &type))
if (!PyArg_UnpackTuple(args, "__get__", 1, 2, &obj, &type))
return NULL;
if (obj == Py_None)
obj = NULL;
Expand All @@ -9136,7 +9172,7 @@ wrap_descr_set(PyObject *self, PyObject *args, void *wrapped)
PyObject *obj, *value;
int ret;

if (!PyArg_UnpackTuple(args, "", 2, 2, &obj, &value))
if (!PyArg_UnpackTuple(args, "__set__", 2, 2, &obj, &value))
return NULL;
ret = (*func)(self, obj, value);
if (ret < 0)
Expand Down Expand Up @@ -9165,7 +9201,7 @@ wrap_buffer(PyObject *self, PyObject *args, void *wrapped)
{
PyObject *arg = NULL;

if (!PyArg_UnpackTuple(args, "", 1, 1, &arg)) {
if (!PyArg_UnpackTuple(args, "__buffer__", 1, 1, &arg)) {
return NULL;
}
Py_ssize_t flags = PyNumber_AsSsize_t(arg, PyExc_OverflowError);
Expand All @@ -9186,7 +9222,7 @@ static PyObject *
wrap_releasebuffer(PyObject *self, PyObject *args, void *wrapped)
{
PyObject *arg = NULL;
if (!PyArg_UnpackTuple(args, "", 1, 1, &arg)) {
if (!PyArg_UnpackTuple(args, "__release_buffer__", 1, 1, &arg)) {
return NULL;
}
if (!PyMemoryView_Check(arg)) {
Expand Down
Loading