Add support for sending videos

Added and documented the following methods:

* botogram.Bot.send_video
* botogram.User.send_video
* botogram.Chat.send_video
* botogram.Message.reply_with_video

Author: Pietro Albini

botogram/frozenbot.py

@@ -154,6 +154,12 @@ def send_voice(self, chat, path, duration=None, reply_to=None, extra=None):
         obj = objects.Chat({"id": chat, "type": ""}, self.api)
         obj.send_voice(path, duration, reply_to, extra)
 
+    def send_video(self, chat, path, duration=None, caption=None,
+                   reply_to=None, extra=None):
+        """Send a video in a chat"""
+        obj = objects.Chat({"id": chat, "type": ""}, self.api)
+        obj.send_video(path, duration, caption, reply_to, extra)
+
     def send_file(self, chat, path, reply_to=None, extra=None):
         """Send a generic file in a chat"""
         obj = objects.Chat({"id": chat, "type": ""}, self.api)

botogram/objects/mixins.py

@@ -94,6 +94,19 @@ def send_voice(self, path, duration=None, title=None, reply_to=None,
         files = {"voice": open(path, "rb")}
         self._api.call("sendVoice", args, files)
 
+    @_require_api
+    def send_video(self, path, duration=None, caption=None, reply_to=None,
+                   extra=None):
+        """Send a video"""
+        args = self._get_call_args(reply_to, extra)
+        if duration is not None:
+            args["duration"] = duration
+        if caption is not None:
+            args["caption"] = caption
+
+        files = {"video": open(path, "rb")}
+        self._api.call("sendVideo", args, files)
+
     @_require_api
     def send_file(self, path, reply_to=None, extra=None):
         """Send a generic file"""
@@ -149,6 +162,11 @@ def reply_with_voice(self, path, duration=None, extra=None):
         """Reply with a voice message to the current message"""
         self.chat.send_voice(path, duration, self.message_id, extra)
 
+    @_require_api
+    def reply_with_video(self, path, duration=None, caption=None, extra=None):
+        """Reply with a video to the current message"""
+        self.chat.send_video(path, duration, caption, self.message_id, extra)
+
     @_require_api
     def reply_with_file(self, path, extra=None):
         """Reply with a generic file to the current chat"""

docs/api/bot.rst

@@ -378,6 +378,31 @@ components.
       :param int reply_to: The ID of the :py:class:`~botogram.Message` this one is replying to
       :param object extra: An extra reply interface object to attach
 
+   .. py:method:: send_video(chat, path, [duration=None, caption=None, reply_to=None, extra=None])
+
+      This method sends a video to a specific chat. The chat must be identified
+      by its ID, and Telegram applies some restrictions on the chats allowed to
+      receive your photo: only users who sent you a message in the past are
+      allowed, and also the group chats your bot is currently in.
+
+      You must provide the *path* to the video, and you may optionally specify
+      the *duration* and the *caption* of the video. If the video you're
+      sending is in reply to another message, set *reply_to* to the ID of the
+      other :py:class:`~botogram.Message`.  *extra* is an optional object which
+      specifies additional reply interface options on the recipient's end, and
+      can be one of the following types:
+
+      * :py:class:`botogram.ReplyKeyboardMarkup`
+      * :py:class:`botogram.ReplyKeyboardHide`
+      * :py:class:`botogram.ForceReply`
+
+      :param int chat: The ID of the chat which should receive the video
+      :param str path: The path to the video
+      :param int duration: The video duration, in seconds
+      :param str caption The caption of the video
+      :param int reply_to: The ID of the :py:class:`~botogram.Message` this one is replying to
+      :param object extra: An extra reply interface object to attach
+
    .. py:method:: send_file(chat, path, [reply_to=None, extra=None])
 
       This method sends a generic file to a specific chat. The chat must be

docs/api/telegram.rst

@@ -139,6 +139,25 @@ Available Classes
       :param int reply_to: The ID of the :py:class:`~botogram.Message` this one is replying to
       :param object extra: An extra reply interface object to attach
 
+   .. py:method:: send_video(path, [duration=None, caption=None, reply_to=None, extra=None])
+
+      Send the video found in the *path* to the user. You may optionally
+      specify the *duration* and the *caption* of the video. If the audio track
+      you're sending is in reply to another message, set *reply_to* to the ID
+      of the other :py:class:`~botogram.Message`.  *extra* is an optional
+      object which specifies additional reply interface options on the
+      recipient's end, and can be one of the following types:
+
+      * :py:class:`botogram.ReplyKeyboardMarkup`
+      * :py:class:`botogram.ReplyKeyboardHide`
+      * :py:class:`botogram.ForceReply`
+
+      :param str path: The path to the video
+      :param int duration: The video duration, in seconds
+      :param str caption: The caption of the video
+      :param int reply_to: The ID of the :py:class:`~botogram.Message` this one is replying to
+      :param object extra: An extra reply interface object to attach
+
    .. py:method:: send_file(path, [reply_to=None, extra=None])
 
       Send the generic file found in the *path* to the user. If the file you're
@@ -289,6 +308,25 @@ Available Classes
       :param int reply_to: The ID of the :py:class:`~botogram.Message` this one is replying to
       :param object extra: An extra reply interface object to attach
 
+   .. py:method:: send_video(path, [duration=None, caption=None, reply_to=None, extra=None])
+
+      Send the video found in the *path* to the chat. You may optionally
+      specify the *duration* and the *caption* of the video. If the audio track
+      you're sending is in reply to another message, set *reply_to* to the ID
+      of the other :py:class:`~botogram.Message`.  *extra* is an optional
+      object which specifies additional reply interface options on the
+      recipient's end, and can be one of the following types:
+
+      * :py:class:`botogram.ReplyKeyboardMarkup`
+      * :py:class:`botogram.ReplyKeyboardHide`
+      * :py:class:`botogram.ForceReply`
+
+      :param str path: The path to the video
+      :param int duration: The video duration, in seconds
+      :param str caption: The caption of the video
+      :param int reply_to: The ID of the :py:class:`~botogram.Message` this one is replying to
+      :param object extra: An extra reply interface object to attach
+
    .. py:method:: send_file(path, [reply_to=None, extra=None])
 
       Send the generic file found in the *path* to the chat. If the file you're
@@ -582,6 +620,22 @@ Available Classes
       :param int duration: The message duration, in seconds
       :param object extra: An extra reply interface object to attach
 
+   .. py:method:: send_video(path, [duration=None, caption=None, extra=None])
+
+      Reply with the video found in the *path* to the chat. You may optionally
+      specify the *duration* and the *caption* of the video. *extra* is an
+      optional object which specifies additional reply interface options on the
+      recipient's end, and can be one of the following types:
+
+      * :py:class:`botogram.ReplyKeyboardMarkup`
+      * :py:class:`botogram.ReplyKeyboardHide`
+      * :py:class:`botogram.ForceReply`
+
+      :param str path: The path to the video
+      :param int duration: The video duration, in seconds
+      :param str caption: The caption of the video
+      :param object extra: An extra reply interface object to attach
+
    .. py:method:: reply_with_file(path, [extra=None])
 
       Reply with the generic file found in the *path* to the chat. If the file