Telegram message interface made asynchronous

dff/messengers/telegram/abstract.py

@@ -5,6 +5,8 @@
 Telegram API.
 """
 
+from abc import abstractmethod, ABC
+from asyncio import Future
 from pathlib import Path
 from typing import Any, Callable, Optional
 
@@ -53,7 +55,7 @@
     telegram_available = False
 
 
-class _AbstractTelegramInterface(MessengerInterfaceWithAttachments):
+class _AbstractTelegramInterface(MessengerInterfaceWithAttachments, ABC):
     """
     Messenger interface mixin for Telegram API usage.
     """
@@ -656,5 +658,28 @@ async def on_callback(self, update: Update, _: Any) -> None:
             update, _, lambda s: Message(attachments=[CallbackQuery(query_string=s.callback_query.data)])
         )
 
+    @abstractmethod
+    async def updater_coroutine(self):
+        raise NotImplementedError
+
     async def connect(self, pipeline_runner: PipelineRunnerFunction, *args, **kwargs):
         self._pipeline_runner = pipeline_runner
+
+        try:
+            await self.application.initialize()
+            if self.application.post_init:
+                await self.application.post_init(self.application)
+            await self.updater_coroutine()
+            await self.application.start()
+            await Future()
+
+        finally:
+            if self.application.updater.running:
+                await self.application.updater.stop()
+            if self.application.running:
+                await self.application.stop()
+                if self.application.post_stop:
+                    await self.application.post_stop(self.application)
+            await self.application.shutdown()
+            if self.application.post_shutdown:
+                await self.application.post_shutdown(self.application)

dff/messengers/telegram/interface.py

@@ -5,17 +5,18 @@
 :py:class:`~._AbstractTelegramInterface`.
 """
 
+from asyncio import get_event_loop
 from pathlib import Path
 from typing import Any, Optional
-
-from dff.pipeline.types import PipelineRunnerFunction
-
 from .abstract import _AbstractTelegramInterface
 
 try:
     from telegram import Update
+    from telegram.error import TelegramError
+
 except ImportError:
     Update = Any
+    TelegramError = Any
 
 
 class LongpollingInterface(_AbstractTelegramInterface):
@@ -35,10 +36,15 @@ def __init__(
         self.interval = interval
         self.timeout = timeout
 
-    async def connect(self, pipeline_runner: PipelineRunnerFunction, *args, **kwargs):
-        await super().connect(pipeline_runner, *args, **kwargs)
-        self.application.run_polling(
-            poll_interval=self.interval, timeout=self.timeout, allowed_updates=Update.ALL_TYPES
+    def error_callback(self, exc: TelegramError) -> None:
+        get_event_loop().create_task(self.application.process_error(error=exc, update=None))
+
+    async def updater_coroutine(self):
+        await self.application.updater.start_polling(
+            poll_interval=self.interval,
+            timeout=self.timeout,
+            allowed_updates=Update.ALL_TYPES,
+            error_callback=self.error_callback,
         )
 
 
@@ -60,6 +66,9 @@ def __init__(
         self.listen = host
         self.port = port
 
-    async def connect(self, pipeline_runner: PipelineRunnerFunction, *args, **kwargs):
-        await super().connect(pipeline_runner, *args, **kwargs)
-        self.application.run_webhook(listen=self.listen, port=self.port, allowed_updates=Update.ALL_TYPES)
+    async def updater_coroutine(self):
+        await self.application.updater.start_webhook(
+            listen=self.listen,
+            port=self.port,
+            allowed_updates=Update.ALL_TYPES,
+        )

tests/messengers/telegram/test_happy_paths.json

@@ -510,15 +510,15 @@
                 "original_message": "gASV+g8AAAAAAACMEHRlbGVncmFtLl91cGRhdGWUjAZVcGRhdGWUk5QpgZR9lCiMD19lZmZlY3Rp\ndmVfY2hhdJSMDnRlbGVncmFtLl9jaGF0lIwEQ2hhdJSTlCmBlH2UKIwKZmlyc3RfbmFtZZSMBFRl\nc3SUjAJpZJRLKowIaXNfZm9ydW2UTowJbGFzdF9uYW1llIwEVXNlcpSMBXRpdGxllE6MBHR5cGWU\njBJ0ZWxlZ3JhbS5jb25zdGFudHOUjAhDaGF0VHlwZZSTlIwHcHJpdmF0ZZSFlFKUjAh1c2VybmFt\nZZSMCXRlc3RfdXNlcpSMB19mcm96ZW6UiIwJX2lkX2F0dHJzlEsqhZSMCmFwaV9rd2FyZ3OUfZR1\nYowSX2VmZmVjdGl2ZV9tZXNzYWdllE6MEV9lZmZlY3RpdmVfc2VuZGVylE6MD19lZmZlY3RpdmVf\ndXNlcpROjBNidXNpbmVzc19jb25uZWN0aW9ulE6MEGJ1c2luZXNzX21lc3NhZ2WUTowOY2FsbGJh\nY2tfcXVlcnmUjBd0ZWxlZ3JhbS5fY2FsbGJhY2txdWVyeZSMDUNhbGxiYWNrUXVlcnmUk5QpgZR9\nlCiMDWNoYXRfaW5zdGFuY2WUjAItMZSMBGRhdGGUjAlmb3JtYXR0ZWSUjAlmcm9tX3VzZXKUjA50\nZWxlZ3JhbS5fdXNlcpRoEJOUKYGUfZQojBhhZGRlZF90b19hdHRhY2htZW50X21lbnWUTowXY2Fu\nX2Nvbm5lY3RfdG9fYnVzaW5lc3OUTowPY2FuX2pvaW5fZ3JvdXBzlE6MG2Nhbl9yZWFkX2FsbF9n\ncm91cF9tZXNzYWdlc5ROaAtoDGgNSyqMBmlzX2JvdJSJjAppc19wcmVtaXVtlE6MDWxhbmd1YWdl\nX2NvZGWUjAJlbpRoD2gQjBdzdXBwb3J0c19pbmxpbmVfcXVlcmllc5ROaBloGmgbiGgcSyqFlGge\nfZR1YowPZ2FtZV9zaG9ydF9uYW1llE5oDYwBMZSMEWlubGluZV9tZXNzYWdlX2lklE6MB21lc3Nh\nZ2WUjBF0ZWxlZ3JhbS5fbWVzc2FnZZSMB01lc3NhZ2WUk5QpgZR9lCiMFV9lZmZlY3RpdmVfYXR0\nYWNobWVudJSMHHRlbGVncmFtLl91dGlscy5kZWZhdWx0dmFsdWWUjAxEZWZhdWx0VmFsdWWUk5Qp\ngZROfZSMBXZhbHVllE5zhpRijAlhbmltYXRpb26UTowFYXVkaW+UTowQYXV0aG9yX3NpZ25hdHVy\nZZROjAtib29zdF9hZGRlZJROjBZidXNpbmVzc19jb25uZWN0aW9uX2lklE6MB2NhcHRpb26UTowQ\nY2FwdGlvbl9lbnRpdGllc5QpjBRjaGFubmVsX2NoYXRfY3JlYXRlZJSJjBNjaGF0X2JhY2tncm91\nbmRfc2V0lE6MC2NoYXRfc2hhcmVklE6MEWNvbm5lY3RlZF93ZWJzaXRllE6MB2NvbnRhY3SUTowR\nZGVsZXRlX2NoYXRfcGhvdG+UiYwEZGljZZROjAhkb2N1bWVudJROjAllZGl0X2RhdGWUTowJZWZm\nZWN0X2lklE6MCGVudGl0aWVzlCmMDmV4dGVybmFsX3JlcGx5lE6MEmZvcnVtX3RvcGljX2Nsb3Nl\nZJROjBNmb3J1bV90b3BpY19jcmVhdGVklE6MEmZvcnVtX3RvcGljX2VkaXRlZJROjBRmb3J1bV90\nb3BpY19yZW9wZW5lZJROjA5mb3J3YXJkX29yaWdpbpROaC9oMSmBlH2UKGg0Tmg1Tmg2Tmg3TmgL\njANCb3SUaA1LEGg4iGg5Tmg6TmgPTmg8TmgZjAdkZmZfYm90lGgbiGgcSxCFlGgefZR1YowEZ2Ft\nZZROjBpnZW5lcmFsX2ZvcnVtX3RvcGljX2hpZGRlbpROjBxnZW5lcmFsX2ZvcnVtX3RvcGljX3Vu\naGlkZGVulE6MCGdpdmVhd2F5lE6MEmdpdmVhd2F5X2NvbXBsZXRlZJROjBBnaXZlYXdheV9jcmVh\ndGVklE6MEGdpdmVhd2F5X3dpbm5lcnOUTowSZ3JvdXBfY2hhdF9jcmVhdGVklImMEWhhc19tZWRp\nYV9zcG9pbGVylE6MFWhhc19wcm90ZWN0ZWRfY29udGVudJROjAdpbnZvaWNllE6MFGlzX2F1dG9t\nYXRpY19mb3J3YXJklE6MD2lzX2Zyb21fb2ZmbGluZZROjBBpc190b3BpY19tZXNzYWdllE6MEGxl\nZnRfY2hhdF9tZW1iZXKUTowUbGlua19wcmV2aWV3X29wdGlvbnOUTowIbG9jYXRpb26UjBh0ZWxl\nZ3JhbS5fZmlsZXMubG9jYXRpb26UjAhMb2NhdGlvbpSTlCmBlH2UKIwHaGVhZGluZ5ROjBNob3Jp\nem9udGFsX2FjY3VyYWN5lE6MCGxhdGl0dWRllEdATTc/UvwmV4wLbGl2ZV9wZXJpb2SUTowJbG9u\nZ2l0dWRllEdAO8r6Hj6vaIwWcHJveGltaXR5X2FsZXJ0X3JhZGl1c5ROaBuIaBxHQDvK+h4+r2hH\nQE03P1L8JleGlGgefZR1YowObWVkaWFfZ3JvdXBfaWSUTowhbWVzc2FnZV9hdXRvX2RlbGV0ZV90\naW1lcl9jaGFuZ2VklE6MEW1lc3NhZ2VfdGhyZWFkX2lklE6MFG1pZ3JhdGVfZnJvbV9jaGF0X2lk\nlE6MEm1pZ3JhdGVfdG9fY2hhdF9pZJROjBBuZXdfY2hhdF9tZW1iZXJzlCmMDm5ld19jaGF0X3Bo\nb3RvlCmMDm5ld19jaGF0X3RpdGxllE6MDXBhc3Nwb3J0X2RhdGGUTowFcGhvdG+UKYwOcGlubmVk\nX21lc3NhZ2WUTowEcG9sbJROjBlwcm94aW1pdHlfYWxlcnRfdHJpZ2dlcmVklE6MBXF1b3RllE6M\nDHJlcGx5X21hcmt1cJSMJXRlbGVncmFtLl9pbmxpbmUuaW5saW5la2V5Ym9hcmRtYXJrdXCUjBRJ\nbmxpbmVLZXlib2FyZE1hcmt1cJSTlCmBlH2UKIwPaW5saW5lX2tleWJvYXJklCiMJXRlbGVncmFt\nLl9pbmxpbmUuaW5saW5la2V5Ym9hcmRidXR0b26UjBRJbmxpbmVLZXlib2FyZEJ1dHRvbpSTlCmB\nlH2UKIwNY2FsbGJhY2tfZGF0YZRoLowNY2FsbGJhY2tfZ2FtZZROjAlsb2dpbl91cmyUTowDcGF5\nlE6ME3N3aXRjaF9pbmxpbmVfcXVlcnmUTowfc3dpdGNoX2lubGluZV9xdWVyeV9jaG9zZW5fY2hh\ndJROjCBzd2l0Y2hfaW5saW5lX3F1ZXJ5X2N1cnJlbnRfY2hhdJROjAR0ZXh0lIwUQ3V0ZSBmb3Jt\nYXR0ZWQgdGV4dCGUjAN1cmyUTowHd2ViX2FwcJROaBuIaBwoaK5OTmguTk5OTk50lGgefZR1YoWU\naKMpgZR9lChopowLYXR0YWNobWVudHOUaKdOaKhOaKlOaKpOaKtOaKxOaK2MFU11bHRpcGxlIGF0\ndGFjaG1lbnRzIZRor05osE5oG4hoHChot05OaLZOTk5OTnSUaB59lHVihZRooymBlH2UKGimjAZz\nZWNyZXSUaKdOaKhOaKlOaKpOaKtOaKxOaK2MDVNlY3JldCBpbWFnZSGUaK9OaLBOaBuIaBwoaL5O\nTmi9Tk5OTk50lGgefZR1YoWUaKMpgZR9lChopowJdGh1bWJuYWlslGinTmioTmipTmiqTmirTmis\nTmitjBhEb2N1bWVudCB3aXRoIHRodW1ibmFpbCGUaK9OaLBOaBuIaBwoaMVOTmjETk5OTk50lGge\nfZR1YoWUaKMpgZR9lChopowEaGFzaJRop05oqE5oqU5oqk5oq05orE5orYwcRmlyc3QgYXR0YWNo\nbWVudCBieXRlcyBoYXNoIZRor05osE5oG4hoHChozE5OaMtOTk5OTnSUaB59lHVihZRooymBlH2U\nKGimjAdyZXN0YXJ0lGinTmioTmipTmiqTmirTmisTmitjAhSZXN0YXJ0IZRor05osE5oG4hoHCho\n005OaNJOTk5OTnSUaB59lHViaKMpgZR9lChopowEcXVpdJRop05oqE5oqU5oqk5oq05orE5orYwF\nUXVpdCGUaK9OaLBOaBuIaBwoaNlOTmjYTk5OTk50lGgefZR1YoaUdJRoG4hoHGjdhZRoHn2UdWKM\nEHJlcGx5X3RvX21lc3NhZ2WUTowOcmVwbHlfdG9fc3RvcnmUTowSc2VuZGVyX2Jvb3N0X2NvdW50\nlE6ME3NlbmRlcl9idXNpbmVzc19ib3SUTowLc2VuZGVyX2NoYXSUTowYc2hvd19jYXB0aW9uX2Fi\nb3ZlX21lZGlhlE6MB3N0aWNrZXKUTowFc3RvcnmUTowSc3VjY2Vzc2Z1bF9wYXltZW50lE6MF3N1\ncGVyZ3JvdXBfY2hhdF9jcmVhdGVklIlorU6MDHVzZXJzX3NoYXJlZJROjAV2ZW51ZZROjAd2aWFf\nYm90lE6MBXZpZGVvlE6MEHZpZGVvX2NoYXRfZW5kZWSUTowfdmlkZW9fY2hhdF9wYXJ0aWNpcGFu\ndHNfaW52aXRlZJROjBR2aWRlb19jaGF0X3NjaGVkdWxlZJROjBJ2aWRlb19jaGF0X3N0YXJ0ZWSU\nTowKdmlkZW9fbm90ZZROjAV2b2ljZZROjAx3ZWJfYXBwX2RhdGGUTowUd3JpdGVfYWNjZXNzX2Fs\nbG93ZWSUTowEY2hhdJRoCYwEZGF0ZZSMCGRhdGV0aW1llIwIZGF0ZXRpbWWUk5RDCgfoBRUTCRQA\nAACUjARweXR6lIwEX1VUQ5STlClSlIaUUpSMCm1lc3NhZ2VfaWSUSwJoG4hoHEsCaAmGlGgefZR1\nYmgbiGgcaECFlGgefZR1YowMY2hhbm5lbF9wb3N0lE6MCmNoYXRfYm9vc3SUTowRY2hhdF9qb2lu\nX3JlcXVlc3SUTowLY2hhdF9tZW1iZXKUTowUY2hvc2VuX2lubGluZV9yZXN1bHSUTowZZGVsZXRl\nZF9idXNpbmVzc19tZXNzYWdlc5ROjBdlZGl0ZWRfYnVzaW5lc3NfbWVzc2FnZZROjBNlZGl0ZWRf\nY2hhbm5lbF9wb3N0lE6MDmVkaXRlZF9tZXNzYWdllE6MDGlubGluZV9xdWVyeZROaEJOjBBtZXNz\nYWdlX3JlYWN0aW9ulE6MFm1lc3NhZ2VfcmVhY3Rpb25fY291bnSUTowObXlfY2hhdF9tZW1iZXKU\nTmiXTowLcG9sbF9hbnN3ZXKUTowScHJlX2NoZWNrb3V0X3F1ZXJ5lE6MEnJlbW92ZWRfY2hhdF9i\nb29zdJROjA5zaGlwcGluZ19xdWVyeZROjAl1cGRhdGVfaWSUSwJoG4hoHEsChZRoHn2UdWIu\n"
             },
             "response_message": {
-                "text": "\nVisit [this link](https://core.telegram.org/bots/api#formatting-options)\nfor more information about formatting options in telegram\\.\n\nRun /start command again to restart\\.\n",
+                "text": "\nHere's your formatted text\\!\nYou can see **text in bold**, _text in italic_ and a \\`code snippet\\`\\.\n\\> Here's a [link](https://core.telegram.org/bots/api\\#formatting-options) in a quote\\.\n\\> Visit the link for more information about formatting options in telegram\\.\nRun /start command again to restart\\.\n",
                 "attachments": null,
                 "annotations": null,
                 "misc": null,
                 "original_message": null,
                 "parse_mode": "MarkdownV2"
             },
             "response_functions": [
-                "send_message(42, '\\nVisit [this link](https://core.telegram.org/bots/api#formatting-options)\\nfor more information about formatting options in telegram\\\\.\\n\\nRun /start command again to restart\\\\.\\n', parse_mode=<ParseMode.MARKDOWN_V2>, disable_notification=None, protect_content=None, reply_markup=None, message_effect_id=None, reply_to_message_id=None, disable_web_page_preview=None)"
+                "send_message(42, \"\\nHere's your formatted text\\\\!\\nYou can see **text in bold**, _text in italic_ and a \\\\`code snippet\\\\`\\\\.\\n\\\\> Here's a [link](https:\/\/core.telegram.org/bots/api\\\\#formatting-options) in a quote\\\\.\\n\\\\> Visit the link for more information about formatting options in telegram\\\\.\\nRun /start command again to restart\\\\.\\n\", parse_mode=<ParseMode.MARKDOWN_V2>, disable_notification=None, protect_content=None, reply_markup=None, message_effect_id=None, reply_to_message_id=None, disable_web_page_preview=None)"
             ]
         },
         {

tests/messengers/telegram/utils.py

@@ -2,8 +2,9 @@
 from contextlib import contextmanager
 from importlib import import_module
 from hashlib import sha256
-from typing import Any, Dict, Hashable, Iterator, List, Optional, Tuple, Union
+from typing import Any, Dict, Hashable, Iterator, List, Optional, Tuple
 
+from dff.pipeline.types import PipelineRunnerFunction
 from pydantic import BaseModel
 from telegram import InputFile, InputMedia, Update
 from typing_extensions import TypeAlias
@@ -15,7 +16,7 @@
 PathStep: TypeAlias = Tuple[Update, Message, Message, List[str]]
 
 
-def cast_dict_to_happy_step(dictionary: Dict, update_only: bool = False) -> Union[List["PathStep"]]:
+def cast_dict_to_happy_step(dictionary: Dict, update_only: bool = False) -> List["PathStep"]:
     imports = globals().copy()
     imports.update(import_module("telegram").__dict__)
     imports.update(import_module("telegram.ext").__dict__)
@@ -73,6 +74,7 @@ class MockApplication(BaseModel, arbitrary_types_allowed=True):
     @classmethod
     def create(cls, interface: _AbstractTelegramInterface, happy_path: List[PathStep]) -> "MockApplication":
         instance = cls(bot=MockBot(), happy_path=happy_path, interface=interface)
+        interface.connect = instance.pseudo_connect
         return instance
 
     @contextmanager
@@ -123,8 +125,6 @@ def _run_bot(self) -> None:
                     else:
                         raise RuntimeError(f"Update {update} type unknown!")
 
-    def run_polling(self, poll_interval: float, timeout: int, allowed_updates: List[str]) -> None:
-        return self._run_bot()
-
-    def run_webhook(self, listen: str, port: str, allowed_updates: List[str]) -> None:
+    async def pseudo_connect(self, pipeline_runner: PipelineRunnerFunction, *args, **kwargs) -> None:
+        self.interface._pipeline_runner = pipeline_runner
         return self._run_bot()

tutorials/messengers/telegram/2_attachments.py

@@ -127,7 +127,6 @@ class and [python-telegram-bot](https://docs.python-telegram-bot.org/)
 
 QUOTED_ATTACHMENTS = [f'"{attachment}"' for attachment in ATTACHMENTS]
 
-
 # %% [markdown]
 """
 The bot below sends different attachments on request.

tutorials/messengers/telegram/3_advanced.py

@@ -69,12 +69,13 @@ class for information about different arguments
 
 image_url = HttpUrl(f"{EXAMPLE_ATTACHMENT_SOURCE}/deeppavlov.png")
 
-formatted_text = """
-Visit [this link](https://core.telegram.org/bots/api#formatting-options)
-for more information about formatting options in telegram\.
-
+formatted_text = r"""
+Here's your formatted text\!
+You can see **text in bold**, _text in italic_ and a \`code snippet\`\.
+\> Here's a [link](https://core.telegram.org/bots/api\#formatting-options) in a quote\.
+\> Visit the link for more information about formatting options in telegram\.
 Run /start command again to restart\.
-"""  # noqa: W605
+"""  # noqa: E501
 
 location_data = {"latitude": 59.9386, "longitude": 30.3141}