迭代器、生成器和可迭代对象

原创

罗罗攀攀 2022-09-01 16:13:04 ©著作权

文章标签 迭代器生成器魔术方法 文章分类 后端开发

©著作权归作者所有：来自51CTO博客作者罗罗攀攀的原创作品，请联系作者获取转载授权，否则将追究法律责任

迭代器、生成器和可迭代对象_魔术方法

前言

上次我们简单分享了迭代器和生成器，本次我们来更加深入的了解相关概念和使用方法，希望能对你有所帮助。

自定义迭代器

首先，我们来看看怎么自定义迭代器，自定义迭代器的类需要下面几个组成。

（1）类中需要定义iter和next魔术方法。（2）iter魔术方法返回对象本身。（3）next方法返回下一个数据，如果没有数据，就报异常StopIteration。

class Test:

    def __init__(self):
        self.counter = 0

    def __iter__(self):
        return self

    def __next__(self):
        self.counter += 1
        if self.counter == 3:
            raise StopIteration
        return self.counter


t = Test()
print(next(t))
print(next(t))
print(next(t))

1
2
StopIteration

当然，我们可以直接使用for循环来调用这个迭代器对象。

for i in t:
     print(i)

1
2

for循环里面到底是怎么执行的了？首先for循环会先调用对象的iter魔术方法，返回一个迭代器对象，然后不断调用next魔术方法（异常就停止循环）。

生成器

我们之前学习过，函数中有yield关键字，那这个函数就是生成器。

def func():
    yield 1
    yield 2


f = func()
print(next(f))
print(next(f))

1
2

其实这个生成器对象内部其实是调用的生成器类generator创建的对象，生成器类的内部其实也声明了iter和next魔术方法。

生成器也完全符合迭代器声明的规则，所以，生成器也是一种特殊的迭代器。

可迭代对象

最后，我们再聊聊可迭代对象，我们都知道，列表就是可迭代对象。

l = [1, 2, 3]
for i in l:
    print(i)

字符串，字典等等能够循环的，都是可迭代对象。其定义是，如果类中有iter魔术方法，并且返回的是迭代器对象，那这个类创建的对象就是可迭代对象。

class Test:

    def __init__(self):
        self.counter = 0

    def __iter__(self):
        return self

    def __next__(self):
        self.counter += 1
        if self.counter == 3:
            raise StopIteration
        return self.counter


class Foo:
    def __iter__(self):
        return Test()


foo = Foo()
for item in foo:
    print(item)

1
2

这里的foo就是可迭代对象，当使用for循环时，先调用iter魔术方法，返回一个迭代器对象，接着就是不断的调用next魔术方法返回值。

我们可以验证下，列表是可迭代对象，那他就应该有iter方法，没有next方法。

l = [1, 2, 3]
print(dir(l))

#['__add__', '__class__', '__contains__', '__delattr__', '__delitem__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__getitem__', '__gt__', '__hash__', '__iadd__', '__imul__', '__init__', '__init_subclass__', '__iter__', '__le__', '__len__', '__lt__', '__mul__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__reversed__', '__rmul__', '__setattr__', '__setitem__', '__sizeof__', '__str__', '__subclasshook__', 'append', 'clear', 'copy', 'count', 'extend', 'index', 'insert', 'pop', 'remove', 'reverse', 'sort']

print(dir(l.__iter__()))

调用iter方法后，就会有iter和next方法了。

自定义range函数

学了这么多，我们来自定义一个range函数来巩固下学习内容。

class RangeIter:

    def __init__(self, num):
        self.num = num
        self.counter = -1

    def __iter__(self):
        return self

    def __next__(self):
        self.counter += 1
        if self.counter == self.num:
            raise StopIteration
        return self.counter


class Xrange:

    def __init__(self, maxnum):
        self.maxnum = maxnum

    def __iter__(self):
        return RangeIter(self.maxnum)

    
for i in Xrange(10):
    print(i)

生成器也可以实现该功能。

class Xrange:

    def __init__(self, maxnum):
        self.maxnum = maxnum

    def __iter__(self):
        counter = 0
        while counter < self.maxnum:
            yield counter
            counter += 1

for i in Xrange(5):
    print(i)