tqdmのように各ループの終了を検知する

Question

実現したいこと

Pythonのtqdmのようなプログレスバーを作りたい。

from tqdm import tqdm
import time

for i in tqdm(range(10)):
  time.sleep(1)

なぜ、for文にこのようにtqdmを組み込むだけで、プログレスバーを表示させることができるのか知りたいです。i=0, i=1がそれぞれ終了したことをtqdmはどのように知っているのですか？

試したこと

下記のプログラムを実行すると、tqdm2関数は一度しか呼ばれていません。そのため、i=0, i=1がそれぞれ終了したことをtqdm2関数が知ることはできません。

def tqdm2(list_):
  print('----')
  return list_
for i in tqdm2(range(4)):
   print(i)

どうすれば、tqdmみたいにinの後に入れるだけで各ループが終了したことを検知することができますか？

Answer 1

イテレータ用のクラスで実装できそうですね

[Python] イテレータを実装する

https://qiita.com/tchnkmr/items/e740173d7400f8672d75

class SampleIterator(object):
    def __init__(self, num):
        self.num = num
        self.current = 0

    def __iter__(self):
        return self

    def __next__(self):
        if self.current == self.num:
            raise StopIteration()

        ret = self.current
        self.current += 1
        return ret

si = SampleIterator(3)

for i in si:
  print(i)

Answer 2

tqdmのソースコードは検索すればすぐ出てきますので、内容を確認してみてはいかがでしょうか。

https://github.com/tqdm/tqdm

Comments

[rell2]

ごめんなさい。tqdmのソースコードは見たのですが理解できませんでした。

[TakaiY]

ということは、残念ながら仕組みを理解するまでにはもう少し研鑽を積まなければならないということだと思いますよ。

ヒントをだすとしたら、tqdm()は tqdm/std.py の247行目で定義されている クラス tqdm であって、for x in tqdm(xxx)で呼ばれたときはアイテムを __iter__()メソッドで取り出すので、1174行目からの __iter__メソッドの内容を追い掛けてみると少しはやっていることがわかるかもしれません。

[rell2]

丁寧な解説ありがとうございます。