Pythonデザインパターン

PythonのIteratorパターン

このレッスンでは、Iteratorパターンを使って、データが内部でどう保存されているかを知らなくてもコレクションをたどれるようにします。

  • 上級
  • 約2分で読めます
  • 実行できるサンプル 1 件

はじめに

どんな問題を解決するか

コレクションをループで回すコードは、中身がどう保存されているかを知らなくてよいはずです。リストでも、木でも、ファイルでも、その場で計算される値でも同じです。Python の for ループは、イテレーション(反復)のプロトコルに従うオブジェクトなら何にでも使えます。

身近なたとえ

イテレーターは総菜売り場の番号札の発券機のようなものです。引くたびに次の番号が出てきます。中で番号がどう保管されているかは見えません。発券機が空になるまで、ただ引き続けるだけです。

番号札の発券機からコードへ
for number in Countdown(3):🎫 空になるまで札を引く
__iter__⚙️ 発券機の仕組み
yield current➡️ 次の番号を渡す
while current > 0:🏁 番号がなくなったら止まる
値は1つずつ届き、保存の仕方は隠れたままです。
ひと言でいうと

Iterator パターンは、保存の仕方を見せずにコレクションの要素へ順にアクセスできるようにします。Python では、__iter__ メソッドがイテレーターを返すオブジェクトが反復可能(イテラブル)です。

重要なポイント

  1. Countdown(3) は開始の数だけを保存します。
  2. __iter__ は for ループが反復を始めるときに呼ぶメソッドです。
  3. yield を含むので、__iter__ は3、2、1を1つずつ生み出すジェネレーターを返します。
  4. ジェネレーターが終わるとループは自動で止まります。

どんな場面で使う?

  • 自作のコレクションを for、list()、sum()、内包表記で使えるようにする。
  • リスト全体をメモリに作らず、値を必要になったときに1つずつ作る(遅延評価)。
  • データの保存や計算の仕方を隠す。

使わなくてよいとき

  • 簡単なリストや range ですでに足りる場合。
  • 位置を指定して要素を取り出したい(ランダムアクセスしたい)場合:イテレーターは前にしか進めません。

サンプルコード

コードを実行 →
main.py
class Countdown:
    # Iterator: traverse values without exposing representation details.
    def __init__(self, start): self.start = start

    def __iter__(self):
        # Yield values without exposing collection storage.
        current = self.start
        while current > 0:
            yield current
            current -= 1


for number in Countdown(3):
    print(number)
この例の実行ボタンを作成

実行結果

3
2
1

コードの解説

クラスCountdownは__iter__メソッドをジェネレーター(generator)として実装しています。yieldに達するたびにジェネレーターは値を1つ返し、ループが次の値を求めるまで一時停止します。そのため、for number in Countdown(3)のループは3、2、1の順に表示します。

値を変更し、PythonをインストールせずにCodeUtilityオンラインPythonコンパイラで実行できます。

発展問題

下のヒントにしたがってコードを書き換えてみましょう。自分で変えて結果を確かめると、コードを読むだけよりずっと深く理解できます。

  1. パターンの構造を保ったまま、サンプルの対象領域を置き換えてください。
  2. パターンをより単純な実装と比較し、トレードオフを説明してください。
  3. 別の実装を追加する前に、各参加要素のテストを書いてください。
Pythonコンパイラで実行 →

よくある間違い

__iter__ からリストを返す

__iter__ はリストではなくイテレーターを返す必要があります。

問題
def __iter__(self):
    return [3, 2, 1]  # TypeError
修正
def __iter__(self):
    return iter([3, 2, 1])

このレッスンを終えましたか?

学習済みにすると進み具合を記録できます。

チャレンジで練習する

このレッスンの内容を使って実際の問題を解きましょう。各チャレンジはブラウザで動き、すぐにテストされ、AI のレビューも受けられます。

すべてのチャレンジ