【保存版】Pythonのyieldを使いこなす｜コード付きで解説

（最終更新月：2023年7月）

✔当記事は以下のような方に向けて書かれています

✔当記事を通してお伝えするポイント

• yield文の基本概念
• Pythonでのyield文の使い方と応用方法
• 実際に使われるyield文の事例

当記事では、yield文の基本から応用的な使い方まで、具体的な例を交えながら詳細に解説します。

ぜひ最後までご覧ください。

Pythonのyieldを理解するための前提知識

こちらでは、「yield」の基本的な概念とその利用のメリットについて説明します。

• Pythonのyieldとは？
• yieldの重要性
• イテレータとジェネレータの概念
• 「yield」の利点と活用シーン

Pythonのyieldとは？

Pythonのyieldとは、ジェネレータ関数を定義する際に使用されるキーワードのこと。

yieldキーワードを使用することで、ジェネレータ関数はイテレータを作成し、値を逐次的に生成します。

以下に、yieldを使用したジェネレータ関数の例を示します:

def count_up_to(n):
    i = 1
    while i <= n:
        yield i
        i += 1

# ジェネレータ関数を呼び出してイテレータを取得
iterator = count_up_to(5)

# イテレータから値を逐次的に取得
print(next(iterator))  # 1
print(next(iterator))  # 2
print(next(iterator))  # 3
print(next(iterator))  # 4
print(next(iterator))  # 5

# イテレータの末尾に到達するとStopIterationが発生する
# print(next(iterator))  # StopIterationエラー

イテレータの末尾に到達した場合、StopIteration例外が発生します。

Pythonの「yield」の重要性

yieldの理解と活用は、とくに大規模なデータを扱う際や、リアルタイムでデータを処理する必要がある場合に、とても有効です。

なぜならジェネレータ関数とyieldにより、大量のデータを一度にロードする必要がなく、必要なときに値を生成できるからです。

ただしその動作は一見すると非直感的であり、初心者にとっては難しく感じるかもしれません。

当記事の内容をしっかりと理解して、より高度なコーディングを目指しましょう。

イテレータとジェネレータの概念

Pythonでは、「yield」はジェネレータと呼ばれる特殊な種類のイテレータを作成します。

イテレータは、「次の要素」を提供する能力を持つオブジェクトで、forループなどで頻繁に使用されます。

全要素を同時にメモリに保持するリストとは異なり、イテレータは一度に一つの要素だけを生成するのです。

これにより、大量のデータを扱う際のメモリ消費を抑制できます。

「yield」の利点と活用シーン

「yield」を使用すると、関数の実行を一時的に停止し、後から再開も可能。

これは例えば、大規模なファイルを行ごとに処理する場合や、大量のデータを小さなチャンクに分割して処理する場合に特に有用です。

以下に具体的なコード例を示します。

def read_large_file(file_path):
    with open(file_path, "r") as file:
        for line in file:
            yield line

「yield」を使用して大きなファイルを行ごとに読み込んでいます。

この関数はイテレータを返し、それを使って一度に1行ずつ処理を進められるのです。

一度に全行をメモリに読み込む必要がなくなり、大きなファイルでもメモリを節約しながら処理を行うことが可能になります。

「yield」の基本的な使い方

こちらでは、「yield」の基本的な使い方について詳しく解説していきます。

• forループを用いた例
• ジェネレータ関数での活用

forループを用いた例

「yield」は通常、forループと組み合わせて使用されます。

以下がその具体例です。

def simple_generator():
    yield 1
    yield 2
    yield 3

for value in simple_generator():
    print(value)

上記のコードを実行すると、「1」「2」「3」が順番に出力されます。

simple_generator関数はジェネレータ関数であり、「yield」を使用して値をひとつずつ生成。

forループはジェネレータから値を取得し、全ての値が取り出されるとループが終了します。

ジェネレータ関数での活用

「yield」はジェネレータ関数内で値を生成するためにも使われます。

以下がその例です。

def count_up_to(n):
    count = 1
    while count <= n:
        yield count
        count += 1

for number in count_up_to(5):
    print(number)

#実行すると、「1」「2」「3」「4」「5」が順番に出力されます。

count_up_to関数は指定した数値まで数を数え上げるジェネレータを作成します。

この関数が呼び出されると、最初に1を生成し、次に2を生成し、というように数を増やしていくのです。

指定した数値に到達した時点でジェネレータは停止します。

必要なときに値を生成しているので、、メモリ効率を高め、パフォーマンスを向上させることが可能です。

高度な使い方：「yield from」

こちらでは、「yield from」の使用法とその利点について説明します。

• 「yield from」の概要と利用方法
• サブジェネレータによる効果

「yield from」の概要と利用方法

Python 3.3以降では、「yield from」文が導入され、ジェネレータをさらに簡単に扱えるようになりました。

「yield from」は、ジェネレータから値を自動的に取り出す構文です。

以下に具体的な例を示します。

def count_up_to(n):
    count = 1
    while count <= n:
        yield count
        count += 1

def count_twice(n):
    yield from count_up_to(n)
    yield from count_up_to(n)

for number in count_twice(3):
    print(number)

count_up_to関数がジェネレータを返し、count_twice関数がyield fromを用いてそのジェネレータから値を取り出しています。

このコードを実行すると、「1」「2」「3」「1」「2」「3」が順番に出力。

つまり、count_up_toが2回実行されることになります。

サブジェネレータによる効果

「yield from」はサブジェネレータという概念と組み合わせると、さらに高度な機能を実現できます。

サブジェネレータは、ジェネレータ関数内から呼び出される別のジェネレータ関数のこと。

これによりジェネレータの作成をモジュール化することが可能になるのです。

def sub_generator(n):
    for i in range(n):
        yield i

def main_generator():
    yield from sub_generator(5)

# メインのジェネレータから値を逐次的に取得
gen = main_generator()
print(next(gen))  # 0
print(next(gen))  # 1
print(next(gen))  # 2
print(next(gen))  # 3
print(next(gen))  # 4

ジェネレータの実践的な活用

こちらでは、実際のプログラムでジェネレータがどのように活用できるかを説明します。

実践例を見ることで、初心者の方でもすぐに使いこなせるようになるはずです。

• シチュエーション1：リソース節約
• シチュエーション2：リアルタイム処理
• 他の実践的な例

シチュエーション1：リソース節約

大量のデータを扱うプログラムでは、ジェネレータが非常に有用です。

ジェネレータを使用すると、一度にすべてのデータをメモリにロードする必要がなくなります。

以下が大量のデータを順に処理するためのジェネレータ関数の例です。

def process_data(data):
    for datum in data:
        yield process(datum)  # process()はデータを処理する仮定の関数

large_data = get_large_data()  # get_large_data()は大量のデータを返す仮定の関数

for result in process_data(large_data):
    print(result)

process_dataジェネレータ関数が大量のデータをひとつずつ処理し、処理結果を生成。

このジェネレータを用いることで、大量のデータをひとつずつ処理し、全データを一度に処理する必要がなくなります。

メモリ消費の抑制に繋がるのです。

シチュエーション2：リアルタイム処理

また、ジェネレータはリアルタイムでデータを処理するプログラムにも適しています。

ジェネレータを使用すれば、ひとつずつのリクエストを順次処理できるようになるからです。

例としては、ユーザーからのリクエストを順次処理するウェブサーバーなどが挙げられます。

以下に、リクエストを順次処理するジェネレータ関数の例を示します。

def handle_requests(request_queue):
    while True:
        request = request_queue.get()  # リクエストをキューから取得
        if request is None:
            break
        yield process_request(request)  # process_request()はリクエストを処理する仮定の関数

for response in handle_requests(request_queue):
    send_response(response)  # send_response()はレスポンスを送信する仮定の関数

handle_requestsジェネレータ関数がキューからリクエストを一つずつ取得し、それを処理してレスポンスを生成します。

このジェネレータを用いると、リクエストを一つずつ処理することが可能で、全てのリクエストを一度に処理する必要がありません。

ほかの実践的な例

ジェネレータは、ほかにもさまざまな場面で活用できます。

とくに順次的な操作が必要な場合には、ジェネレータが適しているといえるでしょう。

• ファイルの読み込み
• 大規模な計算
• データベースのクエリ実行 など

ジェネレータを活用することで、一度にすべてのデータを扱う必要がなく、必要なときにだけデータを取り出せるからです。

これにより、パフォーマンスの向上やリソースの節約が実現します。

def read_lines(filename):
    with open(filename, 'r') as file:
        for line in file:
            yield line.rstrip('\n')

# ファイルの内容を逐次的に表示
lines = read_lines('example.txt')
for line in lines:
    print(line)

まとめ

当記事では、「yield」の基本的な使い方から、高度な使い方（「yield from」やサブジェネレータ）までについて学習してきました。

• yieldとジェネレータを使用することで、大規模なデータを効率的に扱える
• yieldを使用することで、一度にすべてのデータをメモリにロードすることなく、必要なときにだけデータを生成できる

ジェネレータを理解し、適切に使用することで、Pythonにおけるプログラミングスキルを大きく向上させられます。

とくに大規模なデータを扱うアプリケーションを開発する際には、ジェネレータの活用はほぼ必須といえるでしょう。

またリアルタイム処理や非同期処理といった、より高度なプログラミングテクニックを学ぶ上でも、ジェネレータの理解は大きな助けとなります。

これらのテクニックをマスターし、Pythonを使用したソフトウェア開発の幅を広げましょう。