class foo:
def __init__(self, data):
self.data = data
def __len__(self):
return self.data
如果我通过为 data
传递一个字符串来运行它,那么在对此类的实例调用 len
时会出现错误。具体来说,我得到了 'str' object cannot be interpreted as an integer
。
那么__len__
中的return
语句是否必须是一个整数?我想如果我覆盖它,它应该能够输出我想要的任何东西,那为什么这不可能呢?
最佳答案
简短回答
在 C 级,Python 将 __len__
插入到一个特殊槽中,该槽捕获对 __len__
调用的输出,并对其进行一些验证以确保它是正确的.
长答案
为了回答这个问题,我们必须深入了解当 len
时幕后发生的事情。在 Python 中调用。
首先,让我们建立一些行为。
>>> class foo:
... def __init__(self, data):
... self.data = data
... def __len__(self):
... return self.data
...
>>> len(foo(-1))
Traceback:
...
ValueError: __len__() should return >= 0
>>> len(foo('5'))
Traceback:
...
TypeError: 'str' object cannot be interpreted as an integer
>>> len(foo(5))
5
当您调用 len
时, C 函数 builtin_len
被调用。让我们来看看这个。
static PyObject *
builtin_len(PyObject *module, PyObject *obj)
/*[clinic end generated code: output=fa7a270d314dfb6c input=bc55598da9e9c9b5]*/
{
Py_ssize_t res;
res = PyObject_Size(obj); // <=== THIS IS WHAT IS IMPORTANT!!!
if (res < 0 && PyErr_Occurred())
return NULL;
return PyLong_FromSsize_t(res);
}
您会注意到 PyObject_Size
正在调用函数 - 此函数将返回任意 Python 对象的大小。让我们进一步深入兔子洞。
Py_ssize_t
PyObject_Size(PyObject *o)
{
PySequenceMethods *m;
if (o == NULL) {
null_error();
return -1;
}
m = o->ob_type->tp_as_sequence;
if (m && m->sq_length)
return m->sq_length(o); // <==== THIS IS WHAT IS IMPORTANT!!!
return PyMapping_Size(o);
}
它检查类型是否定义了 sq_length
函数(序列长度),如果是,则调用它来获取长度。似乎在 C 级别,Python 将定义 __len__
的所有对象归类为序列或映射(即使这不是我们在 Python 级别对它们的看法);在我们的例子中,Python 认为这个类是一个序列,所以它调用 sq_length
。
让我们快速回顾一下:对于内置类型(例如 list
、 set
等),Python 实际上并不调用函数来计算长度,而是访问存储在 C 结构中的值,使得这个非常快。这些内置类型中的每一个都定义了如何通过将访问器方法分配给 sq_length
来访问它。让我们快速浏览一下how this is implemented for lists :
static Py_ssize_t
list_length(PyListObject *a)
{
return Py_SIZE(a); // <== THIS IS A MACRO for (PyVarObject*) a->ob_size;
}
static PySequenceMethods list_as_sequence = {
...
(lenfunc)list_length, /* sq_length */
...
};
ob_size
存储对象的大小(即列表中的元素数)。因此,当sq_length
被调用时,它被发送到list_length
函数以获取ob_size
的值。
好的,这就是内置类型的处理方式……它如何处理像我们的 foo
这样的自定义类?由于“dunder 方法”(例如 __len__
)很特殊,Python 会在我们的类中检测到它们并对其进行特殊处理(具体来说,将它们插入特殊的槽中)。
其中大部分在 typeobject.c 中处理. __len__
函数被拦截并分配给 sq_length
槽(就像一个内置函数!)near the bottom of the file .
SQSLOT("__len__", sq_length, slot_sq_length, wrap_lenfunc,
"__len__($self, /)\n--\n\nReturn len(self)."),
slot_sq_length
功能是我们可以最终回答您的问题的地方。
static Py_ssize_t
slot_sq_length(PyObject *self)
{
PyObject *res = call_method(self, &PyId___len__, NULL);
Py_ssize_t len;
if (res == NULL)
return -1;
len = PyNumber_AsSsize_t(res, PyExc_OverflowError); // <=== HERE!!!
Py_DECREF(res);
if (len < 0) { // <== AND HERE!!!
if (!PyErr_Occurred())
PyErr_SetString(PyExc_ValueError,
"__len__() should return >= 0");
return -1;
}
return len;
}
这里有两点需要注意:
- 如果返回负数,则会引发
ValueError
消息"__len__() should return >= 0"
。这正是我尝试调用len(foo(-1))
时收到的错误! - Python 在返回之前尝试将
__len__
的返回值强制转换为Py_ssize_t
(Py_ssize_t
是一个已签名size_t
的版本,它就像一种特殊类型的整数,保证能够索引容器中的内容)。
OK,我们来看PyNumber_AsSsize_t
的实现.它有点长,所以我将省略不相关的内容。
Py_ssize_t
PyNumber_AsSsize_t(PyObject *item, PyObject *err)
{
Py_ssize_t result;
PyObject *runerr;
PyObject *value = PyNumber_Index(item);
if (value == NULL)
return -1;
/* OMITTED FOR BREVITY */
此处的相关位在 PyNumber_Index
中,Python 使用它来将任意对象转换为适合索引的整数。 这里是您问题的实际答案所在。我已经做了一些注释。
PyObject *
PyNumber_Index(PyObject *item)
{
PyObject *result = NULL;
if (item == NULL) {
return null_error();
}
if (PyLong_Check(item)) { // IS THE OBJECT ALREADY AN int? IF SO, RETURN IT NOW.
Py_INCREF(item);
return item;
}
if (!PyIndex_Check(item)) { // DOES THE OBJECT DEFINE __index__? IF NOT, FAIL.
PyErr_Format(PyExc_TypeError,
"'%.200s' object cannot be interpreted "
"as an integer", item->ob_type->tp_name);
return NULL;
}
result = item->ob_type->tp_as_number->nb_index(item);
if (!result || PyLong_CheckExact(result))
return result;
if (!PyLong_Check(result)) { // IF __index__ DOES NOT RETURN AN int, FAIL.
PyErr_Format(PyExc_TypeError,
"__index__ returned non-int (type %.200s)",
result->ob_type->tp_name);
Py_DECREF(result);
return NULL;
}
/* Issue #17576: warn if 'result' not of exact type int. */
if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
"__index__ returned non-int (type %.200s). "
"The ability to return an instance of a strict subclass of int "
"is deprecated, and may be removed in a future version of Python.",
result->ob_type->tp_name)) {
Py_DECREF(result);
return NULL;
}
return result;
}
根据您收到的错误,我们可以看到 '5'
没有定义 __index__
。我们可以自己验证:
>>> '5'.__index__()
Traceback:
...
AttributeError: 'str' object has no attribute '__index__'
关于python - 调用len时Python如何保证__len__的返回值是整数?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/42521449/