¿Cuál es el uso de la yieldpalabra clave en Python y qué hace?

Por ejemplo, estoy tratando de entender este código ¹ :

def _get_child_candidates(self, distance, min_dist, max_dist):
    if self._leftchild and distance - max_dist < self._median:
        yield self._leftchild
    if self._rightchild and distance + max_dist >= self._median:
        yield self._rightchild  

Y esta es la persona que llama:

result, candidates = [], [self]
while candidates:
    node = candidates.pop()
    distance = node._get_dist(obj)
    if distance <= max_dist and distance >= min_dist:
        result.extend(node._values)
    candidates.extend(node._get_child_candidates(distance, min_dist, max_dist))
return result

¿Qué sucede cuando _get_child_candidatesse llama al método ? ¿Se devuelve una lista? ¿Un solo elemento? ¿Se llama de nuevo? ¿Cuándo se detendrán las llamadas posteriores?

_{1. Este código fue escrito por Jochen Schulz (jrschulz), quien hizo una gran biblioteca de Python para espacios métricos. Este es el enlace a la fuente completa: Módulo mspace .}

Para entender lo que yieldhace, debes entender qué son los generadores . Y antes de que pueda comprender los generadores, debe comprender los iterables .

Iterables

Cuando crea una lista, puede leer sus elementos uno por uno. Leer sus elementos uno por uno se llama iteración:

>>> mylist = [1, 2, 3]
>>> for i in mylist:
...    print(i)
1
2
3

mylistEs un iterable . Cuando usas una comprensión de lista, creas una lista, y así un iterable:

>>> mylist = [x*x for x in range(3)]
>>> for i in mylist:
...    print(i)
0
1
4

Todo lo que puedes usar " for... in..." es iterable; lists, stringsarchivos ...

Estos iterables son útiles porque puede leerlos todo lo que desee, pero almacena todos los valores en la memoria y esto no siempre es lo que desea cuando tiene muchos valores.

Generadores

Los generadores son iteradores, un tipo de iterativo que solo puede iterar una vez . Los generadores no almacenan todos los valores en la memoria, generan los valores sobre la marcha :

>>> mygenerator = (x*x for x in range(3))
>>> for i in mygenerator:
...    print(i)
0
1
4

Es igual, excepto que usaste en ()lugar de []. PERO, no puede realizar for i in mygeneratoruna segunda vez ya que los generadores solo se pueden usar una vez: calculan 0, luego se olvidan y calculan 1, y terminan de calcular 4, uno por uno.

rendimiento

yieldes una palabra clave que se usa como return, excepto que la función devolverá un generador.

>>> def createGenerator():
...    mylist = range(3)
...    for i in mylist:
...        yield i*i
...
>>> mygenerator = createGenerator() # create a generator
>>> print(mygenerator) # mygenerator is an object!
<generator object createGenerator at 0xb7555c34>
>>> for i in mygenerator:
...     print(i)
0
1
4

Aquí es un ejemplo inútil, pero es útil cuando sabes que tu función devolverá un gran conjunto de valores que solo necesitarás leer una vez.

Para dominar yield, debe comprender que cuando llama a la función, el código que ha escrito en el cuerpo de la función no se ejecuta. La función solo devuelve el objeto generador, esto es un poco complicado :-)

Luego, su código continuará desde donde lo dejó cada vez que foruse el generador.

Ahora la parte difícil:

La primera vez que forllama al objeto generador creado a partir de su función, ejecutará el código en su función desde el principio hasta que llegue yield, luego devolverá el primer valor del bucle. Luego, cada llamada posterior ejecutará otra iteración del bucle que ha escrito en la función y devolverá el siguiente valor. Esto continuará hasta que el generador se considere vacío, lo que sucede cuando la función se ejecuta sin presionar yield. Eso puede ser porque el ciclo ha llegado a su fin, o porque ya no satisfaces un "if/else".

Tu código explicado

Generador:

# Here you create the method of the node object that will return the generator
def _get_child_candidates(self, distance, min_dist, max_dist):

    # Here is the code that will be called each time you use the generator object:

    # If there is still a child of the node object on its left
    # AND if the distance is ok, return the next child
    if self._leftchild and distance - max_dist < self._median:
        yield self._leftchild

    # If there is still a child of the node object on its right
    # AND if the distance is ok, return the next child
    if self._rightchild and distance + max_dist >= self._median:
        yield self._rightchild

    # If the function arrives here, the generator will be considered empty
    # there is no more than two values: the left and the right children

Llamador:

# Create an empty list and a list with the current object reference
result, candidates = list(), [self]

# Loop on candidates (they contain only one element at the beginning)
while candidates:

    # Get the last candidate and remove it from the list
    node = candidates.pop()

    # Get the distance between obj and the candidate
    distance = node._get_dist(obj)

    # If distance is ok, then you can fill the result
    if distance <= max_dist and distance >= min_dist:
        result.extend(node._values)

    # Add the children of the candidate in the candidate's list
    # so the loop will keep running until it will have looked
    # at all the children of the children of the children, etc. of the candidate
    candidates.extend(node._get_child_candidates(distance, min_dist, max_dist))

return result

Este código contiene varias partes inteligentes:

• El ciclo itera en una lista, pero la lista se expande mientras se repite el ciclo :-) Es una forma concisa de revisar todos estos datos anidados, incluso si es un poco peligroso, ya que puede terminar con un ciclo infinito. En este caso, candidates.extend(node._get_child_candidates(distance, min_dist, max_dist))agote todos los valores del generador, pero whilesigue creando nuevos objetos generadores que producirán valores diferentes de los anteriores ya que no se aplica en el mismo nodo.

• El extend()método es un método de objeto de lista que espera un iterable y agrega sus valores a la lista.

Por lo general, le pasamos una lista:

>>> a = [1, 2]
>>> b = [3, 4]
>>> a.extend(b)
>>> print(a)
[1, 2, 3, 4]

Pero en su código, obtiene un generador, lo cual es bueno porque:

1. No necesita leer los valores dos veces.
2. Es posible que tenga muchos hijos y no quiera que todos estén almacenados en la memoria.

Y funciona porque a Python no le importa si el argumento de un método es una lista o no. ¡Python espera iterables para que funcione con cadenas, listas, tuplas y generadores! Esto se llama escribir pato y es una de las razones por las que Python es tan genial. Pero esta es otra historia, para otra pregunta ...

Puede detenerse aquí o leer un poco para ver un uso avanzado de un generador:

Controlando el agotamiento de un generador

>>> class Bank(): # Let's create a bank, building ATMs
...    crisis = False
...    def create_atm(self):
...        while not self.crisis:
...            yield "$100"
>>> hsbc = Bank() # When everything's ok the ATM gives you as much as you want
>>> corner_street_atm = hsbc.create_atm()
>>> print(corner_street_atm.next())
$100
>>> print(corner_street_atm.next())
$100
>>> print([corner_street_atm.next() for cash in range(5)])
['$100', '$100', '$100', '$100', '$100']
>>> hsbc.crisis = True # Crisis is coming, no more money!
>>> print(corner_street_atm.next())
<type 'exceptions.StopIteration'>
>>> wall_street_atm = hsbc.create_atm() # It's even true for new ATMs
>>> print(wall_street_atm.next())
<type 'exceptions.StopIteration'>
>>> hsbc.crisis = False # The trouble is, even post-crisis the ATM remains empty
>>> print(corner_street_atm.next())
<type 'exceptions.StopIteration'>
>>> brand_new_atm = hsbc.create_atm() # Build a new one to get back in business
>>> for cash in brand_new_atm:
...    print cash
$100
$100
$100
$100
$100
$100
$100
$100
$100
...

Nota: Para Python 3, use print(corner_street_atm.__next__())oprint(next(corner_street_atm))

Puede ser útil para varias cosas como controlar el acceso a un recurso.

Itertools, tu mejor amigo

El módulo itertools contiene funciones especiales para manipular iterables. ¿Alguna vez quisiste duplicar un generador? ¿Cadena de dos generadores? ¿Agrupar valores en una lista anidada con una línea? Map / Zipsin crear otra lista?

Entonces solo import itertools.

¿Un ejemplo? Veamos las posibles órdenes de llegada para una carrera de cuatro caballos:

>>> horses = [1, 2, 3, 4]
>>> races = itertools.permutations(horses)
>>> print(races)
<itertools.permutations object at 0xb754f1dc>
>>> print(list(itertools.permutations(horses)))
[(1, 2, 3, 4),
 (1, 2, 4, 3),
 (1, 3, 2, 4),
 (1, 3, 4, 2),
 (1, 4, 2, 3),
 (1, 4, 3, 2),
 (2, 1, 3, 4),
 (2, 1, 4, 3),
 (2, 3, 1, 4),
 (2, 3, 4, 1),
 (2, 4, 1, 3),
 (2, 4, 3, 1),
 (3, 1, 2, 4),
 (3, 1, 4, 2),
 (3, 2, 1, 4),
 (3, 2, 4, 1),
 (3, 4, 1, 2),
 (3, 4, 2, 1),
 (4, 1, 2, 3),
 (4, 1, 3, 2),
 (4, 2, 1, 3),
 (4, 2, 3, 1),
 (4, 3, 1, 2),
 (4, 3, 2, 1)]

Comprender los mecanismos internos de iteración

La iteración es un proceso que implica iterables (implementando el __iter__()método) e iteradores (implementando el __next__()método). Iterables son los objetos de los que puede obtener un iterador. Los iteradores son objetos que le permiten iterar en iterables.

Hay más sobre esto en este artículo sobre cómo forfuncionan los bucles .

Atajo para entender yield

Cuando vea una función con yielddeclaraciones, aplique este sencillo truco para comprender lo que sucederá:

1. Inserte una línea result = []al comienzo de la función.
2. Reemplace cada uno yield exprcon result.append(expr).
3. Inserte una línea return resulten la parte inferior de la función.
4. Yay, ¡no más yielddeclaraciones! 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 yieldes 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 más rápido también. En otros casos, este truco te atrapará en un bucle infinito, aunque la función original funcione bien. Sigue leyendo para aprender más ...

No confunda sus Iterables, Iteradores y Generadores.

Primero el protocolo iterador : cuando escribes

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

Python realiza los siguientes dos pasos:

1. Obtiene un iterador para mylist:

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

   [Este es el paso sobre el que la mayoría de la gente se olvida de contarte]

2. Utiliza el iterador para recorrer los elementos:

   Siga llamando al next()método en el iterador devuelto desde el paso 1. El valor de retorno de next()se asigna a xy se ejecuta el cuerpo del bucle. Si se genera una excepción StopIterationdesde adentro next(), significa que no hay más valores en el iterador y que se cierra el ciclo.

La verdad es que Python realiza los dos pasos anteriores en cualquier momento que quiera recorrer el contenido de un objeto, por lo que podría ser un ciclo for, pero también podría ser un código como otherlist.extend(mylist)(dondeotherlist hay una lista de Python).

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

Ese es el protocolo iterador, muchos objetos implementan este protocolo:

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

Tenga en cuenta que un forbucle no sabe con qué tipo de objeto se trata: solo sigue el protocolo iterador y se complace en obtener elemento tras elemento a medida que llama next(). Las listas incorporadas devuelven sus elementos uno por uno, los diccionarios devuelven las claves una por una, los archivos devuelven las líneas una por una, etc. Y los generadores regresan ... bueno, ahí es donde yieldentra:

def f123():
    yield 1
    yield 2
    yield 3

for item in f123():
    print item

En lugar de yieldsentencias, si tuviera tres returnsentencias, f123()solo la primera se ejecutaría y la función saldría. Pero f123()no es una función ordinaria. Cuando f123()se llama, ¡ 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 forbucle intenta recorrer el objeto generador, la función se reanuda desde su estado suspendido en la línea siguiente después de yieldque regresó previamente, ejecuta la siguiente línea de código, en este caso, una yielddeclaración, y la devuelve como el siguiente articulo. Esto sucede hasta que sale la función, en cuyo punto se eleva el generador StopIterationy sale el bucle.

Entonces, el objeto generador es algo así como un adaptador: en un extremo exhibe el protocolo iterador, al exponer __iter__()y next()métodos para mantener el forciclo feliz. Sin embargo, en el otro extremo, ejecuta la función lo suficiente como para obtener el siguiente valor y la vuelve a poner en modo suspendido.

¿Por qué usar generadores?

Por lo general, puede escribir código que no use generadores pero implemente la misma lógica. Una opción es usar la lista temporal 'truco' 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 tiene una lista realmente larga. El otro enfoque es implementar una nueva clase iterable SomethingIter que mantenga el estado en los miembros de la instancia y realice 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 next()método puede terminar pareciendo muy complejo y 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 elegante para un objeto que tiene un next()método. Entonces, una función de rendimiento 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 sucede detrás de escena, el forciclo se puede reescribir a esto:

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

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

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

La yieldpalabra clave se reduce a dos hechos simples:

1. Si el compilador detecta la yieldpalabra clave en cualquier lugar dentro de una función, esa función ya no regresa a través de la returndeclaración. En cambio , inmediatamente devuelve un objeto "lista pendiente" perezosa llamado generador
2. Un generador es iterable. ¿Qué es un iterable ? Es algo así como una vista listor seto rangedict, con un protocolo incorporado para visitar cada elemento en un orden determinado .

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

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 makeRangeque sea igual a la de Python range. Llamar 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 al generador a que devuelva inmediatamente sus valores pendientes, puede pasarlo list()(como lo haría con cualquier iterable):

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

Ejemplo comparativo a "solo devolver una lista"

El ejemplo anterior se puede considerar como simplemente crear una lista a la que se agrega y se devuelve:

# 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]

Sin embargo, hay una gran diferencia; ver la última sección

Cómo podrías usar generadores

Un iterable es la última parte de la comprensión de una 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 itertoolsmódulo (asegúrese de usarlo en chain.from_iterablelugar de chaincuando esté justificado). Por ejemplo, incluso podría usar generadores para implementar listas perezosas infinitamente largas como itertools.count(). Puede implementar el suyo propio def enumerate(iterable): zip(count(), iterable)o, alternativamente, hacerlo con la yieldpalabra clave en un ciclo while.

Tenga en cuenta que los generadores se pueden utilizar para muchas cosas más, como la implementación de corutinas 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á.

Entre bastidores

Así es como funciona el "protocolo de iteración de Python". Es decir, lo que sucede cuando lo haces list(makeRange(5)). Esto es lo que describí anteriormente como una "lista lenta 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 .next()función de objetos , que es parte del "protocolo de iteración" y se encuentra en todos los iteradores. Puede usar manualmente la next()función (y otras partes del protocolo de iteración) para implementar cosas sofisticadas, generalmente a expensas de la legibilidad, así que trate de evitar hacer eso ...

Minucias

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

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

Cuando solicita un iterador de una lista, 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 esté haciendo algo como esto ...

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

... luego recuerda que un generador es un iterador ; es decir, es de un solo uso. Si desea reutilizarlo, debe llamar myRange(...)nuevamente. Si necesita usar el resultado dos veces, conviértalo 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 una metaprogramación terriblemente hack) pueden usar itertools.teesi es absolutamente necesario, ya que la propuesta de estándares de Python PEP de iterador copiable ha sido diferida.

¿Qué hace la yieldpalabra clave en Python?

Esquema de respuesta / resumen

• Una función con yield, cuando se llama, devuelve un generador .
• Los generadores son iteradores porque implementan el protocolo de iterador , por lo que puede iterar sobre ellos.
• A un generador también se le puede enviar información , haciéndolo conceptualmente una rutina .
• En Python 3, puede delegar de un generador a otro en ambas direcciones con yield from.
• (El apéndice critica un par de respuestas, incluida la principal, y analiza el uso de returnen un generador).

Generadores:

yieldsolo es legal dentro de una definición de función, y la inclusión yielden una definición de función hace que devuelva un generador.

La idea de los generadores proviene de otros idiomas (ver nota 1) con implementaciones variables. En Python's Generators, la ejecución del código está congelada. en el punto del rendimiento. Cuando se llama al generador (los métodos se analizan a continuación), la ejecución se reanuda y luego se congela en el siguiente rendimiento.

yieldproporciona una manera fácil de implementar el protocolo iterador , definido por los dos métodos siguientes: __iter__y next(Python 2) o __next__(Python 3). Ambos métodos hacen que un objeto sea un iterador que podría verificar con la IteratorClase base abstracta del collectionsmódulo.

>>> 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 verificar de esta manera:

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

Una característica de un Iterator es que una vez agotado , no puede reutilizarlo o restablecerlo:

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

Tendrá que hacer otro si desea volver a utilizar su funcionalidad (consulte la nota 2):

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

Uno puede generar datos mediante programación, 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 está disponible en Python 2), puede usar yield from:

def func(an_iterable):
    yield from an_iterable

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

Corutinas

yield forma una expresión que permite enviar datos al generador (ver nota 3)

Aquí hay un ejemplo, tome nota de la receivedvariable, 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)

En primer lugar, hay que poner en cola el generador con la función incorporada, next. Llamará al método nexto __next__método 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 Nonees lo mismo que llamarnext ):

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

Delegación Cooperativa a Sub-Corutina con yield from

Ahora, recuerde que yield fromestá disponible en Python 3. Esto nos permite delegar corutinas 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 la funcionalidad a un subgenerador y puede ser utilizado por un generador como el anterior:

>>> 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

Puede leer más sobre la semántica precisa de yield fromen PEP 380.

Otros métodos: cerrar y tirar

El closemétodo aumenta GeneratorExiten el punto en que se ejecutó la ejecución de la función. Esto también se llamará __del__para que pueda poner cualquier código de limpieza donde maneje el GeneratorExit:

>>> my_account.close()

También puede lanzar una excepción que puede manejarse en el generador o propagarse 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 yieldpalabra clave en Python?

Resulta que yieldhace mucho. Estoy seguro de que podría agregar ejemplos aún más completos a esto. Si desea más o tiene alguna crítica constructiva, hágamelo saber comentando a continuación.

Apéndice:

Crítica de la respuesta principal / aceptada **

• Está confundido sobre lo que hace que sea iterable , solo usando una lista como ejemplo. Vea mis referencias arriba, pero en resumen: un iterable tiene un __iter__método que devuelve un iterador . Un iterador proporciona un método .next(Python 2 o .__next__(Python 3), que los forbucles llaman implícitamente hasta que se elevaStopIteration , y una vez que lo hace, continuará haciéndolo.
• Luego usa una expresión generadora para describir qué 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 yieldparte.
• En Control de un generador de agotamiento que llama el .nextmétodo, cuando en lugar de eso debería utilizar la función interna, next. Sería una capa apropiada de indirección, porque su código no funciona en Python 3.
• Itertools? Esto no era relevante para lo que yieldhace en absoluto.
• No se discuten los métodos que yieldproporciona junto con la nueva funcionalidad yield fromen Python 3. La respuesta superior / aceptada es una respuesta muy incompleta.

Crítica de la respuesta que sugiere yielden una expresión o comprensión generadora.

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

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 el rendimiento es una expresión, algunos lo han promocionado como interesante para usarlo en comprensiones o expresiones generadoras, a pesar de no mencionar ningún caso de uso particularmente bueno.

Los desarrolladores principales de CPython están discutiendo la depreciación de su asignación . Aquí hay una publicación relevante de la lista de correo:

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. Dejar las cosas como están en Python 3 no es bueno, en mi humilde opinión.

Mi voto es que sea un SyntaxError ya que no obtienes lo que esperas de la sintaxis.

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

En términos de llegar allí, probablemente querremos:

• SyntaxWarning or DeprecationWarning en 3.7
• Advertencia de Py3k en 2.7.x
• SyntaxError en 3.8

Saludos, Nick.

- Nick Coghlan | ncoghlan en gmail.com | Brisbane, Australia

Además, hay un problema pendiente (10544) que parece apuntar en la dirección de que esto nunca es 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 yielduna expresión o comprensión generadora.

La returndeclaración en un generador

En Python 2 :

En una función generadora, la returndeclaración no puede incluir un expression_list. En ese contexto, un desnudo returnindica que el generador está listo y hará StopIterationque se levante.

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

En Python 3 :

En una función de generador, la returninstrucción indica que el generador está listo y hará StopIterationque se genere. El valor devuelto (si lo hay) se usa como argumento para construir StopIterationy se convierte en el StopIteration.valueatributo.

Notas al pie

1. _{Se hizo referencia a los lenguajes CLU, Sather e Icon en la propuesta para introducir el concepto de generadores a Python. La idea general es que una función puede mantener el estado interno y generar puntos de datos intermedios a pedido del usuario. Esto prometió ser superior en rendimiento a otros enfoques, incluido el subprocesamiento de Python , que ni siquiera está disponible en algunos sistemas.}

2. _{Esto significa, por ejemplo, que los xrangeobjetos ( rangeen Python 3) no son Iterators, aunque sean iterables, porque pueden reutilizarse. Al igual que las listas, sus __iter__métodos devuelven objetos iteradores.}

3. _{yieldse introdujo originalmente como una declaración, lo que significa que solo podía aparecer al comienzo de una línea en un bloque de código. Ahora yieldcrea una expresión de rendimiento. 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 recibirlos. Para enviar datos, uno debe poder asignarlos a algo, y para eso, una declaración simplemente no funcionará.}

yieldes igual returnque: devuelve todo lo que le dices (como generador). La diferencia es que la próxima vez que llame al generador, la ejecución comienza desde la última llamada a la yielddeclaración. A diferencia del regreso, el marco de la pila no se limpia cuando se produce un rendimiento, sin embargo, el control se transfiere nuevamente al llamante, por lo que su estado se reanudará la próxima vez que se llame a la función.

En el caso de su código, la función get_child_candidatesactúa como un iterador, de modo que cuando extiende su lista, agrega un elemento a la vez a la nueva lista.

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

Hay una cosa más que mencionar: una función que rinde en realidad no tiene que terminar. He escrito un 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 facilita el trabajo con algunas cosas.

Para aquellos que prefieren un ejemplo de trabajo mínimo, mediten en esta sesión interactiva de 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

TL; DR

En lugar de esto:

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

hacer esto:

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

Siempre que te encuentres construyendo una lista desde cero, yieldcada pieza en su lugar.

Este fue mi primer momento "ajá" con rendimiento.

yieldes una manera azucarada de decir

construir una serie de cosas

Mismo comportamiento:

>>> for square in square_list(4):
...     print(square)
...
0
1
4
9
>>> for square in square_yield(4):
...     print(square)
...
0
1
4
9

Comportamiento diferente:

El rendimiento es de un solo paso : solo puede iterar una vez. Cuando una función tiene un rendimiento, la llamamos función generadora . Y un iterador es lo que devuelve. Esos términos son reveladores. Perdemos la conveniencia de un contenedor, pero obtenemos el poder de una serie que se calcula según sea necesario y arbitrariamente larga.

El rendimiento es perezoso , pospone el cálculo. Una función con rendimiento no se ejecuta en absoluto cuando la llamas. Devuelve un objeto iterador que recuerda dónde lo dejó. Cada vez que llama next()al iterador (esto sucede en un bucle for) la ejecución avanza pulgadas hasta el siguiente rendimiento. returnplantea StopIteration y finaliza la serie (este es el final natural de un ciclo for).

El rendimiento es versátil . Los datos no tienen que almacenarse todos juntos, pueden estar disponibles uno a la vez. Puede ser infinito.

>>> 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 necesitas varios pases y la serie no es demasiado larga, simplemente instálela list():

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

Elección brillante de la palabra yieldporque se aplican ambos significados :

rendimiento - producir o proporcionar (como en la agricultura)

... proporcione los siguientes datos de la serie.

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

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

El rendimiento 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 puedes ver, en el primer caso foo guarda la lista completa en la 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 construirlo en el momento en que se llama a la función.

En el segundo caso, barsolo te da un generador. Un generador es iterable, lo que significa que puede usarlo en un forciclo, etc., pero a cada valor solo se puede acceder 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ó, de esta manera, si está usando un iterable para (digamos) contar hasta 50 mil millones, no tiene que contar hasta 50 mil millones a la vez y almacenar los 50 mil millones de números para contar.

Nuevamente, este es un ejemplo bastante ingenioso, probablemente usaría itertools si realmente quisiera contar hasta 50 mil millones. :)

Este es el caso de uso más simple de generadores. Como dijiste, se puede usar para escribir permutaciones eficientes, usando el rendimiento para impulsar las cosas 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 utilizar para atravesar árboles especializados y todo tipo de otras cosas.

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

La idea clave es que el compilador / intérprete / lo que sea haga algún truco para que, en lo que respecta a la persona que llama, pueda seguir llamando a next () y seguirá devolviendo valores, como si el método generador estuviera en pausa . Ahora, obviamente, no puede realmente "pausar" un método, por lo que el compilador construye una máquina de estados para que recuerde dónde se encuentra actualmente y cómo son las variables locales, etc. Esto es mucho más fácil que escribir un iterador usted mismo.

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

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

Las continuaciones en la teoría de lenguajes de programación son un tipo de cálculo mucho más fundamental, pero no se usan con frecuencia, 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 directa: 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 en el programa, se puede invocar la continuación, de modo 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. En el call/cccamino, la pila del programa se guarda literalmente y luego, cuando se invoca la continuación, se restaura la pila.

En el estilo de paso de continuación (CPS), las continuaciones son solo funciones normales (solo en lenguajes donde las funciones son de primera clase) que el programador administra y pasa explícitamente a las subrutinas. En este estilo, el estado del programa se representa mediante 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 invocandolos simplemente llamándolos y regresando después. Un ejemplo muy simple de estilo de paso de continuación es el siguiente:

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 potencialmente puede ser una operación muy compleja con muchos detalles para escribir), y luego pasa esa continuación (es decir, como primer paso). cierre de clase) a otro operador que procesa un poco más y luego lo llama si es necesario. (Uso mucho este patrón de diseño en la programación de la GUI real, ya sea porque me ahorra líneas de código o, lo que es más importante, para administrar el flujo de control después de que se desencadenan los eventos de la GUI).

El resto de esta publicación, sin pérdida de generalidad, conceptualizará las continuaciones como CPS, porque es muchísimo 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 pueden en general guardar el estado de un cálculo (es decir, la pila de llamadas del programa), los generadores solo pueden guardar el estado de la iteración sobre un iterador . Aunque, 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: 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 el poder 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 la iteración. Esto significa que las continuaciones son mucho más poderosas que los generadores, pero también que los generadores son 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 grabar, intente leer y comprender esta página sobre las continuaciones y la llamada / cc ).

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

Cada vez que yieldse llama, le dice a la función que devuelva una continuación. Cuando se vuelve a llamar a la función, comienza desde donde la dejó. Entonces, en pseudo-pseudocódigo (es decir, no pseudocódigo, pero no código), el nextmétodo del generador es básicamente el siguiente:

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 yieldpalabra clave es en realidad azúcar sintáctica para la función de generador real, básicamente algo 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 comprender lo que está sucediendo, intente usar el estilo de paso continuo para implementar objetos generadores sin usar la yieldpalabra clave.

Aquí hay un ejemplo en lenguaje sencillo. Proporcionaré una correspondencia entre los conceptos humanos de alto nivel y los 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 centrarme en la operación que quiero hacer. Entonces, 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 hago saber cuál es el algoritmo.
  Este paso corresponde a defla función del generador, es decir, la función que contiene a 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 de generador que devuelve un objeto generador. Tenga en cuenta que todavía no me dice ningún número; solo agarra tu papel y lápiz.
• Te pregunto, "dime el próximo número", y tú me dices el primer número; después de eso, esperas a que te pida el próximo número. Es su trabajo recordar dónde estaba, qué números ya ha dicho y cuál es el próximo número. No me importan los detalles.
  Este paso corresponde a llamar .next()al objeto generador.
• ... repita el paso anterior, hasta ...
• eventualmente, podrías llegar a su fin. No me dices un número; solo gritas: "¡sostén tus caballos! ¡Ya terminé! ¡No más números!"
  Este paso corresponde al objeto generador que finaliza su trabajo y genera una StopIterationexcepción La función de generador no necesita generar la excepción. Se genera automáticamente cuando la función finaliza o emite a return.

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

El usuario más famoso del protocolo iterador es el forcomando en Python. Entonces, cada vez que haces un:

for item in sequence:

no importa si sequencees una lista, una cadena, un diccionario o un objeto generador como se describe anteriormente; el resultado es el mismo: lee los elementos de una secuencia uno por uno.

Tenga en cuenta que defintroducir una función que contiene una yieldpalabra clave no es la única forma de crear un generador; Es la forma más fácil de crear 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.

Si bien muchas respuestas muestran por qué usarías un yieldpara crear un generador, hay más usos para yield. Es bastante fácil hacer una rutina, 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 yieldpara crear un generador.

Para ayudar a comprender qué yieldhace a 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 toca con el dedo yield, debe esperar a que se ingrese a nexto senda. Cuando nextse llama a, se rastrea el código hasta que se golpea el yield... el código a la derecha del yieldse evalúa y se devuelve a la persona que llama ... luego espera. Cuando nextse vuelve a llamar, realiza otro ciclo a través del código. Sin embargo, notará que en una rutina, yieldtambién se puede usar con un send... que enviará un valor de la persona que llama a la función de rendimiento. Si unsend se da un, entoncesyieldrecibe el valor enviado y lo escupe por el lado izquierdo ... luego la traza a través del código progresa hasta que yieldvuelva a presionar el botón (devolviendo el valor al final, como si nextse hubiera 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 yielduso y significado (desde Python 3.3):

yield from <expr>

De PEP 380 - 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 contenga 'rendimiento' sea factorizada y colocada en otro generador. Además, se permite que el subgenerador regrese con un valor, y el valor se pone a disposición del generador de delegación.

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

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

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

para evitar que las corutinas se confundan con un generador regular (hoy yieldse usa en ambos).

Todas excelentes respuestas, aunque un poco difíciles para los novatos.

Supongo que has aprendido la returndeclaración.

Como analogía, returny yieldson gemelos. returnsignifica 'regresar y parar' mientras que 'ceder' significa 'regresar, pero continuar'

1. Intenta obtener una lista num_con return.

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

Ejecutarlo:

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

Mira, solo obtienes un solo número en lugar de una lista de ellos. returnnunca le permite prevalecer felizmente, solo implemente una vez y salga.

2. Ahi viene yield

Reemplazar returncon 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 el returnque se ejecuta una vez y se detiene, se yieldejecutan los tiempos planeados. Puedes interpretar returncomo return one of themy yieldcomo return all of them. Esto se llama iterable.

3. Un paso más podemos reescribir la yielddeclaración conreturn

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]

Se trata del núcleo yield.

La diferencia entre las returnsalidas de una lista y la yieldsalida del objeto es:

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

En conclusión, como metáfora para asimilarlo:

• returny yieldson gemelos
• listy generatorson gemelos

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

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))

Usando 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)

Uso de cierres de objetos en lugar de generadores (porque ClosuresAndObjectsAreEquivalent )

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)

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

Además, tenga en cuenta que yieldse puede usar en las rutinas como el doble de su uso en las funciones del generador. Aunque no es el mismo uso que el fragmento de código, (yield)se puede usar como una expresión en una función. Cuando una persona que llama envía un valor al método utilizando el send()método, la rutina se ejecutará hasta (yield)que se encuentre la siguiente instrucción.

Los generadores y las rutinas son una forma genial de configurar aplicaciones de tipo flujo de datos. Pensé que valdría la pena saber sobre el otro uso de la yielddeclaración en las funciones.

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

Para implementar iteradores, generadores y grupos de subprocesos para ejecución concurrente, etc. como thunks (también llamados funciones anónimas), uno usa 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 la llamada " iter ".

Hay muchas formas de implementar este cálculo. Utilicé la mutación, pero es fácil hacerlo sin mutación, devolviendo el valor actual y el siguiente rendimiento.

Aquí hay una demostración que utiliza la estructura de R6RS, pero la semántica es absolutamente idéntica a la de Python. Es el mismo modelo de cálculo, 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
->

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 yieldmantiene la posición de flujo del programa y el siguiente ciclo comienza desde la posición "rendimiento". Parece que está esperando en esa posición, y justo antes de eso, devuelve 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 yieldhace.

Me gusta pensar que un hilo tiene una pila (incluso cuando no está implementado de esa manera).

Cuando se llama a una función normal, coloca sus variables locales en la pila, realiza algunos cálculos, luego borra la pila y regresa. Los valores de sus variables locales nunca se vuelven a ver.

Con una yieldfunción, 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 se invoca luego), de manera similar coloca sus variables locales en la pila y calcula durante un tiempo. Pero luego, cuando llega a la yielddeclaración, antes de borrar su parte de la pila y regresar, toma una instantánea de sus variables locales y las almacena en el objeto generador. También escribe el lugar donde está actualmente en su código (es decir, la yielddeclaración particular ).

Por lo tanto, es una especie de función congelada en la que se cuelga el generador.

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 se detuvo, ajena 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 yielddeclaración puede ser inalcanzable, pero si está presente en algún lugar, cambia la naturaleza de lo que estamos tratando.

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

Las llamadas yielderFunction()no ejecutan su código, pero hacen un generador del código. (Tal vez sea una buena idea nombrar tales cosas con el yielderprefijo de 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_codey gi_frameson donde se almacena el estado congelado. Al explorarlos dir(..), podemos confirmar que nuestro modelo mental anterior es creíble.

Como cada respuesta sugiere, yieldse usa para crear un generador de secuencia. Se utiliza para generar alguna secuencia dinámicamente. Por ejemplo, mientras lee un archivo línea por línea en una red, puede usar la yieldfunción 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)

Control de Ejecución Transferencia gotcha

El control de ejecución se transferirá de getNextLines () al forbucle cuando se ejecute el rendimiento. Por lo tanto, cada vez que se invoca getNextLines (), la ejecución comienza desde el punto donde se detuvo la última vez.

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

imprimirá

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

Un ejemplo sencillo para entender de qué se trata: yield

def f123():
    for _ in range(4):
        yield 1
        yield 2


for i in f123():
    print (i)

El resultado es:

1 2 1 2 1 2 1 2

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

Cuando yieldse usa en lugar de una returnfunción de python, esa función se convierte en algo especial llamado generator function. Esa función devolverá un objeto de generatortipo. La yieldpalabra clave es una bandera para notificar al compilador de Python para que trate dicha función especialmente. Las funciones normales finalizarán una vez que se devuelva algún valor. Pero con la ayuda del compilador, la función del generador puede considerarse como reanudable. 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 StopIterationexcepción (que también es parte del protocolo iterador), o llegará al final de la función. Encontré muchas referencias sobre generatoresto, pero unodesde el functional programming perspectivees el más digerible.

(Ahora quiero hablar sobre la lógica subyacente generator, y iteratorsegún mi propia comprensión. Espero que esto pueda ayudarlo a comprender la motivación esencial del iterador y el generador. Tal concepto aparece en otros lenguajes, como C #).

Según tengo entendido, 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 este enfoque ingenuo es problemático. Si el volumen de datos es enorme, es caro almacenarlos como un todo de antemano. Entonces, en lugar de almacenar el datapropio directamente, ¿por qué no almacenar algún tipo de metadataindirectamente, es decirthe logic how the data is computed .

Hay 2 enfoques para envolver dichos metadatos.

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

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

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

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

for i in simple_generator():
    print i

simplemente salidas

one
two
three

La potencia proviene del uso del 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 guardado para cálculos especialmente grandes

Supongamos que desea crear una rangefunción propia que produzca 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í;

for i in myRangeNaive(10):
    print i

Pero esto es ineficiente porque

• Crea una matriz que solo usa una vez (esto desperdicia memoria)
• ¡Este código en realidad recorre esa matriz dos veces! :(

Afortunadamente, Guido y su equipo fueron lo suficientemente generosos como para desarrollar generadores para que pudiéramos hacer esto;

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 llamado next()ejecuta la función hasta que alcanza una declaración de "rendimiento" en la que se detiene y "produce" el valor o llega al final de la función. En este caso, en la primera llamada, se next()ejecuta hasta la declaración de rendimiento y el rendimiento 'n', en la siguiente llamada ejecutará la declaración de incremento, volverá al 'while', la evaluará y, si es verdadero, se detendrá y ceder 'n' nuevamente, continuará de esa manera hasta que la condición while vuelva falsa y el generador salte al final de la función.

El rendimiento es un objeto

A returnen una función devolverá un solo valor.

Si desea que una función devuelva un gran conjunto de valores , use yield.

Más importante aún, yieldes una barrera .

como barrera en el lenguaje CUDA, no transferirá el control hasta que se complete.

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

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

Muchas personas usan en returnlugar de hacerlo yield, pero en algunos casos yieldpueden ser más eficientes y más fáciles de trabajar.

Aquí hay un ejemplo que yielddefinitivamente es mejor para:

volver (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.

Funciones de llamada

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 yieldusa tres líneas en lugar de cinco y tiene una variable menos de la que 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 quieres hacer un generador.

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

La yieldpalabra clave simplemente recopila resultados que regresan. Piensa en yieldcomoreturn +=

Aquí hay un yieldenfoque simple , 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 ingrese esto en su REPL y luego intente llamarlo, obtendrá un resultado desconcertante:

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

Esto se debe a la presencia de yieldPython señalado que desea crear un generador , es decir, un objeto que genera valores a pedido.

Entonces, ¿cómo se generan estos valores? Esto puede hacerse directamente usando la función incorporadanext o, indirectamente, al alimentarlo a una construcción que consume valores.

Usando la next()función incorporada, invoca directamente .next/ __next__, obligando 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 fibun forbucle, un listinicializador, un tupleinicializador o cualquier otra cosa que espere un objeto que genere / produzca valores, "consumirá" el generador hasta que no pueda producir más valores (y regrese) :

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

Del mismo modo, con un tupleinicializador:

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

Un generador difiere de una función en el sentido de que es vago. Lo logra manteniendo su estado local y permitiéndole reanudar cuando lo necesite.

Cuando invocas fibpor primera vez llamándolo:

f = fib()

Python compila la función, encuentra la yieldpalabra clave y simplemente le devuelve un objeto generador. No muy útil parece.

Cuando solicita que genere el primer valor, directa o indirectamente, ejecuta todas las declaraciones que encuentra, hasta que encuentra un yield, luego devuelve el valor que proporcionó yieldy hace una pausa. Para un ejemplo que demuestre esto mejor, usemos algunas printllamadas (reemplace con print "text"if 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 REPL:

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

ahora tiene un objeto generador esperando un comando para que genere un valor. Use nexty vea lo que se imprime:

>>> 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 el que se devuelve yield. Llama de nextnuevo 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 yield valuey se reanuda desde allí. Se imprime el siguiente mensaje y la búsqueda de la yieldinstrucción para pausar se realiza nuevamente (debido al whilebucle).