Skip to content
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.

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

bpo-27541: Reprs of subclasses of some classes now contain actual type name. #3631

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
bpo-27541: Reprs of subclasses of some classes now contain actual typ…
…e name.

Affected classes are bytearray, array, deque, defaultdict, count and repeat.
  • Loading branch information
serhiy-storchaka committed Sep 17, 2017
commit 6e75a2033f3c0a8db875f938d568adcf6dda0eaa
4 changes: 2 additions & 2 deletions Lib/test/test_defaultdict.py
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,8 @@ def _factory(self):
return []
d = sub()
self.assertRegex(repr(d),
r"defaultdict\(<bound method .*sub\._factory "
r"of defaultdict\(\.\.\., \{\}\)>, \{\}\)")
r"sub\(<bound method .*sub\._factory "
r"of sub\(\.\.\., \{\}\)>, \{\}\)")

# NOTE: printing a subclass of a builtin type does not call its
# tp_print slot. So this part is essentially the same test as above.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Reprs of subclasses of some collection and iterator classes (`bytearray`,
`array.array`, `collections.deque`, `collections.defaultdict`,
`itertools.count`, `itertools.repeat`) now contain actual type name insteads
of hardcoded name of the base class.
11 changes: 7 additions & 4 deletions Modules/_collectionsmodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -1384,10 +1384,12 @@ deque_repr(PyObject *deque)
return NULL;
}
if (((dequeobject *)deque)->maxlen >= 0)
result = PyUnicode_FromFormat("deque(%R, maxlen=%zd)",
aslist, ((dequeobject *)deque)->maxlen);
result = PyUnicode_FromFormat("%s(%R, maxlen=%zd)",
_PyType_Name(Py_TYPE(deque)), aslist,
((dequeobject *)deque)->maxlen);
else
result = PyUnicode_FromFormat("deque(%R)", aslist);
result = PyUnicode_FromFormat("%s(%R)",
_PyType_Name(Py_TYPE(deque)), aslist);
Py_ReprLeave(deque);
Py_DECREF(aslist);
return result;
Expand Down Expand Up @@ -2127,7 +2129,8 @@ defdict_repr(defdictobject *dd)
Py_DECREF(baserepr);
return NULL;
}
result = PyUnicode_FromFormat("defaultdict(%U, %U)",
result = PyUnicode_FromFormat("%s(%U, %U)",
_PyType_Name(Py_TYPE(dd)),
defrepr, baserepr);
Py_DECREF(defrepr);
Py_DECREF(baserepr);
Expand Down
6 changes: 4 additions & 2 deletions Modules/arraymodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -2307,7 +2307,8 @@ array_repr(arrayobject *a)
len = Py_SIZE(a);
typecode = a->ob_descr->typecode;
if (len == 0) {
return PyUnicode_FromFormat("array('%c')", (int)typecode);
return PyUnicode_FromFormat("%s('%c')",
_PyType_Name(Py_TYPE(a)), (int)typecode);
}
if (typecode == 'u') {
v = array_array_tounicode_impl(a);
Expand All @@ -2317,7 +2318,8 @@ array_repr(arrayobject *a)
if (v == NULL)
return NULL;

s = PyUnicode_FromFormat("array('%c', %R)", (int)typecode, v);
s = PyUnicode_FromFormat("%s('%c', %R)",
_PyType_Name(Py_TYPE(a)), (int)typecode, v);
Py_DECREF(v);
return s;
}
Expand Down
19 changes: 13 additions & 6 deletions Modules/itertoolsmodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -4067,7 +4067,8 @@ static PyObject *
count_repr(countobject *lz)
{
if (lz->cnt != PY_SSIZE_T_MAX)
return PyUnicode_FromFormat("count(%zd)", lz->cnt);
return PyUnicode_FromFormat("%s(%zd)",
_PyType_Name(Py_TYPE(lz)), lz->cnt);

if (PyLong_Check(lz->long_step)) {
long step = PyLong_AsLong(lz->long_step);
Expand All @@ -4076,11 +4077,14 @@ count_repr(countobject *lz)
}
if (step == 1) {
/* Don't display step when it is an integer equal to 1 */
return PyUnicode_FromFormat("count(%R)", lz->long_cnt);
return PyUnicode_FromFormat("%s(%R)",
_PyType_Name(Py_TYPE(lz)),
lz->long_cnt);
}
}
return PyUnicode_FromFormat("count(%R, %R)",
lz->long_cnt, lz->long_step);
return PyUnicode_FromFormat("%s(%R, %R)",
_PyType_Name(Py_TYPE(lz)),
lz->long_cnt, lz->long_step);
}

static PyObject *
Expand Down Expand Up @@ -4220,9 +4224,12 @@ static PyObject *
repeat_repr(repeatobject *ro)
{
if (ro->cnt == -1)
return PyUnicode_FromFormat("repeat(%R)", ro->element);
return PyUnicode_FromFormat("%s(%R)",
_PyType_Name(Py_TYPE(ro)), ro->element);
else
return PyUnicode_FromFormat("repeat(%R, %zd)", ro->element, ro->cnt);
return PyUnicode_FromFormat("%s(%R, %zd)",
_PyType_Name(Py_TYPE(ro)), ro->element,
ro->cnt);
}

static PyObject *
Expand Down
16 changes: 10 additions & 6 deletions Objects/bytearrayobject.c
Original file line number Diff line number Diff line change
Expand Up @@ -891,11 +891,12 @@ bytearray_init(PyByteArrayObject *self, PyObject *args, PyObject *kwds)
static PyObject *
bytearray_repr(PyByteArrayObject *self)
{
const char *quote_prefix = "bytearray(b";
const char *className = _PyType_Name(Py_TYPE(self));
const char *quote_prefix = "(b";
const char *quote_postfix = ")";
Py_ssize_t length = Py_SIZE(self);
/* 15 == strlen(quote_prefix) + 2 + strlen(quote_postfix) + 1 */
size_t newsize;
/* 6 == strlen(quote_prefix) + 2 + strlen(quote_postfix) + 1 */
Py_ssize_t newsize;
PyObject *v;
Py_ssize_t i;
char *bytes;
Expand All @@ -905,13 +906,14 @@ bytearray_repr(PyByteArrayObject *self)
char *test, *start;
char *buffer;

if (length > (PY_SSIZE_T_MAX - 15) / 4) {
newsize = strlen(className);
if (length > (PY_SSIZE_T_MAX - 6 - newsize) / 4) {
PyErr_SetString(PyExc_OverflowError,
"bytearray object is too large to make repr");
return NULL;
}

newsize = 15 + length * 4;
newsize += 6 + length * 4;
buffer = PyObject_Malloc(newsize);
if (buffer == NULL) {
PyErr_NoMemory();
Expand All @@ -931,6 +933,8 @@ bytearray_repr(PyByteArrayObject *self)
}

p = buffer;
while (*className)
*p++ = *className++;
while (*quote_prefix)
*p++ = *quote_prefix++;
*p++ = quote;
Expand Down Expand Up @@ -966,7 +970,7 @@ bytearray_repr(PyByteArrayObject *self)
*p++ = *quote_postfix++;
}

v = PyUnicode_DecodeASCII(buffer, p - buffer, NULL);
v = PyUnicode_FromStringAndSize(buffer, p - buffer);
PyObject_Free(buffer);
return v;
}
Expand Down