Quizás haya oído que las funciones con yield se denominan generator (generador) en Python. ¿Qué es un generator?
Primero dejemos de lado generator y usemos un problema de programación común para mostrar el concepto de yield.
Cómo generar la secuencia de Fibonacci
La secuencia de Fibonacci es una secuencia recursiva muy simple. Excepto por el primer y segundo número, cualquier número se puede obtener sumando los dos anteriores. Usar un programa de computadora para generar los primeros N números de la secuencia de Fibonacci es un problema muy simple, y muchos principiantes pueden escribir fácilmente la siguiente función:
Listado 1. Salida simple de los primeros N números de la secuencia de Fibonacci
Ejemplo
Al ejecutar el código anterior, podemos obtener la siguiente salida:
1 1 2 3 5
El resultado no tiene problema, pero los desarrolladores con experiencia señalarán que imprimir números directamente con print en la función fab hace que la función tenga poca reutilización, porque la función fab devuelve None y otras funciones no pueden obtener la secuencia generada por esta función.
Para mejorar la reutilización de la función fab, es mejor no imprimir directamente la secuencia, sino devolver una List. A continuación se muestra la segunda versión de la función fab reescrita:
Listado 2. Segunda versión para generar los primeros N números de la secuencia de Fibonacci
Ejemplo
Se puede usar la siguiente forma para imprimir la List devuelta por la función fab:
1 1 2 3 5
La función fab reescrita cumple con los requisitos de reutilización al devolver una List, pero los desarrolladores con más experiencia señalarán que la memoria ocupada durante la ejecución aumenta a medida que aumenta el parámetro max. Si se quiere controlar el uso de memoria, es mejor no usar List
para guardar los resultados intermedios, sino iterar mediante un objeto iterable. Por ejemplo, en Python 2.x, el código:
Listado 3. Iterar mediante un objeto iterable
for i in range(1000): pass
genera una List con 1000 elementos, mientras que el código:
for i in xrange(1000): pass
no genera una List con 1000 elementos, sino que devuelve el siguiente valor en cada iteración, ocupando muy poco espacio de memoria. Porque xrange no devuelve una List, sino un objeto iterable.
Aprovechando iterable, podemos reescribir la función fab como una clase que soporta iterable. A continuación se muestra la tercera versión de Fab:
Listado 4. Tercera versión
Ejemplo
La clase Fab devuelve continuamente el siguiente número de la secuencia mediante next(), y el uso de memoria siempre es constante:
1 1 2 3 5
Sin embargo, esta versión reescrita con class tiene un código mucho menos conciso que la primera versión de la función fab. Si queremos mantener la simplicidad de la primera versión de fab y al mismo tiempo obtener el efecto de iterable, yield resulta útil:
Listado 5. Cuarta versión usando yield
Ejemplo
En comparación con la primera versión, la cuarta versión de fab solo cambia print b por yield b, logrando así el efecto iterable mientras mantiene la simplicidad.
Llamar a la cuarta versión de fab es exactamente igual que llamar a la segunda versión de fab:
1 1 2 3 5
En términos simples, la función de yield es convertir una función en un generator. Una función con yield ya no es una función común; el intérprete de Python la trata como un generator. Llamar a fab(5) no ejecuta la función fab, sino que devuelve un objeto iterable. Durante la ejecución del bucle for, cada iteración ejecuta el código dentro de la función fab. Cuando se llega a yield b, la función fab devuelve un valor de iteración. En la siguiente iteración, el código continúa ejecutándose desde la siguiente instrucción después de yield b, y las variables locales de la función parecen exactamente iguales a las de la última interrupción. Así, la función continúa ejecutándose hasta que se encuentra otro yield.
También se puede llamar manualmente al método next() de fab(5) (porque fab(5) es un objeto generator, y este objeto tiene el método next()), lo que permite ver el flujo de ejecución de fab con mayor claridad:
Listado 6. Flujo de ejecución
Cuando la función termina su ejecución, el generator lanza automáticamente la excepción StopIteration, lo que indica que la iteración ha terminado. En un bucle for, no es necesario manejar la excepción StopIteration; el bucle termina normalmente.
Podemos llegar a las siguientes conclusiones:
Una función con yield es un generator. A diferencia de una función normal, la creación de un generator parece una llamada a función, pero no ejecuta ningún código de la función hasta que se le llama a next() (en un bucle for, next() se llama automáticamente). Aunque el flujo de ejecución sigue el flujo de la función, se interrumpe cada vez que se encuentra una declaración yield y se devuelve un valor de iteración. En la siguiente ejecución, el código continúa desde la siguiente instrucción de yield. Parece como si una función fuera interrumpida varias veces por yield durante su ejecución normal, y cada interrupción devuelve el valor de iteración actual mediante yield.
Las ventajas de yield son evidentes. Convertir una función en un generator otorga capacidad de iteración. En comparación con usar una instancia de clase para guardar el estado y calcular el siguiente valor de next(), no solo el código es más conciso, sino que el flujo de ejecución es especialmente claro.
¿Cómo determinar si una función es una función generator especial? Se puede usar isgeneratorfunction para determinarlo:
Listado 7. Usar isgeneratorfunction para determinar
Hay que tener cuidado de distinguir entre fab y fab(5). fab es una generator function, mientras que fab(5) es un generator devuelto al llamar a fab, similar a la diferencia entre la definición de una clase y una instancia de la clase:
Listado 8. Definición de clase e instancia de clase
Cada llamada a la función fab genera una nueva instancia de generator, y las instancias no se afectan entre sí:
El papel de return
En una generator function, si no hay return, por defecto se ejecuta hasta el final de la función. Si se ejecuta return durante el proceso, se lanza directamente StopIteration para terminar la iteración.
Otro ejemplo
Otro ejemplo de yield proviene de la lectura de archivos. Si se llama directamente al método read() de un objeto de archivo, puede causar un uso impredecible de memoria. Un buen método es usar un búfer de longitud fija para leer continuamente el contenido del archivo. Con yield, ya no necesitamos escribir una clase de iteración para leer archivos, y podemos implementar fácilmente la lectura de archivos:
Listado 9. Otro ejemplo de yield
Ejemplo
Lo anterior solo presenta brevemente los conceptos y usos básicos de yield. yield tiene usos más potentes en Python 3, que discutiremos en artículos posteriores.
Nota: todo el código de este artículo se ha probado en Python 2.7.
Dirección original: https://www.ibm.com/developerworks/cn/opensource/os-cn-python-yield/