【Python】イテレータについて

この記事は[【Python】ジェネレータについて]()という記事の補足として書いたものです。
といっても自分もイテレータについて結構ふんわりとしか理解していなかったのでそれも含めて書いていこうと思います。

# 目次
* イテレータとは
* イテレータをクラスとして実装するとどうなるのか
* Pythonの内部ではどのように振舞っているのか

## 使用環境
* Python 3.8.8

# イテレータとは
> * イテレータ: 要素を反復して取り出すことのできるインタフェース

(引用：[Pythonのイテレータとジェネレータ](https://qiita.com/tomotaka_ito/items/35f3eb108f587022fa09))

> イテレータとは値に含まれている要素を順に1個ずつ取り出せるオブジェクトです。

(引用：[詳細! Python 3 入門ノート](https://www.amazon.co.jp/%E8%A9%B3%E7%B4%B0-Python-%E5%85%A5%E9%96%80%E3%83%8E%E3%83%BC%E3%83%88-%E5%A4%A7%E9%87%8D-%E7%BE%8E%E5%B9%B8/dp/4800711673/ref=sr_1_1?__mk_ja_JP=%E3%82%AB%E3%82%BF%E3%82%AB%E3%83%8A&crid=1R6T2HO3W8OLM&dchild=1&keywords=python3+%E5%85%A5%E9%96%))

ざっくりいうと、並んでるデータ（リストや、タプル）を順番に取り出すことができるモノ

リスト、文字列、タプル、辞書などはイテラブルといい、イテレータではまだありません。

```python
hoge = [1, 2, 3]
hoge_iterator = iter(hoge)

print(next(hoge_iterator))
print(next(hoge_iterator))
print(next(hoge_iterator))
```
このプログラムの実行結果は1 2 3と数字が連続で表示されます。
イテラブルはiter()関数でイテレータになります。そして、イテレータはnext()関数で順番に要素を取り出すことができます。

```python
hoge = [1, 2, 3]

for i in hoge:
    print(i)
```
実際にはこのようにfor文を使うことでiter()やnext（）を明示的に使わなくても実行することもできます。ちなみに、for文はイテラブルでもイテレータでも値を順に取り出すことができます。

# イテレータをクラスとして実装するとどうなるのか
では、イテレータが内部でどのような処理を行なっているのかを理解するためにクラスとして定義してみます。

```python
class MyIterator(object):
    def __init__(self, *numbers):
        self._numbers = numbers
        self._i = 0

    def __iter__(self):
        return self
    
    def __next__(self):
        if self._i == len(self._numbers):
            raise StopIteration()
        value = self._numbers[self._i]
        self._i += 1
        return value
```
（引用：[Pythonのイテレータとジェネレータ](https://qiita.com/tomotaka_ito/items/35f3eb108f587022fa09)）

こちらのプログラムは引用元の記事からお借りをしました。
特殊な文法があるのでいくつか解説しておきます（分かってる人は飛ばして大丈夫です）。

## *args

```python
def func(*args):
    print(args, type(args))
    for i in args:
        print(i)
        
func(1, 2, 3)
```
> 実行結果：
(1, 2, 3) \<class 'tuple'>
1
2
3

こちらのプログラムを見てもらうとわかる通り、関数の引数に『*（アスタリスク）』を先頭につけてあげることで、複数の引数を受け取ることができる。
受け取った引数はタプル形式で、\*を除いた変数名として扱われる。

## raise
```python
raise ValueError('ごめんね！')
print('hoge')
```
> 実行結果：
\---------------------------------------------------------------------------
ValueError                                Traceback (most recent call last)
<ipython-input-147-2f20025c3481> in <module>
----> 1 raise ValueError('ごめんね！')
      2 print('hoge')

>ValueError: ごめんね！

このプログラムでは、raiseの後にエラー名と、引数としてエラーメッセージを渡すことで、任意のエラーを任意の場所で起こすことができる。

エラーが起きるため、その時点でプログラムの処理は停止する。
そのため、その後のhogeは表示されない。

以上で特殊な文法の解説を終わります。
## クラスの解説
イテレータクラスの解説に移ります。

まず、\_\_init__メソッドにてクラスの初期化処理を行うわけですが、そこで_numbers、_iというプロパティを定義しています。_numbersは引数にもあるとおり、\*がついた可変長引数になってます。
そのため、_numbersは引数として渡された値のタプル（イテラブル）を保持していることになります。

続いて、\_\_iter__メソッドです。ここでは、自身のインスタンスのみを返しています。実際の処理とは違うでしょうが、今回はこれで大丈夫です。現時点でこの処理の必要性が理解できなくても問題ないです。後で説明します。

最後に、\_\_next__メソッドにてイテレータとして振る舞うための処理を書きます。まず、if文を通り過ぎると、valueにその回の要素を入れます。そして_iプロパティに１加算します。そして戻り値でvalueを返す。
これを繰り返すことによって、持っている要素を順番に送り出すことができます。
そしてif分のところですが、エラーを表示させています。そのエラーとは以下のプログラム例を見るとわかりますが過剰にイテレーションすると、StopIterationというエラーが出ます。それを再現するためにこのif分の処理が必要です。

```python
hoge = [1, 2, 3]
hoge_iterator = iter(hoge)

print(next(hoge_iterator))
print(next(hoge_iterator))
print(next(hoge_iterator))
print(next(hoge_iterator))
```
>　実行結果：
\---------------------------------------------------------------------------
StopIteration                             Traceback (most recent call last)
<ipython-input-150-3db0db43a483> in <module>
      5 print(next(hoge_iterator))
      6 print(next(hoge_iterator))
----> 7 print(next(hoge_iterator))

>StopIteration: 

## イテレータのクラスを利用してみる
```python
my_iter = MyIterator(1, 2, 3)

my_iter = iter(my_iter)

print(next(my_iter))
print(next(my_iter))
print(next(my_iter))
print(next(my_iter))
```
>　実行結果：
1
2
3
\---------------------------------------------------------------------------
StopIteration                             Traceback (most recent call last)
<ipython-input-151-5a92335bc09a> in <module>
      6 print(next(my_iter))
      7 print(next(my_iter))
----> 8 print(next(my_iter))

>\<ipython-input-1-6ddc4f6f0785> in \_\_next__(self)
      9     def \_\_next__(self):
     10         if self._i == len(self._numbers):
---> 11             raise StopIteration()
     12         value = self._numbers[self._i]
     13         self._i += 1

>StopIteration: 

ちゃんと、イテレーションをして、エラーも正しく実装できました。
これはfor文でも問題なく動作します。

```python
my_iter = MyIterator(1, 2, 3)

for i in my_iter:
    print(i)
```
なぜこのような結果になるのかというと、iter()関数というのは\_\_iter_\_メソッドを呼び出す関数で、next()関数は\_\_next__メソッドを呼び出す関数だからです。
今回は\_\_next\_\_に直接イテレータとしての処理を書いたので、イテラブルをイテレータとする\_\_iter\_\_で自分のインスタンスを返していたのです。

# Pythonの内部ではどのように振舞っているのか
最後に、Pythonの中で、オブジェクトたちがどのように振舞っているのかを確認してみましょう。

```python
hoge = [1, 2, 3]

print(iter(hoge), hoge.__iter__())
#どちらもイテレータオブジェクトが返される
```
>実行結果：
\<list_iterator object at 0x7f0ad9a0b700> \<list_iterator object at 0x7f0ad9a0bee0>

iter()関数と、\_\_iter\_\_メソッドどちらを実行してもイテレータオブジェクトができてるのがわかると思います。

```python
hoge = [1, 2, 3]
hoge_str = 'hoge'

print(iter(tuple(hoge)), iter(set(hoge)), iter(hoge_str))
#タプルとセットは違うイテレータオブジェクトを返される
```
> 実行結果：
\<tuple_iterator object at 0x7f0ae8624ac0> \<set_iterator object at 0x7f0ad9ad5dc0> \<str_iterator object at 0x7f0ae8624130>

このようにタプルやセット、文字列のイテレータオブジェクトは区別される（同じ種類のイテレータオブジェクトではない）。

```python
print(iter(MyIterator(hoge)))
```
> 実行結果：
\<\_\_main__.MyIterator object at 0x7f0ae86243a0>

定義したイテレータクラスはiterを使っても自身のインスタンスを返しているだけなので、インスタンスとして振る舞う。
実際にはイテレータとして振る舞うが、システム上はあくまでインスタンスという部分をおさえておいてほしい。

# まとめ
今回はPythonのイテレータについてまとめました。

* 要素を一つずつ取り出すためのオブジェクト
* for文を使って順番に取り出せる
* iter()関数と、next（）関数でイテラブルをイテレータにして、イテレーションできる

この辺りが重要だと思います。

この記事は[【Python】ジェネレータについて]()を書くために書いた記事になるので、ジェネレータの方をみてもらえると嬉しいです。

# 参考文献
* [詳細! Python 3 入門ノート](https://www.amazon.co.jp/%E8%A9%B3%E7%B4%B0-Python-%E5%85%A5%E9%96%80%E3%83%8E%E3%83%BC%E3%83%88-%E5%A4%A7%E9%87%8D-%E7%BE%8E%E5%B9%B8/dp/4800711673/ref=sr_1_1?__mk_ja_JP=%E3%82%AB%E3%82%BF%E3%82%AB%E3%83%8A&crid=1R6T2HO3W8OLM&dchild=1&keywords=python3+%E5%85%A5%E9%96%80%E3%83%8E%E3%83%BC%E3%83%88&qid=1623283169&sprefix=python3%2Caps%2C267&sr=8-1)
* [Pythonのイテレータとジェネレータ](https://qiita.com/tomotaka_ito/items/35f3eb108f587022fa09)
* [初学者のためのPython講座　オブジェクト指向編7　カプセル化](https://qiita.com/kotakahe/items/2e17231868d78b35639f)
* [Pythonで例外を発生させる：raise](https://uxmilk.jp/39845)
* [Pythonの可変長引数（*args, **kwargs）の使い方](https://note.nkmk.me/python-args-kwargs-usage/)