究竟什么是序列？

Question

Python docs 有点模棱两可

顺序

一个支持通过__getitem__()特殊方法使用整数索引的高效元素访问的可迭代对象，并定义了__len__() 返回序列长度的方法。一些内置序列 类型是列表、字符串、元组和字节。注意 dict 也支持 __getitem__() 和 __len__()，但被认为是映射而不是序列，因为查找使用任意不可变键而不是 整数。

collections.abc.Sequence 抽象基类定义了一个更丰富的接口，不仅限于__getitem__() 和__len__()， 添加 count()、index()、__contains__() 和 __reversed__()。类型 实现这个扩展接口的可以显式注册 使用 register()。

特别是，使用abc.collections.Sequence 作为recommended by some 的黄金标准意味着，例如，numpy 数组不是序列：

isinstance(np.arange(6),collections.abc.Sequence)
# False

还有一个叫做 Sequence Protocol 的东西，但它似乎只在 C-API 中公开。那里的标准是

int PySequence_Check(PyObject *o)

如果对象提供序列协议，则返回 1，否则返回 0。请注意，它为带有 a 的 Python 类返回 1 __getitem__() 方法，除非它们是 dict 子类，因为在一般情况下，无法确定它支持的键类型。 这个函数总是成功的。

最后，我不会太密切地关注这个新的（-ish）类型注释业务，但我想这也将受益于序列是什么的清晰概念。

所以我的问题既有哲学的一面，也有实用的一面：序列到底是什么？以及如何测试某事是否是序列？理想情况下，以某种方式制作 numpy 数组序列。如果我开始注释，我将如何处理序列？

Answer 1

Python中打字简介

如果您知道什么是结构类型、名义类型和鸭子类型，请跳过。

我认为大部分混淆源于 typing 是 3.5 和 3.6 版本之间的临时模块这一事实。并且仍然会在 3.7 和 3.8 版本之间发生变化。这意味着 Python 试图通过类型注释处理类型的方式发生了很大变化。

python 既是鸭子类型又是名义类型也无济于事。也就是说，当访问对象的属性时，Python 是鸭子类型的。仅在运行时检查对象是否具有属性，并且仅在立即请求时才检查该对象。然而，Python 也有名义上的类型特征（例如isinstance()和issubclass()）。名义类型是一种类型被声明为另一种类型的子类。这可以通过继承，或者使用ABCMeta 的register() 方法。

typing 最初使用名义类型的思想引入了它的类型。从 3.8 开始，它正试图允许更多的 Pythonic 结构类型。 结构类型与鸭子类型有关，只是它是在“编译时”而不是运行时考虑的。例如，当 linter 试图检测可能的类型错误时——例如，如果您要将 dict 传递给只接受像元组或列表这样的序列的函数。对于结构类型，如果类B 实现了A 的所有方法，则应将其视为A 的子类型，无论它是否已被声明为A 的子类型（如在名义类型中） )。

回答

序列（小 s）是鸭子类型。序列是提供对其成员的随机访问的任何有序对象集合。具体来说，如果它定义了__len__ 和__getitem__ 并使用0 到n-1 之间的整数索引，那么它就是一个序列。序列（大 s）是一种名义类型。也就是说，要成为一个序列，一个类必须这样声明，要么通过继承自序列，要么注册为子类。

一个numpy数组是一个序列，但它不是一个序列，因为它没有注册为序列的子类。也不应该，因为它没有实现 Sequence 承诺的完整接口（缺少 count() 和 index() 之类的东西）。

听起来你想要的是一个序列（小 s）的结构化类型。从 3.8 开始，这可以通过使用 protocols 来实现。协议定义了一组方法，一个类必须实现这些方法才能被视为协议的子类（结构类型）。

from typing import Protocol
import numpy as np

class MySequence(Protocol):
    def __getitem__(self, index):
        raise NotImplementedError
    def __len__(self):
        raise NotImplementedError
    def __contains__(self, item):
        raise NotImplementedError
    def __iter__(self):
        raise NotImplementedError

def f(s: MySequence):
    for i in range(len(s)):
        print(s[i], end=' ')
    print('end')

f([1, 2, 3, 4]) # should be fine
arr: np.ndarray = np.arange(5)
f(arr) # also fine
f({}) # might be considered fine! Depends on your type checker

协议相当新，因此并非所有 IDE/类型检查器都支持它们。我使用的 IDE PyCharm 可以。它不喜欢f({})，但很高兴将一个 numpy 数组视为一个序列（大 S）（也许并不理想）。您可以使用typing 的runtime_checkable 装饰器启用协议的运行时检查。请注意，所有这些都是单独检查每个协议方法是否可以在给定的对象/类上找到。因此，如果您的协议有很多方法，它可能会变得非常昂贵。

Answer 2

我认为在 Python 中定义序列最实用的方法是“支持整数索引的容器”。

Wikipedia 定义也成立：

序列是对象的枚举集合，其中允许重复且顺序很重要。

为了验证一个对象是否是一个序列，我会模仿Sequence Protocol中的逻辑：

hasattr(test_obj, "__getitem__") and not isinstance(test_obj, collections.abc.Mapping) 

Answer 3

根据您粘贴的文档：

collections.abc.Sequence 抽象基类定义了一个更丰富的接口，不仅限于__getitem__() 和__len__()，还添加了count()、index()、__contains__() 和__reversed__()。实现此扩展接口的类型可以使用 register() 显式注册。

numpy.ndarray 没有实现Sequence 协议，因为它没有实现count() 或index()：

>>> arr = numpy.arange(6)
>>> isinstance(arr, Sequence)
False
>>> arr.count(3)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: 'numpy.ndarray' object has no attribute 'count'
>>> arr.index(3)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: 'numpy.ndarray' object has no attribute 'index'

对比range：

>>> r = range(6)
>>> isinstance(r, Sequence)
True
>>> r.count(3)
1
>>> r.index(3)
3

如果您想声明arr 是Sequence，您可以使用register() 类方法：

>>> Sequence.register(numpy.ndarray)
<class 'numpy.ndarray'>
>>> isinstance(arr, Sequence)
True

但这是一个谎言，因为它实际上并没有实现协议（register() 函数实际上并没有检查它，它只是信任你）：

>>> arr.count(3)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: 'numpy.ndarray' object has no attribute 'count'

如果您将numpy.ndarray 传递给需要Sequence 的函数，这样做可能会导致错误。