流畅的迭代器(一)

流畅的迭代器01.png

通过一个简单类的实现及优化过程,慢慢深入迭代的概念。

该类的主要功能如下:

  • 传入一段话
  • 可以迭代输出这段话的中所包含的每个词

第一版单词序列

这一版的单词序列实现如下两个接口:

  • __getitem__ 根据索引获取数据
  • __len__ 获取序列的长度
import re
import reprlib

RE_WORD = re.compile(r'\w+')


class Sentence(object):
    def __init__(self, text):
        self.text = text
        self.words = RE_WORD.findall(text)

    def __getitem__(self, index):
        # 根据索引获取数据
        return self.words[index]

    def __len__(self):
        # 获取序列的长度
        return len(self.words)

    def __repr__(self):
        # reprlib.repr(xxx) 当xxx长度过长时会用...自动省略
        return 'Sentence(%s)' % reprlib.repr(self.text)
In [1]: s = Sentence('"The time has come," the Walrus said,')          
                                                                       
In [2]: s                                                              
Out[2]: Sentence('"The time ha... Walrus said,')                       
                                                                       
In [3]: s[0]                                                           
Out[3]: 'The'                                                          
                                                                       
In [4]: for word in s:                                                
   ...:     print(word)                                               
   ...:                                                               
The                                                                    
time                                                                   
has                                                                    
come                                                                   
the                                                                    
Walrus                                                                 
said                                                                   

当我们使用 for 循环去迭代的时候,for 循环会先去使用 iter() 函数从目标对象中获取一个迭代器,然后对此迭代器进行迭代。

所以,我们还可以这么去做迭代:

In [5]: sw = Sentence('"The time has come," the Walrus said,')

In [6]: sw_it = iter(sw)

In [7]: while True:
   ...:     try:
   ...:         print(next(sw_it))
   ...:     except StopIteration:
   ...:         del sw_it
   ...:         break
   ...:
The
time
has
come
the
Walrus
said

这种写法,把 for 循环背后的迭代器显式地展现了出来。

iter() 获取迭代器的过程中会进行如下几个主要的操作:

  • 检查有没有实现 __iter__ 方法,如果有则通过该方法获取一个迭代器对象。
  • 如果没有实现 __iter__ 方法,那就会去找有没有实现 __getitem__ 方法,如果实现了,Python 会创建一个迭代器,该迭代器尝试从索引0开始返回数据(必须从0开始)。
  • 如果 __getitem__ 也没有实现,那就抛出 TypeError 异常,表明 C object is not iterable

注意: 如果我们需要自己实现一个迭代器,尽量去实现它的 __iter__ 方法,这是现在的标准做法,__getitem__ 只是为了兼容以前的代码做的补丁。

其实看源码中,对于迭代器对象的检查是这么做的:

class Iterator(Iterable):

    __slots__ = ()

    @abstractmethod
    def __next__(self):
        'Return the next item from the iterator. When exhausted, raise StopIteration'
        raise StopIteration

    def __iter__(self):
        return self

    @classmethod
    def __subclasshook__(cls, C):
        if cls is Iterator:
            return _check_methods(C, '__iter__', '__next__')
        return NotImplemented

__subclasshook__ 方法所示,通过检查有没有 __iter____next__ 两个方法来判断是否为迭代器。

因为我们的 Sentence 类是通过实现 __getitem__ 的接口来获取迭代器的,所以虽然既能使用 for 循环迭代,又可以通过索引获取对应值,但是它本身并不可迭代,无法通过以下代码的验证:

from collections.abc import Iterable


issubclass(list, Iterable)  # True
issubclass(Sentence, Iterable)  # False

isinstance(list(), Iterable)  # True
isinstance(Sentence(''), Iterable)  # False

s_it = iter(Sentence(''))
isinstance(s_it, Iterable)  # True

总结

  1. 使用 iter() 内置函数可以获取迭代器的对象。
  2. 如果对象实现了能返回迭代器的
    __iter__ 方法,那么对象就是可迭代的。
  3. 另外,如果实现了 __getitem__
    法,而且其参数是从零开始的索引,这种对象也可以迭代,但不属于可迭代对象。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,110评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,443评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,474评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,881评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,902评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,698评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,418评论 3 419
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,332评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,796评论 1 316
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,968评论 3 337
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,110评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,792评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,455评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,003评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,130评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,348评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,047评论 2 355