Создайте базовый итератор Python

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

Ответы

Ответ 1

Объекты итераторов в python соответствуют протоколу итераторов, что в основном означает, что они предоставляют два метода: __iter__() и __next__(). __iter__ возвращает объект итератора и неявно вызывается в начале цикла. Метод __next__() возвращает следующее значение и неявно вызывается при каждом увеличении цикла. __next__() вызывает исключение 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)

Это напечатает:

3
4
5
6
7
8

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

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

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

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

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

Ответ 2

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

Примеры:

# 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__ (который должен возвращать новый итератор, идущий в обратном направлении); и итеративный метод getitem (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

Как выбрать, какой использовать? Это в основном дело вкуса. Чаще всего я вижу два метода: генераторы и протокол итератора, а также гибрид (__iter__ возвращает генератор).

Выражения генератора полезны для замены списочных представлений (они ленивы и поэтому могут экономить ресурсы).

Если требуется совместимость с более ранними версиями Python 2.x, используйте __getitem__.

Ответ 3

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

Уступать

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

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

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

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

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

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

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

Ответ 4

Я вижу, что некоторые из вас делают 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

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

Ответ 5

Этот вопрос касается итерируемых объектов, а не об итераторах. В 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)

Ответ 6

Все ответы на этой странице действительно хороши для сложного объекта. Но для тех, которые содержат встроенные итерируемые типы в качестве атрибутов, таких как 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 self.string)
        # or simply
        return self.string.__iter__()
        # also
        return iter(self.string)

Может использоваться как:

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

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

Ответ 7

Это итеративная функция без 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)  

Тест

for i in count(1,10):
    print(i)
1
2
3
4
5
6
7
8
9

Ответ 8

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

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]

Ответ 9

Вдохновленный ответом Мэтта Грегори, здесь есть более сложный итератор, который будет возвращать a, b,..., z, aa, ab,..., zz, aaa, aab,..., 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)