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

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

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 se llama al método _get_child_candidates? ¿Se devuelve una lista? ¿Un solo elemento? ¿Se vuelve a llamar? ¿Cuándo se detendrán las llamadas posteriores?


1. Esta pieza de código fue escrita por Jochen Schulz (jrschulz), quien creó una gran biblioteca de Python para espacios métricos. Este es el enlace a la fuente completa: Módulo mspace .
respuesta

Para comprender lo que yieldhace, debe comprender 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. La lectura de 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 usa una lista de comprensión, crea una lista y, por lo tanto, es iterable:

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

Todo lo que puede usar " for... in..." es iterable; lists, strings, archivos...

Estos iterables son útiles porque puede leerlos tanto como 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 iterable 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 lo mismo, excepto que usó ()en lugar de []. PERO, no se 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.

Producir

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

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

Aquí es un ejemplo inútil, pero es útil cuando sabe que su función devolverá un gran conjunto de valores que solo necesitará 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 dificil:

La primera vez forque llama 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 ciclo. Luego, cada llamada subsiguiente 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 pulsar yield. Eso puede deberse a que el ciclo ha llegado a su fin o porque ya no satisface un "if/else".


Su 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 itera el ciclo. Es una forma concisa de revisar todos estos datos anidados, incluso si es un poco peligroso, ya que puede terminar con un bucle infinito. En este caso, candidates.extend(node._get_child_candidates(distance, min_dist, max_dist))agota todos los valores del generador, pero whilesigue creando nuevos objetos generadores que producirán valores diferentes a 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.

Normalmente le pasamos una lista:

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

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

  1. No es necesario 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, por lo que funcionará con cadenas, listas, tuplas y generadores. Esto se llama tipeo de 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:

Controlar 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 ha deseado duplicar un generador? ¿Encadenar dos generadores? ¿Agrupar valores en una lista anidada con una sola línea? Map / Zipsin crear otra lista?

Entonces solo import itertools.

¿Un ejemplo? Veamos los 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 la iteración

La iteración es un proceso que implica iterables (implementación del __iter__()método) e iteradores (implementación del __next__()método). Los iterables son cualquier objeto del que puede obtener un iterador. Los iteradores son objetos que le permiten iterar sobre iterables.

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

Atajo a la comprensiónyield

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

  1. Inserta 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 también más rápido. En otros casos, este truco lo dejará atrapado en un ciclo infinito, aunque la función original funciona bien. Siga leyendo para obtener más información...

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:

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

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

  2. Utiliza el iterador para recorrer los elementos:

    Siga llamando al next()método en el iterador devuelto del 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 dentro 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 recorrer el contenido de un objeto, por lo que podría ser un bucle for, pero también podría ser un código otherlist.extend(mylist)(donde otherlistestá 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 en la misma clase y __iter__()tener return . Esto funcionará para casos simples, pero no cuando desee que dos iteradores recorran el mismo objeto al mismo tiempo.next()__iter__()self

Así que ese es el protocolo iterador, muchos objetos implementan este protocolo:

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

Tenga en cuenta que un forciclo no sabe con qué tipo de objeto está tratando: simplemente sigue el protocolo del iterador y está feliz de obtener un elemento tras otro a medida que llama next(). Las listas integradas 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 devuelven... bueno, ahí es donde yieldentra:

def f123():
    yield 1
    yield 2
    yield 3

for item in f123():
    print item

En lugar de yielddeclaraciones, si tuviera tres returndeclaraciones, f123()solo se ejecutaría la primera 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, sino que entra en un estado suspendido. Cuando el forbucle intenta recorrer el objeto generador, la función se reanuda desde su estado suspendido en la siguiente línea después de la yieldque regresó anteriormente, ejecuta la siguiente línea de código, en este caso, una yielddeclaración, y la devuelve como la siguiente ít. Esto sucede hasta que la función sale, momento en el que el generador aumenta StopIterationy el bucle sale.

Entonces, el objeto generador es una especie de adaptador: en un extremo exhibe el protocolo iterador, al exponer __iter__()y next()métodos para mantener forfeliz el ciclo. En el otro extremo, sin embargo, 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 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 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 parecer 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 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 forbucle se puede reescribir así:

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 yieldpalabra clave se reduce a dos simples hechos:

  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 returninstrucción. En su lugar , devuelve inmediatamente un objeto perezoso de "lista pendiente" llamado generador.
  2. Un generador es iterable. ¿Qué es un iterable ? Es algo así como una vista listor setor rangeor dict, con un protocolo incorporado para visitar cada elemento en un orden determinado .

En pocas palabras: un generador es una lista perezosa pendiente de forma incremental , y yieldlas sentencias le permiten usar la notación de función para programar los valores de la lista que el generador debería escupir de forma incremental.

generator = myYieldingFunction(...)  # basically a list (but lazy)
x = list(generator)  # evaluate every element into a list

   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

Básicamente, cada vez yieldque se encuentra la declaración, la función se detiene y guarda su estado, luego emite "el siguiente valor de retorno en la 'lista'" de acuerdo con el protocolo iterador de python (a alguna construcción sintáctica como un bucle for que llama next()y captura repetidamente una StopIterationexcepción, etc.). Es posible que haya encontrado generadores con expresiones generadoras ; Las funciones del generador son más poderosas porque puede pasar argumentos a la función del generador en pausa, usándolos para implementar rutinas. Más sobre eso más adelante.


Ejemplo básico ('lista')

Definamos una función makeRangeque sea como la de Python range. Llamando 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 a list()(como lo haría con cualquier iterable):

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

Comparando el ejemplo con "simplemente devolviendo una lista"

Se puede considerar que el ejemplo anterior simplemente crea una lista a la que agrega y devuelve:

# return a list                  #  # return a generator
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
    return TO_RETURN             # 

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

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


Cómo podría usar los 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 chain.from_iterableen lugar de chaincuando esté garantizado). Por ejemplo, incluso podría usar generadores para implementar listas perezosas infinitamente largas como itertools.count(). Puede implementar su propio def enumerate(iterable): zip(count(), iterable), o alternativamente hacerlo con la yieldpalabra clave en un bucle while.

Tenga en cuenta: los generadores en realidad se pueden usar para muchas más cosas, como implementar 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á.


Entre bastidores

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

>>> x=iter(range(5))
>>> next(x)  # calls x.__next__(); x.next() is deprecated
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()simplemente llama a la función de objetos .__next__(), que forma 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...


corrutinas

Ejemplo de rutina :

def interactiveProcedure():
    userResponse = yield makeQuestionWebpage()
    print('user response:', userResponse)
    yield 'success'

coroutine = interactiveProcedure()
webFormData = next(coroutine)  # same as .send(None)
userResponse = serveWebForm(webFormData)

# ...at some point later on web form submit...

successStatus = coroutine.send(userResponse)

Minucias

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

En Python-speak, un iterable es cualquier objeto que "entiende el concepto de un bucle for" como una lista [1,2,3], y un iterador es una instancia específica del bucle for solicitado [1,2,3].__iter__(). Un generador es exactamente igual que cualquier iterador, excepto por la forma en que fue escrito (con sintaxis de 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 pueda hacer algo como esto...

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

...entonces recuerda que un generador es un iterador ; es decir, es de un solo uso. Si desea reutilizarlo, debe myRange(...)volver a llamar. 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 una metaprogramación terriblemente hackeada) pueden usar itertools.tee( todavía funciona en Python 3 ) si es absolutamente necesario, ya que la propuesta de estándares PEP de Python del iterador copiable se ha aplazado.

What does the yield keyword do in Python?

Esquema/resumen de respuestas

  • 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 , convirtiéndolo conceptualmente en una corrutina .
  • 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 de arriba, y analiza el uso de returnen un generador).

Generadores:

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

La idea de los generadores proviene de otros lenguajes (ver nota al pie 1) con diferentes implementaciones. En los generadores de Python, la ejecución del código se congela en el punto de rendimiento. Cuando se llama al generador (los métodos se describen 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 siguientes dos métodos: __iter__y next(Python 2) o __next__(Python 3). Ambos métodos hacen que un objeto sea un iterador que puede 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 el tipo de esta manera:

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

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

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

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

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

Uno puede generar 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 fromtambién permite la delegación a subgeneradores, lo que se explicará en la siguiente sección sobre delegación cooperativa con subrutinas.

Corrutinas:

yieldforma una expresión que permite enviar datos al generador (ver nota al pie 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)

Primero, debemos poner en cola el generador con la función incorporada, next. nextLlamará al método o apropiado __next__, según 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-Corrutina conyield from

Ahora, recordemos que yield fromestá disponible en Python 3. Esto nos permite delegar rutinas a una subrutina:


def money_manager(expected_rate):
    # must receive deposited value from .send():
    under_management = yield                   # yield None to start.
    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'''
            raise
        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'''
    # must queue up manager:
    next(manager)      # <- same as manager.send(None)
    # This is where we send the initial deposit to the manager:
    manager.send(deposited)
    try:
        yield from manager
    except GeneratorExit:
        return manager.close()  # delegate?

Y ahora podemos delegar la funcionalidad a un subgenerador y puede ser utilizada por un generador tal como se indicó anteriormente:

my_manager = money_manager(.06)
my_account = investment_account(1000, my_manager)
first_year_return = next(my_account) # -> 60.0

Ahora simule agregar otros 1,000 a la cuenta más el rendimiento de la cuenta (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 lanzar

El closemétodo se genera GeneratorExiten el punto en que se congeló la ejecución de la función. Esto también será llamado por __del__para que pueda poner cualquier código de limpieza donde maneje 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())

Aumentos:

Traceback (most recent call last):
  File "<stdin>", line 4, in <module>
  File "<stdin>", line 6, in money_manager
  File "<stdin>", line 2, in <module>
ValueError

Conclusión

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

What does the yield keyword do in Python?

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


Apéndice:

Crítica de la respuesta principal/aceptada**

  • Está confundido sobre lo que hace iterable , solo usando una lista como ejemplo. Vea mis referencias anteriores, 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 bucles llaman implícitamente forhasta que genera StopIteration, y una vez que lo hace, continuará haciéndolo.
  • Luego usa una expresión de generador 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 el control del agotamiento de un generador , llama al .nextmétodo, cuando en su lugar debería usar la función incorporada, 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 respuesta sugiriendo yielden un generador expresión o comprensión.

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

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

On 30 January 2017 at 19:05, Brett Cannon wrote:

On Sun, 29 Jan 2017 at 16:39 Craig Rodrigues wrote:

I'm OK with either approach. Leaving things the way they are in Python 3 is no good, IMHO.

My vote is it be a SyntaxError since you're not getting what you expect from the syntax.

I'd agree that's a sensible place for us to end up, as any code relying on the current behaviour is really too clever to be maintainable.

In terms of getting there, we'll likely want:

  • SyntaxWarning or DeprecationWarning in 3.7
  • Py3k warning in 2.7.x
  • SyntaxError in 3.8

Cheers, Nick.

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

Además, hay un problema pendiente (10544) que parece apuntar 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 ponga yieldun generador de expresión o comprensión.

La returndeclaración en un generador.

En Python 2 :

In a generator function, the return statement is not allowed to include an expression_list. In that context, a bare return indicates that the generator is done and will cause StopIteration to be raised.

An expression_listes básicamente cualquier cantidad de expresiones separadas por comas; esencialmente, en Python 2, puede detener el generador con return, pero no puede devolver un valor.

En Python 3 :

In a generator function, the return statement indicates that the generator is done and will cause StopIteration to be raised. The returned value (if any) is used as an argument to construct StopIteration and becomes the StopIteration.value attribute.

notas al pie

  1. Se hizo referencia a los lenguajes CLU, Sather e Icon en la propuesta para introducir el concepto de generadores en 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 prometía 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 rangelos objetos no son Iterators, aunque sean iterables, porque se pueden reutilizar. Al igual que las listas, sus __iter__métodos devuelven objetos iteradores.

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 podría recibirlos. Para enviar datos, uno debe poder asignarlos a algo, y para eso, una declaración simplemente no funcionará.

yieldes como return- devuelve lo que le digas (como un generador). La diferencia es que la próxima vez que llame al generador, la ejecución comenzará desde la última llamada a la yielddeclaración. A diferencia de return, el marco de la pila no se limpia cuando se produce un rendimiento, sin embargo, el control se transfiere de nuevo a la persona que llama, 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 publicaste, sería mucho más claro devolver una tupla y agregarla a la lista.

Hay una cosa adicional que mencionar: una función que produce en realidad 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 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;RD

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.

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

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


yieldes una forma dulce de decir

build a series of stuff

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 ganamos 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 un rendimiento en realidad 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 lentamente hasta el siguiente rendimiento. returngenera 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 necesita varios pases y la serie no es demasiado larga, simplemente llámelo list():

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

Brillante elección de la palabra yieldporque se aplican ambos significados :

yield — produce or provide (as in agriculture)

... proporcionar los siguientes datos de la serie.

yield — give way or relinquish (as in political power)

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

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 puede ver, en el primer caso fooguarda toda la lista 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 forbucle, etc., pero solo se puede acceder a cada valor 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 todos a la vez y almacenar los 50 mil millones de números para contar.

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

Este es el caso de uso más simple de los generadores. Como dijiste, se puede usar para escribir permutaciones eficientes, usando el rendimiento para empujar 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 usar 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á familiarizado con ellos.

La idea clave es que el compilador/intérprete/lo que sea haga algunos trucos 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 crea una máquina de estado para que recuerde dónde se encuentra actualmente y cómo se ven las variables locales, etc. Esto es mucho más fácil que escribir un iterador usted mismo.

Hay un tipo de respuesta que creo que aún no se ha dado, entre las muchas excelentes respuestas que describen cómo usar los 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 rutina, pero las continuaciones representan el mecanismo más general para entender lo que está pasando).

Las continuaciones en la teoría de los 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 sencilla: es el estado de un cómputo que aún no ha terminado. En este estado se guardan los valores actuales de las variables, las operaciones pendientes de realizar, etc. Luego, en algún punto más adelante en el programa, se puede invocar la continuación, de modo que las variables del programa se restablecen a ese estado y se llevan 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, la pila se restaura.

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 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ándolos 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 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 primer paso). cierre de clase) a otro operador que realiza más procesamiento y luego lo llama si es necesario. (Utilizo mucho este patrón de diseño en la programación de GUI real, ya sea porque me ahorra líneas de código o, más importante, para administrar el flujo de control después de que se activan los eventos de 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 iteración sobre un iterador . Aunque, esta definición es un poco 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 probablemente no sea 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 iteración. Esto significa que las continuaciones son mucho más poderosas 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 del lenguaje, y son más fáciles de usar para el programador (si tiene algo de tiempo para quemar, intente leer y comprender esta página sobre continuaciones y call/cc ).

Pero podría implementar fácilmente (y conceptualizar) los 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 se quedó. 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áctico 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 los generadores en Python es más compleja. Pero como ejercicio para comprender lo que está sucediendo, intente usar el estilo de paso de continuación 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 concentrarme 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 calculan de una manera específica, y te digo cuál es el algoritmo.
    Este paso corresponde a defining la función generadora, es decir, la función que contiene un yield.
  • Algún tiempo después, te digo: "Está bien, prepárate para decirme la secuencia de números".
    Este paso corresponde a llamar a la función generadora que devuelve un objeto generador. Tenga en cuenta que aún no me dice ningún número; solo tomas tu papel y lápiz.
  • Yo te pido, "dime el próximo número", y tú me dices el primer número; después de eso, esperas a que te pida el siguiente 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(generator)al objeto generador.
    (En Python 2, .nextera un método del objeto generador; en Python 3, se llama .__next__, pero la forma correcta de llamarlo es usando la next()función integrada como len()y .__len__)
  • … repetir el paso anterior, hasta que…
  • eventualmente, podrías llegar a un final. No me dices un número; simplemente grita: "¡Retengan sus caballos! ¡Terminé! ¡No más números!"
    Este paso corresponde al objeto generador que finaliza su trabajo y genera una StopIterationexcepción.
    La función generadora no necesita generar la excepción. Se genera automáticamente cuando la función finaliza o emite un archivo return.

Esto es lo que hace un generador (una función que contiene un yield); comienza a ejecutarse en el primer next(), se detiene cada vez que hace un yield, y cuando se le solicita el next()valor, continúa desde el último punto. 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, siempre que hagas:

for item in sequence:

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

Tenga en cuenta que defejecutar una función que contiene una yieldpalabra clave no es la única forma de crear un generador; es solo 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ía a yieldpara 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 yieldpara crear un generador.

Para ayudar a comprender lo que yieldhace a en el siguiente código, puede usar su dedo para rastrear el ciclo a través de cualquier código que tenga una extensión yield. Cada vez que su dedo toca el yield, debe esperar a que se ingrese un nexto un . sendCuando nextse llama a, rastrea el código hasta que presiona 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 bucle a través del código. Sin embargo, notará que en una corrutina, yieldtambién se puede usar con un send… que enviará un valor de la persona que llama a la función de rendimiento. Si sendse da a, entoncesyieldrecibe el valor enviado y lo escupe por el lado izquierdo... luego el seguimiento a través del código avanza hasta que presiona de yieldnuevo (devolviendo el valor al final, como si hubiera nextsido 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 :

A syntax is proposed for a generator to delegate part of its operations to another generator. This allows a section of code containing 'yield' to be factored out and placed in another generator. Additionally, the subgenerator is allowed to return with a value, and the value is made available to the delegating generator.

The new syntax also opens up some opportunities for optimisation when one generator re-yields values produced by another.

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 yieldse usa en ambos).

Todas excelentes respuestas, sin embargo, 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 'rendir' significa 'regresar, pero continuar'

  1. Try to get a num_list with return.
def num_list(n):
    for i in range(n):
        return i

Ejecutarlo:

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

Mira, obtienes solo un número en lugar de una lista de ellos. returnNunca te permite prevalecer felizmente, solo implementa una vez y renuncia.

  1. There comes 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, usted gana para obtener todos los números.

En comparación con returnlo que se ejecuta una vez y se detiene, los yieldtiempos de ejecución planificados. Puede interpretar returncomo return one of them, y yieldcomo return all of them. iterableEsto se llama

  1. One more step we can rewrite yield statement with 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 sobre yield.

La diferencia entre returnlas salidas de una lista y la salida del objeto yieldes:

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

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 procesadores, uno usa mensajes enviados a un objeto de cierre , que tiene un despachador, y el despachador responde a "mensajes" .

" next " es un mensaje enviado a un cierre, creado por la llamada " iter ".

Hay muchas maneras de implementar este cálculo. Usé mutación, pero es posible hacer este tipo de cálculo sin mutación, devolviendo el valor actual y el siguiente productor (haciéndolo transparente referencial ). Racket utiliza una secuencia de transformaciones del programa inicial en algunos lenguajes intermedios, una de esas reescrituras hace que el operador yield se transforme en algún lenguaje con operadores más simples.

Aquí hay una demostración de cómo se podría reescribir el rendimiento, que usa la estructura de R6RS, pero la semántica es idéntica a la de Python. Es el mismo modelo de cálculo y solo se requiere un cambio en la sintaxis para reescribirlo usando el rendimiento de 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 algunos ejemplos de Python de cómo implementar 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))

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 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 "leer la página 19 de 'Python: Essential Reference' 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 corrutinas como el doble de su uso en funciones de generador. Aunque no tiene el mismo uso que su fragmento de código, (yield)puede usarse 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 corrutina se ejecutará hasta (yield)que se encuentre la siguiente declaración.

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

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)

Producción:

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 del flujo del programa y el siguiente ciclo comienza desde la posición de "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 llamar a la función, devolviendo un objeto generador, cuyo next()método luego se invoca), coloca de manera similar 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 en el que se encuentra actualmente en su código (es decir, la yielddeclaración en particular).

Así que es una especie de función congelada a la que se aferra 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 computando desde donde la dejó, ajena al hecho de que acababa de pasar una eternidad en almacenamiento en frío.

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

La llamada yielderFunction()no ejecuta su código, sino que hace un generador a partir del código. (Tal vez sea una buena idea nombrar esas cosas con el yielderprefijo para facilitar la lectura).

>>> 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. Explorándolos con dir(..), podemos confirmar que nuestro modelo mental anterior es creíble.

Un ejemplo fácil para entender de qué se trata:yield

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


for i in f123():
    print (i)

La salida es:

1 2 1 2 1 2 1 2

Imagina que has creado una máquina notable que es capaz de generar miles y miles de bombillas al día. La máquina genera estas bombillas en cajas con un número de serie único. No tiene suficiente espacio para almacenar todas estas bombillas al mismo tiempo, por lo que le gustaría ajustarlo para generar bombillas a pedido.

Los generadores de Python no difieren mucho de este concepto. Imagine que tiene una función llamada barcode_generatorque genera números de serie únicos para las cajas. Obviamente, puede tener una gran cantidad de dichos códigos de barras devueltos por la función, sujeto a las limitaciones del hardware (RAM). Una opción más sabia y que ahorra espacio es generar esos números de serie a pedido.

Código de la máquina:

def barcode_generator():
    serial_number = 10000  # Initial barcode
    while True:
        yield serial_number
        serial_number += 1


barcode = barcode_generator()
while True:
    number_of_lightbulbs_to_generate = int(input("How many lightbulbs to generate? "))
    barcodes = [next(barcode) for _ in range(number_of_lightbulbs_to_generate)]
    print(barcodes)

    # function_to_create_the_next_batch_of_lightbulbs(barcodes)

    produce_more = input("Produce more? [Y/n]: ")
    if produce_more == "n":
        break

Tenga en cuenta el next(barcode)bit.

Como puede ver, tenemos una "función" autónoma para generar el siguiente número de serie único cada vez. ¡ Esta función devuelve un generador ! Como puede ver, no estamos llamando a la función cada vez que necesitamos un nuevo número de serie, sino que estamos usando next()el generador dado para obtener el siguiente número de serie.

Iteradores perezosos

Para ser más precisos, ¡este generador es un iterador perezoso ! Un iterador es un objeto que nos ayuda a atravesar una secuencia de objetos. Se llama perezoso porque no carga todos los elementos de la secuencia en la memoria hasta que se necesitan. El uso de nexten el ejemplo anterior es la forma explícita de obtener el siguiente elemento del iterador. La forma implícita es usar bucles for:

for barcode in barcode_generator():
    print(barcode)

Esto imprimirá códigos de barras infinitamente, pero no se quedará sin memoria.

En otras palabras, un generador parece una función pero se comporta como un iterador.

¿Aplicación del mundo real?

Finalmente, ¿aplicaciones del mundo real? Suelen ser útiles cuando trabajas con grandes secuencias. Imagine leer un archivo enorme desde un disco con miles de millones de registros. Leer todo el archivo en la memoria, antes de que pueda trabajar con su contenido, probablemente no sea factible (es decir, se quedará sin memoria).

Como sugiere cada respuesta, yieldse usa para crear un generador de secuencias. 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)

Transferencia de control de ejecución gotcha

El control de ejecución se transferirá desde getNextLines() al forbucle cuando se ejecute yield. 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"

En resumen, la yielddeclaración transforma su función en una fábrica que produce un objeto especial llamado generatorque envuelve el cuerpo de su función original. Cuando generatorse itera, ejecuta su función hasta que llega a la 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 salidas

one
two
three

El poder 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, siendo el beneficio la memoria guardado para cálculos especialmente grandes

Digamos que desea crear su propia rangefunción 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

  • Creas una matriz que solo usas 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, next()se ejecuta hasta la sentencia yield y yield 'n', en la siguiente llamada ejecutará la sentencia de incremento, volverá al 'while', lo evaluará y, si es cierto, se detendrá y yield 'n' nuevamente, continuará de esa manera hasta que la condición while devuelva falso y el generador salte al final de la función.

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

Cuando yieldse usa en lugar de returnen una funció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 un indicador para notificar al compilador de python que trate dicha función de manera especial. Las funciones normales terminarán una vez que se devuelva algún valor. Pero con la ayuda del compilador, la función del generador se puede considerar como reanudable. Es decir, se restaurará el contexto de ejecución y la ejecución continuará desde la última ejecución. Hasta que llame explícitamente a return, lo 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 generatorpero estade la functional programming perspectivees la más digerible.

(Ahora quiero hablar sobre el fundamento detrás de generator, y iteratorbasado en mi propio entendimiento. Espero que esto pueda ayudarlo a comprender la motivación esencial del iterador y el generador. Este concepto también 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 costoso almacenarlos como un todo de antemano. Entonces, en lugar de almacenarlo datadirectamente, ¿por qué no almacenar algún tipo de forma metadataindirecta, es decir,the 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 iteratorque 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 objecttodavía devuelto IS-Aporque también implementa el protocolo iterador.

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

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 , utilice yield.

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

like barrier in the CUDA language, it will not transfer control until it gets completed.

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

Luego, cada 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.

Mucha gente usa returnen lugar de yield, pero en algunos casos yieldpuede ser más eficiente y fácil de usar.

Aquí hay un ejemplo que yielddefinitivamente es mejor para:

return (in function)

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

yield (in function)

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.

Calling functions

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 yieldusan tres líneas en lugar de cinco y tienen una variable menos de la que preocuparse.

This is the result from the code:

Producción

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 yieldpalabra clave simplemente recopila resultados devueltos. pensar en yieldcomoreturn +=

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 se 'produce' algo. 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 'rendidos' en uno, llamando a list(generator()).