イテラブルやイテレータとは

Pythonでfor文について調べていくと必ずでてくるのがイテレータ。
なんだかわかったようでわからない謎な解説ばかりです。
そんなわけでピストルで解説します（もっと謎）。

![pistol.jpg](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/411052/07cebb10-48d2-73b4-0900-cbad12d61b22.jpeg)

弾を詰めて、引き金を引くと一発ずつ発射し、すべてのたまを撃ち終わると終了という普通のピストルです。５発の弾が入るピストルなら５発打つまでは繰り返し、撃つことができます。

イテレーションとは繰り返すという意味です。辞書をひくと繰り返しとでてきます。
で、イテレーションとイテレータは微妙に違います。実はイテラブルという言葉もあって混乱しがちなのですが、まずは登場人物をあげてみます。

##### ➀イテレーション
##### ➁イテラブル
##### ➂イテレータ

## ➀ イテレーション
一番攻略しやすいのはイテレーションです。
イテレーションとは先程述べたように「繰り返し」という意味になります。
たとえば　

```py
for i in range(5):
    処理
```

と書けば処理を5回繰り返しますが、この繰返しのことをイテレーションといいます。

## ➁イテラブル
次に攻略しやすいのはイテラブルです、繰り返しの元を提供するものということで
ピストルの例えでいうと、リボルバーや弾倉とでも言ったらいいでしょうか

たとえば

```py
a = [1, 2, 3, 4, 5]
for i in a:
    処理

```
と書いたときの
##### 配列a
がイテラブルです。


## ➂ イテレータ
最後に真打ちのイテレータですが、こいつは装填済み発射寸前の銃本体みたいなイメージです。引き金が引かれるのを待つばかりといった感じです。（この文、コメントの指摘を受けて修正しました）

Pythonではイテラブルをiter()関数に突っ込んだ結果のオブジェクトがイテレータです。イテラブルが配列aなら　iter(a)がイテレータになります。
たとえば

```py
it = iter(a)
```

　とかくと　itがイテレータになります。

引き金に相当するのがnext()関数で、
it.next()とすると弾丸が発射されるイメージです。

配列aの中の要素が１発ずつ発射されていきます。

実際にやってみましょう
Jupyter notebookで

```py
a = [1,2,3,4,5]
```
と入力します。ここでクイズですが、aはなんだったでしょうか
答えはイテラブルですね。
その次のセルに

```py
it = iter(a)
```

と入力します。ここでまたクイズです。itはなんだったでしょうか

答えはイテレータですね。

ここで　print(next(it))　とすると
1　と表示
弾が１発、発射され、銃本体には４発残っています。

続けてprint(next(it))とすると
2　と表示
２発目の弾が発射され、銃本体には３発残っています。

続けてprint(next(it))とすると
3　と表示
３発目の弾が発射され、銃本体には２発残っています。

続けてprint(next(it))とすると
4　と表示
４発目の弾が発射され、銃本体には１発残っています。

続けてprint(next(it))とすると
5　と表示
５発目の弾が発射され、ここで弾切れになります。

続けてprint(next(it))とすると
StopIteration エラーになります

もう一度整理してみます。
##### イテレーション： 繰り返しのこと、ピストルのたとえだと、繰り返し撃てること
##### イテラブル ：リストa、ピストルのたとえだと、弾倉
##### イテレータ ：iter(a)、ピストルのたとえだと、銃本体

という関係になっています。以下は証拠のキャプチャ画像です。

##![キャプチャ.jpg](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/411052/335605fe-11af-3059-3012-a1b6f8f89c0a.jpeg)


# まとめ
## イテレータはなんのためにあるのか
	→  順番に1つずつ処理するため

## どうやってつくるのか
	→  iter()関数

## なにをつくるのか
	→  オブジェクト（イテレータオブジェクト）

## 最後になってエラーがでたとき
    → try exceptで処理

サンプル
```py
a=iter([1,2,3])  #aはイテレータオブジェクト

b1=next(a)    #１つずつ処理
print(b1)

b2=next(a)
print(b2)

b3=next(a)
print(b3)

try:
    b4=next(a)
    print(b4)
except StopIteration:  #ここで例外処理
    print("end")    
```
# 後日談　2024/01/26追加

その後、ふとある疑問が....

##### iter()は関数である。関数であるからには状態を持てないはず
##### 状態を持てないとイテラブルから値を１つずつ取り出すなんてできないはず
##### 状態が持てないと、どこまで取り出したか忘れちゃうので
##### あれれ、いったいどうなっているのか？？？


クラスかクロージャを使っているんだろうと予想ができたのでchatGPTに聞いてみました
```
    iter()はクラスですか、答えno
    iter()はクロージャを使っているのか　Ｎｏ
```
うーむ謎は深まるばかり。。。。。

# この謎がわかったのは
イテラブル自体がオブジェクトだということ思い出したときです。たとえばar=[1,2,3]とすると、こいつはオブジェクトなのでメソッドをもてます。もちろん状態も持てる！！　と書こうとおもってchatGPTに聞いたらそれも間違いだと言われました。

# 正解は

たとえば、for文が実施される前にイテレータオブジェクトというものが新たに作られます。イテレータオブジェクトは現在位置などの情報（プロパティ）を持ったクラスです。つまりイテラブルとは別のオブジェクト。イテレータオブジェクトがあるおかげで、たとえば、next(ar)を実行するたび、内部のプロパティが変化して、ひとつずつ値が取り出せるというわけなのでした。

# まとめ
```py
iter(ar)はar.__iter__()を呼ぶ関数,イテレータオブジェクトを作り出す
next(ar)はar.__next__()を呼ぶ関数,位置をずらす(1つ進める)
```
といったことをやっています。
浅い理解で書いてしまったので、あわてて記事の前半を読み返したのですが、とりあえず間違ったことは書いてなさそうなので一安心しました。が、なにかまちがっていたらつっこみのほう優しくお願いします。


# さらなる後日談　2024/05/08追加
「いいね」をいただいたのでうれしくなって読み返してみたところ、上の文章は自分でもわかりにくいと思ったので、chatGPT先生の力をかりて補足します。

## arがもとの配列オブジェクトとして、もう一つ別のオブジェクトが作られるというのは具体的にどういうことですか

ChatGPT
arが配列やリストなどのイテラブルオブジェクトとして存在する場合、iter(ar)を実行すると、元のarからは独立した新しいイテレータオブジェクトが生成されます。このイテレータオブジェクトは、arの要素を一つずつ順番にアクセスするための機能（__next__()メソッド）を持っています。

具体的な流れは以下のようになります：

①イテラブルオブジェクト：arとして、例えばリスト[1, 2, 3]があります。
②イテレータの生成：iter(ar)を呼び出すと、Pythonはarの__iter__()メソッドを自動的に呼び出し、新しいイテレータオブジェクトを生成します。このオブジェクトは、arの内容を指し示しながらも、独自の内部状態（現在位置など）を持ちます。
 ③要素のアクセス：生成されたイテレータに対してnext()を呼び出すと、イテレータは内部のカウンタ（現在位置）を更新しながら次の要素を返します。この過程でar本体は変更されず、イテレータだけが「進む」ことになります。

このように、イテレータは元のイテラブルオブジェクトarからは独立しており、ar自体の状態や内容には影響を与えません。イテレータは単にarの各要素へのアクセスを管理するための手段として機能します。


## もとのarオブジェクトにもカウンタはあるのですか

ChatGPT
もとのarオブジェクト（例えばリストや配列）自体にはカウンタのようなものは存在しません。arは単純にその要素を格納しているコンテナであり、イテラブル（iterable）であるため、その要素を順番にアクセスできる能力を持っていますが、そのアクセスの進行状況を追跡するカウンタは持っていません。

カウンタや現在位置の追跡は、arから生成されるイテレータオブジェクトが行います。イテレータオブジェクトはiter(ar)によって生成され、このイテレータが独自の内部状態（現在の位置など）を持ち、next()関数によって次々と要素を取り出します。

つまり、arに対してiter()を複数回呼び出すと、それぞれ独立した状態を持つイテレータオブジェクトが生成され、それぞれが個別に要素のアクセスを管理します。それに対して、ar自体はただのデータの集合であり、イテレーションの状態を保持しません。


## もとのarオブジェクトに存在するプロパティはなにがありますか

ChatGPT
arオブジェクトが何であるかによって持っているプロパティは異なりますが、もしarがPythonの一般的なリストである場合、以下のようなメソッド（特にリスト固有の操作を行うもの）とプロパティを持っています。

#### メソッド:
    append(x): リストの末尾に要素xを一つ追加します。
    extend(iterable): イテラブルから取得した全ての要素をリストに追加します。
    insert(i, x): 指定された位置iに要素xを挿入します。
    remove(x): リストから最初に見つかった要素xを削除します。
    pop([i]): リストの指定された位置iにある要素をリストから削除し、その要素を返します。iが指定されていない場合は、リストの最後の要素を削除して返します。
    clear(): リストから全ての要素を削除します。
    index(x[, start[, end]]): 要素xが見つかる最初の位置を返します。startとendを指定することで、検索範囲を制限できます。
    count(x): リストで要素xが出現する回数を返します。
    sort(key=None, reverse=False): リストの要素をその場で並び替えます。
    reverse(): リストの要素の順番をその場で逆転させます。
    copy(): リストの浅いコピーを返します。

#### プロパティ:
リストそのものに特有のプロパティ（属性としてアクセスできる情報）は存在しませんが、リストの長さなどはlen(ar)関数を使用して得ることができます。

これらのメソッドを通じてリストの操作が行われ、リストの内容や構造を変更することが可能です。リストはその他のプロパティを持たない単純な配列ですが、これらのメソッドによって非常に柔軟なデータ構造として機能します。


### iter(ar)は関数ではなくてクラスのオブジェクト生成（他の言語でいうとnew）ですね

ChatGPT
はい、その通りです。Pythonにおいてiter(ar)は、arオブジェクトに対して__iter__()メソッドを呼び出すことによって、イテレータオブジェクトを生成します。これは他の多くのプログラミング言語でのオブジェクト生成（例えばJavaやC++のnewキーワードの使用）に類似していますが、直接的なnewキーワードの使用はありません。

Pythonでは、iter(ar)の呼び出しは、ar.__iter__()を実行し、arが持つイテレータを返します。これにより、arの各要素に順にアクセスするためのイテレータオブジェクトが生成されます。イテレータオブジェクトは__next__()メソッドを持ち、このメソッドを通じてコレクションの要素が次々と返されます。

したがって、iter()はPythonの内部でクラスのインスタンス化を行い、新しいイテレータオブジェクトを生成するプロセスを抽象化しています。これは他の言語で見られるオブジェクトの生成と似ていますが、Pythonの文法としてはメソッドの呼び出しの形を取っています。



# この解答にはちょっと驚いたのでさらに質問!

### iter(ar)は形の上でインスタンス生成ではないということなのですか

ChatGPT
はい、Pythonでのiter(ar)の使用は形式上、明示的なインスタンス生成の文法（例えばJavaのnewキーワード）を使用していませんが、実質的には新しいイテレータオブジェクトのインスタンスを生成しています。

Pythonでは、オブジェクトの生成やインスタンス化は通常、クラス名の後に括弧を置いて行われます（例: obj = MyClass()）。しかし、iter(ar)のような組み込み関数の使用では、直接的にnewのようなキーワードは使用されませんが、内部的にはar.__iter__()メソッドが呼ばれ、これが新しいイテレータオブジェクトを返します。

このプロセスは、他のオブジェクト指向言語におけるインスタンス生成に似ていますが、Pythonではより暗黙的に行われます。iter()関数は__iter__()メソッドの存在を前提としており、このメソッドが適切なイテレータオブジェクトを返すことを期待しています。これは、クラスのメソッドを通じて新しいインスタンスを生成する、という形で実現されています。

したがって、形の上ではメソッドの呼び出しに見えますが、実際には新しいオブジェクトの生成が行われています。この点が、形式と実質的な操作の違いを示しています。

### なぜ？

ChatGPT
Pythonでiter(ar)が直接的なインスタンス生成の文法を使用せずに、メソッド呼び出しの形式を取る理由は、Pythonの設計哲学とその言語の柔軟性に基づいています。具体的には、以下の理由が挙げられます：

##### 抽象化と統一性: 
Pythonは抽象化のレベルを高めることで、言語の使用をシンプルに保つことを目指しています。iter()やlen()のような組み込み関数は、異なる型に対して一貫したインターフェースを提供します。このように、ユーザーは様々なオブジェクトタイプで共通の操作を同じ方法で行うことができます。

##### プロトコルに基づくデザイン: 
Pythonでは、「プロトコル」という概念が重要です。たとえば、イテラブルプロトコルは任意のオブジェクトが__iter__()メソッドを提供することで満たされます。これにより、オブジェクトがイテレーションをサポートしているかどうかが決定されます。このメソッドはオブジェクト自身がどのようにしてイテレータを提供するかを定義し、この柔軟性がPythonの強力な特徴の一つです。

##### 動的な型付けと遅延評価: 
Pythonは動的型付け言語であり、オブジェクトの型は実行時に解決されます。iter()のような関数がメソッドを呼び出す形式を取ることで、異なる型が実行時に同じインターフェースを提供することが可能になります。これにより、コードの再利用性と拡張性が向上します。

##### ユーザー定義型との一貫性: 
ユーザーが独自のクラスを定義する際にも、__iter__()や__next__()のような特殊メソッドを実装することで、Pythonの組み込み型と同様にイテレータを提供できます。これにより、組み込み型とユーザー定義型の間で一貫性が保たれ、Pythonの全体的なデザインが統一されます。

このような設計により、Pythonは非常に柔軟で拡張可能な言語となっており、様々な状況に適応することができます。それぞれのオブジェクトがどのようにイテレータを提供するかを自身で定義できるため、多様な用途に対応可能です。


　この回答にたいしてはまたまた疑問が湧いてきたのですが、イテレータとは関係なくなってきたのと、正直疲れてきたのでいったんここで終了します。