Bump version to v4.2.1

Adds @message decorator to editMessageText #320

CHANGES.rst

@@ -1,3 +1,10 @@
+**2016-06-10**
+
+*Released 4.2.1*
+
+- Fix ``CallbackQuery.to_dict()`` bug (thanks to @jlmadurga)
+- Fix ``editMessageText`` exception when receiving a ``CallbackQuery``
+
 **2016-05-28**
 
 *Released 4.2*
@@ -45,7 +52,7 @@
 
 - Implement Bot API 2.0
 - Almost complete recode of ``Dispatcher``
-- Please read the `Transistion Guide to 4.0 <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Transistion-guide-to-Version-4.0>`_
+- Please read the `Transition Guide to 4.0 <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Transition-guide-to-Version-4.0>`_
 - **Changes from 4.0rc1**
     - The syntax of filters for ``MessageHandler`` (upper/lower cases)
     - Handler groups are now identified by ``int`` only, and ordered

README.rst

@@ -67,9 +67,9 @@ Table of contents
 
 - `License`_
 
-===============
-_`Introduction`
-===============
+============
+Introduction
+============
 
 This library provides a pure Python interface for the
 `Telegram Bot API <https://core.telegram.org/bots/api>`_.
@@ -81,15 +81,15 @@ In addition to the pure API implementation, this library features a number of hi
 make the development of bots easy and straightforward. These classes are contained in the
 ``telegram.ext`` submodule.
 
-=======================
-_`Telegram API support`
-=======================
+====================
+Telegram API support
+====================
 
 As of **28. May 2016**, all types and methods of the Telegram Bot API are supported.
 
-=============
-_`Installing`
-=============
+==========
+Installing
+==========
 
 You can install or upgrade python-telegram-bot with:
 
@@ -97,9 +97,9 @@ You can install or upgrade python-telegram-bot with:
 
     $ pip install python-telegram-bot --upgrade
 
-==================
-_`Getting started`
-==================
+===============
+Getting started
+===============
 
 Our Wiki contains a lot of resources to get you started with ``python-telegram-bot``:
 
@@ -111,9 +111,9 @@ Other references:
 - `Telegram API documentation <https://core.telegram.org/bots/api>`_
 - `python-telegram-bot documentation <https://pythonhosted.org/python-telegram-bot/>`_
 
-----------------------
-_`Learning by example`
-----------------------
+-------------------
+Learning by example
+-------------------
 
 We believe that the best way to learn and understand this simple package is by example. So here
 are some examples for you to review. Even if it's not your approach for learning, please take a
@@ -129,8 +129,6 @@ code and building on top of it.
 
 - `timerbot <https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/timerbot.py>`_ uses the ``JobQueue`` to send timed messages.
 
-- `clibot <https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/clibot.py>`_ has a command line interface.
-
 Examples using only the pure API:
 
 - `echobot <https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/legacy/echobot.py>`_ replies back messages.
@@ -139,9 +137,9 @@ Examples using only the pure API:
 
 Look at the examples on the `wiki <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Examples>`_ to see other bots the community has built.
 
-----------
-_`Logging`
-----------
+-------
+Logging
+-------
 
 This library uses the ``logging`` module. To set up logging to standard output, put:
 
@@ -167,35 +165,35 @@ If you want DEBUG logs instead:
     logger.setLevel(logging.DEBUG)
 
 
-================
-_`Documentation`
-================
+=============
+Documentation
+=============
 
 ``python-telegram-bot``'s documentation lives at `pythonhosted.org <https://pythonhosted.org/python-telegram-bot/>`_.
 
-===============
-_`Getting help`
-===============
+============
+Getting help
+============
 
 You can get help in several ways:
 
 1. We have a vibrant community of developers helping each other in our `Telegram group <https://telegram.me/pythontelegrambotgroup>`_. Join us!
 
-2. Our `Wiki <https://github.com/python-telegram-bot/python-telegram-bot/wiki/>`_ offers a growing amount of resources.
+2. Our `Wiki pages <https://github.com/python-telegram-bot/python-telegram-bot/wiki/>`_ offer a growing amount of resources.
 
 3. You can ask for help on Stack Overflow using the `python-telegram-bot tag <https://stackoverflow.com/questions/tagged/python-telegram-bot>`_.
 
 4. As last resort, the developers are ready to help you with `serious issues <https://github.com/python-telegram-bot/python-telegram-bot/issues/new>`_.
 
 
-===============
-_`Contributing`
-===============
+============
+Contributing
+============
 
 Contributions of all sizes are welcome. Please review our `contribution guidelines <https://github.com/python-telegram-bot/python-telegram-bot/blob/master/.github/CONTRIBUTING.rst>`_ to get started. You can also help by `reporting bugs <https://github.com/python-telegram-bot/python-telegram-bot/issues/new>`_.
 
-==========
-_`License`
-==========
+=======
+License
+=======
 
-You may copy, distribute and modify the software provided that modifications are described and licensed for free under `LGPL-3 <https://www.gnu.org/licenses/lgpl-3.0.html>`_. Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under `LGPL-3 <https://www.gnu.org/licenses/lgpl-3.0.html>`_, but applications that use the library don't have to be.
+You may copy, distribute and modify the software provided that modifications are described and licensed for free under `LGPL-3 <https://www.gnu.org/licenses/lgpl-3.0.html>`_. Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL-3, but applications that use the library don't have to be.

examples/clibot.py

@@ -1,164 +0,0 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-#
-# Example Bot to show some of the functionality of the library
-# This program is dedicated to the public domain under the CC0 license.
-"""
-This Bot uses the Updater class to handle the bot.
-
-First, a few handler functions are defined. Then, those functions are passed to
-the Dispatcher and registered at their respective places.
-Then, the bot is started and the CLI-Loop is entered, where all text inputs are
-inserted into the update queue for the bot to handle.
-
-Usage:
-Repeats messages with a delay.
-Reply to last chat from the command line by typing "/reply <text>"
-Type 'stop' on the command line to stop the bot.
-"""
-
-from telegram.ext import Updater, StringCommandHandler, StringRegexHandler, \
-    MessageHandler, CommandHandler, RegexHandler, Filters
-from telegram.ext.dispatcher import run_async
-from time import sleep
-import logging
-
-from future.builtins import input
-
-# Enable Logging
-logging.basicConfig(format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
-                    level=logging.INFO)
-
-logger = logging.getLogger(__name__)
-
-# We use this var to save the last chat id, so we can reply to it
-last_chat_id = 0
-
-
-# Define a few (command) handler callback functions. These usually take the
-# two arguments bot and update. Error handlers also receive the raised
-# TelegramError object in error.
-def start(bot, update):
-    """ Answer in Telegram """
-    bot.sendMessage(update.message.chat_id, text='Hi!')
-
-
-def help(bot, update):
-    """ Answer in Telegram """
-    bot.sendMessage(update.message.chat_id, text='Help!')
-
-
-def any_message(bot, update):
-    """ Print to console """
-
-    # Save last chat_id to use in reply handler
-    global last_chat_id
-    last_chat_id = update.message.chat_id
-
-    logger.info("New message\nFrom: %s\nchat_id: %d\nText: %s" %
-                (update.message.from_user, update.message.chat_id, update.message.text))
-
-
-@run_async
-def message(bot, update):
-    """
-    Example for an asynchronous handler. It's not guaranteed that replies will
-    be in order when using @run_async. Also, you have to include **kwargs in
-    your parameter list. The kwargs contain all optional parameters that are
-    """
-
-    sleep(2)  # IO-heavy operation here
-    bot.sendMessage(update.message.chat_id, text='Echo: %s' % update.message.text)
-
-
-# These handlers are for updates of type str. We use them to react to inputs
-# on the command line interface
-def cli_reply(bot, update, args):
-    """
-    For any update of type telegram.Update or str that contains a command, you
-    can get the argument list by appending args to the function parameters.
-    Here, we reply to the last active chat with the text after the command.
-    """
-    if last_chat_id is not 0:
-        bot.sendMessage(chat_id=last_chat_id, text=' '.join(args))
-
-
-def cli_noncommand(bot, update, update_queue):
-    """
-    You can also get the update queue as an argument in any handler by
-    appending it to the argument list. Be careful with this though.
-    Here, we put the input string back into the queue, but as a command.
-
-    To learn more about those optional handler parameters, read the
-    documentation of the Handler classes.
-    """
-    update_queue.put('/%s' % update)
-
-
-def error(bot, update, error):
-    """ Print error to console """
-    logger.warn('Update %s caused error %s' % (update, error))
-
-
-def main():
-    # Create the EventHandler and pass it your bot's token.
-    token = 'TOKEN'
-    updater = Updater(token, workers=10)
-
-    # Get the dispatcher to register handlers
-    dp = updater.dispatcher
-
-    # This is how we add handlers for Telegram messages
-    dp.add_handler(CommandHandler("start", start))
-    dp.add_handler(CommandHandler("help", help))
-    # Message handlers only receive updates that don't contain commands
-    dp.add_handler(MessageHandler([Filters.text], message))
-    # Regex handlers will receive all updates on which their regex matches,
-    # but we have to add it in a separate group, since in one group,
-    # only one handler will be executed
-    dp.add_handler(RegexHandler('.*', any_message), group=1)
-
-    # String handlers work pretty much the same. Note that we have to tell
-    # the handler to pass the args or update_queue parameter
-    dp.add_handler(StringCommandHandler('reply', cli_reply, pass_args=True))
-    dp.add_handler(StringRegexHandler('[^/].*', cli_noncommand, pass_update_queue=True))
-
-    # All TelegramErrors are caught for you and delivered to the error
-    # handler(s). Other types of Errors are not caught.
-    dp.add_error_handler(error)
-
-    # Start the Bot and store the update Queue, so we can insert updates
-    update_queue = updater.start_polling(timeout=10)
-    '''
-    # Alternatively, run with webhook:
-
-    update_queue = updater.start_webhook('0.0.0.0',
-                                         443,
-                                         url_path=token,
-                                         cert='cert.pem',
-                                         key='key.key',
-                                         webhook_url='https://example.com/%s'
-                                             % token)
-
-    # Or, if SSL is handled by a reverse proxy, the webhook URL is already set
-    # and the reverse proxy is configured to deliver directly to port 6000:
-
-    update_queue = updater.start_webhook('0.0.0.0', 6000)
-    '''
-
-    # Start CLI-Loop
-    while True:
-        text = input()
-
-        # Gracefully stop the event handler
-        if text == 'stop':
-            updater.stop()
-            break
-
-        # else, put the text into the update queue to be handled by our handlers
-        elif len(text) > 0:
-            update_queue.put(text)
-
-
-if __name__ == '__main__':
-    main()

telegram/__init__.py

@@ -82,7 +82,7 @@ from .update import Update
 from .bot import Bot
 
 __author__ = 'devs@python-telegram-bot.org'
-__version__ = '4.2.0'
+__version__ = '4.2.1'
 __all__ = ['Audio', 'Bot', 'Chat', 'ChatMember', 'ChatAction', 'ChosenInlineResult',
            'CallbackQuery', 'Contact', 'Document', 'Emoji', 'File', 'ForceReply',
            'InlineKeyboardButton', 'InlineKeyboardMarkup', 'InlineQuery', 'InlineQueryResult',

telegram/bot.py

@@ -1009,6 +1009,7 @@ class Bot(TelegramObject):
         return result
 
     @log
+    @message
     def editMessageText(self,
                         text,
                         chat_id=None,
@@ -1016,7 +1017,6 @@ class Bot(TelegramObject):
                         inline_message_id=None,
                         parse_mode=None,
                         disable_web_page_preview=None,
-                        reply_markup=None,
                         **kwargs):
         """Use this method to edit text messages sent by the bot or via the bot
         (for inline bots).
@@ -1043,6 +1043,10 @@ class Bot(TelegramObject):
             A JSON-serialized object for an inline keyboard.
 
         Keyword Args:
+            reply_markup (Optional[:class:`telegram.ReplyMarkup`]): Additional
+                interface options. A JSON-serialized object for an inline
+                keyboard, custom reply keyboard, instructions to hide reply
+                keyboard or to force a reply from the user.
             timeout (Optional[float]): If this value is specified, use it as
                 the definitive timeout (in seconds) for urlopen() operations.
 
@@ -1070,15 +1074,8 @@ class Bot(TelegramObject):
             data['parse_mode'] = parse_mode
         if disable_web_page_preview:
             data['disable_web_page_preview'] = disable_web_page_preview
-        if reply_markup:
-            if isinstance(reply_markup, ReplyMarkup):
-                data['reply_markup'] = reply_markup.to_json()
-            else:
-                data['reply_markup'] = reply_markup
 
-        result = request.post(url, data, timeout=kwargs.get('timeout'))
-
-        return Message.de_json(result)
+        return url, data
 
     @log
     @message

telegram/callbackquery.py

@@ -43,3 +43,14 @@ class CallbackQuery(TelegramObject):
         data['message'] = Message.de_json(data.get('message'))
 
         return CallbackQuery(**data)
+
+    def to_dict(self):
+        """
+        Returns:
+            dict:
+        """
+        data = super(CallbackQuery, self).to_dict()
+
+        # Required
+        data['from'] = data.pop('from_user', None)
+        return data

tests/test_photo.py

@@ -35,15 +35,14 @@ class PhotoTest(BaseTest, unittest.TestCase):
 
     def setUp(self):
         self.photo_file = open('tests/data/telegram.jpg', 'rb')
-        self.photo_file_id = 'AgADAQADvb8xGx8j9QcpZDKxYoFK3bfX1i8ABFX_dgMWoKDuQugAAgI'
+        self.photo_file_id = 'AgADAQADgEsyGx8j9QfmDMmwkPBrFcKRzy8ABHW8ul9nW7FoNHYBAAEC'
         self.photo_file_url = 'https://raw.githubusercontent.com/python-telegram-bot/python-telegram-bot/master/tests/data/telegram.jpg'
         self.width = 300
         self.height = 300
         self.thumb = {
             'width': 90,
             'height': 90,
-            'file_id':
-            'AgADAQADvb8xGx8j9QcpZDKxYoFK3bfX1i8ABBxRLXFhLnhIQ-gAAgI',
+            'file_id': 'AgADAQADgEsyGx8j9QfmDMmwkPBrFcKRzy8ABD64nkFkjujeNXYBAAEC',
             'file_size': 1478
         }
         self.file_size = 10209