[Python] "yield"キーワードは何をしますか?


Answers

Grokking yieldへのショートカット

yield文を含む関数を見るときは、この簡単なやりかたを適用して何が起こるかを理解してください:

  1. 関数の先頭にline result = []を挿入します。
  2. yield exprresult.append(expr)置き換えます。
  3. 関数の最後に改行return resultを挿入します。
  4. よろしくお願いします。 コードを読み、理解する。
  5. 機能を元の定義と比較する。

このトリックは、関数の背後にあるロジックのアイデアを与えるかもしれませんが、実際にはyieldがどうなるかは、リストベースのアプローチで起こることとは大きく異なります。 多くの場合、歩留まりのアプローチは、より多くのメモリ効率と高速になります。 他のケースでは、このトリックは元の関数が正常に動作しても、無限ループに陥ることになります。 もっと詳しく知りたければ...

イテラブル、イテレータ、ジェネレータを混乱させないでください

まず、 イテレータプロトコル - あなたが書くとき

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

Pythonは次の2つのステップを実行します。

  1. mylistイテレータを取得します。

    iter(mylist)呼び出す - >これは、 next()メソッド(またはPython 3では__next__()を持つオブジェクトを返します。

    [これはほとんどの人があなたに伝えることを忘れているステップです]

  2. イテレータを使用して項目をループする:

    ステップ1から返されたイテレータに対してnext()メソッドを呼び出したままにします。next next()からの戻り値がx割り当てられ、ループ本体が実行されます。 next()内から例外StopIterationが発生した場合は、イテレータに値がなくなり、ループが終了したことを意味します。

真実は、Pythonがオブジェクトの内容をループしたいときはいつでも、上記の2つのステップを実行するので、forループになる可能性がありますが、 otherlist.extend(mylist)ようなコードでもotherlist.extend(mylist)ません( otherlistはPythonリストです) 。

ここでは、iteratorプロトコルを実装しているため、 mylistiterableです。 ユーザ定義のクラスでは、 __iter__()メソッドを実装して、クラスのインスタンスを反復可能にすることができます。 このメソッドはイテレータを返す必要があります 。 イテレータはnext()メソッドを持つオブジェクトです。 同じクラスで__iter__()next()両方を実装し、 __iter__() __iter__() self戻すことができます。 これは単純なケースでは機能しますが、同じオブジェクトに対して2つのイテレーターを同時にループさせたい場合は使用できません。

それがイテレータプロトコルです。多くのオブジェクトがこのプロトコルを実装しています。

  1. 組み込みのリスト、辞書、タプル、セット、ファイル。
  2. __iter__()を実装するユーザー定義クラス。
  3. 発電機。

forループは、どのオブジェクトが扱われているのかわからないことに注意してください。イテレータプロトコルに従うだけで、 next()呼び出すときにitemの後にitemを取得することができます。 ビルトインリストはアイテムを1つずつ返し、辞書はキーを 1つずつ返し、ファイルはラインを 1つずつ返すなどします。ジェネレータは戻ります... yieldが来るところです:

def f123():
    yield 1
    yield 2
    yield 3

for item in f123():
    print item

yield文の代わりに、 f123() 3つのreturn文がある場合は、最初の文だけが実行され、関数は終了します。 しかしf123()は普通の関数ではありません。 f123()が呼び出されると、yield文の値返されません ! ジェネレータオブジェクトを返します。 また、関数は実際には終了せず、中断状態になります。 forループがジェネレータオブジェクトforループしようとすると、関数は以前に返されたyield直後の行でサスペンド状態から再開し、次のコード行(この場合はyield文)を実行し、次の項目。 これは、関数が終了するまで発生し、その時点でジェネレータはStopIteration発生し、ループは終了します。

したがって、ジェネレータオブジェクトはアダプタのようなものです。一方では、 __iter__()およびnext()メソッドを公開してforループを幸せに保ち、イテレータプロトコルを示します。 ただし、もう一方の端では、次の値を取得するのに十分なだけ関数を実行し、サスペンドモードに戻します。

ジェネレータを使用する理由

通常、ジェネレータを使用せず同じロジックを実装するコードを書くことができます。 1つの選択肢は、以前に言及した一時的なリスト 'トリック'を使用することです。 例えば、無限ループがある場合や、本当に長いリストがある場合は、メモリを非効率的に使用する可能性があります。 もう1つのアプローチは、インスタンスメンバーに状態を保持し、 next() (またはPython 3の__next__() )メソッドで次の論理的なステップを実行する新しいiterableクラスSomethingIterを実装することです。 ロジックによっては、 next()メソッド内のコードが非常に複雑になり、バグが発生する可能性があります。 ここでジェネレータはクリーンで簡単なソリューションを提供します。

Question

Pythonでyieldキーワードを使うのは何ですか? それは何をするためのものか?

たとえば、私はこのコードを理解しようとしています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  

これは呼び出し側です。

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

_get_child_candidatesメソッドが呼び出されるとどうなりますか? リストは返されますか? 単一の要素ですか? それは再び呼び出されますか? その後の通話はいつ中止されますか?

1.コードは、Jochen Schulz(jrschulz)が提供しています。 これは完全なソースへのリンクです: Module mspace




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



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.




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.




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

それを実行します:

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.




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.

すなわち、

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.




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




yieldキーワードは2つの単純な事実に還元されます:

  1. コンパイラが関数内のどこかで yieldキーワードを検出した場合、その関数はreturn文では返されません。 代わりに 、ジェネレータと呼ばれる遅延した「保留リスト」オブジェクトを すぐに返します
  2. ジェネレータは反復可能です。 iterableとは何ですか? これは、 listsetrangeまたはdict-viewのようなもので、 各要素を特定の順序で訪問するためのプロトコルが組み込まれています

簡単に言えば、ジェネレータは怠惰で漸進的に保留中のリストで、 yieldステートメントを使用すると、関数表記を使用してジェネレータが徐々に吐き出されるリスト値をプログラムできます

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

Pythonのrange似たmakeRange関数を定義しましょう。 makeRange(n)呼び出すA GENERATORをmakeRange(n)

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>

ジェネレータが保留中の値をすぐに返すようにするには、リストアすることができます(任意のiterableと同じように)。

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

例を「リストを返す」と比較すると、

上記の例は、単に追加して返すリストを作成するものと考えることができます:

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

しかし、大きな違いが1つあります。 最後のセクションを参照してください。

ジェネレータの使い方

iterableはリストの理解の最後の部分であり、すべてのジェネレータはiterableなので、しばしば以下のように使われます:

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

ジェネレータの感触を良くするには、 itertoolsモジュールを使用してchain.from_iterablechain.from_iterable (保証されている場合はchainではなくchain.from_iterableを使用してchain.from_iterable )。 たとえば、ジェネレータを使用してitertools.count()ような無限に長い遅延リストを実装することさえできます。 独自のdef enumerate(iterable): zip(count(), iterable)実装することもできますし、whileループでyieldキーワードを使用することもできます。

注意:ジェネレータは、実際にはコルーチン非決定論的プログラミングやその他のエレガントなものの実装など、もっと多くのものに使用できます。 しかし、私がここに示した「怠惰なリスト」の観点は、あなたが見つける最も一般的な使い方です。

舞台裏

これが「Python反復プロトコル」の仕組みです。 つまり、 list(makeRange(5))するときに何が起こっているのですかlist(makeRange(5)) 。 これは私が以前に「怠惰で増分的なリスト」として記述したものです。

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

組み込み関数next()はオブジェクト.next() next()を呼び出します。これは "反復プロトコル"の一部であり、すべての反復子にあります。 next()関数(および反復プロトコルの他の部分next()手動で使用して、通常は読みやすさを犠牲にして幻想的なものを実装することができます。

マヌティエ

通常、ほとんどの人は以下の区別に気をつけず、おそらくここで読むことを止めたいと思うでしょう。

Pythonでは、 iterableは、リスト[1,2,3]ような "forループの概念を理解する"オブジェクトであり、 イテレータ[1,2,3].__iter__()ように要求されたfor-loopの特定のインスタンスです[1,2,3].__iter__()ジェネレータは、(関数構文を使用して)書かれた方法を除いて、どのイテレータとまったく同じです。

イテレータをリストから要求すると、新しいイテレータが作成されます。 しかし、イテレータをイテレータから要求すると(まれにしか行いません)、それはあなた自身のコピーを提供します。

したがって、あなたがこのようなことをやっていないことは間違いありません...

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

...ジェネレータはイテレータであることを忘れないでください。 つまり、1回限りの使用です。 再利用したい場合は、 myRange(...)もう一度呼び出す必要があります。 結果を2回使用する必要がある場合は、結果をリストに変換し、変数x = list(myRange(5))ます。 コピー可能なイテレータのPython PEP標準の提案が延期されているため、絶対に必要な場合には、ジェネレータをクローンする必要がある人(たとえば、恐ろしくハックしたメタプログラミングを行っている人)はitertools.teeを使用できます。




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.




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



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.




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

例えば:

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



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.




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.




Links