python - with - ¿Qué hace la palabra clave "rendimiento"?
what is a python generator (30)
¿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 .
¿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 buclesfor
hasta que generaStopIteration
, 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 elyield 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 unaexpression_list
. En ese contexto, unreturn
StopIteration
indica que el generador está listo y causará que seStopIteration
.
B expression_list
es 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
return
declaración indica que el generador está listo y causaráStopIteration
que se eleve. El valor devuelto (si existe) se usa como un argumento para construirStopIteration
y se convierte en elStopIteration.value
atributo.
Notas al pie
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.
Esto significa, por ejemplo, que los
xrange
objetos (range
en Python 3) no sonIterator
s, aunque sean iterables, porque pueden reutilizarse. Al igual que las listas, sus__iter__
métodos devuelven objetos iteradores.yield
se 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. Ahorayield
crea 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.
Grokking directo al yield
Grokking
Cuando vea una función con declaraciones de yield
, aplique este truco fácil para comprender lo que sucederá:
- Inserte un
result = []
línearesult = []
al inicio de la función. - Reemplace cada
yield expr
conresult.append(expr)
. - Inserte un
return result
línea en la parte inferior de la función. - Yay - no más declaraciones de
yield
! Leer y averiguar el código. - 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:
Obtiene un iterador para
mylist
:Call
iter(mylist)
-> esto devuelve un objeto con un métodonext()
(o__next__()
en Python 3).[Este es el paso que la mayoría de la gente olvida para contarte]
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 denext()
se asigna ax
y se ejecuta el cuerpo del bucle. Si seStopIteration
una excepciónStopIteration
desde dentro denext()
, 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:
- Listas incorporadas, diccionarios, tuplas, conjuntos, archivos.
- Clases definidas por el usuario que implementan
__iter__()
. - 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.
La palabra clave de yield
se reduce a dos hechos simples:
- 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 dereturn
. En su lugar , devuelve inmediatamente un objeto de "lista pendiente" perezoso llamado generador - Un generador es iterable. ¿Qué es un iterable ? Es algo parecido a una
list
oset
orange
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.
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 mismowhile
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:
- No necesitas leer los valores dos veces.
- 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 .
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. :)
yield
Es como un elemento de retorno para una función. La diferencia es que el yield
elemento 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())
.
yield
es 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 yield
declaració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_candidates
actúa como un iterador, de modo que cuando extiende su lista, agrega un elemento a la vez a la nueva lista.
list.extend
llama 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.
El rendimiento es un objeto
A return
en 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, yield
es 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, yield
cada 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. ( return
Sube StopIteration
y termina la serie.)
El rendimiento es versátil . Puede hacer bucles infinitos:
>>> def squares_all_of_them():
... x = 0
... while True:
... yield x * x
... x += 1
...
>>> squares = squares_all_of_them()
>>> for _ in range(4):
... print(next(squares))
...
0
1
4
9
Si necesita 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 yield
porque 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.
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)
Aquí hay un ejemplo simple:
def isPrimeNumber(n):
print "isPrimeNumber({}) call".format(n)
if n==1:
return False
for x in range(2,n):
if n % x == 0:
return False
return True
def primes (n=1):
while(True):
print "loop step ---------------- {}".format(n)
if isPrimeNumber(n): yield n
n += 1
for n in primes():
if n> 10:break
print "wiriting result {}".format(n)
Salida:
loop step ---------------- 1
isPrimeNumber(1) call
loop step ---------------- 2
isPrimeNumber(2) call
loop step ---------------- 3
isPrimeNumber(3) call
wiriting result 3
loop step ---------------- 4
isPrimeNumber(4) call
loop step ---------------- 5
isPrimeNumber(5) call
wiriting result 5
loop step ---------------- 6
isPrimeNumber(6) call
loop step ---------------- 7
isPrimeNumber(7) call
wiriting result 7
loop step ---------------- 8
isPrimeNumber(8) call
loop step ---------------- 9
isPrimeNumber(9) call
loop step ---------------- 10
isPrimeNumber(10) call
loop step ---------------- 11
isPrimeNumber(11) call
No soy un desarrollador de Python, pero me parece que yield
mantiene la posición 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
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.
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 yield
se 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 yield
declaración en las funciones.
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 return
declaración.
Como analogía, return
y yield
son gemelos. return
significa ''retorno y detención'' mientras que ''rendimiento'' significa ''retorno, pero continúa''
- 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. return
Nunca te permite prevalecer felizmente, solo implementa una vez y abandona.
- Ahi viene
yield
Reemplazar return
con 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 return
que se ejecuta una vez y se detiene, yield
corre los tiempos planeados. Puedes interpretar return
como return one of them
, y yield
como return all of them
. Esto se llama iterable
.
- Un paso más podemos reescribir la
yield
declaració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 return
salidas de una lista y la yield
salida del objeto es:
Siempre obtendrá [0, 1, 2] de un objeto de lista, pero solo podría recuperarlos de ''la yield
salida del objeto '' una vez. Por lo tanto, tiene un nuevo generator
objeto de nombre como se muestra en Out[11]: <generator object num_list at 0x10327c990>
.
En conclusión, como metáfora de asimilarlo:
-
return
yyield
son gemelos -
list
ygenerator
son gemelos
(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 yield
se usa en lugar de a return
en una función de python, esa función se convierte en algo especial llamado generator function
. Esa función devolverá un objeto de generator
tipo. La yield
palabra 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 StopIteration
excepció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 generator
pero este oneDesde el functional programming perspective
es el más digerible.
(Ahora quiero hablar sobre la razón detrás generator
y sobre la iterator
base 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 data
sí mismo directamente, ¿por qué no almacenar algún tipo de forma metadata
indirectathe logic how the data is computed
?
Hay 2 enfoques para envolver tales metadatos.
- El enfoque OO, envolvemos los metadatos
as a class
. Este es el llamadoiterator
quié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 . - El enfoque funcional, envolvemos los metadatos
as a function
. Este es el llamadogenerator function
. Pero bajo el capó, el iterador devueltogenerator object
todavíaIS-A
porque 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 un yield
enfoque 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 yield
Python 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 next
o, 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 fib
a un for
bucle, un list
inicializador, un tuple
inicializador 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 tuple
inicializador:
>>> 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 fib
por primera vez llamándolo:
f = fib()
Python compila la función, encuentra la yield
palabra 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ó yield
y se detiene. Para un ejemplo que demuestre mejor esto, usemos algunas print
llamadas (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 next
y 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 next
nuevo ahora:
>>> next(gen) # continues from yield and runs again
Let''s go through it again.
I''m going to generate the value for you
Then I''ll pause for a while
''Hello, yield!''
El generador recuerda que se detuvo yield value
y se reanuda desde allí. El siguiente mensaje se imprime y la búsqueda de la yield
declaración para pausar se realiza nuevamente (debido al while
bucle).
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 adef
la función del generador, es decir, la función que contiene ayield
. - 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 unaStopIteration
excepción. La función del generador no necesita generar la excepción. Se levanta automáticamente cuando la función termina o emite areturn
.
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 for
comando en Python. Entonces, cuando haces una
for item in sequence:
no importa si sequence
es 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 def
creación de una función que contenga una yield
palabra 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.
Aquí hay una imagen mental de lo que yield
hace.
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 yield
funció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 yield
declaració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 yield
declaració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 yield
declaració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 yielder
prefijo 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_code
y gi_frame
son donde se almacena el estado congelado. Al explorarlos dir(..)
, podemos confirmar que nuestro modelo mental anterior es creíble.
Como cada respuesta sugiere, yield
se utiliza 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 yield
función de la siguiente manera:
def getNextLines():
while con.isOpen():
yield con.read()
Puedes usarlo en tu código de la siguiente manera:
for line in getNextLines():
doSomeThing(line)
Control de Ejecución Transferencia gotcha
El control de ejecución se transferirá de getNextLines () al for
bucle cuando se ejecute el rendimiento. Por lo tanto, cada vez que se invoca getNextLines (), la ejecución comienza desde el punto en que se detuvo la última vez.
Así, en definitiva, 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"
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 ->
En resumen, la yield
declaración transforma su función en una fábrica que produce un objeto especial llamado a generator
que envuelve el cuerpo de su función original. Cuando generator
se itera, ejecuta su función hasta que alcanza la siguiente, yield
luego 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 range
funció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.
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.
Hay otro yield
uso 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 yield
en día se usa en ambos).
Hay un tipo de respuesta que siento que aún no se ha dado, entre las muchas respuestas geniales que describen cómo usar los generadores. Aquí está la respuesta de la teoría del lenguaje de programación:
La yield
declaración en Python devuelve un generador. Un generador en Python es una función que devuelve continuaciones (y específicamente un tipo de coroutine, pero las continuaciones representan el mecanismo más general para entender lo que está sucediendo).
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 qué es una continuación es directa: es el estado de una computación que aún no ha terminado. En este estado, se guardan los valores actuales de las variables, las operaciones que aún no se han realizado, etc. Luego, en algún momento más adelante en el programa, se puede invocar la continuación, de manera 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/cc
camino, 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 idiomas donde las funciones son de primera clase) que el programador gestiona explícitamente y pasa a las subrutinas. En este estilo, el estado del programa se representa mediante cierres (y las variables que se codifican 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 devolviéndolos después. Un ejemplo muy simple de estilo de paso de continuación es el siguiente:
def save_file(filename):
def write_file_continuation():
write_stuff_to_file(filename)
check_if_file_exists_and_user_wants_to_overwrite(write_file_continuation)
En este ejemplo (muy simplista), el programador guarda la operación de escribir realmente el archivo en una continuación (lo que potencialmente puede ser una operación muy compleja con muchos detalles para escribir), y luego pasa esa continuación (es decir, como primera opción). cierre de clase) a otro operador que realiza un procesamiento más, y luego lo llama si es necesario. (Uso 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, lo que es más importante, para administrar el flujo de control después de que se activen los eventos de GUI).
El resto de este post, sin pérdida de generalidad, conceptualizará las continuaciones como CPS, porque es mucho más fácil de entender y leer.
Ahora hablemos de generadores en Python. Los generadores son un subtipo específico de continuación. Mientras que las continuaciones 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 en un iterador . Aunque, esta definición es ligeramente engañosa para ciertos casos de uso de generadores. Por ejemplo:
def f():
while True:
yield 4
Este es claramente un iterable razonable cuyo comportamiento está bien definido: cada vez que el generador itera sobre él, devuelve 4 (y lo hace para siempre). Pero probablemente no es el tipo de prototipo de iterable lo que viene a la mente cuando se piensa en iteradores (es decir, for x in collection: do_something(x)
). Este ejemplo ilustra la potencia de los generadores: si algo es un iterador, un generador puede guardar el estado de su iteración.
Para reiterar: las continuaciones pueden guardar el estado de la pila de un programa y los generadores pueden guardar el estado de iteración. Esto significa que las continuaciones son mucho más poderosas que los generadores, pero también que los generadores son mucho más fáciles. Son más fáciles de implementar para el diseñador lingüístico y más fáciles de usar para el programador (si tiene tiempo para grabar, intente leer y comprender esta página sobre las continuaciones y call / cc ).
Pero podría implementar (y conceptualizar) generadores fácilmente como un caso simple y específico de estilo de aprobación de aprobación:
Cada vez que yield
se llama, le dice a la función que devuelva una continuación. Cuando se vuelve a llamar a la función, comienza desde donde la dejó. Entonces, en pseudo-pseudocódigo (es decir, no pseudocódigo, pero no código) el next
mé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 yield
palabra clave es realmente azúcar sintáctica para la función del 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 un 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 yield
palabra clave.
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.
La yield
palabra clave simplemente recopila resultados de retorno. Pensar en yield
comoreturn +=
Muchas personas usan en return
lugar de yield
, pero en algunos casos yield
pueden ser más eficientes y más fáciles de trabajar.
Aquí hay un ejemplo que yield
es 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 yield
usan 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.
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
Si bien muchas respuestas muestran por qué usarías un yield
para crear un generador, hay más usos para yield
. Es bastante fácil hacer una corrutina, que permite el paso de información entre dos bloques de código. No repetiré ninguno de los buenos ejemplos que ya se han dado sobre el uso yield
para crear un generador.
Para ayudar a entender lo que yield
hace en el siguiente código, puede usar su dedo para rastrear el ciclo a través de cualquier código que tenga un yield
. Cada vez que su dedo golpea el botón yield
, debe esperar a que se ingrese un next
o un send
. Cuando next
se llama a, se rastrea a través del código hasta que se golpea el yield
... el código a la derecha del yield
es evaluado y devuelto a la persona que llama ... luego espera. Cuando next
se vuelve a llamar, se realiza otro bucle a través del código. Sin embargo, observará que, en una rutina, yield
también se puede usar con un send
... que enviará un valor desde el llamante a la función de rendimiento. Si a send
se da, entoncesyield
recibe el valor enviado y lo escupe en el lado izquierdo ... luego la traza a través del código progresa hasta que lo golpeas yield
nuevamente (devolviendo el valor al final, como si next
se llamara).
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()