Merge branch 'renyhp/current_master'

Author: pietroalbini

botogram/objects/mixins.py

@@ -103,10 +103,13 @@ def send_photo(self, path, caption=None, reply_to=None, extra=None,
                               expect=_objects().Message)
 
     @_require_api
-    def send_audio(self, path, duration=None, performer=None, title=None,
-                   reply_to=None, extra=None, attach=None, notify=True):
+    def send_audio(self, path, duration=None, performer=None,
+                   title=None, reply_to=None, extra=None, attach=None,
+                   notify=True, caption=None):
         """Send an audio track"""
         args = self._get_call_args(reply_to, extra, attach, notify)
+        if caption is not None:
+            args["caption"] = caption
         if duration is not None:
             args["duration"] = duration
         if performer is not None:
@@ -121,9 +124,11 @@ 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, attach=None, notify=True):
+                   extra=None, attach=None, notify=True, caption=None):
         """Send a voice message"""
         args = self._get_call_args(reply_to, extra, attach, notify)
+        if caption is not None:
+            args["caption"] = caption
         if duration is not None:
             args["duration"] = duration
 
@@ -148,10 +153,12 @@ 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, attach=None,
-                  notify=True):
+    def send_file(self, path, reply_to=None, extra=None,
+                  attach=None, notify=True, caption=None):
         """Send a generic file"""
         args = self._get_call_args(reply_to, extra, attach, notify)
+        if caption is not None:
+            args["caption"] = caption
 
         files = {"document": open(path, "rb")}
 

docs/api/telegram.rst

@@ -155,7 +155,7 @@ about its business.
 
          Now the method returns the sent message
 
-   .. py:method:: send_audio(path, [duration=None, performer=None, title=None, reply_to=None, attach=None, extra=None, notify=True])
+   .. py:method:: send_audio(path, [duration=None, performer=None, title=None, reply_to=None, attach=None, extra=None, notify=True, caption=None])
 
       Send the audio track found in the *path* to the user. You may optionally
       specify the *duration*, the *performer* and the *title* of the audio
@@ -176,6 +176,7 @@ about its business.
       :param object attach: An extra thing to attach to the message.
       :param object extra: An extra reply interface object to attach
       :param bool notify: If you want to trigger the client notification.
+      :param str caption: A caption for the audio track.
       :returns: The message you sent
       :rtype: ~botogram.Message
 
@@ -186,8 +187,12 @@ about its business.
       .. versionchanged:: 0.3
 
          Now the method returns the sent message
+         
+      .. versionchanged:: 0.5
 
-   .. py:method:: send_voice(chat, path, [duration=None, reply_to=None, attach=None, extra=None, notify=True])
+         Added support for caption
+
+   .. py:method:: send_voice(chat, path, [duration=None, reply_to=None, attach=None, extra=None, notify=True, caption=None])
 
       Send the voice message found in the *path* to the user. You may
       optionally specify the *duration* of the voice message. If the voice
@@ -206,6 +211,7 @@ about its business.
       :param object attach: An extra thing to attach to the message.
       :param object extra: An extra reply interface object to attach
       :param bool notify: If you want to trigger the client notification.
+      :param str caption: A caption for the voice message.
       :returns: The message you sent
       :rtype: ~botogram.Message
 
@@ -216,6 +222,10 @@ about its business.
       .. versionchanged:: 0.3
 
          Now the method returns the sent message
+         
+      .. versionchanged:: 0.5
+
+         Added support for caption
 
    .. py:method:: send_video(path, [duration=None, caption=None, reply_to=None, attach=None, extra=None, notify=True])
 
@@ -248,7 +258,7 @@ about its business.
 
          Now the method returns the sent message
 
-   .. py:method:: send_file(path, [reply_to=None, attach=None, extra=None, notify=True])
+   .. py:method:: send_file(path, [reply_to=None, attach=None, extra=None, notify=True, caption=None])
 
       Send the generic file found in the *path* to the user. If the file you're
       sending is in reply to another message, set *reply_to* to the ID of the
@@ -265,6 +275,7 @@ about its business.
       :param object attach: An extra thing to attach to the message.
       :param object extra: An extra reply interface object to attach
       :param bool notify: If you want to trigger the client notification.
+      :param str caption: A caption for the file.
       :returns: The message you sent
       :rtype: ~botogram.Message
 
@@ -275,6 +286,10 @@ about its business.
       .. versionchanged:: 0.3
 
          Now the method returns the sent message
+         
+      .. versionchanged:: 0.5
+
+         Added support for caption
 
    .. py:method:: send_location(latitude, longitude, [reply_to=None, attach=None, extra=None, notify=True])
 
@@ -728,7 +743,7 @@ about its business.
 
          Now the method returns the sent message
 
-   .. py:method:: send_audio(path, [duration=None, performer=None, title=None, reply_to=None, attach=None, extra=None, notify=True])
+   .. py:method:: send_audio(path, [duration=None, performer=None, title=None, reply_to=None, attach=None, extra=None, notify=True, caption=None])
 
       Send the audio track found in the *path* to the chat. You may optionally
       specify the *duration*, the *performer* and the *title* of the audio
@@ -749,6 +764,7 @@ about its business.
       :param object attach: An extra thing to attach to the message.
       :param object extra: An extra reply interface object to attach
       :param bool notify: If you want to trigger the client notification.
+      :param str caption: A caption for the audio track.
       :returns: The message you sent
       :rtype: ~botogram.Message
 
@@ -760,7 +776,11 @@ about its business.
 
          Now the method returns the sent message
 
-   .. py:method:: send_voice(chat, path, [duration=None, reply_to=None, attach=None, extra=None, notify=True])
+      .. versionchanged:: 0.5
+
+         Added support for caption
+
+   .. py:method:: send_voice(chat, path, [duration=None, reply_to=None, attach=None, extra=None, notify=True, caption=None])
 
       Send the voice message found in the *path* to the chat. You may
       optionally specify the *duration* of the voice message. If the voice
@@ -779,6 +799,7 @@ about its business.
       :param object attach: An extra thing to attach to the message.
       :param object extra: An extra reply interface object to attach
       :param bool notify: If you want to trigger the client notification.
+      :param str caption: A caption for the voice message.
       :returns: The message you sent
       :rtype: ~botogram.Message
 
@@ -790,6 +811,10 @@ about its business.
 
          Now the method returns the sent message
 
+      .. versionchanged:: 0.5
+
+         Added support for caption
+
    .. py:method:: send_video(path, [duration=None, caption=None, reply_to=None, attach=None, extra=None, notify=True])
 
       Send the video found in the *path* to the chat. You may optionally
@@ -821,7 +846,7 @@ about its business.
 
          Now the method returns the sent message
 
-   .. py:method:: send_file(path, [reply_to=None, attach=None, extra=None, notify=True])
+   .. py:method:: send_file(path, [reply_to=None, attach=None, extra=None, notify=True, caption=None])
 
       Send the generic file found in the *path* to the chat. If the file you're
       sending is in reply to another message, set *reply_to* to the ID of the
@@ -838,6 +863,7 @@ about its business.
       :param object attach: An extra thing to attach to the message.
       :param object extra: An extra reply interface object to attach
       :param bool notify: If you want to trigger the client notification.
+      :param str caption: A caption for the file.
       :returns: The message you sent
       :rtype: ~botogram.Message
 
@@ -849,6 +875,10 @@ about its business.
 
          Now the method returns the sent message
 
+      .. versionchanged:: 0.5
+
+         Added support for caption
+
    .. py:method:: send_location(latitude, longitude, [reply_to=None, attach=None, extra=None, notify=True])
 
       Send the geographic location to the chat. If the location you're sending