python generator - ¿Qué hace la palabra clave "rendimiento"?




15 Answers

Para entender qué hace el yield , debes entender qué son los generadores . Y antes de que lleguen los generadores.

Iterables

Cuando creas una lista, puedes leer sus artículos 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

mylist es un iterable . Cuando usas una lista de comprensión, creas una lista, y por lo tanto una 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... " on 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 quiere 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 igual, excepto que usaste () lugar de [] . PERO, no se puede realizar for i in mygenerator por 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

yield es una palabra clave que se utiliza 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

Este 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 el 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 se ejecutará cada vez for use el generador.

Ahora la parte difícil:

La primera vez for llame al objeto generador creado desde su función, ejecutará el código en su función desde el principio hasta que alcance el yield , luego devolverá el primer valor del bucle. Luego, cada una de las otras llamadas ejecutará el bucle que ha escrito en la función una vez más y devolverá el siguiente valor, hasta que no haya ningún valor para devolver.

El generador se considera vacío una vez que se ejecuta la función, pero ya no afecta el yield . Puede ser porque el bucle llegó a su fin, o porque ya no satisfaces 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 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 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 candidates 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 bucle se repite en una lista, pero la lista se expande mientras se repite el bucle :-) 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 al mismo while sigue creando nuevos objetos generadores que producirán valores diferentes a los anteriores ya que no se aplica en el mismo nodo.

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

Usualmente le pasamos una lista:

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

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

  1. No necesitas leer los valores dos veces.
  2. Es posible que tengas muchos hijos y no los quieras a todos 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 tipificación 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:

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__()) o print(next(corner_street_atm))

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

Itertools, tu mejor amigo.

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

Entonces sólo 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)]

Entendiendo los mecanismos internos de iteración.

La iteración es un proceso que implica iterables (implementación del __iter__() ) e iteradores (implementación del __next__() ). Iterables son 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 funcionan los bucles .

function what

¿Cuál es el uso de la palabra clave de yield 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 llama de nuevo? ¿Cuándo se detendrán las llamadas subsiguientes?

1. El código proviene de Jochen Schulz (jrschulz), quien creó una excelente biblioteca de Python para espacios métricos. Este es el enlace a la fuente completa: Módulo mspace .




Piénsalo de esta manera:

Un iterador es solo un término que suena elegante para un objeto que tiene un método next (). Así que una función 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 está sucediendo tras bambalinas, el bucle for se puede reescribir a esto:

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

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

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




¿Qué hace la palabra clave de yield en Python?

Contorno de respuesta / Resumen

  • Una función con yield , cuando se llama, devuelve un Generator .
  • Los generadores son iteradores porque implementan el protocolo del iterador , por lo que puede iterar sobre ellos.
  • A un generador también se le puede enviar información , convirtiéndolo conceptualmente en 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 del return en un generador).

Generadores:

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

La idea de generadores proviene de otros lenguajes (ver nota al pie de página 1) con diferentes implementaciones. En los generadores de Python, la ejecución del código se frozen en el punto del 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.

yield proporciona una manera fácil de implementar el protocolo de 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 clase abstracta de Iterator desde el módulo de collections .

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

El tipo de generador es un subtipo de iterador:

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

Y si es necesario, podemos escribir la siguiente 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 ni restablecerlo:

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

Tendrá que hacer otro si desea usar su funcionalidad nuevamente (ver nota 2):

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

Uno puede producir datos programáticamente, por ejemplo:

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

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

def func(an_iterable):
    yield from an_iterable

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

Coroutines:

yield forma una expresión que permite que los datos se envíen al generador (consulte la nota a pie de página 3)

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

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


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

Primero, debemos poner en cola el generador con la función incorporada, a next . __next__ método next o __next__ apropiado, dependiendo de la versión de Python que esté utilizando:

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

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

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

Delegación cooperativa a Sub-Coroutine con yield from

Ahora, recuerde que el yield from está disponible en Python 3. Esto nos permite delegar coroutines a una subcoroutine:

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 tal como se mencionó anteriormente:

>>> 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 del yield from en PEP 380.

Otros métodos: cerrar y tirar

El método de close genera GeneratorExit en el punto en que se congela 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 el GeneratorExit :

>>> my_account.close()

También puede lanzar una excepción que puede manejarse en el generador o propagarse de nuevo al usuario:

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

Conclusión

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

¿Qué hace la palabra clave de yield en Python?

Resulta que el yield hace 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 parte superior / Respuesta aceptada **

  • Se confunde sobre lo que hace que un iterable , simplemente usando una lista como ejemplo. Vea mis referencias anteriores, pero en resumen: un iterable tiene un método __iter__ que devuelve un iterador . Un iterador proporciona un .next (Python 2 o .__next__ (Python 3), que se llama implícitamente mediante bucles for hasta que genera StopIteration , 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 aún no hemos llegado a la parte de yield .
  • Al Controlar el agotamiento de un generador , llama al método siguiente, cuando en su lugar debe usar la función incorporada, a next . Sería una capa apropiada de indirección, porque su código no funciona en Python 3.
  • Itertools? Esto no fue relevante para lo que el yield hace en absoluto.
  • Ninguna discusión sobre los métodos que proporciona el yield junto con el yield from la nueva funcionalidad en Python 3. La respuesta principal / aceptada es una respuesta muy incompleta.

Crítica de respuesta que sugiere yield en 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 considerado como interesante para usarlo en las expresiones de comprensión o generadoras, a pesar de no citar un 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:

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, IMHO.

Mi voto es que sea un SyntaxError ya que no está obteniendo lo que espera de la sintaxis.

Estoy de acuerdo en que es un lugar sensato para que terminemos, ya que cualquier código que confíe en el comportamiento actual es realmente demasiado inteligente para poder mantenerlo.

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

  • SintaxisWarning o DeprecationWarning en 3.7
  • Aviso 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 estar apuntando en la dirección de que 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 ponga el yield en una expresión o comprensión generadora.

La declaración de return en un generador.

En Python 2 :

En una función de generador, la declaración de return no tiene permitido incluir una expression_list . En ese contexto, un return StopIteration indica que el generador está listo y causará que se StopIteration .

B expression_listes básicamente cualquier número de expresiones separadas por comas; básicamente, en Python 2, puedes detener el generador con return, pero no puedes devolver un valor.

En Python 3 :

En una función de generador, la returndeclaración indica que el generador está listo y causará StopIterationque se eleve. El valor devuelto (si existe) se usa como un argumento para construir StopIterationy se convierte en el StopIteration.valueatributo.

Notas al pie

  1. Los lenguajes CLU, Sather e Icon fueron referenciados 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 podría aparecer al principio 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 de la misma manera que uno podría recibirlo. Para enviar datos, uno debe poder asignarlo a algo, y para eso, una declaración simplemente no funciona.




Hay una cosa adicional que mencionar: una función que cede 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 hace que sea más fácil trabajar con algunas cosas.




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, foo guarda la lista completa en la memoria a la vez. No es un gran problema para una lista con 5 elementos, pero ¿qué sucede si desea una lista de 5 millones? No solo es un gran devorador de memoria, sino que también cuesta mucho tiempo de compilación en el momento en que se llama a la función. En el segundo caso, bar solo te da un generador. Un generador es un iterable, lo que significa que puede usarlo en un bucle for, 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" donde estaba en el bucle la última vez que lo llamó, de esta manera, si está utilizando un iterable para (digamos) contar hasta 50 mil millones, no tiene que contar hasta 50 mil millones de todos a la vez y almacenar los 50 mil millones de números para contar hasta. Una vez más, este es un ejemplo bastante artificial,probablemente utilizarías itertools si realmente quisieras 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, usar 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 usar para el recorrido de árboles especializados, y todo tipo de cosas.




Está devolviendo un generador. No estoy muy familiarizado con Python, pero creo que es el mismo tipo de bloqueos de iteradores de C # si estás 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, puedan seguir llamando a next () y seguirán devolviendo valores, como si el método del generador estuviera en pausa . Obviamente, realmente no puede "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.




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 dejo 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 los números".
    Este paso corresponde a llamar a la función de generador que devuelve un objeto generador. Ten en cuenta que todavía no me dices ningún número; solo agarra tu papel y lápiz.
  • Te pregunto, "dime el siguiente 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()al objeto generador.
  • ... repite el paso anterior, hasta que ...
  • eventualmente, podrías llegar a un final. No me dices un número; simplemente grita: "¡Aguanta los 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 del generador no necesita generar la excepción. Se levanta automáticamente cuando la función termina 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 lo hace a yield, y cuando se le pide un .next()valor, continúa desde el punto en que fue el último. Se ajusta perfectamente al diseño con el protocolo de iterador de Python, que describe cómo solicitar valores de forma secuencial.

El usuario más famoso del protocolo iterador es el forcomando en Python. Entonces, cuando haces una

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: lees los elementos de una secuencia uno por uno.

Tenga en cuenta que la defcreación de una función que contenga una yieldpalabra clave no es la única forma de crear un generador; Es la forma más fácil de crear una.

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




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 del código que contiene el 'rendimiento' se factorice y se coloque en otro generador. Además, se permite que el subgenerador regrese con un valor, y el valor se pone a disposición del generador delegante.

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

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

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

para evitar que las coroutinas se confundan con un generador regular (hoy yielden día se usa en ambos).




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

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

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



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

Supongo que has aprendido la returndeclaración.

Como analogía, returny yieldson gemelos. returnsignifica 'retorno y detención' mientras que 'rendimiento' significa 'retorno, pero continúa'

  1. Trate de obtener un num_list 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 número en lugar de una lista de ellos. returnNunca te permite prevalecer felizmente, solo implementa una vez y abandona.

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

Comparando con lo returnque se ejecuta una vez y se detiene, yieldcorre los tiempos planeados. Puedes interpretar returncomo return one of them, y yieldcomo return all of them. Esto se llama iterable.

  1. 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]

Es el núcleo alrededor 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ía 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 de asimilarlo:

  • returny yieldson gemelos
  • listy generatorson gemelos



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 vuelve. Los valores de sus variables locales nunca se vuelven a ver.

Con una yieldfunción, cuando su código comienza a ejecutarse (es decir, una vez que se llama a la función, devolviendo un objeto generador, cuyo next()método se invoca a continuación), de manera similar coloca sus variables locales en la pila y las calcula durante un tiempo. Pero luego, cuando golpea 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 anota el lugar donde está actualmente en su código (es decir, la yielddeclaración particular ).

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

Cuando next()se llama posteriormente, recupera las pertenencias de la función en la pila y la vuelve a animar. La función continúa calculando desde donde 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 podría ser inalcanzable, pero si está presente en cualquier lugar, cambia la naturaleza de lo que estamos tratando.

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

La llamada yielderFunction()no ejecuta su código, pero hace un generador a partir 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.




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 .

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, cada otra llamada ejecutará el bucle que ha escrito en la función una vez más, devolviendo el siguiente valor hasta que no haya ningún valor para devolver.




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 "cede". El generador se detiene hasta su próxima llamada, y continúa desde exactamente el mismo punto en que comenzó. Puede obtener una secuencia de todos los valores 'producidos' en uno, llamando list(generator()).




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

Aquí hay un ejemplo que yieldes definitivamente el mejor para:

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

Este es el resultado del código:

Como puedes 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 crear un generador.




Aquí hay un yieldenfoque basado 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 que indica que desea crear un generador , es decir, un objeto que genera valores a pedido.

Entonces, ¿cómo se generan estos valores? Esto se puede hacer directamente usando la función incorporada nexto, indirectamente, alimentándolo a una construcción que consume valores.

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

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

Indirectamente, si proporciona fiba un forbucle, un listinicializador, un tupleinicializador o cualquier otra cosa que espere que un objeto genere / genere valores, "consumirá" el generador hasta que no pueda producir más valores (y éste lo devuelva). :

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 se diferencia de una función en el sentido de que es perezoso. Esto se logra al mantener su estado local y permitirle reanudar cada vez que 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 parece ser muy útil.

Cuando luego solicita, genera el primer valor, directa o indirectamente, ejecuta todas las declaraciones que encuentra, hasta que encuentra a yield, luego devuelve el valor que proporcionó yieldy se detiene. Para un ejemplo que demuestre mejor esto, usemos algunas printllamadas (reemplace con print "text"si está en Python 2):

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

Ahora, ingrese en el REPL:

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

ahora tiene un objeto generador esperando un comando para que genere un valor. Utilice nexty vea qué 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 no citados son los que se imprimen. El resultado citado es lo que se devuelve yield. Llame 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í. El siguiente mensaje se imprime y la búsqueda de la yielddeclaración para pausar se realiza nuevamente (debido al whilebucle).




Related

python iterator generator yield coroutine