Python yieldとは？仕組み・使い方・注意点を一気に解説

def simple_gen():
    # 最初に呼び出されたときにここから実行される
    yield 1
    yield 2

g = simple_gen()  # ここではまだ何も実行されない
print(g)          # <generator object ...> のような表示

def simple_gen():
    print("start")
    yield 1
    print("between")
    yield 2
    print("end")

# ジェネレータオブジェクトを作成
g = simple_gen()

print("first next()")
print(next(g))  # 1つ目のyieldまで実行

print("second next()")
print(next(g))  # 2つ目のyieldまで実行

print("third next()")
try:
    print(next(g))  # これ以上yieldがないのでStopIteration
except StopIteration:
    print("StopIterationが発生しました")

def counter():
    n = 0  # このローカル変数nの値が、yieldのたびに保持される
    while n < 3:
        yield n
        n += 1  # 次回再開時はインクリメントされた値からスタート

c = counter()
print(next(c))  # 0
print(next(c))  # 1
print(next(c))  # 2

def numbers():
    print("ジェネレータ開始")
    for i in range(3):
        print(f"yield前: i = {i}")
        yield i
        print(f"yield後: i = {i}")
    print("ジェネレータ終了")

for x in numbers():
    print(f"forループ側: x = {x}")

def numbers(n):
    """0からn-1までの整数を順番に返すジェネレータ"""
    i = 0
    while i < n:
        # 現在のiを返して、一時停止
        yield i
        # 次回再開時はここから
        i += 1

for x in numbers(5):
    print(x)

def read_large_dataset():
    """
    大量データを想定した疑似ジェネレータ。
    実際にはDBや外部API、巨大リストなどから
    1件ずつ読み込んでいくイメージです。
    """
    for i in range(10**7):  # 1,000万件を仮想的に生成
        yield {"id": i, "value": i * 2}

def process():
    total = 0
    # 必要な分だけ1件ずつ取り出して集計する
    for record in read_large_dataset():
        total += record["value"]
    return total

# 実際に実行すると時間はかかりますが、
# メモリを一気に使い切ることはありません。

def read_lines(filepath):
    """ファイルを1行ずつyieldするジェネレータ"""
    with open(filepath, encoding="utf-8") as f:
        for line in f:
            # strip()で改行を取り除いて返す
            yield line.rstrip("\n")

def count_error_lines(filepath):
    """'ERROR'を含む行数をカウントする例"""
    count = 0
    for line in read_lines(filepath):
        if "ERROR" in line:
            count += 1
    return count

# 使い方の例
# error_count = count_error_lines("server.log")
# print(error_count)

def infinite_counter(start=0, step=1):
    """startからstepずつ増える無限カウンタ"""
    n = start
    while True:  # 無限ループ
        yield n
        n += step

# 0から2ずつ増えるカウンタから、最初の5個だけ取り出す例
cnt = infinite_counter(start=0, step=2)
for _ in range(5):
    print(next(cnt))

for n in infinite_counter():
    if n > 10:
        break
    print(n)

def enumerate_lines(filepath):
    """
    ファイルの各行に対して、
    (行番号, 行の内容) をyieldする例
    """
    with open(filepath, encoding="utf-8") as f:
        for lineno, line in enumerate(f, start=1):
            # 1回のyieldで2つの情報をまとめて返す
            yield lineno, line.rstrip("\n")

# 行番号と内容を同時に受け取る
# for lineno, text in enumerate_lines("sample.txt"):
#     print(lineno, text)

def points():
    """2次元座標を連続で返す例"""
    for x in range(3):
        for y in range(3):
            # 辞書で複数の値を返す
            yield {"x": x, "y": y}

for p in points():
    print(f"({p['x']}, {p['y']})")

def accumulator():
    """
    外部から送られてきた数値を累積していくコルーチン的ジェネレータ。
    初回はnext()で起動し、それ以降はsend(value)で値を送る。
    """
    total = 0
    while True:
        # 外部から値が送られてくるのを待つ
        value = yield total  # 現在のtotalを返しつつ、一時停止
        if value is None:
            # Noneが送られたら何もしない
            continue
        total += value

# ジェネレータを作成
acc = accumulator()

# 最初の起動。最初のyieldまで進める必要があるため、next()を呼ぶ
print(next(acc))  # total = 0 が返る

# ここからsendで値を送り込む
print(acc.send(10))  # total += 10 → 10を返す
print(acc.send(5))   # total += 5  → 15を返す
print(acc.send(-3))  # total += -3 → 12を返す

def sample():
    yield 1
    yield 2
    return 999  # ここでジェネレータは終了する

g = sample()
try:
    print(next(g))  # 1
    print(next(g))  # 2
    print(next(g))  # StopIteration
except StopIteration as e:
    print("StopIteration.value =", e.value)

def gen():
    for i in range(5):
        if i == 3:
            return  # ここで終了
        yield i

def safe_divider(numbers, divisor):
    """
    0除算を避けつつ、1件ずつ結果をyieldする例。
    例外は内部で処理し、ログを出してスキップするイメージ。
    """
    for n in numbers:
        try:
            result = n / divisor
        except ZeroDivisionError:
            print("0除算が発生しました。値をスキップします。")
            continue
        else:
            yield result
        finally:
            # 共通後処理がある場合はここに書く
            pass

data = [10, 20, 30]
for r in safe_divider(data, 10):
    print(r)

def gen():
    try:
        while True:
            value = yield
            print("受信:", value)
    except ValueError as e:
        print("ジェネレータ内でValueErrorを捕捉:", e)

g = gen()
next(g)             # 起動
g.send(1)
g.throw(ValueError("エラー発生"))

def read_numbers(filepath):
    """ファイルから整数を1行ずつ読み込む"""
    with open(filepath) as f:
        for line in f:
            yield int(line.strip())

def filter_positive(numbers):
    """正の数だけを通す"""
    for n in numbers:
        if n > 0:
            yield n

def square(numbers):
    """2乗する"""
    for n in numbers:
        yield n * n

# パイプラインとしてつなげて使う
# nums = read_numbers("nums.txt")
# positives = filter_positive(nums)
# squared = square(positives)
# for x in squared:
#     print(x)