Added methods to quickly reply to a message with Markdown or HTML

JosXa · JosXa · commit 135f2c0722c7 · 2017-07-17T17:30:08.000+02:00
diff --git a/telegram/message.py b/telegram/message.py
@@ -23,6 +23,7 @@
 from telegram import (Audio, Contact, Document, Chat, Location, PhotoSize, Sticker, TelegramObject,
                       User, Video, Voice, Venue, MessageEntity, Game, Invoice, SuccessfulPayment,
                       VideoNote)
+from telegram import ParseMode
 from telegram.utils.deprecate import warn_deprecate_obj
 from telegram.utils.helpers import escape_html, escape_markdown, to_timestamp, from_timestamp
 
@@ -305,6 +306,40 @@ def reply_text(self, *args, **kwargs):
         self._quote(kwargs)
         return self.bot.send_message(self.chat_id, *args, **kwargs)
 
+    def reply_markdown(self, *args, **kwargs):
+        """
+        Shortcut for ``bot.sendMessage(update.message.chat_id, parse_mode=ParseMode.MARKDOWN, *args, **kwargs)``
+        Sends a message with markdown formatting.
+
+        Keyword Args:
+            quote (Optional[bool]): If set to ``True``, the message is sent as an actual reply to
+                this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter
+                will be ignored. Default: ``True`` in group chats and ``False`` in private chats.
+        """
+
+        kwargs['parse_mode'] = ParseMode.MARKDOWN
+
+        self._quote(kwargs)
+
+        return self.bot.sendMessage(self.chat_id, *args, **kwargs)
+
+    def reply_html(self, *args, **kwargs):
+        """
+        Shortcut for ``bot.sendMessage(update.message.chat_id, parse_mode=ParseMode.HTML, *args, **kwargs)``
+        Sends a message with HTML formatting.
+
+        Keyword Args:
+            quote (Optional[bool]): If set to ``True``, the message is sent as an actual reply to
+                this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter
+                will be ignored. Default: ``True`` in group chats and ``False`` in private chats.
+        """
+
+        kwargs['parse_mode'] = ParseMode.HTML
+
+        self._quote(kwargs)
+
+        return self.bot.sendMessage(self.chat_id, *args, **kwargs)
+
     def reply_photo(self, *args, **kwargs):
         """
         Shortcut for ``bot.send_photo(update.message.chat_id, *args, **kwargs)``
@@ -510,6 +545,48 @@ def edit_text(self, *args, **kwargs):
         return self.bot.edit_message_text(
             chat_id=self.chat_id, message_id=self.message_id, *args, **kwargs)
 
+    def edit_markdown(self, *args, **kwargs):
+        """
+        Shortcut for
+
+            >>> bot.editMessageText(chat_id=message.chat_id,
+            ...                     message_id=message.message_id,
+            ...                     parse_mode=ParseMode.MARKDOWN,
+            ...                     *args, **kwargs)
+
+        Note:
+            You can only edit messages that the bot sent itself,
+            therefore this method can only be used on the
+            return value of the ``bot.send_*`` family of methods.
+
+        """
+
+        kwargs['parse_mode'] = ParseMode.MARKDOWN
+
+        return self.bot.edit_message_text(
+            chat_id=self.chat_id, message_id=self.message_id, *args, **kwargs)
+
+    def edit_html(self, *args, **kwargs):
+        """
+        Shortcut for
+
+            >>> bot.editMessageText(chat_id=message.chat_id,
+            ...                     message_id=message.message_id,
+            ...                     parse_mode=ParseMode.HTML
+            ...                     *args, **kwargs)
+
+        Note:
+            You can only edit messages that the bot sent itself,
+            therefore this method can only be used on the
+            return value of the ``bot.send_*`` family of methods.
+
+        """
+
+        kwargs['parse_mode'] = ParseMode.HTML
+
+        return self.bot.edit_message_text(
+            chat_id=self.chat_id, message_id=self.message_id, *args, **kwargs)
+
     def edit_caption(self, *args, **kwargs):
         """
         Shortcut for
@@ -610,7 +687,7 @@ def parse_entities(self, types=None):
         return {
             entity: self.parse_entity(entity)
             for entity in self.entities if entity.type in types
-        }
+            }
 
     @property
     def text_html(self):
diff --git a/tests/test_message.py b/tests/test_message.py
@@ -147,6 +147,26 @@ def test_reply_text(self):
         self.assertTrue(self.is_json(message.to_json()))
         self.assertEqual(message.text, 'Testing class method')
 
+    @flaky(3, 1)
+    def test_reply_markdown(self):
+        """Test for Message.reply_text_markdown"""
+        message = self._bot.sendMessage(self._chat_id, '.')
+        text = 'Testing class method *with* _markdown_ `enabled`.'
+        message = message.reply_markdown(text)
+
+        self.assertTrue(self.is_json(message.to_json()))
+        self.assertEqual(message.text_markdown, text)
+
+    @flaky(3, 1)
+    def test_reply_html(self):
+        """Test for Message.reply_text_html"""
+        message = self._bot.sendMessage(self._chat_id, '.')
+        text = 'Testing class method <b>with</b> <i>html</i> <code>enabled</code>.'
+        message = message.reply_html(text)
+
+        self.assertTrue(self.is_json(message.to_json()))
+        self.assertEqual(message.text_html, text)
+
     @flaky(3, 1)
     def test_forward(self):
         """Test for Message.forward"""
@@ -165,6 +185,26 @@ def test_edit_text(self):
         self.assertTrue(self.is_json(message.to_json()))
         self.assertEqual(message.text, 'Testing class method')
 
+    @flaky(3, 1)
+    def test_edit_markdown(self):
+        """Test for Message.edit_text"""
+        message = self._bot.sendMessage(self._chat_id, '.')
+        text = 'Testing class method *with* _markdown_ `enabled`.'
+        message = message.edit_markdown(text)
+
+        self.assertTrue(self.is_json(message.to_json()))
+        self.assertEqual(message.text_markdown, text)
+
+    @flaky(3, 1)
+    def test_edit_html(self):
+        """Test for Message.edit_text"""
+        message = self._bot.sendMessage(self._chat_id, '.')
+        text = 'Testing class method <b>with</b> <i>html</i> <code>enabled</code>.'
+        message = message.edit_html(text)
+
+        self.assertTrue(self.is_json(message.to_json()))
+        self.assertEqual(message.text_html, text)
+
     @flaky(3, 1)
     def test_delete1(self):
         """Test for Message.delete"""
