python 创建定制的序列

创建定制的序列¶

有很多方法让你的Python类行为可以像内置的序列(dict, tuple,list, string等等)。这是目前位置我最喜欢的魔术方法因为它给你很搞的控制权限而且让很多函数在你的类实例上工作的很出色。但是在开始之前，需要先讲一些必须条件。

必须条件¶

现在我们开始讲如何在Python中创建定制的序列，这个时候该讲一讲协议。协议(Protocols)与其他语言中的接口很相似。它给你很多你必须定义的方法。然而在Python中的协议是很不正式的，不需要明确声明实现。事实上，他们更像一种指南。

我们为什么现在讨论协议？因为如果要定制容器类型的话需要用到这些协议。首先，实现不变容器的话有一个协议:实现不可变容器，你只能定义 __len__ 和 __getitem__ (一会会讲更多)。可变容器协议则需要所有不可变容器的所有另外还需要__setitem__ 和 __delitem__ 。最终，如果你希望你的对象是可迭代的话，你需要定义 __iter__ 会返回一个迭代器。迭代器必须遵循迭代器协议，需要有 __iter__ (返回它本身) 和 next 。

容器后的魔法¶

这些是容器使用的魔术方法。__len__(self)然会容器长度。对于可变不可变容器都需要有的协议的一部分。__getitem__(self,key)定义当一个条目被访问时，使用符号 self[key] 。这也是不可变容器和可变容器都要有的协议的一部分。如果键的类型错误和KeyError 或者没有合适的值。那么应该抛出适当的TypeError 异常。__setitem__(self,key, value)定义当一个条目被赋值时的行为,使用self[key] = value 。这也是可变容器和不可变容器协议中都要有的一部分。__delitem__(self,key)定义当一个条目被删除时的行为(比如 del self[key])。这只是可变容器协议中的一部分。当使用一个无效的键时应该抛出适当的异常。__iter__(self)返回一个容器的迭代器。很多情况下会返回迭代器，尤其是当内置的iter() 方法被调用的时候，或者当使用 for x incontainer 方式循环的时候。迭代器是他们本身的对象，他们必须定义返回 self 的 __iter__ 方法。__reversed__(self)实现当reversed() 被调用时的行为。应该返回列表的反转版本。__contains__(self,item)当调用 in 和not in 来测试成员是否存在时候__contains__ 被定义。你问为什么这个不是序列协议的一部分？那是因为当__contains__ 没有被定义的时候，Python会迭代这个序列并且当找到需要的值时会返回True 。__concat__(self,other)最终，你可以通过 __concat__ 来定义当用其他的来连接两个序列时候的行为。当+ 操作符被调用时候会返回一个 self 和 other.__concat__ 被调用后的结果产生的新序列。

一个例子¶

在我们的例子中，让我们看一看你可能在其他语言中 用到的函数构造语句的实现(比如 Haskell)。

class FunctionalList:'''一个封装了一些附加魔术方法比如 head, tail, init, last, drop, 和take的列表类。'''def __init__(self, values=None):if values is None:    self.values = []else:    self.values = valuesdef __len__(self):    return len(self.values)def __getitem__(self, key):    #如果键的类型或者值无效，列表值将会抛出错误    return self.values[key]def __setitem__(self, key, value):    self.values[key] = valuedef __delitem__(self, key):    del self.values[key]def __iter__(self):    return iter(self.values)def __reversed__(self):    return reversed(self.values)def append(self, value):    self.values.append(value)def head(self):    return self.values[0]def tail(self):    return self.values[1:]def init(self):    #返回一直到末尾的所有元素    return self.values[:-1]def last(self):    #返回末尾元素    return self.values[-1]def drop(self, n):    #返回除前n个外的所有元素    return self.values[n:]def take(self, n):    #返回前n个元素    return self.values[:n]

注：setitem只能设置已有条目，不能设置新条目