Pythonインタラクティブガイド - ステップ3 関数 (10) - ジェネレータ関数

「ステップ3 関数」の続きです。

3.9. ジェネレータ関数

今回は、データを効率的に扱うための特殊な関数であるジェネレータ関数について学んでいきます。

3.9.1. ジェネレータ関数とは

「2.2.3. 内包表記」では、ジェネレータ式について扱いました。
ジェネレータ式は、以下の性質を持つ「ジェネレータ(オブジェクト)」を返します:

• イテラブル(繰り返し可能)である
• 値を一度だけ順に取り出せる「使い切り」のオブジェクト
• 値をすべて一度に生成するのではなく、必要に応じて一つずつ生成するためメモリ効率が良い

今回扱う ジェネレータ関数 も、同様にジェネレータを返す関数です。

• 上記ジェネレータ関数で生成されたジェネレータは、コードを順に実行し、yield文に到達するとその時点で指定された値を返します。 この動作を関数が終了するまで繰り返します。
• 関数が終了すると値の生成も終了します。

• next()関数を用いると、ジェネレータから次の値を1つずつ取得できます。

• すべての値を生成後にnext()を呼び出すと、StopIteration例外が発生します。

上記の例から分かるように、ジェネレータ関数が出力するジェネレータは以下の特徴を持ちます：

1. next()関数を呼び出すと、最初のyield文までコードを実行して値を返す
2. 次にnext()が呼ばれると、前回のyield文の直後から実行が再開され、次のyield文までコードを実行して値を返す
3. 上記2パターンのいずれの場合も、次のyield文が存在しない場合は、コードを最後まで実行した後に StopIteration 例外を発生させる

実はfor文は内部で「next()関数を繰り返し呼び出し、StopIterationが発生したら処理を終了する」という仕組みで動いています。

3.9.2. 無限ジェネレータ

ジェネレータ関数を使用すると、リストでは表現できないような無限に続く数列も生成できます。

無限ジェネレータをforループで使用する場合は、何らかの条件で中断する必要があります：

3.9.3. 複数のジェネレータを組み合わせる (yield from)

yield from構文を使用すると、イテラブル(リストやジェネレータなど)から値を順に生成できます。
これを用いて、複数のジェネレータを組み合わせたジェネレータの作成が簡潔に行えます:

yield fromを使わない場合、以下のように冗長な記述が必要になります：

yield fromは単に短縮構文というだけでなく、後に紹介するsend、throw、closeといった操作も内部のジェネレータへそのまま引き渡す働きを持っています。

3.9.4. ジェネレータの高度な機能

ここまではジェネレータを主に「値を生成するオブジェクト」として使用してきました。 次に紹介する機能を用いると、外部からジェネレータにデータを送信でき、処理の流れを双方向で制御できるようになります。

ジェネレータに値を送る (sendメソッド)

send メソッドを使用すると、ジェネレータに値を送信することができます。
送信された値は、以下のように yield 式の戻り値として受け取ります:

上記文では、以下の2つの操作を行っています:

1. この文に到達すると、「出力値」を出力して実行を一時停止する
2. この文で停止時にsendメソッドが実行されると、その引数を「変数」に代入して、次のyield文までコードを実行する

上記のようにしてsendメソッドの値を受け取るため、以下に注意してください:

• sendメソッドを使用するには、そのジェネレータがyield文で停止している必要があります。
  そのため、最初にsendメソッドを使用する前に、next()関数を用いてyield文まで進めておく必要があります。
• 上記文で停止時にnext()関数が使用されると、「変数」にはNoneが代入されます。

ジェネレータに例外を送る (throwメソッド)

sendメソッドが通常のデータを送信するのに対し、throwメソッドを用いるとジェネレータに例外を送ることができます。
throwメソッドを呼び出すと、ジェネレータが最後に停止したyield文の位置で指定した例外が発生します。

例外を送信することで、ジェネレータの実行フローを制御できます。
これはジェネレータ内でエラー処理やリソースのクリーンアップなどを行う際に役立ちます。
(エラー処理については後ほど詳しく解説します)

ジェネレータを終了する (closeメソッド)

closeメソッドを使用すると、ジェネレータを明示的に終了できます：

closeメソッドは、ジェネレータ内部で使用しているリソースの解放が必要な場合などに使用されます。

まとめ

今回はジェネレータ関数について学びました。

• ジェネレータ関数は、yield文を使ってデータを一つずつ生成する特殊な関数です

• メモリ効率が良く、大量のデータや無限のデータ列でも効率的に扱えます

• ジェネレータの主な特徴：

  • 値を一度だけ順に取り出せる「使い切り」のオブジェクト
  • 必要に応じて値を一つずつ生成する「遅延評価」方式
  • for文やnext()関数で値を取り出せる

• 高度な機能：

  • yield from：他のイテラブルから値を生成する簡潔な方法
  • send()メソッド：ジェネレータに値を送信して双方向通信を実現
  • throw()メソッド：ジェネレータに例外を送出して制御
  • close()メソッド：ジェネレータを明示的に終了

ジェネレータ関数は、大規模データの処理やストリーム処理など、様々な場面で活用できる強力な機能です。
特に、メモリ使用量を抑えながら大量のデータを扱う必要がある場合に便利です。

まとめスライド