Boletos de avión

Un generator es una función o expresión que devuelve un tipo especial de iterador llamado generator iterator. Los Generator-iterators son perezosos: no almacenan sus values en memoria, sino que generan sus valores cuando se necesitan.

Una función generadora se ve como cualquier otra función, pero contiene una o más expresiones yield. Cada yield suspende la ejecución del código y guarda el estado de ejecución actual (incluidas todas las variables locales y las sentencias try). Cuando el generador se reanuda, retoma el estado desde donde se suspendió, a diferencia de las funciones normales, que se reinician con cada llamada.

Construir un generador

Los generadores se construyen de forma muy parecida a otras funciones con bucles o recursivas, pero requieren una expresión yield, que exploraremos con más detalle un poco más adelante.

Un ejemplo es una función que devuelve los cuadrados de un array de números dado. Tal como está escrita, se deben procesar todos los valores antes de poder devolver alguno:

>>> def squares(list_of_numbers):
...     squares = []
...     for number in list_of_numbers:
...         squares.append(number ** 2)
...     return squares

Puedes convertir esa función en un generador así:

>>> def squares_generator(list_of_numbers):
...     for number in list_of_numbers:
...         yield number ** 2

La razón de esto es que usas un generador cuando no necesitas producir todos los valores a la vez. Esto ahorra memoria y poder de procesamiento, ya que solo se calcula el valor en el que estás trabajando en ese momento.

Usar un generador

Los generadores pueden usarse en lugar de la mayoría de los iterables en Python. Esto incluye funciones u objetos que requieren un iterable/iterator como argumento.

Para usar el generador squares_generator():

>>> squared_numbers = squares_generator([1, 2, 3, 4])

>>> for square in squared_numbers:
...     print(square)
...
1
4
9
16

Los valores dentro de un generator también se pueden producir u obtener mediante la función next(). next() llama al método __next__() de un objeto iterador generador, «avanzando» o evaluando el código hasta su expresión yield, que luego «cede» o devuelve un valor:

>>> squared_numbers = squares_generator([1, 2])

>>> next(squared_numbers)
1
>>> next(squared_numbers)
4

Cuando un generator-iterator se consume por completo y no le quedan más valores por devolver, lanza un error StopIteration.

>>> next(squared_numbers)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
StopIteration

La expresión yield

La expresión yield es muy similar a la expresión return. A diferencia de la expresión return, yield entrega valores a quien llama en un punto específico, suspendiendo la evaluación o el retorno de cualquier valor adicional hasta que se soliciten. Cuando se evalúa yield, pausa la ejecución de la función que lo contiene y devuelve los valores de la función en ese momento. Luego la función se mantiene en el ámbito y, cuando se llama a __next__(), la ejecución se reanuda hasta que se vuelve a encontrar yield.

>>> def infinite_sequence():
...     current_number = 0
...     while True:
...         yield current_number
...         current_number += 1

>>> lets_try = infinite_sequence()
>>> lets_try.__next__()
0
>>> lets_try.__next__()
1

¿Por qué crear un generador?

Los generadores son útiles en muchas aplicaciones.

Cuando trabajas con una colección de valores potencialmente grande, quizá no quieras ponerlos todos en memoria. Puedes usar un generador para trabajar con datos más grandes poco a poco, lo que ahorra memoria y mejora el rendimiento.

Los generadores también son muy útiles cuando un proceso o cálculo es complejo, costoso o infinito:

>>> def infinite_sequence():
...     current_number = 0
...     while True:
...         yield current_number
...         current_number += 1

Ahora, cada vez que se llama a __next__() en el objeto infinite_sequence, devolverá el número anterior + 1.