Создание базового итератора Python

Как создать итеративную функцию (или объект итератора) в python?

468
iterator object python

9 ответов

объекты итератора в python соответствуют протоколу итератора, что в основном означает, что они предоставляют два метода:__iter__() и next(). The __iter__ возвращает объект итератора и неявно вызывается в начале циклов. The next() метод возвращает следующее значение и неявно вызывается на каждом шаге цикла. next() вызывает исключение StopIteration, когда больше нет возвращаемого значения, которое неявно захватывается циклическими конструкциями для остановки итерация.

вот простой пример счетчика:

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

    def __iter__(self):
        return self

    def next(self): # Python 3: def __next__(self)
        if self.current > self.high:
            raise StopIteration
        else:
            self.current += 1
            return self.current - 1


for c in Counter(3, 8):
    print c

это будет напечатано:

3
4
5
6
7
8

это легче написать с помощью генератора, как описано в предыдущем ответе:

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

for c in counter(3, 8):
    print c

печатный выход будет таким же. Под капотом объект генератора поддерживает протокол итератора и делает что-то примерно похожее на счетчик классов.

статья Дэвида Мерца,итераторы и простые генераторы это довольно хорошее введение.

543

существует четыре способа построения итеративной функции:

примеры:

# 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

чтобы увидеть все четыре метода в действии:

for iterator in uc_gen, uc_genexp, uc_iter, uc_getitem:
    for ch in iterator('abcde'):
        print ch,
    print

что приводит к:

A B C D E
A B C D E
A B C D E
A B C D E

Примечание:

два типа генераторов (uc_gen и uc_genexp) не может быть reversed(); простой итератор (uc_iter) потребуется __reversed__ magic method (который должен возвращать новый итератор, который идет назад); и 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)

чтобы ответить на вторичный вопрос полковника паники о бесконечном лениво оцененном итераторе, вот эти примеры, используя каждый из четырех методов выше:

# 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

результатом которого (по крайней мере для моего образца):

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
342

прежде всего модуль itertools невероятно полезно для всех видов случаев, в которых итератор был бы полезен, но вот все, что вам нужно для создания итератора в python:

доходность

разве это не круто? Выход можно использовать для замены нормального возвращение в функции. Он возвращает объект точно так же, но вместо уничтожения состояния и выхода он сохраняет состояние, когда вы хотите выполнить следующий итерация. Вот пример этого в действии, вытащенном непосредственно из список функций itertools:

 def count(n=0):
     while True:
         yield n
         n += 1

как указано в описании функций (это count () функция из модуля itertools...), он создает итератор, который возвращает последовательные целые числа, начинающиеся с n.

выражений генератор есть куча (огромная червей!). Они могут быть использованы вместо список Понимание для сохранения памяти (понимание списка создайте список в памяти, который будет уничтожен после использования, если не назначен переменной, но выражения генератора могут создать объект генератора... это причудливый способ сказать Iterator). Вот пример определения выражения генератора:

gen = (n for n in xrange(0,11))

Это очень похоже на наше определение итератора выше, за исключением того, что полный диапазон предопределен быть между 0 и 10.

Я только что нашел xrange() (удивительно, что я не видел его раньше...) и добавил его к приведенному выше примеру. xrange() является итерационной версией range () который имеет то преимущество, что не создает список. Было бы очень полезно, если бы у вас был гигантский корпус данных для итерации и было бы так много памяти для этого.

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

конечно, здесь можно также напрямую сделать генератор, но для более сложных классов, может быть полезно.

85

этот вопрос касается итерационных объектов, а не итераторов. В Python, последовательности тоже итерируемые так, чтобы сделать класс Iterable является, чтобы сделать его вести себя как последовательность, т. е. дать ему __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)
8

это функция повторяемое без yield. Он использует iter функция и закрытие, которое сохраняет его состояние в изменяемом (list) в заключительной области для python 2. 

def count(low, high):
    counter = [0]
    def tmp():
        val = low + counter[0]
        if val < high:
            counter[0] += 1
            return val
        return None
    return iter(tmp, None)

для Python 3 состояние закрытия сохраняется в неизменяемом в охватывающей области и nonlocal используется в локальной области для обновления переменной состояния. 

def count(low, high):
    counter = 0
    def tmp():
        nonlocal counter
        val = low + counter
        if val < high:
            counter += 1
            return val
        return None
    return iter(tmp, None)
3

Если вы ищете что-то короткое и простое, возможно, Вам будет достаточно:

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

    def __iter__(self):
        return iter(self.data)

пример использования:

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

In [4]: [i for i in a]
Out[4]: [2, 3, 4]
1

все ответы на этой странице действительно отлично подходят для сложного объекта. Но для тех, кто содержит встроенные итерационные типы в качестве атрибутов, например str, list, set или dict, или любая реализация 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 string)

его можно использовать как:

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

# prints
# a
# b
# c
# d
# e
1

вдохновленный ответом Мэтта Грегори здесь немного более сложный итератор, который вернет a, b,..., z, aa, ab,...,ЗЗ ААА,Ааб..., zzy, zzz

    class AlphaCounter:
    def __init__(self, low, high):
        self.current = low
        self.high = high

    def __iter__(self):
        return self

    def __next__(self): # Python 3: def __next__(self)
        alpha = ' abcdefghijklmnopqrstuvwxyz'
        n_current = sum([(alpha.find(self.current[x])* 26**(len(self.current)-x-1)) for x in range(len(self.current))])
        n_high = sum([(alpha.find(self.high[x])* 26**(len(self.high)-x-1)) for x in range(len(self.high))])
        if n_current > n_high:
            raise StopIteration
        else:
            increment = True
            ret = ''
            for x in self.current[::-1]:
                if 'z' == x:
                    if increment:
                        ret += 'a'
                    else:
                        ret += 'z'
                else:
                    if increment:
                        ret += alpha[alpha.find(x)+1]
                        increment = False
                    else:
                        ret += x
            if increment:
                ret += 'a'
            tmp = self.current
            self.current = ret[::-1]
            return tmp

for c in AlphaCounter('a', 'zzz'):
    print(c)
0