Создайте базовый итератор Python
Вопрос
Как бы создать итеративную функцию (или объект-итератор) в python?
Решение
Объекты Iterator в python соответствуют протоколу iterator, что в основном означает, что они предоставляют два метода: __iter__()
и next()
.Тот Самый __iter__
возвращает объект iterator и неявно вызывается в начале циклов.Тот Самый 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
Печатный результат будет таким же.Под капотом объект generator поддерживает протокол iterator и делает что-то примерно похожее на счетчик классов.
Статья Дэвида Мерца, Итераторы и простые генераторы, является довольно хорошим введением.
Другие советы
Существует четыре способа построения итеративной функции:
- создайте генератор (использует ключевое слово yield)
- используйте выражение-генератор (genexp)
- создайте итератор (определяет
__iter__
и__next__
(илиnext
в Python 2.x)) - создайте класс, который Python может повторять самостоятельно (определяет
__getitem__
)
Примеры:
# 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
Прежде всего, модуль itertools невероятно полезен для всех видов случаев, в которых итератор был бы полезен, но вот все, что вам нужно для создания итератора в python:
уступать
Разве это не круто?Выход может быть использован для замены обычного Возврат в функции.Он возвращает объект точно таким же, но вместо уничтожения состояния и выхода он сохраняет состояние на тот момент, когда вы захотите выполнить следующую итерацию.Вот пример этого в действии, взятый непосредственно из список функций itertools:
def count(n=0):
while True:
yield n
n += 1
Как указано в описании функций (это количество() функция из модуля itertools ...) , она создает итератор, который возвращает последовательные целые числа, начинающиеся с n.
Выражения генератора это целая банка червей (потрясающих червей!).Они могут быть использованы вместо Понимание списка чтобы сэкономить память (понимание списка), создайте список в памяти, который уничтожается после использования, если не присвоен переменной, но выражения генератора могут создавать объект генератора...это причудливый способ сказать "Итератор").Вот пример определения выражения генератора:
gen = (n for n in xrange(0,11))
Это очень похоже на наше определение итератора выше, за исключением того, что полный диапазон заранее определен как находящийся между 0 и 10.
Я только что нашел xrange() (удивлен, что я не видел этого раньше ...) и добавил это к приведенному выше примеру. xrange() является повторяющейся версией диапазон () преимущество которого заключается в том, что он не создает список заранее.Это было бы очень полезно, если бы у вас был огромный объем данных для итерации и только столько памяти для этого.
Я вижу, как некоторые из вас делают 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
Конечно, здесь можно было бы с таким же успехом напрямую создать генератор, но для более сложных классов это может быть полезно.
Этот вопрос касается итеративных объектов, а не итераторов.В 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)
Это итеративная функция без 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
Все ответы на этой странице действительно хороши для сложного объекта.Но для тех, которые содержат встроенные повторяющиеся типы в качестве атрибутов, например 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
Если вы ищете что-то короткое и простое, возможно, вам этого будет достаточно:
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]
Вдохновленный ответом Мэтта Грегори, вот немного более сложный итератор, который вернет 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)