関数のジェネレーターへの変更について

Question

def mufunc(start=0, end=20, multiple=2, non_multiple=5):
    i = start
    while i <= end:
        if i % multiple == 0 and i % non_multiple != 0:
            print(i)
        i += 1

上記の関数をジェネレーターに変更したいです。
なお、現時点でのコーディング状況は以下の通りになります。

def mufunc(start=0, end=20, multiple=2, non_multiple=5):
    for i in range(start, end + 1):
        if i % multiple == 0 != i % non_multiple:
            yield i

Comments

[LouiS0616]

次の二点を追記してください。『なぜジェネレータ関数にする必要があるのか』『そもそもジェネレータの意味はわかっているのか』

[退会済みユーザー]

ですねぇ

[pokkutter]

必要性を問われると大変心苦しいのですが、改めてジェネレータの意味を理解する上で今回の質問を例に何かご提言下さると幸いです。

[退会済みユーザー]

私から言えることは、質問が意味をなしていません、と言うことです。

[LouiS0616]

私が気になるのは質問の動機が不透明なことですね。

[退会済みユーザー]

現時点でのコーディングの何に問題があるのか教えてもらえるとコメントのしようがあるかもしれません。

[退会済みユーザー]

回答を見て思ったのですが、現時点でのコーディングにあるそのコードの使い方分かりますか？

Answer 1

「現時点でのコーディング状況」に問題は見受けられません。あとはそのジェネレーター関数を使用するだけです。

Answer 2

必要性を問われると...改めてジェネレータの意味を理解する上で今回の質問を例に何かご提言...

###質問者さんの課題の推測
generator関数を書いてはおられますが、それが正しいかどうか確信できないということは「generatorがどう動くのかのメカニズムがわからないためどう書くべきかが確信できない」といったところではないでしょうか。

つまり「generatorがコルーチン的な動作をすること」の把握が質問者さんの課題なのだろうと思います。

コルーチンの振る舞いがわかっていないとgeneratorとそれを使う側がどういう動きになるのかがわからず、それゆえ以下のような流れに陥ったのではないでしょうか。

=> なにやら特殊っぽいgeneratorというものをどう書いたらいいのかわからない
=> while文をfor文に変更してみたり、if文の論理を微妙に変えてみたりしたがやはり謎が残ったまま

###とりあえず正解コードは?
元の関数で印字している値を列挙するのが目的なのでしたら、
print(i) => yield i
へ置き換えるだけでよく、それ以外は一文字も変更する必要はありません。

###generator(コルーチン)の動きの解説(めいたもの)
generatorの振る舞いは先に伸べたように「コルーチン」と呼ばれる少々特殊なものです。そのため普通の関数呼び出しのイメージでとらえようとすると、その動作や働きを正しく把握することはできません。本体にyield文が含まれている関数(それ即ちgenerator)は普通の関数とは異なる以下のような振る舞いをします。

def gen(a, b):   #G0
    yield a      #G1
    yield b      #G2

g = generate(1, 2)  #M1
for e in g:         #M2
    print(e)        #M3
                    #M4

先に動きの説明の都合上、for文がループの各要素をどうやって決めるかの内部的な仕組みを述べます。

(ここから)
for文はループごとにinの後ろに指定された値(本件ではg)で決まるiterator(要素を順番に一つずつ列挙するためのオブジェクト)に対して__next__メソッドを呼び出します。そしてその結果の値をその回のループの制御変数(ここでは変数e)の値にしてループ本体を実行します。これを「もう要素がない」という状態になるまで繰り返します。
(ここまで)

さて上のコードの動きですが・・・

M1: gen関数を呼び出すとG0の地点で中断した状態になります。そしてその中断状態を表すようなgenerator iteratorが結果として返され、それがgen()呼び出しの結果の値となります。

M2(1回目): __next__()が呼び出されたとき、M1で生成されたgenerator iteratorを通じて**genは最後に中断した状態(つまりG0の地点)から実行を再開**します。再開する際にはgenのコンテキスト(引数やローカル変数の値、for文の内側なら何回目のループだったかなども含む)は全て「以前に中断したときと同じ状態で再開される」ことに注意してください。その後のgenの実行は次のyield文が出現するまで継続します。G1まで進むとyieldに指定した値a(つまり1)が__next__()からreturnされます。ここでgenは再び中断状態になります。

M3: 1が印字される

M2(2回目): 2回目の__next__()が呼び出されるとgenはG1の直後から再開し、G2のyieldで再び中断し、bの値(つまり2)が__next__()からreturnされます。

M3: 2が印字される

M2(3回目): 3回目ではgenはG2の直後から動き出しますがyieldがそれ以上出現せずに関数定義が完了(要するにreturn)します。このとき__next__は「yieldされずにgeneratorの実行が終わったのでもう列挙すべき要素はない」と判断し呼び出し元(for文)に「もうないです」といいます(内部的にはStopIteration例外をraiseします)

M4: for文によるループ終了
...

こういう仕組みで動いていることをイメージすると、「generatorを書くには列挙したい値が求まるたびに、単にその値に対してyieldを書けばよいだけ」ということがわかってくるのではないでしょうか？

Answer 3

落ち穂拾いぽいの。
range関数にはstepオプションがあります。

for i in range(start, end + 1, multiple):
    if i % non_multiple:
        yield i

Comments

[YouheiSakurai]

それだとstart=3, end=10, multiple=2の時に(3, 5, 7, 9)でループしてしまいます。単に落ち穂拾いの落ち穂拾いですが。

[umyu]

>YouheiSakuraiさんへ
そうですね。失礼しました。