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




function what (25)

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


Answers

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

Cuando yieldse usa en lugar de a 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 una marca para notificar al compilador de Python para tratar dicha función especialmente. Las funciones normales terminarán una vez que se le devuelva algún valor. Pero con la ayuda del compilador, la función del generador se puede considerar como reanudable. Es decir, el contexto de ejecución se restaurará y la ejecución continuará desde la última ejecución. Hasta que llame explícitamente a return, lo que generará una StopIterationexcepción (que también es parte del protocolo del iterador) o llegará al final de la función. He encontrado una gran cantidad de referencias sobre generatorpero este oneDesde el functional programming perspectivees el más digerible.

(Ahora quiero hablar sobre la razón detrás generatory sobre la iteratorbase de mi propio entendimiento. Espero que esto pueda ayudarlo a comprender la motivación esencial del iterador y el generador. Tal concepto aparece en otros idiomas, como C #)

Según tengo entendido, cuando queremos procesar una gran cantidad de datos, generalmente almacenamos los datos en algún lugar y luego los procesamos uno por uno. Pero este enfoque intuitivo es problemático. Si el volumen de datos es enorme, es costoso almacenarlos como un todo de antemano. Entonces, en lugar de almacenar el datasí mismo directamente, ¿por qué no almacenar algún tipo de forma metadataindirectathe logic how the data is computed ?

Hay 2 enfoques para envolver tales metadatos.

  1. El enfoque OO, envolvemos los metadatos as a class. Este es el llamado iteratorquién implementa el protocolo de iterador (es decir __next__(), los __iter__()métodos y ). Este es también el patrón de diseño del 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 devuelto generator objecttodavía IS-Aporque también implementa el protocolo del iterador.

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


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)

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


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


TL; DR

En lugar de esto:

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

hacer esto:

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

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

Este fue mi primer momento "aha" con rendimiento.

yield es una forma dulce de decir

construir una serie de cosas

Mismo comportamiento:

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

Diferente comportamiento

El rendimiento es de una sola pasada : solo se puede iterar una vez. Cuando una función tiene un rendimiento, la llamamos una función de generador . Y un iterator es lo que devuelve. Eso es revelador. Perdemos la conveniencia de un contenedor, pero ganamos el poder de una serie arbitrariamente larga.

El rendimiento es perezoso , posterga el cálculo. Una función con un rendimiento no se ejecuta en realidad cuando la llamas. El objeto iterador que devuelve utiliza magic para mantener el contexto interno de la función. Cada vez que llama next()al iterador (esto sucede en un bucle for), la ejecución avanza hasta el siguiente rendimiento. ( returnSube StopIterationy termina la serie.)

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

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

Si necesita varios pases y la serie no es demasiado larga, solo tiene que llamar list():

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

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

rendimiento - producir o proporcionar (como en la agricultura)

... proporcionar los siguientes datos en la serie.

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

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


Para aquellos que prefieren un ejemplo de trabajo mínimo, medite 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

Sin embargo, otro TL; DR

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

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

Puede ver el rendimiento / generador como una forma de ejecutar manualmente el flujo de control desde el exterior (como continuar un ciclo en un paso), llamando next, sin embargo, el flujo es complejo.

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


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

La palabra clave de yield se reduce a dos hechos simples:

  1. Si el compilador detecta la palabra clave de yield cualquier lugar dentro de una función, esa función ya no regresa a través de la declaración de return . En su lugar , devuelve inmediatamente un objeto de "lista pendiente" perezoso llamado generador
  2. Un generador es iterable. ¿Qué es un iterable ? Es algo parecido a una list o set o range o vista de dictado, con un protocolo incorporado para visitar cada elemento en un cierto orden .

En pocas palabras: un generador es una lista perezosa, con pendientes incrementales , y las declaraciones de yield permiten usar la notación de funciones para programar los valores de la lista que el generador debe escupir de manera incremental.

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

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

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

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

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

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

Ejemplo

Definamos una función makeRange que sea igual que el range de Python. Llamando a makeRange(n) A 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 devolver inmediatamente sus valores pendientes, puede pasarlo a la list() (como si fuera posible):

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

Comparando ejemplo con "solo devolviendo una lista"

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

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

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

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

Como puedes usar generadores

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

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

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

Tenga en cuenta que los generadores se pueden usar para muchas más cosas, como implementar coroutines o programación no determinista u otras cosas elegantes. Sin embargo, el punto de vista de las "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é sucede cuando haces la list(makeRange(5)) . Esto es lo que describo anteriormente como una "lista perezosa e incremental".

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

La función incorporada next() simplemente llama a la función .next() los objetos, que forma parte del "protocolo de iteración" y se encuentra en todos los iteradores. Puede usar manualmente la función next() (y otras partes del protocolo de iteración) para implementar cosas sofisticadas, generalmente a expensas de la legibilidad, así que trate de evitar hacer eso ...

Minucias

Normalmente, la mayoría de las personas no se preocupan por las siguientes distinciones y probablemente quieran dejar de leer aquí.

En lenguaje Python, 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 como [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 esté haciendo 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 llamar a myRange(...) nuevamente. 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 realizando una metaprogramación terriblemente pirata) pueden usar itertools.tee si es absolutamente necesario, ya que la propuesta de los estándares de Python PEP que se puede itertools.tee puede ser diferida.


Grokking directo al yield Grokking

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

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

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

No confunda sus iterables, iteradores y generadores

Primero, el protocolo iterador - cuando escribes

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

Python realiza los siguientes dos pasos:

  1. Obtiene un iterador para mylist :

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

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

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

    Siga llamando al método next() en el iterador devuelto desde el paso 1. El valor de retorno de next() se asigna a x y se ejecuta el cuerpo del bucle. Si se StopIteration una excepción StopIteration desde dentro de 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 siempre que quiera recorrer el contenido de un objeto, por lo que podría ser un bucle for, pero también podría ser un código como otherlist.extend(mylist) (donde otherlist es una lista de Python) .

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

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

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

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

def f123():
    yield 1
    yield 2
    yield 3

for item in f123():
    print item

En lugar de declaraciones de yield , si tuviera tres declaraciones de return en f123() solo se ejecutaría la primera y la función se cerraría. Pero f123() no es una función ordinaria. Cuando se llama a f123() , ¡ no devuelve ninguno de los valores en las declaraciones de rendimiento! Devuelve un objeto generador. Además, la función realmente no sale, entra en un estado suspendido. Cuando el bucle for intenta recorrer el objeto generador, la función se reanuda desde su estado suspendido en la siguiente línea después del yield que devolvió anteriormente, ejecuta la siguiente línea de código, en este caso una declaración de yield , y la devuelve como el siguiente articulo Esto sucede hasta que la función sale, en cuyo punto el generador genera StopIteration y el bucle sale.

Así que el objeto generador es como un adaptador: en un extremo exhibe el protocolo del iterador, al exponer los __iter__() y next() para mantener el bucle for feliz. Sin embargo, en el otro extremo, ejecuta la función lo suficiente para obtener el siguiente valor y la pone de nuevo 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é anteriormente. 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 método next() puede terminar pareciendo muy complejo y ser propenso a errores. Aquí los generadores proporcionan una solución limpia y fácil.


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.


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

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

Supongamos que desea crear una rangefunción propia que produzca un rango de números iterable, podría hacerlo así,

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

y utilízalo así;

for i in myRangeNaive(10):
    print i

Pero esto es ineficiente porque

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

Afortunadamente, Guido y su equipo fueron lo suficientemente generosos como para desarrollar generadores, por lo que solo pudimos 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 'cede' el valor o llega al final de la función. En este caso, en la primera llamada, se next()ejecuta hasta la declaración de rendimiento y el rendimiento 'n', en la siguiente llamada ejecutará la instrucción de incremento, saltará de nuevo al 'while', lo evaluará y, si es verdadero, se detendrá y ceda 'n' otra vez, continuará de esa manera hasta que la condición while devuelva falso y el generador salte al final de la función.


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.


La yieldpalabra clave simplemente recopila resultados de retorno. Pensar en yieldcomoreturn +=


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

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

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

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

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

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

Welcome to Racket v6.5.0.3.

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

yieldes como return- devuelve lo que le digas (como 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 del retorno, 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 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 del ejemplo de código que publicó, sería mucho más claro simplemente devolver una tupla y adjuntarlo a la lista.


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.


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


Aquí hay un ejemplo simple:

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

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

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

Salida:

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

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

Parece ser una habilidad interesante y agradable: D


Iba a publicar "lea 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 utilizar en coroutines como el doble de su uso en las funciones del generador. Aunque no es 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 usando el send()método, entonces la rutina se ejecutará hasta (yield)que se encuentre la siguiente declaración.

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


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 .


  • def foo(param1, *param2): es un método que puede aceptar un número arbitrario de valores para *param2 ,
  • def bar(param1, **param2): es un método que puede aceptar un número arbitrario de valores con claves para *param2
  • param1 es un parámetro simple.

Por ejemplo, la sintaxis para implementar varargs en Java de la siguiente manera:

accessModifier methodName(datatype… arg) {
    // method body
}




python iterator generator yield coroutine