Python3 – yield文によるジェネレーターの実装

1 return文の確認
2 yield文にするとジェネレーターが生成される
3 yield文によるジェネレーターの挙動
4 yiled文とreturn文を混ぜた場合
5 実装の例

`return`文の確認

yield文はreturn文と同様に関数の中で使われ、戻り値を指定するが、その挙動は全く異なる。

まず準備として、通常のreturn文を持つ関数の動作を確認。呼び出されるたびに常に関数の先頭からreturn文まで実行される。

def func0():
    print("called")
    return 1

print(func0())
print(func0())

# called
# 1
# called
# 1

def func0():

print("called")

return 1

print(func0())

# called

# 1

# called

# 1

`yield`文にするとジェネレーターが生成される

このreturn文をyield文に変更してみると、関数の戻り値を返すのではなく、この関数がジェネレーターオブジェクトのコンストラクターとなっている。

def func1():
    print("called")
    yield 2

print(func1())

# <generator object func1 at 0x047BCF30>

def func1():

print("called")

yield 2

print(func1())

# <generator object func1 at 0x047BCF30>

ジェネレーターオブジェクトには、(Python3では)__next__()メソッドがあって、ジェネレーターで生成された値を順次取り出してくれる。そこで上のfunc1()でジェネレーターのインスタンスを生成し、直接値を取り出してみる。

generator = func1()
print(generator.__next__())
print(generator.__next__())

# called
# 2
# Traceback (most recent call last):
# .....
# StopIteration

generator = func1()

print(generator.__next__())

# called

# 2

# Traceback (most recent call last):

# .....

# StopIteration

このジェネレーターは値を1つしか生成しないので、2つ目を取り出そうとするとStopIteration例外を投げる。

`yield`文によるジェネレーターの挙動

以下の例は、3つの値を返すジェネレーターの例で、確認のためにyield文の前の処理をprint文で表示させるようにしている。なお、ここでは__next__()メソッドの代わりに組み込み関数next()を用いている。

def func3():
    print("He said:")
    yield "How are you?"

    print("She replied and asked:")
    yield "I'm fine. How are you?"

    print("He replied:")
    yield "I'm fine too."

generator = func3()
print(next(generator))
print(next(generator))
print(next(generator))

# He said:
# How are you?
# She replied and asked:
# I'm fine. How are you?
# He replied:
# I'm fine too.

def func3():

print("He said:")

yield "How are you?"

print("She replied and asked:")

yield "I'm fine. How are you?"

print("He replied:")

yield "I'm fine too."

generator = func3()

print(next(generator))

# He said:

# How are you?

# She replied and asked:

# I'm fine. How are you?

# He replied:

# I'm fine too.

関数で生成されるのはジェネレーターでStopIterationを投げるので、次のようにfor文で使える。

for x in func3():
    print(x)

# He said:
# How are you?
# She replied and asked:
# I'm fine. How are you?
# He replied:
# I'm fine too.

for x in func3():

print(x)

# He said:

# How are you?

# She replied and asked:

# I'm fine. How are you?

# He replied:

# I'm fine too.

`yiled`文と`return`文を混ぜた場合

関数の中でyield文を書くと、return文があってもジェネレーターが生成される。

def func4():
    yield 1
    yield 2
    yield 3
    return 4

print(func4())
for x in func4():
    print(x)

# <generator object func4 at 0x03B5CF30>
# 1
# 2
# 3

def func4():

yield 1

yield 2

yield 3

return 4

print(func4())

for x in func4():

print(x)

# <generator object func4 at 0x03B5CF30>

# 1

# 2

# 3

ただしreturn文があるとそこでStopIterationが投げられる。このとき、return文で指定した戻り値が得られるようだが、ジェネレーターとしては無視されるらしい。

def func5():
    yield 1
    yield 2
    return 3
    yield 4

g = func5()
print(next(g))
print(next(g))
print(next(g))

# 1
# 2
# Traceback (most recent call last):
# .....
# StopIteration: 3

def func5():

yield 1

yield 2

return 3

yield 4

g = func5()

print(next(g))

# 1

# 2

# Traceback (most recent call last):

# .....

# StopIteration: 3

このジェネレーターをfor文で使うと、以下のようにreturn文の手前まで実行される。

for x in func5():
    print(x)

# 1
# 2

for x in func5():

print(x)

# 1

# 2

実装の例

たとえば引数を与えて、その数以下であるフィボナッチ数列を返すジェネレーターを考える。

ef fibonacci(max):
    a = 1
    b = 1
    yield a
    yield b
    next_value = a + b
    while next_value < max:
        yield next_value
        a = b
        b = next_value
        next_value = a + b

for x in fibonacci(100):
    print(x)

# 1
# 1
# 2
# 3
# 5
# 8
# 13
# 21
# 34
# 55
# 89

ef fibonacci(max):

a = 1

b = 1

yield a

yield b

next_value = a + b

while next_value < max:

yield next_value

a = b

b = next_value

next_value = a + b

for x in fibonacci(100):

print(x)

# 1

# 2

# 3

# 5

# 8

# 13

# 21

# 34

# 55

# 89

TauStation

Python3 – yield文によるジェネレーターの実装

`return`文の確認

`yield`文にするとジェネレーターが生成される

`yield`文によるジェネレーターの挙動

`yiled`文と`return`文を混ぜた場合

実装の例

コメントを残すコメントをキャンセル

return文の確認

yield文にするとジェネレーターが生成される

yield文によるジェネレーターの挙動

yiled文とreturn文を混ぜた場合

実装の例

コメントを残す コメントをキャンセル

`return`文の確認

`yield`文にするとジェネレーターが生成される

`yield`文によるジェネレーターの挙動

`yiled`文と`return`文を混ぜた場合

コメントを残すコメントをキャンセル