构建一个基本的Python迭代器

akd*_*dom 545 python iterator object

如何在python中创建迭代函数(或迭代器对象)?

ars*_*ars 622

python中的迭代器对象符合迭代器协议,这基本上意味着它们提供了两种方法:__iter__()__next__().在__iter__返回迭代器对象,并隐式调用在循环的开始.该__next__()方法返回下一个值,并在每个循环增量处隐式调用. __iter__()当没有更多值返回时引发StopIteration异常,循环结构隐式捕获该异常以停止迭代.

这是一个简单的计数器示例:

class Counter:
    def __init__(self, low, high):
        self.current = low - 1
        self.high = high

    def __iter__(self):
        return self

    def __next__(self): # Python 2: def next(self)
        self.current += 1
        if self.current < self.high:
            return self.current
        raise StopIteration


for c in Counter(3, 9):
    print(c)
Run Code Online (Sandbox Code Playgroud)

这将打印:

3
4
5
6
7
8
Run Code Online (Sandbox Code Playgroud)

使用生成器更容易编写,如前面的答案所述:

def counter(low, high):
    current = low
    while current < high:
        yield current
        current += 1

for c in counter(3, 9):
    print(c)
Run Code Online (Sandbox Code Playgroud)

打印输出将是相同的.在引擎盖下,生成器对象支持迭代器协议,并执行与类Counter类似的操作.

David Mertz的文章,Iterators和Simple Generators,是一个非常好的介绍.

  • 不,迭代器应该返回自己。迭代器返回迭代器,但迭代器不应该实现`__next__`。`counter` 是一个迭代器,但它不是一个序列。它不存储其值。例如,您不应该在双重嵌套的 for 循环中使用计数器。 (17认同)
  • @Curt:绝对不是。Counter是一个迭代器,迭代器只应该被迭代一次。如果您在__iter__中重置self.current,则Counter上的嵌套循环将被完全破坏,并且会违反各种假定的迭代器行为(在其上调用iter是幂等的)。如果您希望能够多次迭代`ctr`,则它必须是非迭代器可迭代的,每次调用`__iter__`时它将返回一个全新的迭代器。尝试混合匹配(调用__iter__时隐式重置的迭代器)违反了协议。 (5认同)
  • 这主要是一个很好的答案,但它返回自我的事实有点不太理想.例如,如果您在双嵌套for循环中使用相同的计数器对象,则可能无法获得您所指的行为. (4认同)
  • 在Counter示例中,self.current应该在`__iter__`中分配(除了`__init__`).否则,对象只能迭代一次.例如,如果你说'ctr = Counters(3,8)`,那么你不能多次在ctr`中使用`for c'. (4认同)
  • 例如,如果`Counter`是不可迭代的迭代器,则应完全删除`__next__` /`next`的定义,并可能将`__iter__`重新定义为与上述生成器具有相同形式的生成器函数。在此答案的末尾(除了不是来自__iter__的参数的界限,它们将是保存在self上并从__iter__的self进行访问的__init__的参数)。 (2认同)

Eth*_*man 396

有四种方法可以构建迭代函数:

例子:

# generator
def uc_gen(text):
    for char in text:
        yield char.upper()

# generator expression
def uc_genexp(text):
    return (char.upper() for char in text)

# iterator protocol
class uc_iter():
    def __init__(self, text):
        self.text = text
        self.index = 0
    def __iter__(self):
        return self
    def __next__(self):
        try:
            result = self.text[self.index].upper()
        except IndexError:
            raise StopIteration
        self.index += 1
        return result

# getitem method
class uc_getitem():
    def __init__(self, text):
        self.text = text
    def __getitem__(self, index):
        result = self.text[index].upper()
        return result
Run Code Online (Sandbox Code Playgroud)

要查看所有四种方法:

for iterator in uc_gen, uc_genexp, uc_iter, uc_getitem:
    for ch in iterator('abcde'):
        print ch,
    print
Run Code Online (Sandbox Code Playgroud)

结果如下:

A B C D E
A B C D E
A B C D E
A B C D E
Run Code Online (Sandbox Code Playgroud)

注意:

两种发电机类型(uc_genuc_genexp)不能reversed(); plain iterator(uc_iter)需要__reversed__magic方法(必须返回一个向后的新迭代器); 并且getitem iteratable(uc_getitem)必须具有__len__魔术方法:

    # for uc_iter
    def __reversed__(self):
        return reversed(self.text)

    # for uc_getitem
    def __len__(self)
        return len(self.text)
Run Code Online (Sandbox Code Playgroud)

要回答Panic上校关于无限延迟评估迭代器的第二个问题,下面是这些例子,使用上述四种方法中的每一种:

# generator
def even_gen():
    result = 0
    while True:
        yield result
        result += 2


# generator expression
def even_genexp():
    return (num for num in even_gen())  # or even_iter or even_getitem
                                        # not much value under these circumstances

# iterator protocol
class even_iter():
    def __init__(self):
        self.value = 0
    def __iter__(self):
        return self
    def __next__(self):
        next_value = self.value
        self.value += 2
        return next_value

# getitem method
class even_getitem():
    def __getitem__(self, index):
        return index * 2

import random
for iterator in even_gen, even_genexp, even_iter, even_getitem:
    limit = random.randint(15, 30)
    count = 0
    for even in iterator():
        print even,
        count += 1
        if count >= limit:
            break
    print
Run Code Online (Sandbox Code Playgroud)

这导致(至少我的样本运行):

0 2 4 6 8 10 12 14 16 18 20 22 24 26 28 30 32 34 36 38 40 42 44 46 48 50 52 54
0 2 4 6 8 10 12 14 16 18 20 22 24 26 28 30 32 34 36 38
0 2 4 6 8 10 12 14 16 18 20 22 24 26 28 30
0 2 4 6 8 10 12 14 16 18 20 22 24 26 28 30 32
Run Code Online (Sandbox Code Playgroud)

  • 我喜欢这个摘要,因为它是完整的.这三种方式(yield,generator表达式和迭代器)基本相同,尽管有些方法比其他方式更方便.yield运算符捕获包含状态的"continuation"(例如我们最多的索引).信息保存在延续的"闭包"中.迭代器方法将相同的信息保存在迭代器的字段中,这与闭包基本相同.__getitem__方法有点不同,因为它索引内容并且本质上不是迭代的. (4认同)
  • 你可以在 `__iter__` 中设置 `self.index = 0`,这样你就可以迭代多次。否则你不能。 (3认同)
  • @metaperl:实际上是.在上述所有四种情况中,您都可以使用相同的代码进行迭代. (2认同)

akd*_*dom 102

首先,itertools模块对于迭代器很有用的各种情况非常有用,但是这里只需要在python中创建一个迭代器:

那不是很酷吗?Yield可用于替换函数中的正常返回.它返回的对象是相同的,但它不是破坏状态和退出,而是为你想要执行下一次迭代时保存状态.以下是直接从itertools函数列表中提取的操作示例:

def count(n=0):
    while True:
        yield n
        n += 1
Run Code Online (Sandbox Code Playgroud)

正如函数描述中所述(它是来自itertools模块的count()函数...),它产生一个迭代器,它返回以n开头的连续整数.

生成器表达式是另一种蠕虫(真棒蠕虫!).可以使用它们代替List Comprehension来节省内存(列表推导在内存中创建一个列表,如果没有分配给变量,在使用后会被销毁,但生成器表达式可以创建一个生成器对象...这是一种奇特的方式说Iterator).以下是生成器表达式定义的示例:

gen = (n for n in xrange(0,11))
Run Code Online (Sandbox Code Playgroud)

这与上面的迭代器定义非常相似,只是整个范围预定在0到10之间.

我刚刚找到xrange()(我以前没见过它而感到惊讶......)并将它添加到上面的例子中. xrange()range()的可迭代版本,其优点是不预先构建列表.如果你有一个巨大的数据集来迭代并且只有这么多的内存来完成它将是非常有用的.

  • 从python 3.0开始,不再有xrange(),新的range()表现得像旧的xrange() (19认同)
  • 你应该仍然在2._中使用xrange,因为2to3会自动翻译它. (6认同)

Man*_*nux 99

我看到一些你做return self__iter__.我只是想指出,__iter__本身可以是一台发电机(从而消除了需要__next__和提高StopIteration例外)

class range:
  def __init__(self,a,b):
    self.a = a
    self.b = b
  def __iter__(self):
    i = self.a
    while i < self.b:
      yield i
      i+=1
Run Code Online (Sandbox Code Playgroud)

当然,这里也可以直接生成一个生成器,但对于更复杂的类,它可能很有用.

  • 大!在`__iter__`中只写`return self`就这么无聊.当我打算在其中尝试使用`yield`时,我发现你的代码正是我想要尝试的. (5认同)
  • @Lenna,它已经"实现"了,因为iter(self)返回一个迭代器,而不是一个范围实例. (4认同)
  • 要明确的是,这种方法使您的类“可迭代”,而不是“迭代器”。每次在类实例上调用“ iter”时,都会得到新鲜的“迭代器”,但它们本身并不是类的实例。 (4认同)
  • 但在这种情况下,如何实现`next()`?`return iter(self).next()`? (3认同)
  • 这是最简单的方法,不需要跟踪例如``self.current``或任何其他计数器.这应该是最受欢迎的答案! (3认同)

小智 12

这个问题是关于可迭代的对象,而不是迭代器.在Python中,序列也是可迭代的,因此制作可迭代类的一种方法是使其行为像序列,即给它__getitem____len__方法.我在Python 2和3上测试了这个.

class CustomRange:

    def __init__(self, low, high):
        self.low = low
        self.high = high

    def __getitem__(self, item):
        if item >= len(self):
            raise IndexError("CustomRange index out of range")
        return self.low + item

    def __len__(self):
        return self.high - self.low


cr = CustomRange(0, 10)
for i in cr:
    print(i)
Run Code Online (Sandbox Code Playgroud)

  • 它不必有`__len__()`方法。单独使用 __getitem__` 和预期的行为就足够了。 (2认同)

Dan*_*kin 6

如果您正在寻找简短而简单的东西,也许对您来说就足够了:

class A(object):
    def __init__(self, l):
        self.data = l

    def __iter__(self):
        return iter(self.data)
Run Code Online (Sandbox Code Playgroud)

用法示例:

In [3]: a = A([2,3,4])

In [4]: [i for i in a]
Out[4]: [2, 3, 4]
Run Code Online (Sandbox Code Playgroud)


小智 6

在您的类代码中包含以下代码。

 def __iter__(self):
        for x in self.iterable:
            yield x
Run Code Online (Sandbox Code Playgroud)

确保更换self.iterable为您迭代的可迭代对象。

这是一个示例代码

class someClass:
    def __init__(self,list):
        self.list = list
    def __iter__(self):
        for x in self.list:
            yield x


var = someClass([1,2,3,4,5])
for num in var: 
    print(num) 
Run Code Online (Sandbox Code Playgroud)

输出

1
2
3
4
5
Run Code Online (Sandbox Code Playgroud)

注意:由于字符串也是可迭代的,因此它们也可以用作类的参数

foo = someClass("Python")
for x in foo:
    print(x)
Run Code Online (Sandbox Code Playgroud)

输出

P
y
t
h
o
n
Run Code Online (Sandbox Code Playgroud)


Joh*_*ood 5

对于复杂的对象,此页面上的所有答案都非常有用。但对于含有内置的迭代类型,属性那些像strlistsetdict,或任何实现collections.Iterable,你可以在你的类省略某些事情。

class Test(object):
    def __init__(self, string):
        self.string = string

    def __iter__(self):
        # since your string is already iterable
        return (ch for ch in self.string)
        # or simply
        return self.string.__iter__()
        # also
        return iter(self.string)
Run Code Online (Sandbox Code Playgroud)

可以像这样使用:

for x in Test("abcde"):
    print(x)

# prints
# a
# b
# c
# d
# e
Run Code Online (Sandbox Code Playgroud)

  • 正如您所说,字符串已经是可迭代的,所以为什么要在中间添加额外的生成器表达式,而不是仅仅向字符串询问迭代器(生成器表达式在内部执行此操作):“return iter(self.string)”。 (2认同)