Acceso directo a Grokking yield

Cuando vea una función con instrucciones yield, aplique este truco fácil para entender lo que sucederá:

1. Inserte una línea result = [] al inicio de la función.
2. Sustitúyase cada yield expr por result.append(expr).
3. Inserte una línea return result en la parte inferior de la función.
4. Yay - no más yield declaraciones! Leer y descifrar el código.
5. Compare la función con la definición original.

Este truco puede darle una idea de la lógica detrás de la función, pero lo que realmente sucede con yield es significativamente diferente de lo que sucede en el enfoque basado en listas. En muchos casos, el enfoque de rendimiento será mucho más eficiente en memoria y también más rápido. En otros casos, este truco te atrapará en un bucle infinito, a pesar de que la función original funciona bien. Siga leyendo para obtener más información...

No confunda sus Iterables, Iteradores y Generadores

Primero, el iterador protocolo - cuando escribes

for x in mylist:
    ...loop body...

Python realiza los siguientes dos pasos:

1. Obtiene un iterador para mylist:

   Call iter(mylist) - > esto devuelve un objeto con un método next() (o __next__() en Python 3).

   [Este es el paso que la mayoría de la gente olvida decirte]

2. Utiliza el iterador para hacer un bucle sobre los elementos:

   Siga llamando al método next() en el iterador devuelto desde el paso 1. El valor devuelto desde next() es asignado a x y se ejecuta el cuerpo del bucle. Si se genera una excepción StopIteration desde next(), significa que no hay más valores en el iterador y se sale del bucle.

La verdad es que Python realiza los dos pasos anteriores cada vez que quiere hacer un bucle sobre el contenido de un objeto, por lo que podría ser un bucle for, pero también podría ser código como otherlist.extend(mylist) (donde otherlist es una lista de Python).

Aquí mylist es un iterable porque implementa el protocolo iterador. En una clase definida por el usuario, puede implementar el método __iter__() para hacer iterables las instancias de su clase. Este método debe devolver un iterador . Un iterador es un objeto con un método next(). Es posible implementar __iter__() y next() en la misma clase, y tener __iter__() return self. Esto funcionará para casos simples, pero no cuando desee dos iteradores en bucle sobre el mismo objeto al mismo tiempo.

Así que ese es el protocolo iterador, muchos objetos aplicar el presente protocolo:

1. Listas integradas, diccionarios, tuplas, conjuntos, archivos.
2. Clases definidas por el usuario que implementan __iter__().
3. Generadores.

Tenga en cuenta que un bucle for no sabe con qué tipo de objeto está tratando - simplemente sigue el protocolo iterador, y está feliz de obtener elemento tras elemento mientras llama next(). Las listas integradas devuelven sus elementos uno por uno, los diccionarios devuelven las claves una por una, los archivos devuelven líneas una por una, etc. Y los generadores vuelven... bueno, ahí es donde entra yield:

def f123():
    yield 1
    yield 2
    yield 3

for item in f123():
    print item

En lugar de las sentencias yield, si tuviera tres sentencias return en f123() solo la primera se ejecutaría, y la función saldría. Pero f123() no es una función ordinaria. Cuando se llama f123(), no devuelve ninguno de los valores en las declaraciones de rendimiento! Devuelve un objeto generador. Además, la función realmente no sale - entra en un estado suspendido. Cuando el for loop intenta hacer un bucle sobre el objeto generador, la función se reanuda desde su estado suspendido en la línea siguiente después de la yield de la que anteriormente regresó, ejecuta la siguiente línea de código, en este caso una instrucción yield, y devuelve eso como el siguiente elemento. Esto sucede hasta que la función sale, momento en el que el generador levanta StopIteration, y el bucle sale.

Así que el objeto generador es una especie de adaptador - en un extremo exhibe el protocolo iterador, exponiendo __iter__() y next() métodos para mantener el bucle for feliz. En el otro extremo, sin embargo, ejecuta la función lo suficiente para obtener el siguiente valor de ella, y la vuelve a poner en modo suspendido.

¿Por Qué Usar Generadores?

Normalmente se puede escribir código que no utilice generadores sino que implemente la misma lógica. Una opción es usar el 'truco' de la lista temporal que mencioné antes. Eso no funcionará en todos los casos, por ejemplo, si tiene bucles infinitos, o puede hacer un uso ineficiente de la memoria cuando tienes una lista muy larga. El otro enfoque es implementar una nueva clase iterable SomethingIter que mantiene el estado en los miembros de la instancia y realiza el siguiente paso lógico en su método next() (o __next__() en Python 3). Dependiendo de la lógica, el código dentro del método next() puede terminar pareciendo muy complejo y ser propenso a errores. Aquí los generadores proporcionan una solución limpia y fácil.

Piénsalo de esta manera:

Un iterador es solo un término que suena elegante para un objeto que tiene un método next (). Así que una función yield-ed termina siendo algo como esto:

Versión original:

def some_function():
    for i in xrange(4):
        yield i

for i in some_function():
    print i

Esto es básicamente lo que hace el intérprete de Python con el código anterior:

class it:
    def __init__(self):
        # Start at -1 so that we get 0 when we add 1 below.
        self.count = -1

    # The __iter__ method will be called once by the 'for' loop.
    # The rest of the magic happens on the object returned by this method.
    # In this case it is the object itself.
    def __iter__(self):
        return self

    # The next method will be called repeatedly by the 'for' loop
    # until it raises StopIteration.
    def next(self):
        self.count += 1
        if self.count < 4:
            return self.count
        else:
            # A StopIteration exception is raised
            # to signal that the iterator is done.
            # This is caught implicitly by the 'for' loop.
            raise StopIteration

def some_func():
    return it()

for i in some_func():
    print i

Para obtener más información sobre lo que está sucediendo detrás de escena, el bucle for se puede reescribir a esto:

iterator = some_func()
try:
    while 1:
        print iterator.next()
except StopIteration:
    pass

¿Eso tiene más sentido o simplemente te confunde más? :)

Debo señalar que esto es una simplificación excesiva con fines ilustrativos. :)

La palabra clave yield se reduce a dos hechos simples:

1. Si el compilador detecta la palabra clave yield en cualquier lugar dentro de una función, esa función ya no regresa a través de la instrucción return. En su lugar, it immediately returns a lazy "pending list" object called a generator
2. Un generador es iterable. ¿Qué es un iterable? Es algo así como un list o set o range o dict-view, con un incorporado protocolo para visitar cada elemento en un orden determinado.

En pocas palabras: un generador es una lista perezosa, pendiente de incremento, y yield las instrucciones le permiten usar la notación de función para programar los valores de lista que el generador debe escupir de forma incremental.

generator = myYieldingFunction(...)
x = list(generator)

   generator
       v
[x[0], ..., ???]

         generator
             v
[x[0], x[1], ..., ???]

               generator
                   v
[x[0], x[1], x[2], ..., ???]

                       StopIteration exception
[x[0], x[1], x[2]]     done

list==[x[0], x[1], x[2]]

Ejemplo

Definamos una función makeRange que es igual a la de Python range. Llamando A makeRange(n) DEVUELVE Un GENERADOR:

def makeRange(n):
    # return 0,1,2,...,n-1
    i = 0
    while i < n:
        yield i
        i += 1

>>> makeRange(5)
<generator object makeRange at 0x19e4aa0>

Para forzar el generador a devuelva inmediatamente sus valores pendientes, puede pasarlo a list() (al igual que podría hacerlo con cualquier iterable):

>>> list(makeRange(5))
[0, 1, 2, 3, 4]

Comparando el ejemplo con"simplemente devolviendo una lista"

El ejemplo anterior se puede considerar como simplemente crear una lista a la que se agrega y devuelve:{[34]]}

# list-version                   #  # generator-version
def makeRange(n):                #  def makeRange(n):
    """return [0,1,2,...,n-1]""" #~     """return 0,1,2,...,n-1"""
    TO_RETURN = []               #>
    i = 0                        #      i = 0
    while i < n:                 #      while i < n:
        TO_RETURN += [i]         #~         yield i
        i += 1                   #          i += 1  ## indented
    return TO_RETURN             #>

>>> makeRange(5)
[0, 1, 2, 3, 4]

Hay una diferencia importante, sin embargo; ver la última sección.

Cómo podría usar los generadores

Un iterable es la última parte de una comprensión de lista, y todos los generadores son iterables, por lo que a menudo se usan así:

#                   _ITERABLE_
>>> [x+10 for x in makeRange(5)]
[10, 11, 12, 13, 14]

Para tener una mejor idea de los generadores, puede jugar con el módulo itertools (asegúrese de usar chain.from_iterable en lugar de chain cuando esté justificado). Por ejemplo, incluso puede usar generadores para implementar listas perezosas infinitamente largas como itertools.count(). Puedes implementar tu propio def enumerate(iterable): zip(count(), iterable), o alternativamente hacerlo con la palabra clave yield en un bucle while.

Tenga en cuenta: los generadores en realidad se pueden usar para muchas más cosas, como implementando corrutinas o programación no determinista u otras cosas elegantes. Sin embargo, el punto de vista de "listas perezosas" que presento aquí es el uso más común que encontrará.

Detrás de escena

Así es como funciona el "protocolo de iteración de Python". Es decir, lo que está pasando cuando lo haces list(makeRange(5)). Esto es lo que describo anteriormente como una "lista perezosa e incremental".

>>> x=iter(range(5))
>>> next(x)
0
>>> next(x)
1
>>> next(x)
2
>>> next(x)
3
>>> next(x)
4
>>> next(x)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
StopIteration

La función incorporada next() solo llama a la función objects .next(), que es una parte del "protocolo de iteración" y se encuentra en todos los iteradores. Puede usar manualmente la función next() (y otras partes del protocolo de iteración) para implementar cosas elegantes, generalmente a expensas de la legibilidad, así que trate de evitar hacerlo...

Minucias

Normalmente, a la mayoría de las personas no les importarían las siguientes distinciones y probablemente quieran dejar de leer aquí.

En lenguaje Python, un iterable es cualquier objeto que " entiende el concepto de for-loop " como una lista [1,2,3], y un iterador es una instancia específica del bucle for solicitado como [1,2,3].__iter__(). Un generador es exactamente el mismo que cualquier iterador, excepto por la forma en que fue escrito (con sintaxis de función).

Cuando se solicita un iterador de una lista, se crea un nuevo iterador. Sin embargo, cuando solicita un iterador de un iterador (lo que rara vez haría), solo le da una copia de sí mismo.

Por lo tanto, en el improbable caso de que no hacer algo como esto...

> x = myRange(5)
> list(x)
[0, 1, 2, 3, 4]
> list(x)
[]

... entonces recuerde que un generador es un iterador ; es decir, es de un solo uso. Si desea reutilizarlo, debe llamar a myRange(...) de nuevo. Si necesita usar el resultado dos veces, convierta el resultado en una lista y guárdelo en una variable x = list(myRange(5)). Aquellos que absolutamente necesitan clonar un generador (por ejemplo, que están haciendo metaprogramación aterradoramente hackish) pueden utilizar itertools.tee si es absolutamente necesario, ya que el iterador copiable La propuesta de estándares Python PEP ha sido diferida.

¿Qué hace la palabra clave yield en Python?

Esquema/Resumen de la respuesta

• Una función con yield, cuando se llama, devuelve una Generador.
• Los generadores son iteradores porque implementan protocolo iterador, así que usted puede iterar sobre ellos.
• Un generador también puede ser información enviada , por lo que es conceptualmente un corrutina .
• En Python 3, puedes delegar de un generador a otro en ambas direcciones con yield from.
• (El apéndice critica un par de respuestas, incluyendo la primera, y discute el uso de return en un generador.)

Generadores:

yield es solo legal dentro de una definición de función, y la inclusión de yield en una definición de función hace que devuelva un generador.

El idea for generators proviene de otros lenguajes (ver nota 1) con diferentes implementaciones. En los generadores de Python, la ejecución del código está congelada en el punto del rendimiento. Cuando se llama al generador (los métodos se discuten a continuación), la ejecución se reanuda y luego se congela en el siguiente rendimiento.

yield proporciona un forma fácil de implementar el protocolo iterador , definido por los siguientes dos métodos: __iter__ y next (Python 2) o __next__ (Python 3). Ambos de esos métodos convierte un objeto en un iterador que podrías escribir-comprueba con la Base Abstracta Iterator Clase del módulo collections.

>>> def func():
...     yield 'I am'
...     yield 'a generator!'
... 
>>> type(func)                 # A function with yield is still a function
<type 'function'>
>>> gen = func()
>>> type(gen)                  # but it returns a generator
<type 'generator'>
>>> hasattr(gen, '__iter__')   # that's an iterable
True
>>> hasattr(gen, 'next')       # and with .next (.__next__ in Python 3)
True                           # implements the iterator protocol.

El tipo de generador es un subtipo de iterador:

>>> import collections, types
>>> issubclass(types.GeneratorType, collections.Iterator)
True

Y si es necesario, podemos escribir-check así:

>>> isinstance(gen, types.GeneratorType)
True
>>> isinstance(gen, collections.Iterator)
True

Una característica de un Iterator es que una vez agotado , no se puede reutilizar o restablecer:

>>> list(gen)
['I am', 'a generator!']
>>> list(gen)
[]

Tendrás que hacer otro si quieres usar su funcionalidad de nuevo (ver nota al pie 2):

>>> list(func())
['I am', 'a generator!']

Uno puede producir datos programáticamente, por ejemplo:

def func(an_iterable):
    for item in an_iterable:
        yield item

El generador simple anterior también es equivalente al siguiente: a partir de Python 3.3 (y no disponible en Python 2), puede usar yield from:

def func(an_iterable):
    yield from an_iterable

Sin embargo, yield from también permite la delegación a subgeneradores, que se explicará en la siguiente sección sobre la delegación cooperativa con subcoroutinas.

Corrutinas:

yield forma una expresión que permite datos para enviar al generador (véase la nota 3)

Aquí hay un ejemplo, tome nota de la variable received, que apuntará a los datos que se envían al generador:

def bank_account(deposited, interest_rate):
    while True:
        calculated_interest = interest_rate * deposited 
        received = yield calculated_interest
        if received:
            deposited += received


>>> my_account = bank_account(1000, .05)

Primero, debemos poner en cola el generador con la función builtin, next. Lo hará llame al método next o __next__ apropiado, dependiendo de la versión de Python que está utilizando:

>>> first_year_interest = next(my_account)
>>> first_year_interest
50.0

Y ahora podemos enviar datos al generador. (Enviar None es lo mismo que llamar next.) :

>>> next_year_interest = my_account.send(first_year_interest + 1000)
>>> next_year_interest
102.5

Delegación cooperativa a Subcoroutina con yield from

Ahora, recordemos que yield from está disponible en Python 3. Esto nos permite delegar corrutinas a una subcorutina:

def money_manager(expected_rate):
    under_management = yield     # must receive deposited value
    while True:
        try:
            additional_investment = yield expected_rate * under_management 
            if additional_investment:
                under_management += additional_investment
        except GeneratorExit:
            '''TODO: write function to send unclaimed funds to state'''
        finally:
            '''TODO: write function to mail tax info to client'''


def investment_account(deposited, manager):
    '''very simple model of an investment account that delegates to a manager'''
    next(manager) # must queue up manager
    manager.send(deposited)
    while True:
        try:
            yield from manager
        except GeneratorExit:
            return manager.close()

Y ahora podemos delegar funcionalidad a un sub-generador y se puede utilizar por un generador como arriba:

>>> my_manager = money_manager(.06)
>>> my_account = investment_account(1000, my_manager)
>>> first_year_return = next(my_account)
>>> first_year_return
60.0
>>> next_year_return = my_account.send(first_year_return + 1000)
>>> next_year_return
123.6

Puedes leer más sobre la semántica precisa de yield from en PEP 380.

Otros métodos: cerrar y throw

El método close plantea GeneratorExit en el punto de la función la ejecución fue congelada. Esto también será llamado por __del__ por lo que usted puede poner cualquier código de limpieza donde maneje el GeneratorExit:

>>> my_account.close()

También puede lanzar una excepción que se puede manejar en el generador o propagado de nuevo al usuario:

>>> import sys
>>> try:
...     raise ValueError
... except:
...     my_manager.throw(*sys.exc_info())
... 
Traceback (most recent call last):
  File "<stdin>", line 4, in <module>
  File "<stdin>", line 2, in <module>
ValueError

Conclusión

Creo que he cubierto todos los aspectos de la siguiente pregunta:

¿Qué hace la palabra clave yield en Python?

Resulta que yield hace mucho. Estoy seguro de que podría añadir aún más ejemplos exhaustivos de esto. Si quieres más o tienes alguna crítica constructiva, házmelo saber comentando debajo.

Apéndice:

Crítica de la Respuesta Superior / Aceptada * *

• Se confunde en lo que hace un iterable, solo usando una lista como ejemplo. Ver mis referencias anteriores, pero en resumen: un iterable tiene un método __iter__ que devuelve un iterador. Un iterador proporciona un método .next (Python 2 o .__next__ (Python 3), que es llamado implícitamente por bucles for hasta que levanta StopIteration, y una vez que lo hace, continuará haciéndolo.
• Luego usa una expresión generator para describir lo que es un generador. Dado que un generador es simplemente una forma conveniente de crear un iterador , solo confunde el asunto, y todavía no hemos llegado a la parte yield.
• En Controlando una agotamiento del generador llama al método .next, cuando en su lugar debe usar la función builtin, next. Sería una capa de indirección apropiada, porque su código no funciona en Python 3.
• Itertools? Esto no era relevante para lo que yield hace en absoluto.
• No hay discusión sobre los métodos que yield proporciona junto con la nueva funcionalidad yield from en Python 3. La respuesta top/accepted es una respuesta muy incompleta.

Crítica de la respuesta sugiriendo yield en una expresión generadora o comprensión.

La gramática actualmente permite la comprensión de cualquier expresión en una lista.

expr_stmt: testlist_star_expr (annassign | augassign (yield_expr|testlist) |
                     ('=' (yield_expr|testlist_star_expr))*)
...
yield_expr: 'yield' [yield_arg]
yield_arg: 'from' test | testlist

Dado que yield es una expresión, algunos han promocionado como interesante usarlo en comprensiones o expresiones generadoras, a pesar de no citar ningún caso de uso particularmente bueno.

Los desarrolladores del núcleo de CPython están discutiendo desaprobar su asignación. Aquí hay una publicación relevante del correo lista:

El 30 de enero de 2017 a las 19:05, Brett Cannon escribió:

El domingo, 29 de enero de 2017 a las 16:39 Craig Rodrigues escribió:

Estoy bien con cualquier enfoque. Dejando las cosas como están en Python 3 no es bueno, en MI humilde opinión.

Mi voto es que sea un error sintáctico ya que no estás obteniendo lo que esperas de sintaxis.

Estoy de acuerdo en que es un lugar sensato para que terminemos, ya que cualquier código confiar en el comportamiento actual es realmente demasiado inteligente para ser mantenible.

En términos de llegar allí, es probable que queramos:

• Advertencia de sintaxis o advertencia en desuso en 3.7
• Advertencia de Py3k en 2.7.x
• Error sintáctico en 3.8

Salud, Nick.

Nick Nick Coghlan / ncoghlan at gmail.com Brisbane, Australia

Además, hay una cuestión pendiente (10544) que parece estar apuntando en la dirección de que esto nunca sea una buena idea (PyPy, una implementación de Python escrita en Python, ya está generando advertencias de sintaxis.)

En pocas palabras, hasta que los desarrolladores de CPython nos digan lo contrario: No pongas yield en una expresión o comprensión generadora.

La instrucción return en un generador

En Python 2:

En una función generator, la instrucción return no puede incluya un expression_list. En ese contexto, un return desnudo indica que el generador está hecho y hará que StopIteration se eleve.

Un expression_list es básicamente cualquier número de expresiones separadas por comas - esencialmente, en Python 2, puede detener el generador con return, pero no puede devolver un valor.

En Python 3:

En una función generator, la instrucción return indica que el generador está hecho y hará que StopIteration se eleve. El el valor devuelto (si lo hay) se usa como argumento para construir StopIteration y se convierte en el atributo StopIteration.value.

Notas al pie

1. _{Los idiomas CLU, Sather e Icon fueron referenciados en la propuesta introducir el concepto de generadores a Python. La idea general es que una función puede mantener el estado interno y el rendimiento intermedio puntos de datos a petición del usuario. Esto prometía ser superior en rendimiento a otros enfoques, incluyendo Python threading , que ni siquiera está disponible en algunos sistemas.}

2. _{Esto significa, por ejemplo, que los objetos xrange (range en Python 3) no son Iterators, aunque sean iterables, porque pueden ser reutilizados. Al igual que las listas, sus métodos __iter__ devuelven objetos iteradores.}

3. _{yield se introdujo originalmente como una declaración, lo que significa que solo puede aparecer al principio de una línea en un bloque de código. Ahora yield crea un rendimiento expresion. https://docs.python.org/2/reference/simple_stmts.html#grammar-token-yield_stmt Este cambio se propuso para permitir que un usuario envíe datos al generador tal como uno podría recibirlo. Para enviar datos, uno debe ser capaz de asignarlos a algo, y para eso, una declaración simplemente no funcionará.}

yield es igual que return - devuelve lo que le digas (como un generador). La diferencia es que la próxima vez que llame al generador, la ejecución comienza desde la última llamada hasta la instrucción yield. A diferencia de return, el marco de pila no se limpia cuando se produce un yield, sin embargo, el control se transfiere de nuevo al llamador, por lo que su estado se reanudará la próxima vez que la función.

En el caso de su código, la función get_child_candidates está actuando como un iterador de modo que cuando se extiende su lista, agrega un elemento a la vez a la nueva lista.

list.extend llama a un iterador hasta que se agote. En el caso de la muestra de código que publicaste, sería mucho más claro devolver una tupla y agregarla a la lista.

Hay una cosa extra que mencionar: una función que rinde no tiene que terminar. He escrito código como este:

def fib():
    last, cur = 0, 1
    while True: 
        yield cur
        last, cur = cur, last + cur

Entonces puedo usarlo en otro código como este:

for f in fib():
    if some_condition: break
    coolfuncs(f);

Realmente ayuda a simplificar algunos problemas, y hace que algunas cosas sean más fáciles de trabajar.

Para aquellos que prefieren un ejemplo de trabajo mínimo, medita en esta sesión interactiva Python:

>>> def f():
...   yield 1
...   yield 2
...   yield 3
... 
>>> g = f()
>>> for i in g:
...   print i
... 
1
2
3
>>> for i in g:
...   print i
... 
>>> # Note that this time nothing was printed

Yield te da un generador.

def get_odd_numbers(i):
    return range(1, i, 2)
def yield_odd_numbers(i):
    for x in range(1, i, 2):
       yield x
foo = get_odd_numbers(10)
bar = yield_odd_numbers(10)
foo
[1, 3, 5, 7, 9]
bar
<generator object yield_odd_numbers at 0x1029c6f50>
bar.next()
1
bar.next()
3
bar.next()
5

Como puede ver, en el primer caso foo mantiene toda la lista en memoria a la vez. No es un gran problema para una lista con 5 elementos, pero ¿qué pasa si quieres una lista de 5 millones? No solo es un gran devorador de memoria, sino que también cuesta mucho tiempo construir en el momento en que se llama a la función. En el segundo caso, bar solo le da un generador. Un generador es un iterable which lo que significa que puede usarlo en un bucle for, etc, pero cada valor solo puede ser accedido una vez. Todos los valores tampoco se almacenan en la memoria al mismo tiempo; el objeto generador "recuerda" dónde estaba en el bucle la última vez que lo llamó this de esta manera, si está utilizando un iterable para (digamos) contar hasta 50 mil millones, no tiene que contar hasta 50 mil millones de una vez y almacenar los números de 50 mil millones para contar. De nuevo, este es un ejemplo bastante artificial, probablemente usarías itertools si realmente quisieras contar hasta 50 mil millones. :)

Este es el más simple caso de uso de generadores. Como dijiste, se puede usar para escribir permutaciones eficientes, usando yield para empujar cosas hacia arriba a través de la pila de llamadas en lugar de usar algún tipo de variable de pila. Los generadores también se pueden usar para el recorrido especializado de árboles y todo tipo de otras cosas.

Está devolviendo un generador. No estoy particularmente familiarizado con Python, pero creo que es el mismo tipo de cosa que bloques iteradores de C# si estás familiarizado con ellos.

Hay un artículo de IBM que lo explica razonablemente bien (para Python) por lo que puedo ver.

La idea clave es que el compilador / intérprete / lo que sea haga algún truco para que en lo que respecta al llamador, pueda seguir llamando a next () y siga devolviendo valores - como si el método generador se ha pausado. Ahora obviamente no puedes realmente "pausar" un método, por lo que el compilador construye una máquina de estados para que recuerdes dónde estás actualmente y cómo se ven las variables locales, etc. Esto es mucho más fácil que escribir un iterador tú mismo.

TL; DR

En lugar de esto:

def squares_list(n):
    the_list = []                         # Replace
    for x in range(n):
        y = x * x
        the_list.append(y)                # these
    return the_list                       # lines

Haz esto:

def squares_the_yield_way(n):
    for x in range(n):
        y = x * x
        yield y                           # with this one.

Cada vez que te encuentres construyendo una lista desde cero, yield cada pieza en su lugar.

Este fue mi primer momento de "aha" con yield.

yield es una forma azucarada de decir

Construir una serie de cosas

El mismo comportamiento:

>>> for square in squares_list(4):
...     print(square)
...
0
1
4
9
>>> for square in squares_the_yield_way(4):
...     print(square)
...
0
1
4
9

Comportamiento diferente:

Yield es single-pass: solo se puede iterar una vez. Cuando una función tiene un rendimiento en ella lo llamamos una función generadora . Y un iterador es lo que devuelve. Eso es revelador. Perdemos la comodidad de un contenedor, pero ganamos el poder de una serie arbitrariamente larga.

El rendimiento es perezoso, pospone el cálculo. Una función con un yield en ella no se ejecuta realmente en absoluto cuando la llamas. El objeto iterador que devuelve usa magic para mantener el contexto interno de la función. Cada el tiempo que se llama a next() en el iterador (esto sucede en un bucle for) avanza pulgadas hacia el siguiente rendimiento. (return sube StopIteration y termina la serie.)

El rendimiento es versátil. Puede hacer bucles infinitos:

>>> def squares_all_of_them():
...     x = 0
...     while True:
...         yield x * x
...         x += 1
...
>>> squares = squares_all_of_them()
>>> for _ in range(4):
...     print(next(squares))
...
0
1
4
9

Si necesita múltiples pases y la serie no es demasiado larga, simplemente llame a list() en ella:

>>> list(squares_the_yield_way(4))
[0, 1, 4, 9]

Brillante elección de la palabra yield porque ambos significados se aplican: {[15]]}

Rendimiento - producir o proporcionar (como en la agricultura)

...proporcione los siguientes datos de la serie.

Ceder - ceder o renunciar (como en el poder político)

...renunciar a la ejecución de la CPU hasta que el iterador avance.

Hay un tipo de respuesta que no siento que se haya dado todavía, entre las muchas grandes respuestas que describen cómo usar los generadores. Aquí está la respuesta de la teoría del lenguaje de programación:

La instrucción yield en Python devuelve un generador. Un generador en Python es una función que devuelve continuaciones (y específicamente un tipo de corrutina, pero las continuaciones representan el mecanismo más general para entender lo que está sucediendo).

Continuaciones en la programación la teoría de los lenguajes es un tipo de computación mucho más fundamental, pero no se usan a menudo, porque son extremadamente difíciles de razonar y también muy difíciles de implementar. Pero la idea de lo que es una continuación, es sencilla: es el estado de un cálculo que aún no ha terminado. En este estado, se guardan los valores actuales de las variables, las operaciones que aún no se han realizado, etc. Luego, en algún momento posterior del programa, se puede invocar la continuación, tal que las variables del programa se restablezcan a ese estado y se lleven a cabo las operaciones que se guardaron.

Las continuaciones, en esta forma más general, se pueden implementar de dos maneras. De la manera call/cc, la pila del programa se guarda literalmente y luego cuando se invoca la continuación, la pila se restaura.

En continuation passing style (CPS), las continuaciones son solo funciones normales (solo en lenguajes donde las funciones son de primera clase) que el programador maneja explícitamente y pasa a las subrutinas. En este estilo, el estado del programa está representado por cierres (y las variables que están codificadas en ellos) en lugar de variables que residen en algún lugar de la pila. Las funciones que administran el flujo de control aceptan la continuación como argumentos (en algunas variaciones de CPS, las funciones pueden aceptar múltiples continuaciones) y manipulan el flujo de control invocándolas simplemente llamándolas y regresándolas después. Un ejemplo muy simple de estilo de paso de continuación es como sigue:

def save_file(filename):
  def write_file_continuation():
    write_stuff_to_file(filename)

  check_if_file_exists_and_user_wants_to_overwrite(write_file_continuation)

En este ejemplo (muy simplista), el programador guarda la operación de escribir realmente el archivo en una continuación (que puede ser potencialmente una operación muy compleja con muchos detalles para escribir), y luego pasa esa continuación (es decir, como un cierre de primera clase) a otro operador que hace un poco más de procesamiento, y luego lo llama si es necesario. (Uso este patrón de diseño mucho en la programación GUI real, ya sea porque me ahorra líneas de código o, más es importante destacar, para gestionar el flujo de control después de eventos GUI trigger.)

El resto de este post, sin pérdida de generalidad, conceptualizará las continuaciones como CPS, porque es mucho más fácil de entender y leer.

Ahora hablemos de generadores en Python. Los generadores son un subtipo específico de continuación. Mientras que las continuaciones son capaces en general de salvar el estado de un cálculo (es decir, la pila de llamadas del programa), los generadores solo pueden guardar el estado de iteración sobre un iterador . Sin embargo, esta definición es ligeramente engañosa para ciertos casos de uso de generadores. Por ejemplo:

def f():
  while True:
    yield 4

Este es claramente un iterable razonable cuyo comportamiento está bien definido each cada vez que el generador itera sobre él, devuelve 4 (y lo hace para siempre). Pero no es probablemente el tipo prototípico de iterable que viene a la mente cuando se piensa en iteradores (es decir, for x in collection: do_something(x)). Este ejemplo ilustra la potencia de los generadores: si algo es un iterador, un generador puede guardar el estado de su iteración.

Para reiterar: Las continuaciones pueden guardar el estado de la pila de un programa y los generadores pueden guardar el estado de iteración. Esto significa que las continuaciones son mucho más potentes que los generadores, pero también que los generadores son mucho, mucho más fáciles. Son más fáciles de implementar para el diseñador de lenguaje, y son más fáciles de usar para el programador (si tiene algo de tiempo para quemar, intenta leer y entender esta página sobre continuaciones y call/cc).

Pero podría implementar (y conceptualizar) generadores como un caso simple y específico de estilo de paso de continuación:

Cuando se llama a yield, le dice a la función que devuelva una continuación. Cuando la función se llama de nuevo, comienza desde donde lo dejó. Por lo tanto, en pseudo-pseudocódigo (es decir, no pseudocódigo, pero no código) el método next del generador es básicamente como sigue:

class Generator():
  def __init__(self,iterable,generatorfun):
    self.next_continuation = lambda:generatorfun(iterable)

  def next(self):
    value, next_continuation = self.next_continuation()
    self.next_continuation = next_continuation
    return value

Donde la palabra clave yield es en realidad azúcar sintáctica para la función generador real, básicamente algo así como:

def generatorfun(iterable):
  if len(iterable) == 0:
    raise StopIteration
  else:
    return (iterable[0], lambda:generatorfun(iterable[1:]))

Recuerde que esto es solo pseudocódigo y la implementación real de generadores en Python es más compleja. Pero como un ejercicio para entender lo que está pasando, intente usar el estilo de paso de continuación para implementar objetos generator sin el uso de la palabra clave yield.

Aquí hay un ejemplo en lenguaje sencillo. Proporcionaré una correspondencia entre conceptos humanos de alto nivel y conceptos de Python de bajo nivel.

Quiero operar en una secuencia de números, pero no quiero molestarme con la creación de esa secuencia, solo quiero enfocarme en la operación que quiero hacer. Por lo tanto, hago lo siguiente:

• Te llamo y te digo que quiero una secuencia de números que se produce de una manera específica, y te dejo saber lo que el algoritmo ser.
  Este paso corresponde a def ining la función del generador, es decir, la función que contiene un yield.
• Algún tiempo después, te digo, "OK, prepárate para decirme la secuencia de números".
  Este paso corresponde a llamar a la función generator que devuelve un objeto generator. Note que usted no me dice ningún número todavía; usted toma su papel y lápiz.
• Yo te pregunto: "Dime el siguiente número", y tú me dices el primer número; después de eso, espera a que te pida el siguiente número. Es tu trabajo recordar dónde estabas, qué números ya has dicho y cuál es el siguiente número. No me importan los detalles.
  Este paso corresponde a llamar a .next() en el objeto generador.
• repeat repita el paso anterior, hasta {
• eventualmente, podrías llegar a su fin. No me dices un número; solo gritas: "¡Alto! ¡He terminado! No más números!"
  Este paso corresponde a la objeto generator que finaliza su trabajo y genera una excepción StopIteration La función generator no necesita generar la excepción. Se genera automáticamente cuando la función termina o emite un return.

Esto es lo que hace un generador (una función que contiene un yield); comienza a ejecutarse, se detiene cada vez que hace un yield, y cuando se le pide un valor .next() continúa desde el último punto que fue. Encaja perfectamente por diseño con el protocolo iterador de Python, que describe cómo para solicitar valores secuencialmente.

El usuario más famoso del protocolo iterador es el comando for en Python. Así que, cada vez que haces un:

for item in sequence:

No importa si sequence es una lista, una cadena, un diccionario o un generador objeto como se describió anteriormente; el resultado es el mismo: lee elementos de una secuencia uno por uno.

Tenga en cuenta que defining una función que contiene una palabra clave yield no es la única manera de crear un generador; es solo la forma más fácil de crea uno.

Para obtener información más precisa, lea sobre los tipos de iteradores , la declaración de rendimiento y los generadores en la documentación de Python.

Mientras que muchas respuestas muestran por qué usarías un yield para crear un generador, hay más usos para yield. Es bastante fácil hacer una corrutina, que permite el paso de información entre dos bloques de código. No repetiré ninguno de los buenos ejemplos que ya se han dado sobre el uso de yield para crear un generador.

Para ayudar a entender lo que hace un yield en el siguiente código, puede usar su dedo para rastrear el ciclo a través de cualquier código que tenga un yield. Cada vez que su el dedo golpea el yield, tienes que esperar a que se introduzca un next o un send. Cuando se llama a un next, se rastrea a través del código hasta que se pulsa el yield the el código a la derecha del yield se evalúa y se devuelve al llamante then luego se espera. Cuando se vuelve a llamar a next, se realiza otro bucle a través del código. Sin embargo, notará que en una corrutina, yield también se puede usar con un send which que enviará un valor desde el llamante a la función de rendimiento. Si se da un send, entonces yield recibe el valor enviado, y lo escupe hacia fuera el lado izquierdo then entonces el rastro a través del código progresa hasta que usted golpea el yield otra vez (devolviendo el valor al final, como si next fuera llamado).

Por ejemplo:

>>> def coroutine():
...     i = -1
...     while True:
...         i += 1
...         val = (yield i)
...         print("Received %s" % val)
...
>>> sequence = coroutine()
>>> sequence.next()
0
>>> sequence.next()
Received None
1
>>> sequence.send('hello')
Received hello
2
>>> sequence.close()

Hay otro yield uso y significado (desde Python 3.3):

yield from <expr>

De PEP 380 Syntax Sintaxis para Delegar a un Subgenerador:

Se propone una sintaxis para que un generador delegue parte de sus operaciones a otro generador. Esto permite que una sección de código que contiene 'yield' se factorice y se coloque en otro generador. Además, se permite que el subgenerador regrese con un valor, y el valor se pone a disposición del delegado generador.

La nueva sintaxis también abre algunas oportunidades para la optimización cuando un generador devuelve valores producidos por otro.

Además esto introducirá (desde Python 3.5):

async def new_coroutine(data):
   ...
   await blocking_action()

Para evitar que las corrutinas se confundan con un generador regular (hoy yield se usa en ambos).

Iba a publicar "lea la página 19 de 'Python: Essential Reference' de Beazley para una descripción rápida de los generadores", pero muchos otros ya han publicado buenas descripciones.

También, tenga en cuenta que yield se puede utilizar en las corrutinas como el dual de su uso en las funciones del generador. Aunque no es el mismo uso que su fragmento de código, (yield) se puede usar como una expresión en una función. Cuando un llamador envía un valor al método usando el método send(), entonces la corrutina se ejecutará hasta que se encuentra la siguiente instrucción (yield).

Los generadores y las corrutinas son una forma genial de configurar aplicaciones de tipo flujo de datos. Pensé que valdría la pena conocer el otro uso de la instrucción yield en funciones.

Aquí hay algunos ejemplos de Python de cómo implementar generadores como si Python no les proporcionara azúcar sintáctica:

Como generador de Python:

from itertools import islice

def fib_gen():
    a, b = 1, 1
    while True:
        yield a
        a, b = b, a + b

assert [1, 1, 2, 3, 5] == list(islice(fib_gen(), 5))

Uso de cierres léxicos en lugar de generadores

def ftake(fnext, last):
    return [fnext() for _ in xrange(last)]

def fib_gen2():
    #funky scope due to python2.x workaround
    #for python 3.x use nonlocal
    def _():
        _.a, _.b = _.b, _.a + _.b
        return _.a
    _.a, _.b = 0, 1
    return _

assert [1,1,2,3,5] == ftake(fib_gen2(), 5)

Usar cierres de objetos en lugar de generadores (porque los cierres y los objetos son equivalentes)

class fib_gen3:
    def __init__(self):
        self.a, self.b = 1, 1

    def __call__(self):
        r = self.a
        self.a, self.b = self.b, self.a + self.b
        return r

assert [1,1,2,3,5] == ftake(fib_gen3(), 5)

Desde un punto de vista de programación, los iteradores se implementan como thunks.

Para implementar iteradores, generadores y grupos de subprocesos para la ejecución concurrente, etc. como thunks (también llamadas funciones anónimas), se usan mensajes enviados a un objeto de cierre, que tiene un despachador, y el despachador responde a "mensajes".

Http://en.wikipedia.org/wiki/Message_passing

"siguiente " es un mensaje enviado a un cierre, creado por el "iter " call.

Hay muchas maneras de implementar este cálculo. Usé mutación, pero es fácil hacerlo sin mutación, devolviendo el valor actual y el siguiente productor.

Aquí hay una demostración que usa la estructura de R6RS, pero la semántica es absolutamente idéntica a la de Python. Es el mismo modelo de computación, y solo se requiere un cambio en la sintaxis para reescribirlo en Python.

Welcome to Racket v6.5.0.3.

-> (define gen
     (lambda (l)
       (define yield
         (lambda ()
           (if (null? l)
               'END
               (let ((v (car l)))
                 (set! l (cdr l))
                 v))))
       (lambda(m)
         (case m
           ('yield (yield))
           ('init  (lambda (data)
                     (set! l data)
                     'OK))))))
-> (define stream (gen '(1 2 3)))
-> (stream 'yield)
1
-> (stream 'yield)
2
-> (stream 'yield)
3
-> (stream 'yield)
'END
-> ((stream 'init) '(a b))
'OK
-> (stream 'yield)
'a
-> (stream 'yield)
'b
-> (stream 'yield)
'END
-> (stream 'yield)
'END
->

Todas las grandes respuestas, sin embargo, un poco difícil para los novatos.

Asumo que has aprendido la declaración return.

Como analogía, return y yield son gemelos. return significa "retorno y parada" mientras que "rendimiento" significa "retorno, pero continuar"

1. Intenta obtener una num_list con return.

def num_list(n):
    for i in range(n):
        return i

Ejecutarlo:

In [5]: num_list(3)
Out[5]: 0

Vea, usted obtiene solo un número en lugar de una lista de ellos. return nunca te permite prevalecer felizmente, solo implementa una vez y renunciar.

1. Ahí viene yield

Sustitúyase return por yield:

In [10]: def num_list(n):
    ...:     for i in range(n):
    ...:         yield i
    ...:

In [11]: num_list(3)
Out[11]: <generator object num_list at 0x10327c990>

In [12]: list(num_list(3))
Out[12]: [0, 1, 2]

Ahora, ganas para obtener todos los números.

En comparación con return que se ejecuta una vez y se detiene, yield se ejecuta veces que planeó. Puedes interpretar return como return one of them, y yield como return all of them. Esto se llama iterable.

1. Un paso más podemos reescribir yield sentencia con return

In [15]: def num_list(n):
    ...:     result = []
    ...:     for i in range(n):
    ...:         result.append(i)
    ...:     return result

In [16]: num_list(3)
Out[16]: [0, 1, 2]

Es el núcleo acerca de yield.

La diferencia entre una lista return salidas y el objeto yield salida es:

Siempre obtendrá [0, 1, 2] de un objeto list, pero solo podrá recuperarlos de 'la salida del objeto yield' una vez. Por lo tanto, tiene un nuevo objeto name generator como se muestra en Out[11]: <generator object num_list at 0x10327c990>.

En conclusión, como metáfora de grok it:{[33]]}

• return y yield son gemelos
• list y generator son gemelos

Aquí hay un ejemplo simple:

def isPrimeNumber(n):
    print "isPrimeNumber({}) call".format(n)
    if n==1:
        return False
    for x in range(2,n):
        if n % x == 0:
            return False
    return True

def primes (n=1):
    while(True):
        print "loop step ---------------- {}".format(n)
        if isPrimeNumber(n): yield n
        n += 1

for n in primes():
    if n> 10:break
    print "wiriting result {}".format(n)

Salida:

loop step ---------------- 1
isPrimeNumber(1) call
loop step ---------------- 2
isPrimeNumber(2) call
loop step ---------------- 3
isPrimeNumber(3) call
wiriting result 3
loop step ---------------- 4
isPrimeNumber(4) call
loop step ---------------- 5
isPrimeNumber(5) call
wiriting result 5
loop step ---------------- 6
isPrimeNumber(6) call
loop step ---------------- 7
isPrimeNumber(7) call
wiriting result 7
loop step ---------------- 8
isPrimeNumber(8) call
loop step ---------------- 9
isPrimeNumber(9) call
loop step ---------------- 10
isPrimeNumber(10) call
loop step ---------------- 11
isPrimeNumber(11) call

No soy un desarrollador de Python, pero me parece que yield mantiene la posición de flujo de programa y el siguiente bucle comienza desde la posición de "rendimiento". Parece que está esperando en esa posición, y justo antes de eso, devolver un valor afuera, y la próxima vez continúa funcionando.

Parece ser una habilidad interesante y agradable :D

Aquí hay una imagen mental de lo que yield hace.

Me gusta pensar que un hilo tiene una pila (incluso cuando no se implementa de esa manera).

Cuando se llama a una función normal, coloca sus variables locales en la pila, hace algún cálculo, luego borra la pila y devuelve. Los valores de sus variables locales nunca se vuelven a ver.

Con una función yield, cuando su código comienza a ejecutarse (es decir, después de que se llama a la función, devolviendo un objeto generador, cuyo next() método es entonces invocado), de manera similar pone sus variables locales en la pila y calcula por un tiempo. Pero luego, cuando llega a la instrucción yield, antes de limpiar su parte de la pila y regresar, toma una instantánea de sus variables locales y las almacena en el objeto generator. También escribe el lugar donde está actualmente en su código (es decir, la instrucción particular yield).

Así que es una especie de función congelada a la que el generador se aferra.

Cuando next() se llama posteriormente, recupera las pertenencias de la función en la pila y la vuelve a animar. La función continúa calculando desde donde lo dejó, ajeno al hecho de que acababa de pasar una eternidad en almacenamiento en frío.

Compare los siguientes ejemplos:

def normalFunction():
    return
    if False:
        pass

def yielderFunction():
    return
    if False:
        yield 12

Cuando llamamos a la segunda función, se comporta de manera muy diferente a la primera. La declaración yield puede ser inalcanzable, pero si está presente en algún lugar, cambia la naturaleza de lo que estamos tratando con.

>>> yielderFunction()
<generator object yielderFunction at 0x07742D28>

Llamar a yielderFunction() no ejecuta su código, sino que crea un generador a partir del código. (Tal vez sea una buena idea nombrar tales cosas con el prefijo yielder para legibilidad.)

>>> gen = yielderFunction()
>>> dir(gen)
['__class__',
 ...
 '__iter__',    #Returns gen itself, to make it work uniformly with containers
 ...            #when given to a for loop. (Containers return an iterator instead.)
 'close',
 'gi_code',
 'gi_frame',
 'gi_running',
 'next',        #The method that runs the function's body.
 'send',
 'throw']

Los campos gi_code y gi_frame son donde se almacena el estado congelado. Explorándolos con dir(..), podemos confirmar que nuestro modelo mental anterior es creíble.

Como toda respuesta sugiere, yield se usa para crear un generador de secuencias. Se utiliza para generar una secuencia dinámicamente. Por ejemplo, al leer un archivo línea por línea en una red, puede usar la función yield de la siguiente manera:

def getNextLines():
   while con.isOpen():
       yield con.read()

Puede usarlo en su código de la siguiente manera:

for line in getNextLines():
    doSomeThing(line)

Transferencia de Control de Ejecución gotcha

El control de ejecución será transferido desde getNextLines() al bucle for cuando se ejecute yield. Así, cada vez que se invoca getNextLines (), la ejecución comienza desde el punto donde se detuvo la última vez.

Así, en resumen, una función con el siguiente código

def simpleYield():
    yield "first time"
    yield "second time"
    yield "third time"
    yield "Now some useful value {}".format(12)

for i in simpleYield():
    print i

Se imprimirá

"first time"
"second time"
"third time"
"Now some useful value 12"

Yield es un objeto

Un return en una función devolverá un solo valor.

Si quieres que una función devuelva un gran conjunto de valores, usa yield.

Más importante, yield es una barrera .

Al igual que la barrera en el lenguaje CUDA, no transferirá el control hasta que se completo.

Es decir, ejecutará el código en su función desde el principio hasta que llegue a yield. Entonces, devolverá el primer valor de bucle.

Entonces, cada otra llamada ejecutará el bucle que ha escrito en la función una vez más, devolviendo el siguiente valor hasta que no haya ningún valor para devolver.

En resumen, la instrucción yield transforma su función en una fábrica que produce un objeto especial llamado generator que envuelve el cuerpo de su función original. Cuando se itera el generator, ejecuta su función hasta que alcanza el siguiente yield, luego suspende la ejecución y evalúa el valor pasado a yield. Repite este proceso en cada iteración hasta que la ruta de ejecución sale de la función. Por ejemplo,

def simple_generator():
    yield 'one'
    yield 'two'
    yield 'three'

for i in simple_generator():
    print i

Simplemente produce

one
two
three

El la energía proviene de usar el generador con un bucle que calcula una secuencia, el generador ejecuta el bucle deteniéndose cada vez para' producir ' el siguiente resultado del cálculo, de esta manera calcula una lista sobre la marcha, el beneficio es la memoria guardada para cálculos especialmente grandes

Digamos que desea crear su propia función range que produce un rango iterable de números, podría hacerlo así,

def myRangeNaive(i):
    n = 0
    range = []
    while n < i:
        range.append(n)
        n = n + 1
    return range

Y úsalo así; {[14]]}

for i in myRangeNaive(10):
    print i

Pero esto es ineficiente porque

• Se crea un array que solo se usa una vez (esto desperdicia memoria)
• Este código en realidad loops sobre esa matriz dos veces! :(

Afortunadamente Guido y su equipo fueron lo suficientemente generosos para desarrollar generadores para que pudiéramos hacer esto;{[14]]}

def myRangeSmart(i):
    n = 0
    while n < i:
       yield n
       n = n + 1
    return

for i in myRangeSmart(10):
    print i

Ahora, en cada iteración, una función en el generador llamada next() ejecuta la función hasta que alcanza una sentencia ' yield 'en la que se detiene y 'yield' el valor o llega al final de función. En este caso en la primera llamada, next() ejecuta hasta la instrucción yield y yield 'n', en la siguiente llamada ejecutará la instrucción increment, saltará de nuevo al 'while', lo evaluará, y si es true, se detendrá y volverá a rendir 'n', continuará de esa manera hasta que la condición while devuelva false y el generador salte al final de la función.

yield es como un elemento de retorno para una función. La diferencia es que el elemento yield convierte una función en un generador. Un generador se comporta como una función hasta que algo es 'cedido'. El generador se detiene hasta que se llama a continuación, y continúa exactamente desde el mismo punto en que comenzó. Puede obtener una secuencia de todos los valores 'cedidos' en uno, llamando a list(generator()).

(Mi respuesta a continuación solo habla desde la perspectiva de usar Python generator, no la implementación subyacente del mecanismo del generador, que implica algunos trucos de manipulación de pila y montón.)

Cuando se usa yield en lugar de return en una función de python, esa función se convierte en algo especial llamado generator function. Esa función devolverá un objeto de tipo generator. La palabra clave yield es un indicador para notificar al compilador de python que trate dicha función especialmente. Las funciones normales terminarán una vez que se devuelva algún valor. Pero con la ayuda del compilador, la función generadora puede considerarse como resumible. Es decir, el contexto de ejecución se restaurará y la ejecución continuará desde la última ejecución. Hasta que llame explícitamente a return, que generará una excepción StopIteration (que también es parte del protocolo iterador), o llegue al final de la función. He encontrado un montón de referencias sobre generator pero este uno de la functional programming perspective es la más digerible.

(Ahora quiero hablar sobre la razón detrás de generator, y el iterator basado en mi propio entendimiento. Espero que esto pueda ayudarle a comprender el motivación esencial de iterador y generador. Este concepto aparece también en otros lenguajes como C#.)

Según entiendo, cuando queremos procesar un montón de datos, generalmente primero almacenamos los datos en algún lugar y luego los procesamos uno por uno. Pero esto intuitivo el enfoque es problemático. Si el volumen de datos es enorme, es costoso almacenarlos como un todo de antemano. Así que en lugar de almacenar el data directamente, ¿por qué no almacenar algún tipo de metadata indirectamente, i. e.the logic how the data is computed.

Hay 2 enfoques para envolver tales metadatos.

1. El enfoque OO, envolvemos los metadatos as a class. Este es el llamado iterator que implementa el protocolo iterador (es decir, los métodos __next__() y __iter__()). Esto es también el comúnmente visto patrón de diseño iterador.
2. El enfoque funcional, envolvemos los metadatos as a function. Esto es los llamados generator function. Pero bajo el capó, el iterador devuelto generator object still IS-A porque también implementa el protocolo iterador.

De cualquier manera, se crea un iterador, es decir, algún objeto que puede darle los datos que desea. El enfoque OO puede ser un poco complejo. De todos modos, cuál usar depende de ti.

Muchas personas usan return en lugar de yield, pero en algunos casos yield puede ser más eficiente y fácil de trabajar.

Aquí hay un ejemplo que yield es definitivamente mejor para:

Return (en función)

import random

def return_dates():
    dates = [] # With 'return' you need to create a list then return it
    for i in range(5):
        date = random.choice(["1st", "2nd", "3rd", "4th", "5th", "6th", "7th", "8th", "9th", "10th"])
        dates.append(date)
    return dates

Rendimiento (en función)

def yield_dates():
    for i in range(5):
        date = random.choice(["1st", "2nd", "3rd", "4th", "5th", "6th", "7th", "8th", "9th", "10th"])
        yield date # 'yield' makes a generator automatically which works
                   # in a similar way. This is much more efficient.

Llamando a funciones

dates_list = return_dates()
print(dates_list)
for i in dates_list:
    print(i)

dates_generator = yield_dates()
print(dates_generator)
for i in dates_generator:
    print(i)

Ambas funciones hacen lo mismo, pero yield usa tres líneas en lugar de cinco y tiene una menos variable de qué preocuparse.

Este es el resultado del código:

Como puede ver, ambas funciones hacen lo mismo. La única diferencia es que return_dates() da una lista y yield_dates() da un generador.

Un ejemplo de la vida real sería algo así como leer un archivo línea por línea o si solo desea hacer un generador.

La palabra clave yield simplemente recopila los resultados que regresan. Piensa en yield como return +=

Aquí hay un simple yield enfoque basado, para calcular la serie de fibonacci, explicado:

def fib(limit=50):
    a, b = 0, 1
    for i in range(limit):
       yield b
       a, b = b, a+b

Cuando introduzcas esto en tu REPL y luego intentes llamarlo, obtendrás un resultado desconcertante: {[34]]}

>>> fib()
<generator object fib at 0x7fa38394e3b8>

Esto se debe a que la presencia de yield señaló a Python que desea crear un generador , es decir, un objeto que genera valores bajo demanda.

Entonces, ¿cómo generas estos valores? Esto se puede hacer directamente mediante el uso de la función incorporada next, o, indirectamente alimentándolo a una construcción que consume valores.

Usando la función incorporada next(), invoca directamente.next/__next__, forzando al generador a producir un valor:

>>> g = fib()
>>> next(g)
1
>>> next(g)
1
>>> next(g)
2
>>> next(g)
3
>>> next(g)
5

Indirectamente, si proporciona fib a un bucle for, un inicializador list, un inicializador tuple, o cualquier otra cosa que espere un objeto que genere / produzca valores, "consumirá" el generador hasta que no pueda producir más valores (y devuelve):

results = []
for i in fib(30):       # consumes fib
    results.append(i) 
# can also be accomplished with
results = list(fib(30)) # consumes fib

De manera similar, con un inicializador tuple:

>>> tuple(fib(5))       # consumes fib
(1, 1, 2, 3, 5)

Un generador difiere de una función en el sentido de que es perezoso. Se logra esto mediante el mantenimiento de su estado local y lo que le permite reanudar siempre que lo necesite.

Cuando invoques por primera vez fib llamándolo:

f = fib()

Python compila la función, encuentra la palabra clave yield y simplemente devuelve un objeto generator. No parece muy útil.

Cuando luego request it genera el primer valor, directa o indirectamente, ejecuta todas las sentencias que encuentra, hasta que encuentra un yield, luego devuelve el valor que proporcionó a yield y hace una pausa. Para un ejemplo que demuestra mejor esto, usemos algunas llamadas print (reemplazar con print "text" si en Python 2):

def yielder(value):
    """ This is an infinite generator. Only use next on it """ 
    while 1:
        print("I'm going to generate the value for you")
        print("Then I'll pause for a while")
        yield value
        print("Let's go through it again.")

Ahora, ingrese en el REPL:

>>> gen = yielder("Hello, yield!")

Ahora tiene un objeto generador esperando un comando para que genere un valor. Utilice next y ver lo que get's impreso:

>>> next(gen) # runs until it finds a yield
I'm going to generate the value for you
Then I'll pause for a while
'Hello, yield!'

Los resultados sin comillas son lo que se imprime. El resultado citado es lo que se devuelve de yield. Llama next de nuevo ahora:

>>> next(gen) # continues from yield and runs again
Let's go through it again.
I'm going to generate the value for you
Then I'll pause for a while
'Hello, yield!'

El generador recuerda que se detuvo en yield value y se reanuda desde allí. Se imprime el siguiente mensaje y se realiza de nuevo la búsqueda de la instrucción yield para pausarla (debido al bucle while).

Otro TL; DR

Iterador en la lista: next() devuelve el siguiente elemento de la lista

Generador de iteradores: next() calculará el siguiente elemento sobre la marcha (ejecutar código)

Puede ver el yield/generator como una forma de ejecutar manualmente el control flow desde fuera (como continuar bucle un paso), llamando a next, por complejo que sea el flujo.

Nota: El generador es NO una función normal. Recuerda el anterior estado como variables locales (pila). Vea otras respuestas o artículos para una explicación detallada. El generador solo puede ser iterado una vez. Usted podría prescindir de yield, pero no sería tan agradable, por lo que se puede considerar 'muy agradable' azúcar idioma.