Add basic support for sending inline keyboards

Author: pietroalbini

botogram/__init__.py

@@ -34,6 +34,7 @@
 from .runner import run
 from .objects import *
 from .utils import usernames_in
+from .callbacks import buttons
 
 
 # This code will simulate the Windows' multiprocessing behavior if the

botogram/callbacks.py

@@ -18,6 +18,65 @@
 #   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 
 
+class ButtonsRow:
+    """A row of an inline keyboard"""
+
+    def __init__(self):
+        self._content = []
+
+    def url(self, label, url):
+        """Open an URL when the button is pressed"""
+        self._content.append({"text": label, "url": url})
+
+    def callback(self, label, callback, data=None):
+        """Trigger a callback when the button is pressed"""
+        if data is not None:
+            msg = "%s\0%s" % (callback, data)
+        else:
+            msg = callback
+
+        self._content.append({"text": label, "callback_data": msg})
+
+    def switch_inline_query(self, label, query="", current_chat=False):
+        """Switch the user to this bot's inline query"""
+        if current_chat:
+            self._content.append({
+                "text": label,
+                "switch_inline_query_current_chat": query,
+            })
+        else:
+            self._content.append({
+                "text": label,
+                "switch_inline_query": query,
+            })
+
+
+class Buttons:
+    """Factory for inline keyboards"""
+
+    def __init__(self):
+        self._rows = {}
+
+    def __getitem__(self, index):
+        if index not in self._rows:
+            self._rows[index] = ButtonsRow()
+        return self._rows[index]
+
+    def _serialize_attachment(self):
+        rows = [
+            row._content for i, row in sorted(
+                tuple(self._rows.items()), key=lambda i: i[0]
+            )
+        ]
+
+        return {"inline_keyboard": rows}
+
+
+def buttons():
+    """Create a new inline keyboard"""
+    return Buttons()
+
+
 def parse_callback_data(data):
     """Parse the callback data generated by botogram and return it"""
     if "\0" in data:

botogram/hooks.py

@@ -220,7 +220,6 @@ def _call(self, bot, update):
         q = update.callback_query
 
         name, data = parse_callback_data(q._data)
-        print(name, self._name)
         if name != self._name:
             return
 

botogram/objects/mixins.py

@@ -23,6 +23,7 @@
 
 from .. import utils
 from .. import syntaxes
+from ..utils.deprecations import _deprecated_message
 
 
 _objects_module = None
@@ -51,7 +52,7 @@ def __(self, *args, **kwargs):
 class ChatMixin:
     """Add some methods for chats"""
 
-    def _get_call_args(self, reply_to, extra, notify=True):
+    def _get_call_args(self, reply_to, extra, attach, notify):
         """Get default API call arguments"""
         # Convert instance of Message to ids in reply_to
         if hasattr(reply_to, "message_id"):
@@ -61,17 +62,24 @@ def _get_call_args(self, reply_to, extra, notify=True):
         if reply_to is not None:
             args["reply_to_message_id"] = reply_to
         if extra is not None:
+            _deprecated_message(
+                "The extra parameter", "1.0", "use the attach parameter", -4
+            )
             args["reply_markup"] = json.dumps(extra.serialize())
+        if attach is not None:
+            if not hasattr(attach, "_serialize_attachment"):
+                raise ValueError("%s is not an attachment" % attach)
+            args["reply_markup"] = json.dumps(attach._serialize_attachment())
         if not notify:
             args["disable_notification"] = True
 
         return args
 
     @_require_api
     def send(self, message, preview=True, reply_to=None, syntax=None,
-             extra=None, notify=True):
+             extra=None, attach=None, notify=True):
         """Send a message"""
-        args = self._get_call_args(reply_to, extra, notify)
+        args = self._get_call_args(reply_to, extra, attach, notify)
         args["text"] = message
         args["disable_web_page_preview"] = not preview
 
@@ -83,9 +91,9 @@ def send(self, message, preview=True, reply_to=None, syntax=None,
 
     @_require_api
     def send_photo(self, path, caption=None, reply_to=None, extra=None,
-                   notify=True):
+                   attach=None, notify=True):
         """Send a photo"""
-        args = self._get_call_args(reply_to, extra, notify)
+        args = self._get_call_args(reply_to, extra, attach, notify)
         if caption is not None:
             args["caption"] = caption
 
@@ -96,9 +104,9 @@ def send_photo(self, path, caption=None, reply_to=None, extra=None,
 
     @_require_api
     def send_audio(self, path, duration=None, performer=None, title=None,
-                   reply_to=None, extra=None, notify=True):
+                   reply_to=None, extra=None, attach=None, notify=True):
         """Send an audio track"""
-        args = self._get_call_args(reply_to, extra, notify)
+        args = self._get_call_args(reply_to, extra, attach, notify)
         if duration is not None:
             args["duration"] = duration
         if performer is not None:
@@ -113,9 +121,9 @@ def send_audio(self, path, duration=None, performer=None, title=None,
 
     @_require_api
     def send_voice(self, path, duration=None, title=None, reply_to=None,
-                   extra=None, notify=True):
+                   extra=None, attach=None, notify=True):
         """Send a voice message"""
-        args = self._get_call_args(reply_to, extra, notify)
+        args = self._get_call_args(reply_to, extra, attach, notify)
         if duration is not None:
             args["duration"] = duration
 
@@ -126,9 +134,9 @@ def send_voice(self, path, duration=None, title=None, reply_to=None,
 
     @_require_api
     def send_video(self, path, duration=None, caption=None, reply_to=None,
-                   extra=None, notify=True):
+                   extra=None, attach=None, notify=True):
         """Send a video"""
-        args = self._get_call_args(reply_to, extra, notify)
+        args = self._get_call_args(reply_to, extra, attach, notify)
         if duration is not None:
             args["duration"] = duration
         if caption is not None:
@@ -140,9 +148,10 @@ def send_video(self, path, duration=None, caption=None, reply_to=None,
                               expect=_objects().Message)
 
     @_require_api
-    def send_file(self, path, reply_to=None, extra=None, notify=True):
+    def send_file(self, path, reply_to=None, extra=None, attach=None,
+                  notify=True):
         """Send a generic file"""
-        args = self._get_call_args(reply_to, extra, notify)
+        args = self._get_call_args(reply_to, extra, attach, notify)
 
         files = {"document": open(path, "rb")}
 
@@ -151,9 +160,9 @@ def send_file(self, path, reply_to=None, extra=None, notify=True):
 
     @_require_api
     def send_location(self, latitude, longitude, reply_to=None, extra=None,
-                      notify=True):
+                      attach=None, notify=True):
         """Send a geographic location"""
-        args = self._get_call_args(reply_to, extra, notify)
+        args = self._get_call_args(reply_to, extra, attach, notify)
         args["latitude"] = latitude
         args["longitude"] = longitude
 
@@ -162,9 +171,9 @@ def send_location(self, latitude, longitude, reply_to=None, extra=None,
 
     @_require_api
     def send_venue(self, latitude, longitude, title, address, foursquare=None,
-                   reply_to=None, extra=None, notify=True):
+                   reply_to=None, extra=None, attach=None, notify=True):
         """Send a venue"""
-        args = self._get_call_args(reply_to, extra, notify)
+        args = self._get_call_args(reply_to, extra, attach, notify)
         args["latitude"] = latitude
         args["longitude"] = longitude
         args["title"] = title
@@ -175,19 +184,20 @@ def send_venue(self, latitude, longitude, title, address, foursquare=None,
         self._api.call("sendVenue", args, expect=_objects().Message)
 
     @_require_api
-    def send_sticker(self, sticker, reply_to=None, extra=None, notify=True):
+    def send_sticker(self, sticker, reply_to=None, extra=None, attach=None,
+                     notify=True):
         """Send a sticker"""
-        args = self._get_call_args(reply_to, extra, notify)
+        args = self._get_call_args(reply_to, extra, attach, notify)
 
         files = {"sticker": open(sticker, "rb")}
         return self._api.call("sendSticker", args, files,
                               expect=_objects().Message)
 
     @_require_api
     def send_contact(self, phone, first_name, last_name=None, *, reply_to=None,
-                     extra=None, notify=True):
+                     extra=None, attach=None, notify=True):
         """Send a contact"""
-        args = self._get_call_args(reply_to, extra, notify)
+        args = self._get_call_args(reply_to, extra, attach, notify)
         args["phone_number"] = phone
         args["first_name"] = first_name
 
@@ -228,7 +238,7 @@ def forward_to(self, to, notify=True):
                               expect=_objects().Message)
 
     @_require_api
-    def edit(self, text, syntax=None, preview=True, extra=None):
+    def edit(self, text, syntax=None, preview=True, extra=None, attach=None):
         """Edit this message"""
         args = {"message_id": self.message_id, "chat_id": self.chat.id}
         args["text"] = text
@@ -239,24 +249,47 @@ def edit(self, text, syntax=None, preview=True, extra=None):
 
         if not preview:
             args["disable_web_page_preview"] = True
+
         if extra is not None:
-            args["reply_markup"] = extra.serialize()
+            _deprecated_message(
+                "The extra parameter", "1.0", "use the attach parameter", -3
+            )
+            args["reply_markup"] = json.dumps(extra.serialize())
+        if attach is not None:
+            if not hasattr(attach, "_serialize_attachment"):
+                raise ValueError("%s is not an attachment" % attach)
+            args["reply_markup"] = json.dumps(attach._serialize_attachment())
 
         self._api.call("editMessageText", args)
         self.text = text
 
     @_require_api
-    def edit_caption(self, caption, extra=None):
+    def edit_caption(self, caption, extra=None, attach=None):
         """Edit this message's caption"""
         args = {"message_id": self.message_id, "chat_id": self.chat.id}
         args["caption"] = caption
 
         if extra is not None:
-            args["reply_markup"] = extra.serialize()
+            _deprecated_message(
+                "The extra parameter", "1.0", "use the attach parameter", -3
+            )
+            args["reply_markup"] = json.dumps(extra.serialize())
+        if attach is not None:
+            if not hasattr(attach, "_serialize_attachment"):
+                raise ValueError("%s is not an attachment" % attach)
+            args["reply_markup"] = json.dumps(attach._serialize_attachment())
 
         self._api.call("editMessageCaption", args)
         self.caption = caption
 
+    @_require_api
+    def edit_attachs(self, attach):
+        """Edit this message's attachments"""
+        args = {"message_id": self.message_id, "chat_id": self.chat.id}
+        args["reply_markup"] = attach
+
+        self._api.call("editMessageReplyMarkup", args)
+
     @_require_api
     def reply(self, *args, **kwargs):
         """Reply to the current message"""

tests/test_callbacks.py

@@ -18,7 +18,34 @@
 #   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 #   DEALINGS IN THE SOFTWARE.
 
-from botogram.callbacks import parse_callback_data
+import json
+
+from botogram.callbacks import Buttons, parse_callback_data
+
+
+def test_buttons():
+    buttons = Buttons()
+    buttons[0].url("test 1", "http://example.com")
+    buttons[0].callback("test 2", "test_callback")
+    buttons[3].callback("test 3", "another_callback", "data")
+    buttons[2].switch_inline_query("test 4")
+    buttons[2].switch_inline_query("test 5", "wow", current_chat=True)
+
+    assert buttons._serialize_attachment() == {
+        "inline_keyboard": [
+            [
+                {"text": "test 1", "url": "http://example.com"},
+                {"text": "test 2", "callback_data": "test_callback"},
+            ],
+            [
+                {"text": "test 4", "switch_inline_query": ""},
+                {"text": "test 5", "switch_inline_query_current_chat": "wow"},
+            ],
+            [
+                {"text": "test 3", "callback_data": "another_callback\0data"},
+            ],
+        ],
+    }
 
 
 def test_parse_callback_data():