have tqdm call a callback when certain progress has been made

[spott]

• I have marked all applicable categories:
  • exception-raising bug
  • visual output bug
  • documentation request (i.e. "X is missing from the documentation." If instead I want to ask "how to use X?" I understand [StackOverflow#tqdm] is more appropriate)
  • new feature request
• I have visited the [source website], and in particular
  read the [known issues]
• I have searched through the [issue tracker] for duplicates

I would like to be able to have TQDM perform some callback at regular (or calculated) intervals.

For example, I would like tqdm to be able to send a message to slack when I'm 25% done. Or have tqdm send messages to a log file with much less frequency than when it sends to the console or notebook.

I am aware that this can be done by extending tqdm, but I thought it would be something that people might want built-in.

[casperdcl]

@ThyrixYang fine but probably won't be merged before #815 and/or it gets enough community support

[casperdcl]

For future ref (manual tqdm.update()):

from tqdm import tqdm as base_tqdm
# or: from tqdm.auto import tqdm as base_tqdm

class tqdm(base_tqdm):
    def update(self, n=1):
        super(tqdm, self).update(n)
        some_callback(n)

The iter(tqdm) version would be much harder to patch.

[spott]

@casperdcl:

Maybe this should change to a documentation change, rather than a feature request... that is pretty simple.

Would this work with the 'auto' tqdm?

[casperdcl]

yes. would work with auto and any other subclass (updated to show this). I labelled it as question which is also used for doc update candidates. The thing is tqdm.update() is usually the callback - not the other way around - so I'm not sure how useful this is...

[LucaCappelletti94]

Any updates on this? I'd love to do an integration with Notipy me that sends you an email every like, 12 hours of progress.

[casperdcl]

https://github.com/tqdm/tqdm#custom-integration

[casperdcl]

duplicate of #518 - updated there...

[casperdcl]

srry not a duplicate

[casperdcl]

For future ref (manual tqdm.update()):

from tqdm import tqdm as base_tqdm
# or: from tqdm.auto import tqdm as base_tqdm

class tqdm(base_tqdm):
    def update(self, n=1):
        super(tqdm, self).update(n)
        some_callback(n)

The iter(tqdm) version would be much harder to patch.

I think maybe if update() is changed to return True iff a display was actually triggered, then this could be improved:

from tqdm.auto import tqdm as base_tqdm

class tqdm(base_tqdm):
    def update(self, n=1, always_callback=False):
        if super(tqdm, self).update(n) or always_callback:
            some_callback(**self.format_dict)