Pythonのジェネレータへの苦手意識をなくしたい

今日も一日一文法シリーズ、やる。

Pythonのリファレンスや、参考書を読んでこれは知らなかったなとか、うろ覚えだな…というものを個人的に紹介していく。勉強中の方の役にたてば嬉しい。そんな趣旨ではじめた。読者になってもらうと一緒に勉強できておすすめ(勧誘)

教材としてしばらく以下の本を使用する。今回のトピックスでもここから見つけた。

入門 Python 3

作者: Bill Lubanovic,斎藤康毅,長尾高弘
出版社/メーカー: オライリージャパン
発売日: 2015/12/01
メディア: 単行本（ソフトカバー）
この商品を含むブログ (3件) を見る

初めて3日だけど他の言語も勉強したくなってきた… 一文法だから別言語でもいいだろう、たまにScalaにする。

ジェネレータとは
ジェネレータの定義方法
- 宣言
値の取り出し
ジェネレータの性質
- 性質1：listやdictのように値を反復して取り出すことができる。
- 性質2：取り出している場所の情報を記録しており、途中から再開することができる。
性質3：再度まで要素を取り出すと、要素はもう取り出すことはできない。
ジェネレータはどういう場合に使うべきか
- 参考

ジェネレータとは

公式ドキュメントより…

ジェネレータオブジェクトは、 Python がジェネレータイテレータを実装するのに使っているオブジェクトです。ジェネレータオブジェクトは通常、 PyGen_New() や PyGen_NewWithQualName() の明示的な呼び出しではなく、値を yield する関数のイテレーションにより生成されます。

PyGen_New()?ちょっと聞いたことないけど大事なのは前半と後半の

Python がジェネレータイテレータを実装するのに使っているオブジェクト
値を yield する関数のイテレーションにより生成されます

が重要だが概念の説明は分かりにくいので特徴を抽出して並べると以下のような感じになる。

listやdictのように値を反復して取り出すことができる。
取り出している場所の情報を記録しており、途中から再開することができる。
再度まで要素を取り出すと、要素はもう取り出すことはできない。

ざっとこんなとこだろうか、順番に性質を確認していきたい。その前に定義方法を確認する。

ジェネレータの定義方法

宣言

>>> def gen():
...     yield "gen"

上記のように関数に類似した宣言をするが、関数との差異はreturnがyieldとなる点が異なる。

値の取り出し

>>> g = gen()
>>> next(g)
'gen'
>>>

ここも関数と類似しており上記の場合gen()を実行するとジェネレータオブジェクトが生成される。ジェネレータオブジェクトに対してnext()メソッドを使用すると値が取り出せる。

他にも以下のようにiter()によってイテレータをを取り出してイテレータをして使用できる。

ジェネレータの性質

性質1：`list`や`dict`のように値を反復して取り出すことができる。

>>> def gen3(n):
...     for i in range(n):
...             yield i
... 
>>> ggg = gen3(3)
>>> next(ggg)
0
>>> next(ggg)
1
>>> next(ggg)
2
>>> next(ggg)

性質2：取り出している場所の情報を記録しており、途中から再開することができる。

>>> def gen5(n):
...     for i in range(n):
...             yield i
... 
>>> g = gen5(5)
>>> for i in range(2):
...     next(g)
... 
0
1
>>> for i in range(2):
...     next(g)
... 
2
3

性質3：再度まで要素を取り出すと、要素はもう取り出すことはできない。

>>> def gen3(n):
...     for i in range(n):
...             yield i
... 
>>> ggg = gen3(3)
>>> next(ggg)
0
>>> next(ggg)
1
>>> next(ggg)
2
>>> next(ggg)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
StopIteration