""" Sends updates to a Telegram bot. Usage: >>> from tqdm.contrib.telegram import tqdm, trange >>> for i in trange(10, token='{token}', chat_id='{chat_id}'): ... ... ![screenshot](https://tqdm.github.io/img/screenshot-telegram.gif) """ from warnings import warn from requests import Session from ..auto import tqdm as tqdm_auto from ..std import TqdmWarning from ..utils import envwrap from .utils_worker import MonoWorker __author__ = {"github.com/": ["casperdcl"]} __all__ = ['TelegramIO', 'tqdm_telegram', 'ttgrange', 'tqdm', 'trange'] class TelegramIO(MonoWorker): """Non-blocking file-like IO using a Telegram Bot.""" API = 'https://api.telegram.org/bot' def __init__(self, token, chat_id): """Creates a new message in the given `chat_id`.""" super().__init__() self.token = token self.chat_id = chat_id self.session = Session() self.text = self.__class__.__name__ self.message_id # pylint: disable=pointless-statement @property def message_id(self): if hasattr(self, '_message_id'): return self._message_id # pylint: disable=access-member-before-definition try: req = self.session.post( f'{self.API}{self.token}/sendMessage', data={'text': f"`{self.text}`", 'chat_id': self.chat_id, 'parse_mode': 'MarkdownV2'}) res = req.json() req.raise_for_status() except Exception as e: if req.status_code == 429: warn("Creation rate limit: try increasing `mininterval`.", TqdmWarning, stacklevel=2) else: tqdm_auto.write(str(e)) else: self._message_id = res['result']['message_id'] return self._message_id def write(self, s): """Replaces internal `message_id`'s text with `s`.""" if not s: s = "..." s = s.replace('\r', '').strip() if s == self.text: return # avoid duplicate message Bot error message_id = self.message_id if message_id is None: return self.text = s try: future = self.submit( self.session.post, f'{self.API}{self.token}/editMessageText', data={'text': f"`{s}`", 'chat_id': self.chat_id, 'message_id': message_id, 'parse_mode': 'MarkdownV2'}) except Exception as e: tqdm_auto.write(str(e)) else: return future def delete(self): """Deletes internal `message_id`.""" try: future = self.submit( self.session.post, '{self.API}{self.token}/deleteMessage', data={'chat_id': self.chat_id, 'message_id': self.message_id}) except Exception as e: tqdm_auto.write(str(e)) else: return future class tqdm_telegram(tqdm_auto): # pylint: disable=inconsistent-mro """ Standard `tqdm.auto.tqdm` but also sends updates to a Telegram Bot. May take a few seconds to create (`__init__`). - create a bot - copy its `{token}` - add the bot to a chat and send it a message such as `/start` - go to to find out the `{chat_id}` - paste the `{token}` & `{chat_id}` below >>> from tqdm.contrib.telegram import tqdm, trange >>> for i in tqdm(iterable, token='{token}', chat_id='{chat_id}'): ... ... """ @envwrap("tqdm", "telegram", is_method=True) def __init__(self, *args, token=None, chat_id=None, **kwargs): """ Parameters ---------- token : str, required. Telegram token [default: ${TQDM_TELEGRAM_TOKEN}]. chat_id : str, required. Telegram chat ID [default: ${TQDM_TELEGRAM_CHAT_ID}]. See `tqdm.auto.tqdm.__init__` for other parameters. """ if not kwargs.get('disable'): kwargs = kwargs.copy() self.tgio = TelegramIO(token, chat_id) super().__init__(*args, **kwargs) def display(self, **kwargs): # pylint: disable=arguments-differ super().display(**kwargs) fmt = self.format_dict if fmt.get('bar_format', None): fmt['bar_format'] = fmt['bar_format'].replace( '', '{bar:10u}').replace('{bar}', '{bar:10u}') self.tgio.write(self.format_meter(**fmt)) def clear(self, *args, **kwargs): super().clear(*args, **kwargs) if not self.disable: self.tgio.write("") def close(self): if self.disable: return super().close() if not (self.leave or (self.leave is None and self.pos == 0)): self.tgio.delete() def ttgrange(*args, **kwargs): """Shortcut for `tqdm.contrib.telegram.tqdm(range(*args), **kwargs)`.""" return tqdm_telegram(range(*args), **kwargs) # Aliases tqdm = tqdm_telegram trange = ttgrange