【Python】ジェネレータの実装方法

この記事では、Pythonのジェネレータの使い方を解説します。ジェネレータを使うことで簡単にイテレータを作成することができます。

イテレータについては以下の記事を参考にしてください。

ジェネレーターとは？

ジェネレータとは、イテレータを簡単に作成するための機能です。リストやタプルなどを使わなくても、複数の値を返す関数を定義することができます。

ジェネレータの実装方法

ジェネレータは、returnの代わりにyield文を使ったジェネレータ関数を定義して使用します。ちなみに、ジェネレータ関数内ではreturnは使えません。

def 関数名():
    yield 戻り値

yieldは同時にいくつでも定義することもできます。

def 関数名():
    yield 戻り値1
    yield 戻り値2
    yield 戻り値3

POINT

yield文が処理されても関数は終了しません。

ジェネレータオブジェクト

ジェネレータ関数を実行するとジェネレータオブジェクトが返されます。
※ ジェネレータイテレータとも呼ばれる

<generator object 関数名 at 0x10bef73d0>

ジェネレータオブジェクトは、for文で要素にアクセスしたり、

for val in ジェネレータオブジェクト:
    print(val)

# yieldで返した値1
# yieldで返した値2
# yieldで返した値3
・
・
・

リストやタプルに変換したりできます。

list(ジェネレータオブジェクト)

サンプル

以下のコードは、渡された文字列を1文字ずつ文字コードにして返します。

def ords(string: str):
    for char in string:
        # yieldで文字コードを返す
        yield ord(char)


for o in ords('abc'):
    print(o)

# リストに変換
print(list(Ords('abc')))

実行結果

97
98
99
[97, 98, 99]

ジェネレータの仕組み

ジェネレータは以下のように処理されています。

yield文で値を返した時に処理を中断して、その場所を記憶する
新たに値を要求されたら、記憶した場所から処理を再開する

これを繰り返すことで、ジェネレータは複数の値を返しています。

サンプル

以下の例を見てください。next()で要素を要求されるたびに、関数内のprint()によって値が出力されているのがわかります。

def generator():
    print('start')
    print('yield 1')
    yield 1
    print('yield 2')
    yield 2
    print('yield 3')
    yield 3
    print('end')


g = generator()

# next()で次の要素を要求できる
print('next 1')
print(next(g))
print('next 2')
print(next(g))
print('next 3')
print(next(g))
print('next 4')
print(next(g))

実行結果

next 1
start
yield 1
1
next 2
yield 2
2
next 3
yield 3
3
next 4
end
Traceback (most recent call last):
  File "main.py", line 22, in <module>
    print(next(g))
StopIteration

このように、ジェネレータは値を求められるたびに演算して要素を返しています。なので、通常の関数と違い演算コストを分散させることができます。

ジェネレータ式

単純なジェネレータならば、さらに簡潔に式として記述することができます。

書式

以下のように内包表現と同じ書き方をします。[]ではなく()を使う点に注意してください。

(戻り値 for 変数名 in イテラブルオブジェクト)

サンプル

先ほどのサンプルで作成したジェネレータ関数をジェネレータ式で書き直してみます。

for n in (ord(char) for char in 'abc'):
    print(n)

実行結果

97
98
99

なんとfor文と合わせて2行で実装できてしまいました。このように、単純なジェネレータを生成する場合、ジェネレータ式を使うことでより簡単に実装することができます。

まとめ

この記事では、Pythonのジェネレータとジェネレータ式の使い方を解説しました。

ジェネレータはそんなに使う機会は多くないですが、複数の値を返したいけどリストやタプルなどを使いたくない場合は実装を検討してみてはいかがでしょうか？

おさらい

# ジェネレータ
def 関数名():
    yield 戻り値1
    yield 戻り値2
    yield 戻り値3

# ジェネレータ式
(戻り値 for 変数名 in イテラブルオブジェクト)

それでは今回の内容はここまでです。ではまたどこかで〜( ・∀・)ﾉ