[python] Was macht das Keyword "yield"?



Answers

Grokking für Grokking yield

Wenn Sie eine Funktion mit yield Anweisungen sehen, wenden Sie diesen einfachen Trick an, um zu verstehen, was passieren wird:

  1. Fügen Sie am Anfang der Funktion eine Zeile result = [] .
  2. Ersetzen Sie jede yield expr durch result.append(expr) .
  3. Fügen Sie am Ende der Funktion ein Zeilenrückgabeergebnis ein.
  4. Yay - keine yield mehr! Lesen und verstehen Sie den Code.
  5. Funktion mit der ursprünglichen Definition vergleichen

Dieser Trick kann Ihnen eine Vorstellung von der Logik hinter der Funktion geben, aber was tatsächlich mit der yield geschieht, unterscheidet sich wesentlich von dem, was im listenbasierten Ansatz passiert. In vielen Fällen wird der Ertragsansatz viel effizienter und schneller sein. In anderen Fällen bringt Sie dieser Trick in eine Endlosschleife, obwohl die ursprüngliche Funktion einwandfrei funktioniert. Lesen Sie weiter, um mehr zu erfahren ...

Verwechsle deine Iterables, Iteratoren und Generatoren nicht

Erstens, das Iterator-Protokoll - wenn Sie schreiben

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

Python führt die folgenden zwei Schritte aus:

  1. Ruft einen Iterator für mylist :

    Call iter(mylist) -> Dies gibt ein Objekt mit einer next() Methode zurück (oder __next__() in Python 3).

    [Dies ist der Schritt, den die meisten Menschen vergessen, Ihnen zu erzählen]

  2. Verwendet den Iterator, um Elemente zu durchlaufen:

    Rufen Sie die next() -Methode für den von Schritt 1 zurückgegebenen Iterator auf. Der Rückgabewert von next() wird x zugewiesen, und der Schleifenkörper wird ausgeführt. Wenn eine Ausnahme StopIteration innerhalb von next() StopIteration wird, bedeutet dies, dass im Iterator keine Werte mehr vorhanden sind und die Schleife beendet wird.

Die Wahrheit ist, dass Python die obigen zwei Schritte ausführt, wann immer es den Inhalt eines Objekts durchlaufen will - es könnte also eine for-Schleife sein, aber es könnte auch Code wie otherlist.extend(mylist) (wo otherlist eine Python-Liste ist) .

Hier ist mylist iterierbar, weil sie das Iterator-Protokoll implementiert. In einer benutzerdefinierten Klasse können Sie die Methode __iter__() implementieren, um Instanzen Ihrer Klasse iterierbar zu machen. Diese Methode sollte einen Iterator zurückgeben . Ein Iterator ist ein Objekt mit einer next() -Methode. Es ist möglich, sowohl __iter__() als auch next() für dieselbe Klasse zu implementieren und __iter__() return self . Dies funktioniert in einfachen Fällen, aber nicht, wenn zwei Iteratoren gleichzeitig über dasselbe Objekt laufen sollen.

Das ist das Iteratorprotokoll, viele Objekte implementieren dieses Protokoll:

  1. Built-in-Listen, Wörterbücher, Tupel, Sets, Dateien.
  2. Benutzerdefinierte Klassen, die __iter__() implementieren.
  3. Generatoren.

Beachten Sie, dass eine for Schleife nicht weiß, um was für ein Objekt es sich handelt - sie folgt nur dem Iterator-Protokoll und freut sich, beim next() Aufruf von item nach item zu kommen. Integrierte Listen geben ihre Elemente einzeln zurück, Wörterbücher geben die Schlüssel einzeln zurück, Dateien geben die Zeilen einzeln zurück usw. Und Generatoren kehren zurück ... Nun, hier kommt die yield Spiel:

def f123():
    yield 1
    yield 2
    yield 3

for item in f123():
    print item

Wenn Sie in f123() drei return Anweisungen hatten, würde anstelle von yield Anweisungen nur die erste ausgeführt, und die Funktion würde beendet. Aber f123() ist keine gewöhnliche Funktion. Wenn f123() aufgerufen wird, gibt es keinen der Werte in den yield-Anweisungen zurück! Es gibt ein Generatorobjekt zurück. Außerdem wird die Funktion nicht wirklich beendet - sie geht in einen angehaltenen Zustand über. Wenn die for Schleife versucht, das generator-Objekt zu durchlaufen, wird die Funktion in der nächsten Zeile nach dem yield sie zuvor zurückgegeben wurde, von ihrem suspendierten Zustand wieder ausgeführt, führt die nächste Codezeile aus, in diesem Fall eine yield Anweisung, und gibt as zurück der nächste Artikel. Dies geschieht so lange, bis die Funktion beendet wird. An diesem Punkt löst der Generator StopIteration und die Schleife wird beendet.

Das Generator-Objekt ist also wie ein Adapter - an einem Ende zeigt es das Iterator-Protokoll, indem es die __iter__() und next() __iter__() , um die for Schleife glücklich zu machen. Am anderen Ende jedoch führt es die Funktion gerade genug aus, um den nächsten Wert daraus zu erhalten, und setzt es in den gesperrten Modus zurück.

Warum Generatoren verwenden?

Normalerweise können Sie Code schreiben, der keine Generatoren verwendet, sondern dieselbe Logik implementiert. Eine Möglichkeit ist es, die temporäre Liste "Trick" zu verwenden, die ich zuvor erwähnt habe. Das funktioniert nicht in allen Fällen, z. B. wenn Sie Endlosschleifen haben, oder wenn Sie eine wirklich lange Liste haben, kann dies den Speicher ineffizient machen. Der andere Ansatz besteht darin, eine neue iterierbare Klasse SomethyIter zu implementieren, die in Instanzmembern den Status behält und den nächsten logischen Schritt in ihrer Methode next() (oder __next__() in Python 3) __next__() . Je nach Logik kann der Code in der next() -Methode sehr komplex aussehen und fehleranfällig sein. Hier bieten Generatoren eine saubere und einfache Lösung.

Question

Was nutzt das Keyword yield in Python? Was tut es?

Zum Beispiel versuche ich, diesen Code 1 zu verstehen:

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  

Und das ist der Anrufer:

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

Was passiert, wenn die Methode _get_child_candidates aufgerufen wird? Wird eine Liste zurückgegeben? Ein einzelnes Element? Wird es noch einmal angerufen? Wann werden nachfolgende Anrufe gestoppt?

1. Der Code stammt von Jochen Schulz (jrschulz), der eine großartige Python-Bibliothek für metrische Räume erstellt hat. Dies ist der Link zur vollständigen Quelle: Modul Mspace .




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

Beispielsweise:

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



Das yield Keyword ist auf zwei einfache Fakten reduziert:

  1. Wenn der Compiler das yield Schlüsselwort irgendwo innerhalb einer Funktion erkennt, wird diese Funktion nicht mehr über die return Anweisung zurückgegeben. Stattdessen gibt es sofort ein faules "ausstehende Liste" -Objekt zurück, das als Generator bezeichnet wird
  2. Ein Generator ist iterierbar. Was ist ein iterabler ? Es ist alles wie eine list oder ein set oder ein range oder eine dict-Ansicht mit einem eingebauten Protokoll, um jedes Element in einer bestimmten Reihenfolge zu besuchen .

Kurz gesagt: Ein Generator ist eine faule, inkrementell anhängige Liste , und yield Anweisungen ermöglichen es Ihnen, die Funktionsnotation zu verwenden, um die Listenwerte zu programmieren, die der Generator inkrementell ausgeben soll.

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

Beispiel

Definieren wir eine Funktion makeRange , die genau wie der Python- range . Aufruf von makeRange(n) gibt einen Generator zurück:

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>

Um zu erzwingen, dass der Generator seine anstehenden Werte sofort zurückgibt, können Sie ihn in list() (genau wie Sie es iterieren könnten):

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

Vergleich mit "nur eine Liste zurückgeben"

Das obige Beispiel kann so aussehen, als ob Sie nur eine Liste erstellen, an die Sie sich anhängen und zurückgeben:

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

Es gibt jedoch einen großen Unterschied; siehe den letzten Abschnitt.

Wie könnten Sie Generatoren verwenden?

Ein iterabler Wert ist der letzte Teil eines Listenverständnisses, und alle Generatoren sind iterierbar, weshalb sie oft wie folgt verwendet werden:

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

Um ein besseres Gefühl für Generatoren zu bekommen, können Sie mit dem itertools Modul itertools (achten Sie darauf, chain.from_iterable zu verwenden, anstatt zu chain.from_iterable chain wenn dies gerechtfertigt ist). Zum Beispiel könnten Sie sogar Generatoren verwenden, um unendlich lange faule Listen wie itertools.count() zu implementieren. Sie könnten Ihre eigene def enumerate(iterable): zip(count(), iterable) implementieren def enumerate(iterable): zip(count(), iterable) , oder alternativ mit dem yield Schlüsselwort in einer while-Schleife.

Bitte beachten Sie: Generatoren können tatsächlich für viele andere Dinge verwendet werden, wie zum Beispiel die Implementierung von Coroutinen oder nicht-deterministische Programmierung oder andere elegante Dinge. Der hier verwendete "faule Listen" -Punkt ist jedoch der häufigste, den Sie finden werden.

Hinter den Kulissen

So funktioniert das "Python-Iterationsprotokoll". Das heißt, was list(makeRange(5)) wenn Sie list(makeRange(5)) . Das ist, was ich früher als "faul, inkrementelle Liste" beschrieben habe.

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

Die eingebaute Funktion next() ruft nur die Objekte .next() -Funktion auf, die Teil des "Iterationsprotokolls" ist und in allen Iteratoren gefunden wird. Sie können die next() -Funktion (und andere Teile des Iterationsprotokolls) manuell verwenden, um ausgefallene Dinge zu implementieren, normalerweise auf Kosten der Lesbarkeit. Versuchen Sie also, dies zu vermeiden ...

Minutien

Normalerweise würden die meisten Leute die folgenden Unterscheidungen nicht interessieren und wahrscheinlich hier aufhören zu lesen.

In Python ist ein iterable jedes Objekt, das das Konzept einer for-Schleife wie eine Liste versteht [1,2,3] , und ein Iterator ist eine spezifische Instanz der angeforderten for-Schleife wie [1,2,3].__iter__() . Ein Generator ist genau wie jeder Iterator, abgesehen von der Art, wie er geschrieben wurde (mit der Funktionssyntax).

Wenn Sie einen Iterator von einer Liste anfordern, erstellt er einen neuen Iterator. Wenn Sie jedoch einen Iterator von einem Iterator anfordern (was Sie selten tun würden), erhalten Sie nur eine Kopie von sich selbst.

In dem unwahrscheinlichen Fall, dass Sie etwas nicht tun ...

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

... dann erinnere dich, dass ein Generator ein Iterator ist ; das heißt, es ist einmalig. Wenn Sie es wiederverwenden möchten, sollten Sie myRange(...) erneut aufrufen. Wenn Sie das Ergebnis zweimal verwenden müssen, konvertieren Sie das Ergebnis in eine Liste und speichern Sie es in einer Variablen x = list(myRange(5)) . Diejenigen, die unbedingt einen Generator klonen müssen (zum Beispiel, die eine erschreckend hackische Metaprogrammierung machen) können itertools.tee wenn dies absolut notwendig ist, da der Vorschlag des kopierbaren Iterators Python PEP Standards zurückgestellt wurde.




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.




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

ie

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.




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.




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




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




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.




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.




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.




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

Starte es:

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.




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





Links