セクション18:ジェネレータ

リスト生成式により、リストを直接作成できます.ただし、メモリの制限を受けると、リストの容量は限られているに違いありません.また、100万個の要素を含むリストを作成すると、大きなストレージスペースを消費するだけでなく、前のいくつかの要素にアクセスするだけで、後ろのほとんどの要素が消費するスペースが無駄になります.
だから、リスト要素が何らかのアルゴリズムで推定できるなら、ループの過程で後続の要素を絶えず推定することができますか?これにより、listを完全に作成する必要がなくなり、大量のスペースを節約できます.Pythonでは,このように循環しながら計算するメカニズムをジェネレータ:generatorと呼ぶ.
generatorを作成するには、さまざまな方法があります.1つ目の方法は簡単で、1つのリスト生成式の[]を()に変更するとgeneratorが作成されます.

>>> L = [x * x for x in range(10)]
>>> L
[0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
>>> g = (x * x for x in range(10))
>>> g
 at 0x1022ef630>

作成Lとgの違いは最外層のみ[]と()Lはlist、gはgeneratorです.
リストの各要素を直接印刷することができますが、generatorの各要素をどのように印刷しますか?
1つずつ印刷する場合は、next()関数でgeneratorの次の戻り値を取得できます.

>>> next(g)
0
>>> next(g)
1
>>> next(g)
4
>>> next(g)
9
>>> next(g)
16
>>> next(g)
25
>>> next(g)
36
>>> next(g)
49
>>> next(g)
64
>>> next(g)
81
>>> next(g)
Traceback (most recent call last):
  File "", line 1, in 
StopIteration

generatorが保存しているアルゴリズムは、next(g)を呼び出すたびにgの次の要素の値を計算し、最後の要素まで計算し、それ以上の要素がない場合にStopIterationのエラーを投げ出すアルゴリズムです.
もちろん、上記のような呼び出しが絶えないnext(g)あまりにも変態で、正しい方法はforループを使うことです.generatorも反復可能なオブジェクトですから.

>>> g = (x * x for x in range(10))
>>> for n in g:
...     print(n)
... 
0
1
4
9
16
25
36
49
64
81

したがって、generatorを作成すると、基本的には呼び出されないnext()ではなく、forループによって反復され、StopIterationのエラーに関心を持つ必要はありません.
generatorはとても強いです.推定アルゴリズムが複雑であれば,類似リスト生成式のforループで実現できない場合には,関数で実現することも可能である.
例えば、有名なフィボラッチ数列(Fibonacci)は、最初の数と2番目の数を除いて、いずれの数も前の2つの数から加算することができます.
1, 1, 2, 3, 5, 8, 13, 21, 34, ...
フィポラチ数列はリスト生成式では書けませんが、関数で印刷するのは簡単です.

def fib(max):
    n, a, b = 0, 0, 1
    while n < max:
        print(b)
        a, b = b, a + b
        n = n + 1
    return 'done'

注記:

a, b = b, a + b

次のようになります.

t = (b, a + b) # t   tuple
a = t[0]
b = t[1]

ただし、一時変数tを明示的に書く必要はなく、値を付与することができる.
上の関数は、フィボナッチ数列の最初のN個の数を出力することができます.

>>> fib(6)
1
1
2
3
5
8
'done'

よく見ると、fib関数は実際にフィポラチ数列を定義した推定規則であり、最初の要素から後続の任意の要素を推定することができるが、この論理はgeneratorに非常に似ている.
すなわち,上の関数はgeneratorとは一歩しか離れていない.fib関数をgeneratorにするには、print(b)をyield bに変更するだけです.

def fib(max):
    n, a, b = 0, 0, 1
    while n < max:
        yield b
        a, b = b, a + b
        n = n + 1
    return 'done'

これがgeneratorを定義する別の方法です.関数定義にyieldキーワードが含まれている場合、この関数は通常の関数ではなくgeneratorです.

>>> f = fib(6)
>>> f

ここで最も理解しにくいのはgeneratorと関数の実行フローが異なることです.関数は順番に実行され、return文または最後の行の関数文に遭遇すると返されます.generatorとなる関数は、呼び出しnext()のたびに実行され、遭遇yield文が返され、再実行時に前回返されたyield文から実行されます.
簡単な例を挙げてgeneratorを定義し、数字1,3,5を順に返します.

def odd():
    print('step 1')
    yield 1
    print('step 2')
    yield(3)
    print('step 3')
    yield(5)

このgeneratorを呼び出すときは、まずgeneratorオブジェクトを生成し、次にnext()関数を使用して次の戻り値を取得します.

>>> o = odd()
>>> next(o)
step 1
1
>>> next(o)
step 2
3
>>> next(o)
step 3
5
>>> next(o)
Traceback (most recent call last):
  File "", line 1, in 
StopIteration

odd普通の関数ではなくgeneratorであり、実行中にyieldに遭遇すると中断し、次回も実行を継続することがわかります.3回yieldを実行した後、すでにyield実行可能ではなかったので、4回目呼び出しnext(o)がエラーとなりました.fibの例に戻ると、ループ中に呼び出し続けますyieldと、途切れ続けます.もちろん、ループに条件を設定してループを終了します.そうしないと、無限数の列が生成されます.
同様に、関数をgeneratorに変更すると、基本的にはnext()で次の戻り値を取得するのではなく、forループを直接使用して反復します.

>>> for n in fib(6):
...     print(n)
...
1
1
2
3
5
8

しかしforgeneratorをループで呼び出すと、generatorのreturn文の戻り値が得られないことがわかります.戻り値を取得するには、必ずキャプチャStopIterationエラー、戻り値はStopIterationのvalueに含まれます.

>>> g = fib(6)
>>> while True:
...     try:
...         x = next(g)
...         print('g:', x)
...     except StopIteration as e:
...         print('Generator return value:', e.value)
...         break
...
g: 1
g: 1
g: 2
g: 3
g: 5
g: 8
Generator return value: done

エラーのキャプチャ方法については、後述するエラー処理についても詳しく説明します.
練習する
楊輝三角の定義は以下の通りである.

          1
         / \
        1   1
       / \ / \
      1   2   1
     / \ / \ / \
    1   3   3   1
   / \ / \ / \ / \
  1   4   6   4   1
 / \ / \ / \ / \ / \
1   5   10  10  5   1

各行をリストと見なし、generatorを書いて、次の行のリストを出力し続けます.

def triangles():
    pass

#     :
# [1]
# [1, 1]
# [1, 2, 1]
# [1, 3, 3, 1]
# [1, 4, 6, 4, 1]
# [1, 5, 10, 10, 5, 1]
# [1, 6, 15, 20, 15, 6, 1]
# [1, 7, 21, 35, 35, 21, 7, 1]
# [1, 8, 28, 56, 70, 56, 28, 8, 1]
# [1, 9, 36, 84, 126, 126, 84, 36, 9, 1]
n = 0
results = []
for t in triangles():
    print(t)
    results.append(t)
    n = n + 1
    if n == 10:
        break
if results == [
    [1],
    [1, 1],
    [1, 2, 1],
    [1, 3, 3, 1],
    [1, 4, 6, 4, 1],
    [1, 5, 10, 10, 5, 1],
    [1, 6, 15, 20, 15, 6, 1],
    [1, 7, 21, 35, 35, 21, 7, 1],
    [1, 8, 28, 56, 70, 56, 28, 8, 1],
    [1, 9, 36, 84, 126, 126, 84, 36, 9, 1]
]:
    print('    !')
else:
    print('    !')

小結
generatorは非常に強力なツールで、Pythonではリスト生成式をgeneratorに簡単に変更したり、関数で複雑な論理のgeneratorを実現したりすることができます.
generatorの動作原理を理解するには、forループの過程で次の要素を次々と算出し、適切な条件で終了するforループである.関数を変更したgeneratorでは、return文に遭遇したり、関数体の最後の行の文に実行したりして、generatorの命令を終了し、forループが終了します.
一般関数とgenerator関数を区別し、一般関数呼び出しは直接結果を返すことに注意してください.

>>> r = abs(6)
>>> r
6

generator関数の呼び出しは、実際にgeneratorオブジェクトを返します.

>>> g = fib(6)
>>> g