Python的序列协议是什么？

Question

Python 用魔术方法做了很多事情，其中​​大部分是某些协议的一部分。我熟悉“迭代器协议”和“数字协议”，但最近偶然发现了 "sequence protocol" 一词。但即使经过一些研究，我也不确定“序列协议”是什么。

例如，C API 函数PySequence_Check 检查（根据文档）是否某个对象实现了“序列协议”。 source code 表示这是一个不是 dict 的类，但实现了 __getitem__ 方法，该方法大致与 iter 上的文档中的说明相同：

[...]必须支持序列协议（__getitem__() 方法，整数参数从 0 开始）。[...]

但以0 开头的要求并不是在PySequence_Check 中“实现”的。

还有collections.abc.Sequence类型，基本上就是说实例要实现__reversed__、__contains__、__iter__和__len__。

但是根据该定义，实现“序列协议”的类不一定是序列，例如"data model" 和抽象类保证序列具有长度。但是一个只实现__getitem__（通过PySequence_Check）的类在使用len(an_instance_of_that_class)时会抛出异常。

有人可以为我澄清一下序列和序列协议之间的区别（如果除了阅读源代码之外还有协议的定义）以及何时使用哪个定义？

Answer 1

这不是真的一致。

这里是PySequence_Check：

int
PySequence_Check(PyObject *s)
{
    if (PyDict_Check(s))
        return 0;
    return s != NULL && s->ob_type->tp_as_sequence &&
        s->ob_type->tp_as_sequence->sq_item != NULL;
}

PySequence_Check 检查对象是否提供 C 序列协议，通过 PyTypeObject 中的 tp_as_sequence 成员实现，表示对象的类型。这个tp_as_sequence 成员是一个指向结构的指针，该结构包含一系列用于序列行为的函数，例如sq_item 用于通过数字索引检索项目，sq_ass_item 用于项目分配。

具体来说，PySequence_Check 要求其参数不是 dict，并且它提供 sq_item。

用 Python 编写的带有__getitem__ 的类型将提供sq_item，无论它们在概念上是序列还是映射，因此不从dict 继承的用Python 编写的映射将传递PySequence_Check。

---

另一方面，collections.abc.Sequence 只检查一个对象是否具体继承自collections.abc.Sequence，或者它的类（或超类）是否明确地registered 和collections.abc.Sequence。如果你只是自己实现一个序列而不做任何这些事情，它不会通过isinstance(your_sequence, Sequence)。此外，大多数使用collections.abc.Sequence 注册的类并不支持collections.abc.Sequence 的所有方法。总体而言，collections.abc.Sequence 的可靠性远不如人们通常预期的那么可靠。

---

至于在实践中算作序列的内容，通常是支持__len__ 和__getitem__ 且整数索引从0 开始且不是映射的任何内容。如果一个函数的文档说它需要任何序列，那几乎总是它所需要的。不幸的是，“不是一个映射”很难测试，原因类似于“是一个序列”很难确定。

Answer 2

要符合序列协议的类型，必须满足这四个条件：

• 按索引检索元素

  item = seq[index]

• 按值查找项目

  index = seq.index(item)

• 计数项目

  num = seq.count(item)

• 产生一个相反的序列

  r = reversed(seq)