[Python] Que fait le mot-clé "yield"?



Answers

Raccourci vers le yield Grokking

Lorsque vous voyez une fonction avec yield instructions de yield , appliquez cette astuce pour comprendre ce qui va se passer:

  1. Insérez un result = [] ligne result = [] au début de la fonction.
  2. Remplacez chaque result.append(expr) yield expr avec result.append(expr) .
  3. Insérer un return result ligne au bas de la fonction.
  4. Yay - pas plus de déclarations de yield ! Lire et comprendre le code.
  5. Comparer la fonction à la définition d'origine.

Cette astuce peut vous donner une idée de la logique derrière la fonction, mais ce qui se passe réellement avec le yield est significativement différent de ce qui se passe dans l'approche basée sur la liste. Dans de nombreux cas, l'approche du rendement sera beaucoup plus efficace et plus rapide. Dans d'autres cas, cette astuce vous bloquera dans une boucle infinie, même si la fonction d'origine fonctionne très bien. Continuez à lire pour en savoir plus...

Ne confondez pas vos Iterables, Iterators et Generators

Tout d'abord, le protocole de l' itérateur - quand vous écrivez

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

Python effectue les deux étapes suivantes:

  1. Obtient un itérateur pour mylist :

    Appelez iter(mylist) -> ceci retourne un objet avec une méthode next() (ou __next__() dans Python 3).

    [C'est l'étape que la plupart des gens oublient de vous dire]

  2. Utilise l'itérateur pour faire une boucle sur les éléments:

    Continuez à appeler la méthode next() sur l'itérateur renvoyé à l'étape 1. La valeur de retour de next() est affectée à x et le corps de la boucle est exécuté. Si une exception StopIteration est StopIteration depuis next() , cela signifie qu'il n'y a plus de valeurs dans l'itérateur et que la boucle est fermée.

La vérité est que Python exécute les deux étapes ci-dessus chaque fois qu'il veut faire une boucle sur le contenu d'un objet - donc ça pourrait être une boucle for, mais ça pourrait aussi être un code comme otherlist.extend(mylist) (où otherlist est une liste Python) .

Ici mylist est une itérative car il implémente le protocole itérateur. Dans une classe définie par l'utilisateur, vous pouvez implémenter la __iter__() pour rendre les instances de votre classe itératives. Cette méthode devrait retourner un itérateur . Un itérateur est un objet avec une méthode next() . Il est possible d'implémenter __iter__() et next() sur la même classe, et d'avoir __iter__() return self . Cela fonctionnera pour les cas simples, mais pas quand vous voulez deux itérateurs en boucle sur le même objet en même temps.

Donc, c'est le protocole de l'itérateur, de nombreux objets implémentent ce protocole:

  1. Listes intégrées, dictionnaires, tuples, ensembles, fichiers.
  2. Classes définies par l'utilisateur qui implémentent __iter__() .
  3. Générateurs.

Notez qu'une boucle for ne sait pas quel type d'objet elle traite - elle suit juste le protocole de l'itérateur, et est heureuse d'obtenir élément après élément comme elle appelle next() . Les listes intégrées renvoient leurs articles un par un, les dictionnaires renvoient les clés une par une, les fichiers renvoient les lignes une à une, etc. Et les générateurs reviennent ... enfin c'est là que le yield arrive:

def f123():
    yield 1
    yield 2
    yield 3

for item in f123():
    print item

A la place des instructions yield , si vous aviez trois instructions return dans f123() seule la première serait exécutée et la fonction se terminerait. Mais f123() n'est pas une fonction ordinaire. Quand f123() est appelé, il ne renvoie aucune des valeurs dans les déclarations de rendement! Il renvoie un objet générateur. De plus, la fonction ne sort pas vraiment - elle passe à l'état suspendu. Lorsque la boucle for essaye de faire une boucle sur l'objet générateur, la fonction reprend son état suspendu à la ligne suivante après le retour qu'elle a précédemment généré, exécute la ligne de code suivante, dans ce cas une instruction yield , et la renvoie comme l'article suivant. Cela se produit jusqu'à ce que la fonction se termine, à quel point le générateur déclenche StopIteration , et la boucle se StopIteration .

Donc l'objet générateur est un peu comme un adaptateur - à une extrémité il présente le protocole d'itérateur, en exposant les __iter__() et next() pour garder la boucle for heureuse. À l'autre extrémité cependant, il exécute la fonction juste assez pour en extraire la valeur suivante, et la remet en mode suspendu.

Pourquoi utiliser des générateurs?

Habituellement, vous pouvez écrire du code qui n'utilise pas de générateurs mais qui implémente la même logique. Une option consiste à utiliser l'astuce de la liste temporaire que j'ai mentionnée auparavant. Cela ne fonctionnera pas dans tous les cas, par exemple si vous avez des boucles infinies, ou cela peut rendre inefficace l'utilisation de la mémoire lorsque vous avez une liste vraiment longue. L'autre approche consiste à implémenter une nouvelle classe itérative SomethingIter qui conserve l'état dans les membres d'instance et effectue la prochaine étape logique dans sa méthode next() (ou __next__() in Python 3). Selon la logique, le code à l'intérieur de la méthode next() peut avoir l'air très complexe et être sujet à des bogues. Ici, les générateurs fournissent une solution propre et facile.

Question

Quelle est l'utilisation du mot-clé yield dans Python? Qu'est ce que ça fait?

Par exemple, j'essaie de comprendre ce code 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  

Et voici l'appelant:

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

Que se passe-t-il lorsque la méthode _get_child_candidates est appelée? Une liste est-elle renvoyée? Un seul élément? Est-il appelé à nouveau? Quand les appels suivants s'arrêteront-ils?

1. Le code vient de Jochen Schulz (jrschulz), qui a fait une grande bibliothèque Python pour les espaces métriques. C'est le lien vers la source complète: Module mspace .




Le mot-clé yield est réduit à deux faits simples:

  1. Si le compilateur détecte le mot-clé yield à l' intérieur d'une fonction, cette fonction ne retourne plus via l'instruction return . Au lieu de cela , il renvoie immédiatement un objet "liste en attente" paresseux appelé générateur
  2. Un générateur est itérable. Qu'est-ce qu'un itérable ? C'est quelque chose comme une list ou un set ou une range ou dict-view, avec un protocole intégré pour visiter chaque élément dans un certain ordre .

En un mot: un générateur est une liste paresseuse, incrémentielle en attente , et les instructions de yield vous permettent d'utiliser la notation de fonction pour programmer les valeurs de liste que le générateur devrait cracher de manière incrémentielle.

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

Exemple

Définissons une fonction makeRange qui est juste comme la range de Python. Appeler makeRange(n) RETOURNE UN GENERATEUR:

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>

Pour forcer le générateur à retourner immédiatement ses valeurs en attente, vous pouvez le passer dans list() (comme vous le feriez pour tout itérable):

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

Comparer l'exemple à "juste retourner une liste"

L'exemple ci-dessus peut être considéré comme une simple création d'une liste à laquelle vous ajoutez et renvoyez:

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

Il y a une différence majeure, cependant; voir la dernière section.

Comment vous pourriez utiliser des générateurs

Une itération est la dernière partie de la compréhension d'une liste, et tous les générateurs sont itérables, donc ils sont souvent utilisés comme tels:

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

Pour avoir une meilleure idée des générateurs, vous pouvez jouer avec le module itertools (assurez-vous d'utiliser chain.from_iterable plutôt que de chain si nécessaire). Par exemple, vous pourriez même utiliser des générateurs pour implémenter des listes paresseuses infiniment longues comme itertools.count() . Vous pouvez implémenter votre propre def enumerate(iterable): zip(count(), iterable) , ou bien le faire avec le mot clé yield dans une boucle while.

S'il vous plaît noter: les générateurs peuvent effectivement être utilisés pour beaucoup plus de choses, telles que la mise en œuvre de coroutines ou de programmation non déterministe ou d'autres choses élégantes. Cependant, le point de vue «listes paresseuses» que je présente ici est l'utilisation la plus courante que vous trouverez.

Dans les coulisses

C'est ainsi que fonctionne le "protocole d'itération Python". C'est, ce qui se passe quand vous faites la list(makeRange(5)) . C'est ce que je décris plus haut comme une liste paresseuse et incrémentale.

>>> 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 fonction intégrée next() appelle simplement la fonction .next() , qui fait partie du "protocole d'itération" et se trouve sur tous les itérateurs. Vous pouvez utiliser manuellement la fonction next() (et d'autres parties du protocole d'itération) pour implémenter des choses fantaisistes, généralement au détriment de la lisibilité, alors essayez d'éviter cela ...

Menus détails

Normalement, la plupart des gens ne se soucient pas des distinctions suivantes et veulent probablement arrêter de lire ici.

En langage Python, un itérable est un objet qui "comprend le concept d'une boucle for" comme une liste [1,2,3] , et un itérateur est une instance spécifique de la boucle for demandée comme [1,2,3].__iter__() . Un générateur est exactement le même que n'importe quel itérateur, sauf pour la façon dont il a été écrit (avec la syntaxe de la fonction).

Lorsque vous demandez un itérateur à partir d'une liste, il crée un nouvel itérateur. Cependant, lorsque vous demandez un itérateur d'un itérateur (ce que vous feriez rarement), il vous donne juste une copie de lui-même.

Ainsi, dans le cas improbable où vous ne parvenez pas à faire quelque chose comme ça ...

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

... alors rappelez-vous qu'un générateur est un itérateur ; c'est-à-dire, c'est une utilisation unique. Si vous voulez le réutiliser, vous devriez appeler myRange(...) nouveau. Si vous devez utiliser le résultat deux fois, convertissez le résultat en liste et stockez-le dans une variable x = list(myRange(5)) . Ceux qui ont absolument besoin de cloner un générateur (par exemple, qui font une métaprogrammation hactique terrifiante) peuvent utiliser itertools.tee si itertools.tee est absolument nécessaire, puisque la proposition de standards Python PEP itératif a été différée.




From a programming viewpoint, the iterators are implemented as thunks

http://en.wikipedia.org/wiki/Thunk_(functional_programming)

To implement iterators/generators/thread pools for concurrent execution/etc as thunks (also called anonymous functions), one uses messages sent to a closure object, which has a dispatcher, and the dispatcher answers to "messages".

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

" next " is a message sent to a closure, created by " iter " call.

There are lots of ways to implement this computation. I used mutation but it is easy to do it without mutation, by returning the current value and the next yielder.

Here is a demonstration which uses the structure of R6RS but the semantics is absolutely identical as in python, it's the same model of computation, only a change in syntax is required to rewrite it in 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
-> 



yield is just like return - it returns whatever you tell it to. The only difference is that the next time you call the function, execution starts from the last call to the yield statement.

In the case of your code, the function get_child_candidates is acting like an iterator so that when you extend your list, it adds one element at a time to the new list.

list.extend calls an iterator until it's exhausted. In the case of the code sample you posted, it would be much clearer to just return a tuple and append that to the list.




Many people use return rather than yield but in some cases yield can be more efficient and easier to work with.

Here is an example which yield is definitely best for:

return (in function)

import random

def return_dates():
    dates = [] # with return you need to create a list then return it
    for i in range(5):
        date = random.choice(["1st", "2nd", "3rd", "4th", "5th", "6th", "7th", "8th", "9th", "10th"])
        dates.append(date)
    return dates

yield (in function)

def yield_dates():
    for i in range(5):
        date = random.choice(["1st", "2nd", "3rd", "4th", "5th", "6th", "7th", "8th", "9th", "10th"])
        yield date # yield makes a generator automatically which works in a similar way, this is much more efficient

Calling functions

dates_list = return_dates()
print(dates_list)
for i in dates_list:
    print(i)

dates_generator = yield_dates()
print(dates_generator)
for i in  dates_generator:
    print(i)

Both functions do the same thing but yield uses 3 lines instead of 5 and has one less variable to worry about.

This is the result from the code:

As you can see both functions do the same thing, the only difference is return_dates() gives a list and yield_dates() gives a generator

A real life example would be something like reading a file line by line or if you just want to make a generator




Here is a mental image of what yield does.

I like to think of a thread as having a stack (even when it's not implemented that way).

When a normal function is called, it puts its local variables on the stack, does some computation, then clears the stack and returns. The values of its local variables are never seen again.

With a yield function, when its code begins to run (ie after the function is called, returning a generator object, whose next() method is then invoked), it similarly puts its local variables onto the stack and computes for a while. But then, when it hits the yield statement, before clearing its part of the stack and returning, it takes a snapshot of its local variables and stores them in the generator object. It also writes down the place where it's currently up to in its code (ie the particular yield statement).

So it's a kind of a frozen function that the generator is hanging onto.

When next() is called subsequently, it retrieves the function's belongings onto the stack and re-animates it. The function continues to compute from where it left off, oblivious to the fact that it had just spent an eternity in cold storage.

Compare the following examples:

def normalFunction():
    return
    if False:
        pass

def yielderFunction():
    return
    if False:
        yield 12

When we call the second function, it behaves very differently to the first. The yield statement might be unreachable, but if it's present anywhere, it changes the nature of what we're dealing with.

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

Calling yielderFunction() doesn't run its code, but makes a generator out of the code. (Maybe it's a good idea to name such things with the yielder prefix for readability.)

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

The gi_code and gi_frame fields are where the frozen state is stored. Exploring them with dir(..) , we can confirm that our mental model above is credible.




It's returning a generator. I'm not particularly familiar with Python, but I believe it's the same kind of thing as C#'s iterator blocks if you're familiar with those.

There's an IBM article which explains it reasonably well (for Python) as far as I can see.

The key idea is that the compiler/interpreter/whatever does some trickery so that as far as the caller is concerned, they can keep calling next() and it will keep returning values - as if the generator method was paused . Now obviously you can't really "pause" a method, so the compiler builds a state machine for you to remember where you currently are and what the local variables etc look like. This is much easier than writing an iterator yourself.




For those who prefer a minimal working example, meditate on this interactive Python session:

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



Yield is an Object

A return in a function will return a single value.

If you want function to return huge set of values use yield .

More importantly, yield is a barrier

like Barrier in Cuda Language, it will not transfer control until it gets completed.

c'est à dire

It will run the code in your function from the beginning until it hits yield . Then, it'll return the first value of the loop. Then, every other call will run the loop you have written in the function one more time, returning the next value until there is no value to return.




All great answers whereas a bit difficult for newbies.

I assume you have learned return statement.
As an analogy, return and yield are twins.
return means 'Return and Stop' whereas 'yield` means 'Return but Continue'

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

Exécuter:

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

See, you get only a single number instead of a list of them,. return never allow you happy to prevail. It implemented once and quit.

  1. There comes yield

Replace return with 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]

Now, you win to get all the numbers.
Comparing to return which runs once and stops, yield runs times you planed.
You can interpret return as return one of them ,
yield as return all of them . This is called iterable .

  1. One more step we can rewrite yield statement with return
In [15]: def num_list(n):
    ...:     result = []
    ...:     for i in range(n):
    ...:         result.append(i)
    ...:     return result

In [16]: num_list(3)
Out[16]: [0, 1, 2]

It's the core about yield .

The difference between a list return outputs and the object yield output is:
You can get [0, 1, 2] from a list object always whereas can only retrieve them from 'the object yield output' once.
So, it has a new name generator object as displayed in Out[11]: <generator object num_list at 0x10327c990> .

In conclusion as a metaphor to grok it,

return and yield are twins,
list and generator are twins.




While a lot of answers show why you'd use a yield to create a generator, there are more uses for yield . It's quite easy to make a coroutine, which enables the passing of information between two blocks of code. I won't repeat any of the fine examples that have already been given about using yield to create a generator.

To help understand what a yield does in the following code, you can use your finger to trace the cycle through any code that has a yield . Every time your finger hits the yield , you have to wait for a next or a send to be entered. When a next is called, you trace through the code until you hit the yield … the code on the right of the yield is evaluated and returned to the caller… then you wait. When next is called again, you perform another loop through the code. However, you'll note that in a coroutine, yield can also be used with a send … which will send a value from the caller into the yielding function. If a send is given, then yield receives the value sent, and spits it out the left hand side… then the trace through the code progresses until you hit the yield again (returning the value at the end, as if next was called).

Par exemple:

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



I was going to post "read page 19 of Beazley's 'Python: Essential Reference' for a quick description of generators", but so many others have posted good descriptions already.

Also, note that yield can be used in coroutines as the dual of their use in generator functions. Although it isn't the same use as your code snippet, (yield) can be used as an expression in a function. When a caller sends a value to the method using the send() method, then the coroutine will execute until the next (yield) statement is encountered.

Generators and coroutines are a cool way to set up data-flow type applications. I thought it would be worthwhile knowing about the other use of the yield statement in functions.




(My below answer only speaks from the perspective of using Python generator, not the underlying implementation of generator mechanism , which involves some tricks of stack and heap manipulation.)

When yield is used instead of a return in a python function, that function is turned into something special called generator function . That function will return an object of generator type. The yield keyword is a flag to notify the python compiler to treat such function specially. Normal functions will terminate once some value is returned from it. But with the help of the compiler, the generator function can be thought of as resumable. That is, the execution context will be restored and the execution will continue from last run. Until you explicitly call return, which will raise a StopIteration exception (which is also part of the iterator protocol), or reach the end of the function. I found a lot of references about generator but this one from the functional programming perspective is the most digestable.

(Now I want to talk about the rationale behind generator , and the iterator based on my own understanding. I hope this can help you grasp the essential motivation of iterator and generator. Such concept shows up in other languages as well such as C#.)

As I understand, when we want to process a bunch of data, we usually first store the data somewhere and then process it one by one. But this intuitive approach is problematic. If the data volume is huge, it's expensive to store them as a whole beforehand. So instead of storing the data itself directly, why not store some kind of metadata indirectly, ie the logic how the data is computed .

There are 2 approaches to wrap such metadata.

  1. The OO approach, we wrap the metadata as a class . This is the so-called iterator who implements the iterator protocol (ie the __next__() , and __iter__() methods). This is also the commonly seen iterator design pattern .
  2. The functional approach, we wrap the metadata as a function . This is the so-called generator function . But under the hood, the returned generator object still IS-A iterator because it also implements the iterator protocol.

Either way, an iterator is created, ie some object that can give you the data you want. The OO approach may be a bit complex. Anyway, which one to use is up to you.




TL;DR

When you find yourself building a list from scratch...

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

... yield each piece instead

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

This was my first "aha" moment with yield.

yield is a sugary way to say

build a series of stuff

Same behavior:

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

Different behavior:

Yield is single-pass : you can only iterate through once. When a function has a yield in it we call it a generator function . And an iterator is what it returns. That's revealing. We lose the convenience of a container, but gain the power of an arbitrarily long series.

Yield is lazy , it puts off computation. A function with a yield in it doesn't actually execute at all when you call it. The iterator object it returns uses magic to maintain the function's internal context. Each time you call next() on the iterator (this happens in a for-loop) execution inches forward to the next yield. ( return raises StopIteration and ends the series.)

Yield is versatile . It can do infinite loops:

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

If you need multiple passes and the series isn't too long, just call list() on it:

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

Brilliant choice of the word yield because both meanings apply:

yield — produce or provide (as in agriculture)

...provide the next data in the series.

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

...relinquish CPU execution until the iterator advances.




Yet another TL;DR

iterator on list : next() returns the next element of the list

iterator generator : next() will compute the next element on the fly (execute code)

You can see the yield/generator as a way to manually run the control flow from outside (like continue loop 1 step), by calling next, however complex the flow.

NOTE: the generator is NOT a normal function, it remembers previous state like local variables (stack), see other answers or articles for detailed explanation, the generator can only be iterated on once . You could do without yield but it would not be as nice, so it can be considered 'very nice' language sugar.




Links