Python魔法方法-iter，next

作者: 莫忘初心_倒霉熊 | 来源:发表于2020-02-19 18:37 被阅读0次

Python魔法方法-__iter__，__next__
【Python入门】15.面向对象编程之定制类常用的定制方法
python中的迭代器和生成器
Python 进阶之迭代器, 生成器
Python如何自定义迭代器和可迭代对象
9-1 自定义迭代器
Python 迭代器和生成器
__iter__() 和 __next__()
迭代
python之__iter__函数与__next__函数

iter，next

__iter__将一个对象变为可迭代对象。
__next__将一个对象变为迭代器。

⚠️迭代器一定是可迭代的，所以一个对象如想成为一个迭代器，必须既要实现__iter__方法，也要实现__next__方法
iter(xxx)方法会自动调用xxx.__iter__方法
next(xxx)方法会自动调用xxx.__next__方法

看下面代码：

from collections.abc import Iterable
from collections.abc import Iterator

class Classmate(object):
    def __init__(self):
        self.names=list();

    def add(self,name):
        self.names.append(name)

classmate = Classmate()

classmate.add("张三")
classmate.add("李四")
classmate.add("王五")

print(isinstance(classmate,Iterable))       # 不是可迭代对象，输出 False
print(isinstance(classmate,Iterator))       # 不是迭代器，输出 False

for name in classmate:
    print(name)

# 报错
"""
Traceback (most recent call last):
  File "/Users/xxx/PycharmProjects/untitled/xxxx.py", line 20, in <module>
    for name in classmate:
TypeError: 'Classmate' object is not iterable
"""

代码中想要通过for循环，遍历打印classmate对象中的names列表，报错TypeError: 'Classmate' object is not iterable，因为classmate对象不是一个可迭代对象。那如何将其变成可迭代对象呢？

如下修改代码：

from collections.abc import Iterable
from collections.abc import Iterator

class Classmate(object):
    def __init__(self):
        self.names=list();

    def add(self,name):
        self.names.append(name)

    def __iter__(self):
        """如果想要一个对象成为一个可迭代对象，既可以使用for，那么必须实现__iter__方法"""
        pass

classmate = Classmate()

classmate.add("张三")
classmate.add("李四")
classmate.add("王五")

print(isinstance(classmate,Iterable))       # 是可迭代对象，输出 True
print(isinstance(classmate,Iterator))       # 不是迭代器，输出 False

for name in classmate:
    print(name)

# 报错
"""
Traceback (most recent call last):
  File "/Users/xxx/PycharmProjects/untitled/xxxxx.py", line 23, in <module>
    for name in classmate:
TypeError: iter() returned non-iterator of type 'NoneType'
"""

可以看到，修改后

print(isinstance(classmate,Iterable))

输出 True,说明classmate已经是可迭代对象了。但是依然报错了TypeError: iter() returned non-iterator of type 'NoneType'，这是因为classmate对象的__iter__必须要返回一个拥有__iter__和__next__方法的对象的引用。

再次修改代码：

from collections.abc import Iterable
from collections.abc import Iterator

class Classmate(object):
    def __init__(self):
        self.names=list();

    def add(self,name):
        self.names.append(name)

    def __iter__(self):
        """如果想要一个对象成为一个可迭代对象，既可以使用for，那么必须实现__iter__方法"""
        return ClassmateIterator()

class ClassmateIterator(object):
    def __iter__(self):
        pass

    def __next__(self):
        pass

classmate = Classmate()

classmate.add("张三")
classmate.add("李四")
classmate.add("王五")

print(isinstance(classmate,Iterable))       # 是可迭代对象，输出 True
print(isinstance(classmate,Iterator))       # 不是迭代器，输出 False

for name in classmate:
    print(name)

运行程序，发现可以正常运行，控制台一直输出None，这是因为没有设置迭代器返回的条件。

继续修改代码，如下：

from collections.abc import Iterable
from collections.abc import Iterator

class Classmate(object):
    def __init__(self):
        self.names=list();

    def add(self,name):
        self.names.append(name)

    def __iter__(self):
        """如果想要一个对象成为一个可迭代对象，既可以使用for，那么必须实现__iter__方法"""
        return ClassmateIterator(self)

class ClassmateIterator(object):
    def __init__(self,obj):
        self.obj = obj
        self.index = 0

    def __iter__(self):
        pass

    def __next__(self):
        if self.index<len(self.obj.names):
            ret = self.obj.names[self.index]
            self.index += 1
            return ret
        else:
            raise StopIteration

classmate = Classmate()

classmate.add("张三")
classmate.add("李四")
classmate.add("王五")

print(isinstance(classmate,Iterable))       # 是可迭代对象，输出 True
print(isinstance(classmate,Iterator))       # 不是迭代器，输出 False

for name in classmate:
    print(name)

# 张三
# 李四
# 王五

扩展

可能有的人，会说可不可以把类Classmate 和类ClassmateIterator合并呢？如下：

from collections.abc import Iterable
from collections.abc import Iterator

class Classmate(object):
    def __init__(self):
        self.names=list()
        self.index = 0

    def add(self,name):
        self.names.append(name)

    def __iter__(self):
        """如果想要一个对象成为一个可迭代对象，既可以使用for，那么必须实现__iter__方法"""
        return self

    def __next__(self):
        if self.index<len(self.names):
            ret = self.names[self.index]
            self.index += 1
            return ret
        else:
            raise StopIteration

classmate = Classmate()

classmate.add("张三")
classmate.add("李四")
classmate.add("王五")

print(isinstance(classmate,Iterable))       # 是可迭代对象，输出 True
print(isinstance(classmate,Iterator))       # 是迭代器，输出 True

for name in classmate:
    print(name)

# 张三
# 李四
# 王五

⚠️ 这样看起来并没有什么错误，输出的结果也是对的，但是如果想打印如下结果：

张三 张三
张三 李四
张三 王五
李四 张三
李四 李四
李四 王五
王五 张三
王五 李四
王五 王五

即：

for name in classmate:
    for name1 in classmate:
        print(name,name1)

# 张三 李四
# 张三 王五

发现输出的结果并不是我们预期的结果，这是因为俩个for循环所引用的迭代器是同一个所导致的（self.index在俩个for循环使用的是同一引用）

解决方案

那该如何解决呢？？？

将类Classmate 和类ClassmateIterator分开，即上文的代码。

from collections.abc import Iterable
from collections.abc import Iterator

class Classmate(object):
    def __init__(self):
        self.names=list();

    def add(self,name):
        self.names.append(name)

    def __iter__(self):
        """如果想要一个对象成为一个可迭代对象，既可以使用for，那么必须实现__iter__方法"""
        return ClassmateIterator(self)

class ClassmateIterator(object):
    def __init__(self,obj):
        self.obj = obj
        self.index = 0

    def __iter__(self):
        pass

    def __next__(self):
        if self.index<len(self.obj.names):
            ret = self.obj.names[self.index]
            self.index += 1
            return ret
        else:
            raise StopIteration

classmate = Classmate()

classmate.add("张三")
classmate.add("李四")
classmate.add("王五")

print(isinstance(classmate,Iterable))       # 是可迭代对象，输出 True
print(isinstance(classmate,Iterator))       # 不是迭代器，输出 False

for name in classmate:
    for name1 in classmate:
        print(name,name1)

使用self.names本身自己的迭代器返回

from collections.abc import Iterable
from collections.abc import Iterator

class Classmate(object):
    def __init__(self):
        self.names=list()
        self.index = 0

    def add(self,name):
        self.names.append(name)

    def __iter__(self):
        ii = iter(self.names)
        return ii

classmate = Classmate()

classmate.add("张三")
classmate.add("李四")
classmate.add("王五")

print(isinstance(classmate,Iterable))       # 是可迭代对象，输出 True
print(isinstance(classmate,Iterator))       # 不是迭代器，输出 False

for name in classmate:
    for name1 in classmate:
        print(name,name1)

利用yield生成器

from collections.abc import Iterable
from collections.abc import Iterator

class Classmate(object):
    def __init__(self):
        self.names=list()
        self.index = 0

    def add(self,name):
        self.names.append(name)

    def __iter__(self):
        for v in self.names:
            yield v

classmate = Classmate()

classmate.add("张三")
classmate.add("李四")
classmate.add("王五")

print(isinstance(classmate,Iterable))       # 是可迭代对象，输出 True
print(isinstance(classmate,Iterator))       # 不是迭代器，输出 False

for name in classmate:
    for name1 in classmate:
        print(name,name1)

Python魔法方法-__iter__，__next__
__iter__，__next__ __iter__将一个对象变为可迭代对象。__next__将一个对象变为迭代器...
【Python入门】15.面向对象编程之定制类常用的定制方法
摘要：常用定方法：__str__( )；__repr__( )；__iter__( )与__next__( )；_...
python中的迭代器和生成器
迭代器 python中只要实现了__iter__和__next__方法的对象都可以称之为迭代器，迭代器是一个带状态...
Python 进阶之迭代器, 生成器
一.迭代器(iterator) 迭代器 :任何实现了 __iter__ 和 __next__方法的对象都是迭代器....
Python如何自定义迭代器和可迭代对象
什么是迭代器和可迭代对象迭代器：凡是实现了__iter__()和__next__()（python2.x是nex...
9-1 自定义迭代器
迭代对象和迭代器是实现了 __iter__ 方法的而迭代器是额外还需要实现了 __next__ 方法的可迭代对...
Python 迭代器和生成器
1. 迭代器任何包含__iter__和__next__的函数将成为迭代器，而只包含__iter__的函数则是可迭...
__iter__() 和 __next__()
要实现一个可迭代对象，比如一个类想被用于 for ... in 循环，类似 list 或 tuple 那样，就必须...
迭代
Python中自定义迭代类型，需要包含自定义的__next__方法。__next__方法能够返回迭代类型的下一项，...
python之__iter__函数与__next__函数
https://blog.csdn.net/liweibin1994/article/details/77374854