Merge pull request #348 from python-telegram-bot/urllib3_fix_proxy_auth

Urllib3 fix proxy auth

.coveragerc

@@ -1,8 +1,5 @@
 [run]
 source = telegram
-omit = telegram/vendor/*
 
 [report]
-omit =
-    tests/
-    telegram/vendor/*
+omit = tests/

.github/CONTRIBUTING.rst

@@ -1,41 +1,34 @@
 How To Contribute
-===================
+=================
 
 Every open source project lives from the generous help by contributors that sacrifice their time and ``python-telegram-bot`` is no different. To make participation as pleasant as possible, this project adheres to the `Code of Conduct`_ by the Python Software Foundation.
 
 Setting things up
--------------------
+-----------------
 
 1. Fork the ``python-telegram-bot`` repository to your GitHub account.
 
 2. Clone your forked repository of ``python-telegram-bot`` to your computer:
 
-   .. code-block:: bash
+   ``$ git clone https://github.com/<your username>/python-telegram-bot``
 
-      $ git clone https://github.com/<your username>/python-telegram-bot --recursive
-      $ cd python-telegram-bot
+   ``$ cd python-telegram-bot``
 
 3. Add a track to the original repository:
 
-   .. code-block:: bash
-
-      $ git remote add upstream https://github.com/python-telegram-bot/python-telegram-bot
+   ``$ git remote add upstream https://github.com/python-telegram-bot/python-telegram-bot``
 
 4. Install dependencies:
 
-   .. code-block:: bash
-
-      $ sudo pip install -r requirements.txt -r requirements-dev.txt
+   ``$ pip install -r requirements.txt -r requirements-dev.txt``
 
 
 5. Install pre-commit hooks:
 
-   .. code-block:: bash
-
-      $ pre-commit install
+   ``$ pre-commit install``
 
 Finding something to do
-###################
+-----------------------
 
 If you already know what you'd like to work on, you can skip this section.
 
@@ -44,7 +37,7 @@ If you have an idea for something to do, first check if it's already been filed
 Another great way to start contributing is by writing tests. Tests are really important because they help prevent developers from accidentally breaking existing code, allowing them to build cool things faster. If you're interested in helping out, let the development team know by posting to the `developers' mailing list`_, and we'll help you get started.
 
 Instructions for making a code change
-####################
+-------------------------------------
 
 The central development branch is ``master``, which should be clean and ready for release at any time. In general, all changes should be done as feature branches based off of ``master``.
 
@@ -54,12 +47,13 @@ Here's how to make a one-off code change.
 
 2. **Create a new branch with this name, starting from** ``master``. In other words, run:
 
-   .. code-block:: bash
+   ``$ git fetch upstream``
 
-      $ git fetch upstream
-      $ git checkout master
-      $ git merge upstream/master
-      $ git checkout -b your-branch-name
+   ``$ git checkout master``
+
+   ``$ git merge upstream/master``
+
+   ``$ git checkout -b your-branch-name``
 
 3. **Make a commit to your feature branch**. Each commit should be self-contained and have a descriptive commit message that helps other developers understand why the changes were made.
 
@@ -81,33 +75,19 @@ Here's how to make a one-off code change.
 
    - Before making a commit ensure that all automated tests still pass:
 
-     .. code-block::
-
-        $ make test
-
-     If you don't have ``make``, do:
-
-     .. code-block::
-
-        $ nosetests -v
+      ``$ make test``
 
    - To actually make the commit (this will trigger tests for yapf, lint and pep8 automatically):
 
-     .. code-block:: bash
+      ``$ git add your-file-changed.py``
 
-        $ git add your-file-changed.py
+        - yapf may change code formatting, make sure to re-add them to your commit.
 
-   - yapf may change code formatting, make sure to re-add them to your commit.
-
-     .. code-block:: bash
-
-      $ git commit -a -m "your-commit-message-here"
+      ``$ git commit -a -m "your-commit-message-here"``
 
    - Finally, push it to your GitHub fork, run:
 
-     .. code-block:: bash
-
-      $ git push origin your-branch-name
+      ``$ git push origin your-branch-name``
 
 4. **When your feature is ready to merge, create a pull request.**
 
@@ -127,74 +107,73 @@ Here's how to make a one-off code change.
 
    - Resolve any merge conflicts that arise. To resolve conflicts between 'your-branch-name' (in your fork) and 'master' (in the ``python-telegram-bot`` repository), run:
 
-     .. code-block:: bash
+      ``$ git checkout your-branch-name``
 
-      	$ git checkout your-branch-name
-      	$ git fetch upstream
-	$ git merge upstream/master
-      	$ ...[fix the conflicts]...
-      	$ ...[make sure the tests pass before committing]...
-      	$ git commit -a
-      	$ git push origin your-branch-name
+      ``$ git fetch upstream``
+
+      ``$ git merge upstream/master``
+
+      ``$ ...[fix the conflicts]...``
+
+      ``$ ...[make sure the tests pass before committing]...``
+
+      ``$ git commit -a``
+
+      ``$ git push origin your-branch-name``
 
    - At the end, the reviewer will merge the pull request.
 
 6. **Tidy up!** Delete the feature branch from both your local clone and the GitHub repository:
 
-   .. code-block:: bash
+   ``$ git branch -D your-branch-name``
 
-      $ git branch -D your-branch-name
-      $ git push origin --delete your-branch-name
+   ``$ git push origin --delete your-branch-name``
 
 7. **Celebrate.** Congratulations, you have contributed to ``python-telegram-bot``!
 
 Style commandments
----------------------
+==================
 
 Specific commandments
-#####################
+---------------------
 
 - Avoid using "double quotes" where you can reasonably use 'single quotes'.
 
 AssertEqual argument order
-######################
+--------------------------
 
-- assertEqual method's arguments should be in ('actual', 'expected') order.
+assertEqual method's arguments should be in ('actual', 'expected') order.
 
 Properly calling callables
-#######################
+--------------------------
 
 Methods, functions and classes can specify optional parameters (with default
 values) using Python's keyword arg syntax. When providing a value to such a
-callable we prefer that the call also uses keyword arg syntax. For example:
+callable we prefer that the call also uses keyword arg syntax. For example::
 
-.. code-block:: python
+    # GOOD
+    f(0, optional=True)
 
-   # GOOD
-   f(0, optional=True)
-
-   # BAD
-   f(0, True)
+    # BAD
+    f(0, True)
 
 This gives us the flexibility to re-order arguments and more importantly
 to add new required arguments. It's also more explicit and easier to read.
 
 Properly defining optional arguments
-########################
+------------------------------------
 
-It's always good to not initialize optional arguments at class creation,
-instead use ``**kwargs`` to get them. It's well known Telegram API can
-change without notice, in that case if a new argument is added it won't
-break the API classes. For example:
-
-.. code-block:: python
+It's always good to not initialize optional arguments at class creation, 
+instead use ``**kwargs`` to get them. It's well known Telegram API can 
+change without notice, in that case if a new argument is added it won't 
+break the API classes. For example::
 
     # GOOD
-    def __init__(self, id, name, last_name=None, **kwargs):
-       self.last_name = last_name
+    def __init__(self, id, name, **kwargs):
+       self.last_name = kwargs.get('last_name', '')
 
     # BAD
-    def __init__(self, id, name, last_name=None):
+    def __init__(self, id, name, last_name=''):
        self.last_name = last_name
 
 
@@ -204,4 +183,4 @@ break the API classes. For example:
 .. _`PEP 8 Style Guide`: https://www.python.org/dev/peps/pep-0008/
 .. _`Google Python Style Guide`: https://google-styleguide.googlecode.com/svn/trunk/pyguide.html
 .. _`Google Python Style Docstrings`: http://sphinx-doc.org/latest/ext/example_google.html
-.. _AUTHORS.rst: ../AUTHORS.rst
+.. _AUTHORS.rst: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/AUTHORS.rst

.github/ISSUE_TEMPLATE.md

@@ -1,10 +1,6 @@
 <!--
 Thanks for reporting issues of python-telegram-bot!
 To make it easier for us to help you please enter detailed information below.
-
-Please note, we only support the latest version of python-telegram-bot and
-master branch. Please make sure to upgrade & recreate the issue on the latest
-version prior to opening an issue.
 -->
 ### Steps to reproduce
 1.
@@ -23,9 +19,13 @@ Tell us what happens instead
 **Operating System:**
 
 
-**Version of Python, python-telegram-bot & dependencies:**
+**Version of Python:**
 
-``$ python -m telegram``
+``$ python -V``
+
+**Version of python-telegram-bot:**
+
+``$ python -c 'import telegram; print(telegram.__version__)'``
 
 ### Logs
 Insert logs here (if necessary)

.gitignore

@@ -65,13 +65,6 @@ target/
 # unitests files
 telegram.mp3
 telegram.mp4
-telegram2.mp4
 telegram.ogg
 telegram.png
 telegram.webp
-
-# original files from merges
-*.orig
-
-# Exclude .exrc file for Vim
-.exrc

.gitmodules

@@ -1,4 +0,0 @@
-[submodule "telegram/vendor/urllib3"]
-	path = telegram/vendor/ptb_urllib3
-	url = https://github.com/python-telegram-bot/urllib3.git
-	branch = ptb

.pre-commit-config.yaml

@@ -1,17 +1,15 @@
--   repo: git://github.com/python-telegram-bot/mirrors-yapf
-    sha: v0.12.2
+-   repo: git://github.com/pre-commit/mirrors-yapf
+    sha: 316b795b2f32cbe80047aff7e842b72368d5a2c1
     hooks:
     -   id: yapf
         files: ^(telegram|tests)/.*\.py$
-        args:
-        - --diff
 -   repo: git://github.com/pre-commit/pre-commit-hooks
-    sha: 18d7035de5388cc7775be57f529c154bf541aab9
+    sha: 6dfcb89af3c9b4d172cc2e5a8a2fa0f54615a338
     hooks:
     -   id: flake8
         files: ^telegram/.*\.py$
 -   repo: git://github.com/pre-commit/mirrors-pylint
-    sha: v1.5.5
+    sha: 4de6c8dfadef1a271a814561ce05b8bc1c446d22
     hooks:
     -   id: pylint
         files: ^telegram/.*\.py$

.travis.yml

@@ -1,23 +1,18 @@
 language: python
 python:
+  - "2.6"
   - "2.7"
   - "3.3"
   - "3.4"
   - "3.5"
-  - "3.6"
   - "pypy"
   - "pypy3"
-branches:
-  only:
-    - master
 install:
   - pip install coveralls
   - pip install -r requirements.txt
   - pip install -r requirements-dev.txt
-  - if [[ $TRAVIS_PYTHON_VERSION != 'pypy'* ]]; then pip install ujson; fi
 script:
-  - nosetests -v --with-flaky --no-flaky-report --with-coverage --cover-package=telegram/ tests
-  - if [[ $TRAVIS_PYTHON_VERSION == 3.5 ]]; then pre-commit run --all-files; fi
-  - python ./setup.py bdist_dumb
+  - nosetests -v --with-flaky --no-flaky-report --with-coverage --cover-package=telegram/
+  - 'if [ $TRAVIS_PYTHON_VERSION != 2.6 ] && [ $TRAVIS_PYTHON_VERSION != 3.3 ] && [ $TRAVIS_PYTHON_VERSION != pypy3 ]; then pre-commit run --all-files; fi'
 after_success:
   coveralls

AUTHORS.rst

@@ -1,62 +1,30 @@
 Credits
 =======
 
-``python-telegram-bot`` was originally created by
-`Leandro Toledo <https://github.com/leandrotoledo>`_ and is now maintained by
-`Jannes Höke <https://github.com/jh0ker>`_ (`@jh0ker <https://t.me/jh0ker>`_ on Telegram) and
-`Noam Meltzer <https://github.com/tsnoam>`_.
-
-We're vendoring urllib3 as part of ``python-telegram-bot`` which is distributed under the MIT
-license. For more info, full credits & license terms, the sources can be found here:
-`https://github.com/python-telegram-bot/urllib3`.
+``python-telegram-bot`` is written and maintained by `Leandro Toledo <https://github.com/leandrotoledo>`_.
 
 Contributors
 ------------
 
 The following wonderful people contributed directly or indirectly to this project:
 
-- `Alateas <https://github.com/alateas>`_
 - `Avanatiker <https://github.com/Avanatiker>`_
-- `Anton Tagunov <https://github.com/anton-tagunov>`_
 - `Balduro <https://github.com/Balduro>`_
 - `bimmlerd <https://github.com/bimmlerd>`_
-- `d-qoi <https://github.com/d-qoi>`_
-- `daimajia <https://github.com/daimajia>`_
-- `Eli Gao <https://github.com/eligao>`_
 - `ErgoZ Riftbit Vaper <https://github.com/ergoz>`_
-- `Eugene Lisitsky <https://github.com/lisitsky>`_
-- `Eugenio Panadero <https://github.com/azogue>`_
-- `evgfilim1 <https://github.com/evgfilim1>`_
 - `franciscod <https://github.com/franciscod>`_
-- `Hugo Damer <https://github.com/HakimusGIT>`_
-- `Jacob Bom <https://github.com/bomjacob>`_
 - `JASON0916 <https://github.com/JASON0916>`_
-- `jeffffc <https://github.com/jeffffc>`_
 - `jh0ker <https://github.com/jh0ker>`_
-- `John Yong <https://github.com/whipermr5>`_
-- `jossalgon <https://github.com/jossalgon>`_
 - `JRoot3D <https://github.com/JRoot3D>`_
 - `jlmadurga <https://github.com/jlmadurga>`_
-- `Kjwon15 <https://github.com/kjwon15>`_
-- `Li-aung Yip <https://github.com/LiaungYip>`_
 - `macrojames <https://github.com/macrojames>`_
-- `Michael Elovskikh <https://github.com/wronglink>`_
 - `naveenvhegde <https://github.com/naveenvhegde>`_
-- `neurrone <https://github.com/neurrone>`_
 - `njittam <https://github.com/njittam>`_
 - `Noam Meltzer <https://github.com/tsnoam>`_
 - `Oleg Shlyazhko <https://github.com/ollmer>`_
-- `overquota <https://github.com/overquota>`_
-- `Patrick Hofmann <https://github.com/PH89>`_
-- `Pieter Schutz <https://github.com/eldinnie>`_
 - `Rahiel Kasim <https://github.com/rahiel>`_
-- `Joscha Götzer <https://github.com/Rostgnom>`_
-- `Sascha <https://github.com/saschalalala>`_
 - `Shelomentsev D <https://github.com/shelomentsevd>`_
 - `sooyhwang <https://github.com/sooyhwang>`_
-- `thodnev <https://github.com/thodnev>`_
-- `Valentijn <https://github.com/Faalentijn>`_
-- `voider1 <https://github.com/voider1>`_
 - `wjt <https://github.com/wjt>`_
 
 Please add yourself here alphabetically when you submit your first pull request.

CHANGES.rst

@@ -1,107 +1,3 @@
-=======
-Changes
-=======
-
-**2017-06-18**
-
-*Released 6.1.0*
-
-- Fully support Bot API 3.0
-- Add more fine-grained filters for status updates
-- Bug fixes and other improvements
-
-**2017-05-29**
-
-*Released 6.0.3*
-
-- Faulty PyPI release
-
-**2017-05-29**
-
-*Released 6.0.2*
-
-- Avoid confusion with user's ``urllib3`` by renaming vendored ``urllib3`` to ``ptb_urllib3``
-
-**2017-05-19**
-
-*Released 6.0.1*
-
-- Add support for ``User.language_code``
-- Fix ``Message.text_html`` and ``Message.text_markdown`` for messages with emoji
-
-**2017-05-19**
-
-*Released 6.0.0*
-
-- Add support for Bot API 2.3.1
-- Add support for ``deleteMessage`` API method
-- New, simpler API for ``JobQueue`` - https://github.com/python-telegram-bot/python-telegram-bot/pull/484
-- Download files into file-like objects - https://github.com/python-telegram-bot/python-telegram-bot/pull/459
-- Use vendor ``urllib3`` to address issues with timeouts
-  - The default timeout for messages is now 5 seconds. For sending media, the default timeout is now 20 seconds.
-- String attributes that are not set are now ``None`` by default, instead of empty strings
-- Add ``text_markdown`` and ``text_html`` properties to ``Message`` - https://github.com/python-telegram-bot/python-telegram-bot/pull/507
-- Add support for Socks5 proxy - https://github.com/python-telegram-bot/python-telegram-bot/pull/518
-- Add support for filters in ``CommandHandler`` - https://github.com/python-telegram-bot/python-telegram-bot/pull/536
-- Add the ability to invert (not) filters - https://github.com/python-telegram-bot/python-telegram-bot/pull/552
-- Add ``Filters.group`` and ``Filters.private``
-- Compatibility with GAE via ``urllib3.contrib`` package - https://github.com/python-telegram-bot/python-telegram-bot/pull/583
-- Add equality rich comparision operators to telegram objects - https://github.com/python-telegram-bot/python-telegram-bot/pull/604
-- Several bugfixes and other improvements
-- Remove some deprecated code
-
-**2017-04-17**
-
-*Released 5.3.1*
-
-- Hotfix release due to bug introduced by urllib3 version 1.21
-
-**2016-12-11**
-
-*Released 5.3*
-
-- Implement API changes of November 21st (Bot API 2.3)
-- ``JobQueue`` now supports ``datetime.timedelta`` in addition to seconds
-- ``JobQueue`` now supports running jobs only on certain days
-- New ``Filters.reply`` filter
-- Bugfix for ``Message.edit_reply_markup``
-- Other bugfixes
-
-**2016-10-25**
-
-*Released 5.2*
-
-- Implement API changes of October 3rd (games update)
-- Add ``Message.edit_*`` methods
-- Filters for the ``MessageHandler`` can now be combined using bitwise operators (``& and |``)
-- Add a way to save user- and chat-related data temporarily
-- Other bugfixes and improvements
-
-**2016-09-24**
-
-*Released 5.1*
-
-- Drop Python 2.6 support
-- Deprecate ``telegram.Emoji``
-
-- Use ``ujson`` if available
-- Add instance methods to ``Message``, ``Chat``, ``User``, ``InlineQuery`` and ``CallbackQuery``
-- RegEx filtering for ``CallbackQueryHandler`` and ``InlineQueryHandler``
-- New ``MessageHandler`` filters: ``forwarded`` and ``entity``
-- Add ``Message.get_entity`` to correctly handle UTF-16 codepoints and ``MessageEntity`` offsets
-- Fix bug in ``ConversationHandler`` when first handler ends the conversation
-- Allow multiple ``Dispatcher`` instances
-- Add ``ChatMigrated`` Exception
-- Properly split and handle arguments in ``CommandHandler``
-
-**2016-07-15**
-
-*Released 5.0*
-
-- Rework ``JobQueue``
-- Introduce ``ConversationHandler``
-- Introduce ``telegram.constants`` - https://github.com/python-telegram-bot/python-telegram-bot/pull/342
-
 **2016-07-12**
 
 *Released 4.3.4*

README.rst

@@ -1,9 +1,9 @@
 .. image:: https://github.com/python-telegram-bot/logos/blob/master/logo-text/png/ptb-logo-text_768.png?raw=true
    :align: center
-   :target: https://python-telegram-bot.org
+   :target: https://github.com/python-telegram-bot/logos
    :alt: python-telegram-bot Logo
 
-We have made you a wrapper you can't refuse
+Not **just** a Python wrapper around the Telegram Bot API
 
 *Stay tuned for library updates and new releases on our* `Telegram Channel <https://telegram.me/pythontelegrambotchannel>`_.
 
@@ -16,7 +16,7 @@ We have made you a wrapper you can't refuse
    :alt: Supported python versions
 
 .. image:: https://img.shields.io/badge/docs-latest-af1a97.svg
-   :target: https://python-telegram-bot.readthedocs.io/
+   :target: https://pythonhosted.org/python-telegram-bot/
    :alt: Documentation Status
 
 .. image:: https://img.shields.io/pypi/l/python-telegram-bot.svg
@@ -37,7 +37,7 @@ We have made you a wrapper you can't refuse
    
 .. image:: http://isitmaintained.com/badge/resolution/python-telegram-bot/python-telegram-bot.svg
    :target: http://isitmaintained.com/project/python-telegram-bot/python-telegram-bot
-   :alt: Median time to resolve an issue
+   :alt: Average time to resolve an issue
 
 .. image:: https://img.shields.io/badge/Telegram-Group-blue.svg
    :target: https://telegram.me/pythontelegrambotgroup
@@ -73,7 +73,8 @@ Introduction
 
 This library provides a pure Python interface for the
 `Telegram Bot API <https://core.telegram.org/bots/api>`_.
-It's compatible with Python versions 2.7, 3.3+ and `PyPy <http://pypy.org/>`_.
+It works with Python versions from 2.6+ (**Note:** Support for 2.6 will be dropped at some point
+this year. 2.7 will still be supported).
 It also works with `Google App Engine <https://cloud.google.com/appengine>`_.
 
 In addition to the pure API implementation, this library features a number of high-level classes to
@@ -84,7 +85,7 @@ make the development of bots easy and straightforward. These classes are contain
 Telegram API support
 ====================
 
-As of **18. June 2017**, all types and methods of the Telegram Bot API 3.0 are supported.
+As of **28. May 2016**, all types and methods of the Telegram Bot API are supported.
 
 ==========
 Installing
@@ -96,20 +97,6 @@ You can install or upgrade python-telegram-bot with:
 
     $ pip install python-telegram-bot --upgrade
 
-Or you can install from source with:
-
-.. code:: shell
-
-    $ git clone https://github.com/python-telegram-bot/python-telegram-bot --recursive
-    $ cd python-telegram-bot
-    $ python setup.py install
-    
-In case you have a previously cloned local repository already, you should initialize the added urllib3 submodule before installing with:
-
-.. code:: shell
-
-    $ git submodule update --init --recursive
-
 ===============
 Getting started
 ===============
@@ -122,7 +109,7 @@ Our Wiki contains a lot of resources to get you started with ``python-telegram-b
 Other references:
 
 - `Telegram API documentation <https://core.telegram.org/bots/api>`_
-- `python-telegram-bot documentation <https://python-telegram-bot.readthedocs.io/>`_
+- `python-telegram-bot documentation <https://pythonhosted.org/python-telegram-bot/>`_
 
 -------------------
 Learning by example
@@ -130,11 +117,21 @@ 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
-look at ``echobot2``, it is de facto the base for most of the bots out there. Best of all,
+look at ``echobot2`` (below), it is de facto the base for most of the bots out there. Best of all,
 the code for these examples are released to the public domain, so you can start by grabbing the
 code and building on top of it.
 
-Visit `this page <https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/README.md>`_ to discover the official examples or 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.
+- `echobot2 <https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/echobot2.py>`_ replies back messages.
+
+- `inlinebot <https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/inlinebot.py>`_ basic example of an `inline bot <https://core.telegram.org/bots/inline>`_.
+
+- `state machine bot <https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/state_machine_bot.py>`_ keeps the state for individual users, useful for multipart conversations.
+
+- `timerbot <https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/timerbot.py>`_ uses the ``JobQueue`` to send timed messages.
+
+- `echobot <https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/legacy/echobot.py>`_ uses only the pure API to echo messages.
+
+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
@@ -168,7 +165,7 @@ If you want DEBUG logs instead:
 Documentation
 =============
 
-``python-telegram-bot``'s documentation lives at `readthedocs.io <https://python-telegram-bot.readthedocs.io/>`_.
+``python-telegram-bot``'s documentation lives at `pythonhosted.org <https://pythonhosted.org/python-telegram-bot/>`_.
 
 ============
 Getting help

docs/Makefile

@@ -189,4 +189,4 @@ xml:
 pseudoxml:
 	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
 	@echo
-	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

docs/source/conf.py

@@ -11,10 +11,11 @@
 #
 # All configuration values have a default; values that are commented out
 # serve to show the default.
+
 import sys
 import os
 import shlex
-# import telegram
+import telegram
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -24,7 +25,7 @@ sys.path.insert(0, os.path.abspath('../..'))
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-needs_sphinx = '1.5.4'  # fixes issues with autodoc-skip-member and napoleon
+#needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -50,7 +51,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'Python Telegram Bot'
-copyright = u'2015-2017, Leandro Toledo'
+copyright = u'2015-2016, Leandro Toledo'
 author = u'Leandro Toledo'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -58,9 +59,9 @@ author = u'Leandro Toledo'
 # built documents.
 #
 # The short X.Y version.
-version = '6.1'  # telegram.__version__[:3]
+version = telegram.__version__[:3]
 # The full version, including alpha/beta/rc tags.
-release = '6.1.0'  # telegram.__version__
+release = telegram.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -130,12 +131,12 @@ html_theme = 'sphinx_rtd_theme'
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-html_logo = 'ptb-logo-orange.png'
+#html_logo = None
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-html_favicon = 'ptb-logo-orange.ico'
+#html_favicon = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -208,17 +209,14 @@ htmlhelp_basename = 'PythonTelegramBotdoc'
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-
 # The paper size ('letterpaper' or 'a4paper').
-    'papersize': 'a4paper',
+#'papersize': 'letterpaper',
 
 # The font size ('10pt', '11pt' or '12pt').
 #'pointsize': '10pt',
 
 # Additional stuff for the LaTeX preamble.
-    'preamble': r'''\setcounter{tocdepth}{2}
-\usepackage{enumitem}
-\setlistdepth{99}''',
+#'preamble': '',
 
 # Latex figure (float) alignment
 #'figure_align': 'htbp',
@@ -229,12 +227,12 @@ latex_elements = {
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
   (master_doc, 'PythonTelegramBot.tex', u'Python Telegram Bot Documentation',
-   author, 'manual'),
+   u'Leandro Toledo', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-latex_logo = 'ptb-logo_1024.png'
+#latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
@@ -273,7 +271,7 @@ man_pages = [
 #  dir menu entry, description, category)
 texinfo_documents = [
   (master_doc, 'PythonTelegramBot', u'Python Telegram Bot Documentation',
-   author, 'PythonTelegramBot', "We have made you a wrapper you can't refuse",
+   author, 'PythonTelegramBot', 'Not just a Python wrapper around the Telegram Bot API',
    'Miscellaneous'),
 ]
 
@@ -288,21 +286,3 @@ texinfo_documents = [
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 #texinfo_no_detailmenu = False
-
-# -- script stuff --------------------------------------------------------
-
-import inspect
-
-
-def autodoc_skip_member(app, what, name, obj, skip, options):
-    try:
-        if inspect.getmodule(obj).__name__.startswith('telegram') and inspect.isfunction(obj):
-            if name.lower() != name:
-                return True
-    except AttributeError:
-        pass
-    # Return None so napoleon can handle it
-
-
-def setup(app):
-    app.connect('autodoc-skip-member', autodoc_skip_member)

docs/source/index.rst

@@ -6,8 +6,11 @@
 Welcome to Python Telegram Bot's documentation!
 ===============================================
 
+Contents:
+
 .. toctree::
-   telegram
+   :maxdepth: 2
+
 
 
 Indices and tables

docs/source/modules.rst

@@ -0,0 +1,7 @@
+telegram
+========
+
+.. toctree::
+   :maxdepth: 4
+
+   telegram

docs/source/telegram.animation.rst

@@ -1,7 +0,0 @@
-telegram.animation module
-=========================
-
-.. automodule:: telegram.animation
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.callbackgame.rst

@@ -1,7 +0,0 @@
-telegram.callbackgame module
-============================
-
-.. automodule:: telegram.callbackgame
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.callbackquery.rst

@@ -1,7 +0,0 @@
-telegram.callbackquery module
-=============================
-
-.. automodule:: telegram.callbackquery
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.chatmember.rst

@@ -1,7 +0,0 @@
-telegram.chatmember module
-==========================
-
-.. automodule:: telegram.chatmember
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.constants.rst

@@ -1,7 +0,0 @@
-telegram.constants module
-=========================
-
-.. automodule:: telegram.constants
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.contrib.rst

@@ -1,17 +0,0 @@
-telegram.contrib package
-========================
-
-Submodules
-----------
-
-.. toctree::
-
-    telegram.contrib.botan
-
-Module contents
----------------
-
-.. automodule:: telegram.contrib
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.emoji.rst

@@ -1,7 +1,7 @@
-telegram.venue module
+telegram.emoji module
 =====================
 
-.. automodule:: telegram.venue
+.. automodule:: telegram.emoji
     :members:
     :undoc-members:
     :show-inheritance:

docs/source/telegram.ext.callbackqueryhandler.rst

@@ -1,7 +1,7 @@
-telegram.ext.callbackqueryhandler module
-========================================
+telegram.ext.handler module
+===========================
 
-.. automodule:: telegram.ext.callbackqueryhandler
+.. automodule:: telegram.ext.handler
     :members:
     :undoc-members:
     :show-inheritance:

docs/source/telegram.ext.conversationhandler.rst

@@ -1,7 +0,0 @@
-telegram.ext.conversationhandler module
-=======================================
-
-.. automodule:: telegram.ext.conversationhandler
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.ext.filters.rst

@@ -1,7 +0,0 @@
-telegram.ext.filters module
-===========================
-
-.. automodule:: telegram.ext.filters
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.ext.messagequeue.rst

@@ -1,7 +0,0 @@
-telegram.ext.messagequeue module
-================================
-
-.. automodule:: telegram.ext.messagequeue
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.ext.rst

@@ -10,14 +10,10 @@ Submodules
     telegram.ext.dispatcher
     telegram.ext.jobqueue
     telegram.ext.handler
-    telegram.ext.callbackqueryhandler
     telegram.ext.choseninlineresulthandler
-    telegram.ext.conversationhandler
     telegram.ext.commandhandler
     telegram.ext.inlinequeryhandler
     telegram.ext.messagehandler
-    telegram.ext.messagequeue
-    telegram.ext.filters
     telegram.ext.regexhandler
     telegram.ext.stringcommandhandler
     telegram.ext.stringregexhandler

docs/source/telegram.file.rst

@@ -1,7 +0,0 @@
-telegram.file module
-====================
-
-.. automodule:: telegram.file
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.game.rst

@@ -1,7 +0,0 @@
-telegram.game module
-====================
-
-.. automodule:: telegram.game
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.gamehighscore.rst

@@ -1,7 +0,0 @@
-telegram.gamehighscore module
-=============================
-
-.. automodule:: telegram.gamehighscore
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.inlinekeyboardbutton.rst

@@ -1,5 +1,5 @@
 telegram.inlinekeyboardbutton module
-====================================
+===========================
 
 .. automodule:: telegram.inlinekeyboardbutton
     :members:

docs/source/telegram.inlinekeyboardmarkup.rst

@@ -1,5 +1,5 @@
 telegram.inlinekeyboardmarkup module
-====================================
+==========================
 
 .. automodule:: telegram.inlinekeyboardmarkup
     :members:

docs/source/telegram.inlinequeryresultarticle.rst

@@ -1,5 +1,5 @@
 telegram.inlinequeryresultarticle module
-========================================
+=================================
 
 .. automodule:: telegram.inlinequeryresultarticle
     :members:

docs/source/telegram.inlinequeryresultaudio.rst

@@ -1,5 +1,5 @@
 telegram.inlinequeryresultaudio module
-======================================
+=================================
 
 .. automodule:: telegram.inlinequeryresultaudio
     :members:

docs/source/telegram.inlinequeryresultcachedaudio.rst

@@ -1,5 +1,5 @@
 telegram.inlinequeryresultcachedaudio module
-============================================
+=================================
 
 .. automodule:: telegram.inlinequeryresultcachedaudio
     :members:

docs/source/telegram.inlinequeryresultcacheddocument.rst

@@ -1,5 +1,5 @@
 telegram.inlinequeryresultcacheddocument module
-===============================================
+=================================
 
 .. automodule:: telegram.inlinequeryresultcacheddocument
     :members:

docs/source/telegram.inlinequeryresultcachedgif.rst

@@ -1,5 +1,5 @@
 telegram.inlinequeryresultcachedgif module
-==========================================
+=================================
 
 .. automodule:: telegram.inlinequeryresultcachedgif
     :members:

docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst

@@ -1,5 +1,5 @@
 telegram.inlinequeryresultcachedmpeg4gif module
-===============================================
+=================================
 
 .. automodule:: telegram.inlinequeryresultcachedmpeg4gif
     :members:

docs/source/telegram.inlinequeryresultcachedphoto.rst

@@ -1,5 +1,5 @@
 telegram.inlinequeryresultcachedphoto module
-============================================
+=================================
 
 .. automodule:: telegram.inlinequeryresultcachedphoto
     :members:

docs/source/telegram.inlinequeryresultcachedsticker.rst

@@ -1,5 +1,5 @@
 telegram.inlinequeryresultcachedsticker module
-==============================================
+=================================
 
 .. automodule:: telegram.inlinequeryresultcachedsticker
     :members:

docs/source/telegram.inlinequeryresultcachedvideo.rst

@@ -1,5 +1,5 @@
 telegram.inlinequeryresultcachedvideo module
-============================================
+=================================
 
 .. automodule:: telegram.inlinequeryresultcachedvideo
     :members:

docs/source/telegram.inlinequeryresultcachedvoice.rst

@@ -1,5 +1,5 @@
 telegram.inlinequeryresultcachedvoice module
-============================================
+=================================
 
 .. automodule:: telegram.inlinequeryresultcachedvoice
     :members:

docs/source/telegram.inlinequeryresultcontact.rst

@@ -1,5 +1,5 @@
 telegram.inlinequeryresultcontact module
-========================================
+=================================
 
 .. automodule:: telegram.inlinequeryresultcontact
     :members:

docs/source/telegram.inlinequeryresultdocument.rst

@@ -1,5 +1,5 @@
 telegram.inlinequeryresultdocument module
-=========================================
+=================================
 
 .. automodule:: telegram.inlinequeryresultdocument
     :members:

docs/source/telegram.inlinequeryresultgame.rst

@@ -1,7 +0,0 @@
-telegram.inlinequeryresultgame module
-=====================================
-
-.. automodule:: telegram.inlinequeryresultgame
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.inlinequeryresultgif.rst

@@ -1,5 +1,5 @@
 telegram.inlinequeryresultgif module
-====================================
+=================================
 
 .. automodule:: telegram.inlinequeryresultgif
     :members:

docs/source/telegram.inlinequeryresultlocation.rst

@@ -1,5 +1,5 @@
 telegram.inlinequeryresultlocation module
-=========================================
+=================================
 
 .. automodule:: telegram.inlinequeryresultlocation
     :members:

docs/source/telegram.inlinequeryresultmpeg4gif.rst

@@ -1,5 +1,5 @@
 telegram.inlinequeryresultmpeg4gif module
-=========================================
+=================================
 
 .. automodule:: telegram.inlinequeryresultmpeg4gif
     :members:

docs/source/telegram.inlinequeryresultphoto.rst

@@ -1,5 +1,5 @@
 telegram.inlinequeryresultphoto module
-======================================
+=================================
 
 .. automodule:: telegram.inlinequeryresultphoto
     :members:

docs/source/telegram.inlinequeryresultvenue.rst

@@ -1,5 +1,5 @@
 telegram.inlinequeryresultvenue module
-======================================
+=================================
 
 .. automodule:: telegram.inlinequeryresultvenue
     :members:

docs/source/telegram.inlinequeryresultvideo.rst

@@ -1,5 +1,5 @@
 telegram.inlinequeryresultvideo module
-======================================
+=================================
 
 .. automodule:: telegram.inlinequeryresultvideo
     :members:

docs/source/telegram.inlinequeryresultvoice.rst

@@ -1,5 +1,5 @@
 telegram.inlinequeryresultvoice module
-======================================
+=================================
 
 .. automodule:: telegram.inlinequeryresultvoice
     :members:

docs/source/telegram.inputcontactmessagecontent.rst

@@ -1,7 +0,0 @@
-telegram.inputcontactmessagecontent module
-==========================================
-
-.. automodule:: telegram.inputcontactmessagecontent
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.inputlocationmessagecontent.rst

@@ -1,7 +0,0 @@
-telegram.inputlocationmessagecontent module
-===========================================
-
-.. automodule:: telegram.inputlocationmessagecontent
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.inputmessagecontent.rst

@@ -1,7 +0,0 @@
-telegram.inputmessagecontent module
-===================================
-
-.. automodule:: telegram.inputmessagecontent
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.inputtextmessagecontent.rst

@@ -1,7 +0,0 @@
-telegram.inputtextmessagecontent module
-=======================================
-
-.. automodule:: telegram.inputtextmessagecontent
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.inputvenuemessagecontent.rst

@@ -1,7 +0,0 @@
-telegram.inputvenuemessagecontent module
-========================================
-
-.. automodule:: telegram.inputvenuemessagecontent
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.keyboardbutton.rst

@@ -1,7 +0,0 @@
-telegram.keyboardbutton module
-==============================
-
-.. automodule:: telegram.keyboardbutton
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.messageentity.rst

@@ -1,7 +0,0 @@
-telegram.messageentity module
-=============================
-
-.. automodule:: telegram.messageentity
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.nullhandler.rst

@@ -1,7 +1,7 @@
-telegram.webhookinfo module
+telegram.nullhandler module
 ===========================
 
-.. automodule:: telegram.webhookinfo
+.. automodule:: telegram.nullhandler
     :members:
     :undoc-members:
     :show-inheritance:

docs/source/telegram.parsemode.rst

@@ -1,7 +0,0 @@
-telegram.parsemode module
-=========================
-
-.. automodule:: telegram.parsemode
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.replykeyboardhide.rst

@@ -0,0 +1,7 @@
+telegram.replykeyboardhide module
+=================================
+
+.. automodule:: telegram.replykeyboardhide
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/telegram.replykeyboardremove.rst

@@ -1,7 +0,0 @@
-telegram.replykeyboardremove module
-===================================
-
-.. automodule:: telegram.replykeyboardremove
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.rst

@@ -6,30 +6,14 @@ Submodules
 
 .. toctree::
 
-   telegram.contrib
-   telegram.ext
-   telegram.animation
    telegram.audio
    telegram.base
    telegram.bot
-   telegram.callbackgame
-   telegram.callbackquery
-   telegram.chat
-   telegram.chataction
-   telegram.chatmember
-   telegram.choseninlineresult
-   telegram.constants
-   telegram.contact
-   telegram.document
-   telegram.error
-   telegram.file
-   telegram.forcereply
-   telegram.game
-   telegram.gamehighscore
-   telegram.inlinekeyboardbutton
-   telegram.inlinekeyboardmarkup
+   telegram.ext
    telegram.inlinequery
    telegram.inlinequeryresult
+   telegram.inlinekeyboardbutton
+   telegram.inlinekeyboardmarkup
    telegram.inlinequeryresultarticle
    telegram.inlinequeryresultaudio
    telegram.inlinequeryresultcachedaudio
@@ -42,7 +26,6 @@ Submodules
    telegram.inlinequeryresultcachedvoice
    telegram.inlinequeryresultcontact
    telegram.inlinequeryresultdocument
-   telegram.inlinequeryresultgame
    telegram.inlinequeryresultgif
    telegram.inlinequeryresultlocation
    telegram.inlinequeryresultmpeg4gif
@@ -50,29 +33,28 @@ Submodules
    telegram.inlinequeryresultvenue
    telegram.inlinequeryresultvideo
    telegram.inlinequeryresultvoice
-   telegram.inputcontactmessagecontent
+   telegram.choseninlineresult
+   telegram.chataction
+   telegram.contact
+   telegram.document
+   telegram.emoji
+   telegram.error
+   telegram.forcereply
+   telegram.chat
    telegram.inputfile
-   telegram.inputlocationmessagecontent
-   telegram.inputmessagecontent
-   telegram.inputtextmessagecontent
-   telegram.inputvenuemessagecontent
-   telegram.keyboardbutton
    telegram.location
    telegram.message
-   telegram.messageentity
-   telegram.parsemode
+   telegram.nullhandler
    telegram.photosize
-   telegram.replykeyboardremove
+   telegram.replykeyboardhide
    telegram.replykeyboardmarkup
    telegram.replymarkup
    telegram.sticker
    telegram.update
    telegram.user
    telegram.userprofilephotos
-   telegram.venue
    telegram.video
    telegram.voice
-   telegram.webhookinfo
 
 Module contents
 ---------------

examples/README.md

@@ -1,26 +0,0 @@
-# Examples
-
-The examples in this folder are small bots meant to show you how a bot that is written with `python-telegram-bot` looks like. Some bots focus on one specific aspect of the Telegram Bot API while others focus on one of the mechanics of this library. Except for the `echobot.py` example, they all use the high-level framework this library provides with the `telegram.ext` submodule.
-
-All examples are licensed under the [CC0 License](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/LICENSE.txt) and are therefore fully dedicated to the public domain. You can use them as the base for your own bots without worrying about copyrights.
-
-### [`echobot2.py`](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/echobot2.py) 
-This is probably the base for most of the bots made with `python-telegram-bot`. It simply replies to each text message with a message that contains the same text.
-
-### [`timerbot.py`](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/timerbot.py) 
-This bot uses the [`JobQueue`](https://python-telegram-bot.readthedocs.io/en/latest/telegram.ext.jobqueue.html) class to send timed messages. The user sets a timer by using `/set` command with a specific time, for example `/set 30`. The bot then sets up a job to send a message to that user after 30 seconds. The user can also cancel the timer by sending `/unset`. To learn more about the `JobQueue`, read [this wiki article](https://github.com/python-telegram-bot/python-telegram-bot/wiki/Extensions-%E2%80%93-JobQueue).
-
-### [`conversationbot.py`](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/conversationbot.py)
-A common task for a bot is to ask information from the user. In v5.0 of this library, we introduced the [`ConversationHandler`](https://python-telegram-bot.readthedocs.io/en/latest/telegram.ext.conversationhandler.html) for that exact purpose. This example uses it to retrieve user-information in a conversation-like style. To get a better understanding, take a look at the [state diagram](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/conversationbot.png).
-
-### [`conversationbot2.py`](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/conversationbot2.py)
-A more complex example of a bot that uses the `ConversationHandler`. It is also more confusing. Good thing there is a [fancy state diagram](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/conversationbot2.png) for this one, too!
-
-### [`inlinekeyboard.py`](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/inlinekeyboard.py)
-This example sheds some light on inline keyboards, callback queries and message editing.
-
-### [`inlinebot.py`](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/inlinebot.py)
-A basic example of an [inline bot](https://core.telegram.org/bots/inline). Don't forget to enable inline mode with [@BotFather](https://telegram.me/BotFather).
-
-## Pure API
-The [`echobot.py`](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/echobot.py) example uses only the pure, "bare-metal" API wrapper. 

examples/conversationbot.py

@@ -1,159 +0,0 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-#
-# Simple Bot to reply to Telegram messages
-# 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 callback functions are defined. Then, those functions are passed to
-the Dispatcher and registered at their respective places.
-Then, the bot is started and runs until we press Ctrl-C on the command line.
-
-Usage:
-Example of a bot-user conversation using ConversationHandler.
-Send /start to initiate the conversation.
-Press Ctrl-C on the command line or send a signal to the process to stop the
-bot.
-"""
-
-from telegram import (ReplyKeyboardMarkup, ReplyKeyboardRemove)
-from telegram.ext import (Updater, CommandHandler, MessageHandler, Filters, RegexHandler,
-                          ConversationHandler)
-
-import logging
-
-# Enable logging
-logging.basicConfig(format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
-                    level=logging.INFO)
-
-logger = logging.getLogger(__name__)
-
-GENDER, PHOTO, LOCATION, BIO = range(4)
-
-
-def start(bot, update):
-    reply_keyboard = [['Boy', 'Girl', 'Other']]
-
-    update.message.reply_text(
-        'Hi! My name is Professor Bot. I will hold a conversation with you. '
-        'Send /cancel to stop talking to me.\n\n'
-        'Are you a boy or a girl?',
-        reply_markup=ReplyKeyboardMarkup(reply_keyboard, one_time_keyboard=True))
-
-    return GENDER
-
-
-def gender(bot, update):
-    user = update.message.from_user
-    logger.info("Gender of %s: %s" % (user.first_name, update.message.text))
-    update.message.reply_text('I see! Please send me a photo of yourself, '
-                              'so I know what you look like, or send /skip if you don\'t want to.',
-                              reply_markup=ReplyKeyboardRemove())
-
-    return PHOTO
-
-
-def photo(bot, update):
-    user = update.message.from_user
-    photo_file = bot.get_file(update.message.photo[-1].file_id)
-    photo_file.download('user_photo.jpg')
-    logger.info("Photo of %s: %s" % (user.first_name, 'user_photo.jpg'))
-    update.message.reply_text('Gorgeous! Now, send me your location please, '
-                              'or send /skip if you don\'t want to.')
-
-    return LOCATION
-
-
-def skip_photo(bot, update):
-    user = update.message.from_user
-    logger.info("User %s did not send a photo." % user.first_name)
-    update.message.reply_text('I bet you look great! Now, send me your location please, '
-                              'or send /skip.')
-
-    return LOCATION
-
-
-def location(bot, update):
-    user = update.message.from_user
-    user_location = update.message.location
-    logger.info("Location of %s: %f / %f"
-                % (user.first_name, user_location.latitude, user_location.longitude))
-    update.message.reply_text('Maybe I can visit you sometime! '
-                              'At last, tell me something about yourself.')
-
-    return BIO
-
-
-def skip_location(bot, update):
-    user = update.message.from_user
-    logger.info("User %s did not send a location." % user.first_name)
-    update.message.reply_text('You seem a bit paranoid! '
-                              'At last, tell me something about yourself.')
-
-    return BIO
-
-
-def bio(bot, update):
-    user = update.message.from_user
-    logger.info("Bio of %s: %s" % (user.first_name, update.message.text))
-    update.message.reply_text('Thank you! I hope we can talk again some day.')
-
-    return ConversationHandler.END
-
-
-def cancel(bot, update):
-    user = update.message.from_user
-    logger.info("User %s canceled the conversation." % user.first_name)
-    update.message.reply_text('Bye! I hope we can talk again some day.',
-                              reply_markup=ReplyKeyboardRemove())
-
-    return ConversationHandler.END
-
-
-def error(bot, update, error):
-    logger.warn('Update "%s" caused error "%s"' % (update, error))
-
-
-def main():
-    # Create the EventHandler and pass it your bot's token.
-    updater = Updater("TOKEN")
-
-    # Get the dispatcher to register handlers
-    dp = updater.dispatcher
-
-    # Add conversation handler with the states GENDER, PHOTO, LOCATION and BIO
-    conv_handler = ConversationHandler(
-        entry_points=[CommandHandler('start', start)],
-
-        states={
-            GENDER: [RegexHandler('^(Boy|Girl|Other)$', gender)],
-
-            PHOTO: [MessageHandler(Filters.photo, photo),
-                    CommandHandler('skip', skip_photo)],
-
-            LOCATION: [MessageHandler(Filters.location, location),
-                       CommandHandler('skip', skip_location)],
-
-            BIO: [MessageHandler(Filters.text, bio)]
-        },
-
-        fallbacks=[CommandHandler('cancel', cancel)]
-    )
-
-    dp.add_handler(conv_handler)
-
-    # log all errors
-    dp.add_error_handler(error)
-
-    # Start the Bot
-    updater.start_polling()
-
-    # Run the bot until you press Ctrl-C or the process receives SIGINT,
-    # SIGTERM or SIGABRT. This should be used most of the time, since
-    # start_polling() is non-blocking and will stop the bot gracefully.
-    updater.idle()
-
-
-if __name__ == '__main__':
-    main()

examples/conversationbot2.py

@@ -1,152 +0,0 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-#
-# Simple Bot to reply to Telegram messages
-# 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 callback functions are defined. Then, those functions are passed to
-the Dispatcher and registered at their respective places.
-Then, the bot is started and runs until we press Ctrl-C on the command line.
-
-Usage:
-Example of a bot-user conversation using ConversationHandler.
-Send /start to initiate the conversation.
-Press Ctrl-C on the command line or send a signal to the process to stop the
-bot.
-"""
-
-from telegram import ReplyKeyboardMarkup
-from telegram.ext import (Updater, CommandHandler, MessageHandler, Filters, RegexHandler,
-                          ConversationHandler)
-
-import logging
-
-# Enable logging
-logging.basicConfig(format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
-                    level=logging.INFO)
-
-logger = logging.getLogger(__name__)
-
-CHOOSING, TYPING_REPLY, TYPING_CHOICE = range(3)
-
-reply_keyboard = [['Age', 'Favourite colour'],
-                  ['Number of siblings', 'Something else...'],
-                  ['Done']]
-markup = ReplyKeyboardMarkup(reply_keyboard, one_time_keyboard=True)
-
-
-def facts_to_str(user_data):
-    facts = list()
-
-    for key, value in user_data.items():
-        facts.append('%s - %s' % (key, value))
-
-    return "\n".join(facts).join(['\n', '\n'])
-
-
-def start(bot, update):
-    update.message.reply_text(
-        "Hi! My name is Doctor Botter. I will hold a more complex conversation with you. "
-        "Why don't you tell me something about yourself?",
-        reply_markup=markup)
-
-    return CHOOSING
-
-
-def regular_choice(bot, update, user_data):
-    text = update.message.text
-    user_data['choice'] = text
-    update.message.reply_text('Your %s? Yes, I would love to hear about that!' % text.lower())
-
-    return TYPING_REPLY
-
-
-def custom_choice(bot, update):
-    update.message.reply_text('Alright, please send me the category first, '
-                              'for example "Most impressive skill"')
-
-    return TYPING_CHOICE
-
-
-def received_information(bot, update, user_data):
-    text = update.message.text
-    category = user_data['choice']
-    user_data[category] = text
-    del user_data['choice']
-
-    update.message.reply_text("Neat! Just so you know, this is what you already told me:"
-                              "%s"
-                              "You can tell me more, or change your opinion on something."
-                              % facts_to_str(user_data),
-                              reply_markup=markup)
-
-    return CHOOSING
-
-
-def done(bot, update, user_data):
-    if 'choice' in user_data:
-        del user_data['choice']
-
-    update.message.reply_text("I learned these facts about you:"
-                              "%s"
-                              "Until next time!" % facts_to_str(user_data))
-
-    user_data.clear()
-    return ConversationHandler.END
-
-
-def error(bot, update, error):
-    logger.warn('Update "%s" caused error "%s"' % (update, error))
-
-
-def main():
-    # Create the Updater and pass it your bot's token.
-    updater = Updater("TOKEN")
-
-    # Get the dispatcher to register handlers
-    dp = updater.dispatcher
-
-    # Add conversation handler with the states GENDER, PHOTO, LOCATION and BIO
-    conv_handler = ConversationHandler(
-        entry_points=[CommandHandler('start', start)],
-
-        states={
-            CHOOSING: [RegexHandler('^(Age|Favourite colour|Number of siblings)$',
-                                    regular_choice,
-                                    pass_user_data=True),
-                       RegexHandler('^Something else...$',
-                                    custom_choice),
-                       ],
-
-            TYPING_CHOICE: [MessageHandler(Filters.text,
-                                           regular_choice,
-                                           pass_user_data=True),
-                            ],
-
-            TYPING_REPLY: [MessageHandler(Filters.text,
-                                          received_information,
-                                          pass_user_data=True),
-                           ],
-        },
-
-        fallbacks=[RegexHandler('^Done$', done, pass_user_data=True)]
-    )
-
-    dp.add_handler(conv_handler)
-
-    # log all errors
-    dp.add_error_handler(error)
-
-    # Start the Bot
-    updater.start_polling()
-
-    # Run the bot until you press Ctrl-C or the process receives SIGINT,
-    # SIGTERM or SIGABRT. This should be used most of the time, since
-    # start_polling() is non-blocking and will stop the bot gracefully.
-    updater.idle()
-
-
-if __name__ == '__main__':
-    main()

examples/echobot.py

@@ -20,7 +20,7 @@ def main():
     # get the first pending update_id, this is so we can skip over it in case
     # we get an "Unauthorized" exception.
     try:
-        update_id = bot.get_updates()[0].update_id
+        update_id = bot.getUpdates()[0].update_id
     except IndexError:
         update_id = None
 
@@ -39,12 +39,14 @@ def main():
 def echo(bot):
     global update_id
     # Request updates after the last update_id
-    for update in bot.get_updates(offset=update_id, timeout=10):
+    for update in bot.getUpdates(offset=update_id, timeout=10):
+        # chat_id is required to reply to any message
+        chat_id = update.message.chat_id
         update_id = update.update_id + 1
 
         if update.message:  # your bot can receive updates without messages
             # Reply to the message
-            update.message.reply_text(update.message.text)
+            bot.sendMessage(chat_id=chat_id, text=update.message.text)
 
 
 if __name__ == '__main__':

examples/echobot2.py

@@ -29,15 +29,15 @@ logger = logging.getLogger(__name__)
 # Define a few command handlers. These usually take the two arguments bot and
 # update. Error handlers also receive the raised TelegramError object in error.
 def start(bot, update):
-    update.message.reply_text('Hi!')
+    bot.sendMessage(update.message.chat_id, text='Hi!')
 
 
 def help(bot, update):
-    update.message.reply_text('Help!')
+    bot.sendMessage(update.message.chat_id, text='Help!')
 
 
 def echo(bot, update):
-    update.message.reply_text(update.message.text)
+    bot.sendMessage(update.message.chat_id, text=update.message.text)
 
 
 def error(bot, update, error):
@@ -56,7 +56,7 @@ def main():
     dp.add_handler(CommandHandler("help", help))
 
     # on noncommand i.e message - echo the message on Telegram
-    dp.add_handler(MessageHandler(Filters.text, echo))
+    dp.add_handler(MessageHandler([Filters.text], echo))
 
     # log all errors
     dp.add_error_handler(error)
@@ -64,7 +64,7 @@ def main():
     # Start the Bot
     updater.start_polling()
 
-    # Run the bot until you press Ctrl-C or the process receives SIGINT,
+    # Run the bot until the you presses Ctrl-C or the process receives SIGINT,
     # SIGTERM or SIGABRT. This should be used most of the time, since
     # start_polling() is non-blocking and will stop the bot gracefully.
     updater.idle()

examples/inlinebot.py

@@ -34,11 +34,11 @@ logger = logging.getLogger(__name__)
 # Define a few command handlers. These usually take the two arguments bot and
 # update. Error handlers also receive the raised TelegramError object in error.
 def start(bot, update):
-    update.message.reply_text('Hi!')
+    bot.sendMessage(update.message.chat_id, text='Hi!')
 
 
 def help(bot, update):
-    update.message.reply_text('Help!')
+    bot.sendMessage(update.message.chat_id, text='Help!')
 
 
 def escape_markdown(text):
@@ -68,11 +68,11 @@ def inlinequery(bot, update):
                                                 "_%s_" % escape_markdown(query),
                                                 parse_mode=ParseMode.MARKDOWN)))
 
-    update.inline_query.answer(results)
+    bot.answerInlineQuery(update.inline_query.id, results=results)
 
 
 def error(bot, update, error):
-    logger.warning('Update "%s" caused error "%s"' % (update, error))
+    logger.warn('Update "%s" caused error "%s"' % (update, error))
 
 
 def main():

examples/inlinekeyboard.py

@@ -1,49 +1,108 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 #
-# Basic example for a bot that uses inline keyboards.
+# Basic example for a bot that awaits an answer from the user. It's built upon
+# the state_machine_bot.py example
 # This program is dedicated to the public domain under the CC0 license.
 
 import logging
-from telegram import InlineKeyboardButton, InlineKeyboardMarkup
-from telegram.ext import Updater, CommandHandler, CallbackQueryHandler
+from telegram import Emoji, ForceReply, InlineKeyboardButton, \
+    InlineKeyboardMarkup
+from telegram.ext import Updater, CommandHandler, MessageHandler, \
+    CallbackQueryHandler, Filters
 
 logging.basicConfig(format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
-                    level=logging.INFO)
+                    level=logging.DEBUG)
+
+# Define the different states a chat can be in
+MENU, AWAIT_CONFIRMATION, AWAIT_INPUT = range(3)
+
+# Python 2 and 3 unicode differences
+try:
+    YES, NO = (Emoji.THUMBS_UP_SIGN.decode('utf-8'), Emoji.THUMBS_DOWN_SIGN.decode('utf-8'))
+except AttributeError:
+    YES, NO = (Emoji.THUMBS_UP_SIGN, Emoji.THUMBS_DOWN_SIGN)
+
+# States are saved in a dict that maps chat_id -> state
+state = dict()
+# Sometimes you need to save data temporarily
+context = dict()
+# This dict is used to store the settings value for the chat.
+# Usually, you'd use persistence for this (e.g. sqlite).
+values = dict()
 
 
-def start(bot, update):
-    keyboard = [[InlineKeyboardButton("Option 1", callback_data='1'),
-                 InlineKeyboardButton("Option 2", callback_data='2')],
+# Example handler. Will be called on the /set command and on regular messages
+def set_value(bot, update):
+    chat_id = update.message.chat_id
+    user_id = update.message.from_user.id
+    user_state = state.get(chat_id, MENU)
 
-                [InlineKeyboardButton("Option 3", callback_data='3')]]
-
-    reply_markup = InlineKeyboardMarkup(keyboard)
-
-    update.message.reply_text('Please choose:', reply_markup=reply_markup)
+    if user_state == MENU:
+        state[user_id] = AWAIT_INPUT  # set the state
+        bot.sendMessage(chat_id,
+                        text="Please enter your settings value",
+                        reply_markup=ForceReply())
 
 
-def button(bot, update):
+def entered_value(bot, update):
+    chat_id = update.message.chat_id
+    user_id = update.message.from_user.id
+    chat_state = state.get(user_id, MENU)
+
+    # Check if we are waiting for input
+    if chat_state == AWAIT_INPUT:
+        state[user_id] = AWAIT_CONFIRMATION
+
+        # Save the user id and the answer to context
+        context[user_id] = update.message.text
+        reply_markup = InlineKeyboardMarkup([[InlineKeyboardButton(YES, callback_data=YES),
+                                              InlineKeyboardButton(NO, callback_data=NO)]])
+        bot.sendMessage(chat_id, text="Are you sure?", reply_markup=reply_markup)
+
+
+def confirm_value(bot, update):
     query = update.callback_query
+    chat_id = query.message.chat_id
+    user_id = query.from_user.id
+    text = query.data
+    user_state = state.get(user_id, MENU)
+    user_context = context.get(user_id, None)
 
-    bot.edit_message_text(text="Selected option: %s" % query.data,
-                          chat_id=query.message.chat_id,
-                          message_id=query.message.message_id)
+    # Check if we are waiting for confirmation and the right user answered
+    if user_state == AWAIT_CONFIRMATION:
+        del state[user_id]
+        del context[user_id]
+        bot.answerCallbackQuery(query.id, text="Ok!")
+        if text == YES:
+            values[user_id] = user_context
+            bot.editMessageText(text="Changed value to %s." % values[user_id],
+                                chat_id=chat_id,
+                                message_id=query.message.message_id)
+        else:
+            bot.editMessageText(text="Alright, value is still %s." %
+                                values.get(user_id, 'not set'),
+                                chat_id=chat_id,
+                                message_id=query.message.message_id)
 
 
 def help(bot, update):
-    update.message.reply_text("Use /start to test this bot.")
+    bot.sendMessage(update.message.chat_id, text="Use /set to test this bot.")
 
 
 def error(bot, update, error):
     logging.warning('Update "%s" caused error "%s"' % (update, error))
 
-
 # Create the Updater and pass it your bot's token.
 updater = Updater("TOKEN")
 
-updater.dispatcher.add_handler(CommandHandler('start', start))
-updater.dispatcher.add_handler(CallbackQueryHandler(button))
+# The command
+updater.dispatcher.add_handler(CommandHandler('set', set_value))
+# The answer
+updater.dispatcher.add_handler(MessageHandler([Filters.text], entered_value))
+# The confirmation
+updater.dispatcher.add_handler(CallbackQueryHandler(confirm_value))
+updater.dispatcher.add_handler(CommandHandler('start', help))
 updater.dispatcher.add_handler(CommandHandler('help', help))
 updater.dispatcher.add_error_handler(error)
 

examples/paymentbot.py

@@ -1,146 +0,0 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-#
-# Basic example for a bot that can receive payment from user.
-# This program is dedicated to the public domain under the CC0 license.
-
-from telegram import (LabeledPrice, ShippingOption)
-from telegram.ext import (Updater, CommandHandler, MessageHandler,
-                          Filters, PreCheckoutQueryHandler, ShippingQueryHandler)
-import logging
-
-# Enable logging
-logging.basicConfig(format='%(asctime)s - %(name)s - %(levelname)s - %(message)s', level=logging.INFO)
-
-logger = logging.getLogger(__name__)
-
-
-def error(bot, update, error):
-    logger.warn('Update "%s" caused error "%s"' % (update, error))
-
-
-def start_callback(bot, update):
-    msg = "Use /shipping to get an invoice for shipping-payment, "
-    msg += "or /noshipping for an invoice without shipping."
-    update.message.reply_text(msg)
-
-
-def start_with_shipping_callback(bot, update):
-    chat_id = update.message.chat_id
-    title = "Payment Example"
-    description = "Payment Example using python-telegram-bot"
-    # select a payload just for you to recognize its the donation from your bot
-    payload = "Custom-Payload"
-    # get your provider_token at @botfather, see https://core.telegram.org/bots/payments#getting-a-token
-    provider_token = "PROVIDER_TOKEN"
-    start_parameter = "test-payment"
-    currency = "USD"
-    # price in dollars
-    price = 1
-    # price * 100 so as to include 2 d.p.
-    # check https://core.telegram.org/bots/payments#supported-currencies for more details
-    prices = [LabeledPrice("Test", price * 100)]
-
-    # optionally pass need_name=True, need_phone_number=True,
-    # need_email=True, need_shipping_address=True, is_flexible=True
-    bot.sendInvoice(chat_id, title, description, payload,
-                    provider_token, start_parameter, currency, prices,
-                    need_name=True, need_phone_number=True,
-                    need_email=True, need_shipping_address=True, is_flexible=True)
-
-
-def start_without_shipping_callback(bot, update):
-    chat_id = update.message.chat_id
-    title = "Payment Example"
-    description = "Payment Example using python-telegram-bot"
-    # select a payload just for you to recognize its the donation from your bot
-    payload = "Custom-Payload"
-    # get your provider_token at @botfather, see https://core.telegram.org/bots/payments#getting-a-token
-    provider_token = "PROVIDER_TOKEN"
-    start_parameter = "test-payment"
-    currency = "USD"
-    # price in dollars
-    price = 1
-    # price * 100 so as to include 2 d.p.
-    prices = [LabeledPrice("Test", price * 100)]
-
-    # optionally pass need_name=True, need_phone_number=True,
-    # need_email=True, need_shipping_address=True, is_flexible=True
-    bot.sendInvoice(chat_id, title, description, payload,
-                    provider_token, start_parameter, currency, prices)
-
-
-def shipping_callback(bot, update):
-    query = update.shipping_query
-    # check the payload, is this from your bot?
-    if query.invoice_payload != 'Custom-Payload':
-        # answer False pre_checkout_query
-        bot.answer_shipping_query(shipping_query_id=query.id, ok=False,
-                                  error_message="Something went wrong...")
-        return
-    else:
-        options = list()
-        # a single LabeledPrice
-        options.append(ShippingOption('1', 'Shipping Option A', [LabeledPrice('A', 100)]))
-        # an array of LabeledPrice objects
-        price_list = [LabeledPrice('B1', 150), LabeledPrice('B2', 200)]
-        options.append(ShippingOption('2', 'Shipping Option B', price_list))
-        bot.answer_shipping_query(shipping_query_id=query.id, ok=True,
-                                  shipping_options=options)
-
-
-# after (optional) shipping, it's the pre-checkout
-def precheckout_callback(bot, update):
-    query = update.pre_checkout_query
-    # check the payload, is this from your bot?
-    if query.invoice_payload != 'Custom-Payload':
-        # answer False pre_checkout_query
-        bot.answer_pre_checkout_query(pre_checkout_query_id=query.id, ok=False,
-                                      error_message="Something went wrong...")
-    else:
-        bot.answer_pre_checkout_query(pre_checkout_query_id=query.id, ok=True)
-
-
-# finally, after contacting to the payment provider...
-def successful_payment_callback(bot, update):
-    # do something after successful receive of payment?
-    update.message.reply_text("Thank you for your payment!")
-
-
-def main():
-    # Create the EventHandler and pass it your bot's token.
-    updater = Updater(token="BOT_TOKEN")
-
-    # Get the dispatcher to register handlers
-    dp = updater.dispatcher
-
-    # simple start function
-    dp.add_handler(CommandHandler("start", start_callback))
-
-    # Add command handler to start the payment invoice
-    dp.add_handler(CommandHandler("shipping", start_with_shipping_callback))
-    dp.add_handler(CommandHandler("noshipping", start_without_shipping_callback))
-
-    # Optional handler if your product requires shipping
-    dp.add_handler(ShippingQueryHandler(shipping_callback))
-
-    # Pre-checkout handler to final check
-    dp.add_handler(PreCheckoutQueryHandler(precheckout_callback))
-
-    # Success! Notify your user!
-    dp.add_handler(MessageHandler(Filters.successful_payment, successful_payment_callback))
-
-    # log all errors
-    dp.add_error_handler(error)
-
-    # Start the Bot
-    updater.start_polling()
-
-    # Run the bot until you press Ctrl-C or the process receives SIGINT,
-    # SIGTERM or SIGABRT. This should be used most of the time, since
-    # start_polling() is non-blocking and will stop the bot gracefully.
-    updater.idle()
-
-
-if __name__ == '__main__':
-    main()

examples/state_machine_bot.py

@@ -0,0 +1,100 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# Basic example for a bot that awaits an answer from the user
+# This program is dedicated to the public domain under the CC0 license.
+
+import logging
+from telegram import Emoji, ForceReply, ReplyKeyboardMarkup, KeyboardButton
+from telegram.ext import Updater, CommandHandler, MessageHandler, Filters
+
+logging.basicConfig(format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
+                    level=logging.INFO)
+
+# Define the different states a chat can be in
+MENU, AWAIT_CONFIRMATION, AWAIT_INPUT = range(3)
+
+# Python 2 and 3 unicode differences
+try:
+    YES, NO = (Emoji.THUMBS_UP_SIGN.decode('utf-8'), Emoji.THUMBS_DOWN_SIGN.decode('utf-8'))
+except AttributeError:
+    YES, NO = (Emoji.THUMBS_UP_SIGN, Emoji.THUMBS_DOWN_SIGN)
+
+# States are saved in a dict that maps chat_id -> state
+state = dict()
+# Sometimes you need to save data temporarily
+context = dict()
+# This dict is used to store the settings value for the chat.
+# Usually, you'd use persistence for this (e.g. sqlite).
+values = dict()
+
+
+# Example handler. Will be called on the /set command and on regular messages
+def set_value(bot, update):
+    chat_id = update.message.chat_id
+    user_id = update.message.from_user.id
+    text = update.message.text
+    chat_state = state.get(chat_id, MENU)
+    chat_context = context.get(chat_id, None)
+
+    # Since the handler will also be called on messages, we need to check if
+    # the message is actually a command
+    if chat_state == MENU and text[0] == '/':
+        state[chat_id] = AWAIT_INPUT  # set the state
+        context[chat_id] = user_id  # save the user id to context
+        bot.sendMessage(chat_id,
+                        text="Please enter your settings value or send "
+                        "/cancel to abort",
+                        reply_markup=ForceReply())
+
+    # If we are waiting for input and the right user answered
+    elif chat_state == AWAIT_INPUT and chat_context == user_id:
+        state[chat_id] = AWAIT_CONFIRMATION
+
+        # Save the user id and the answer to context
+        context[chat_id] = (user_id, update.message.text)
+        reply_markup = ReplyKeyboardMarkup(
+            [[KeyboardButton(YES), KeyboardButton(NO)]],
+            one_time_keyboard=True)
+        bot.sendMessage(chat_id, text="Are you sure?", reply_markup=reply_markup)
+
+    # If we are waiting for confirmation and the right user answered
+    elif chat_state == AWAIT_CONFIRMATION and chat_context[0] == user_id:
+        del state[chat_id]
+        del context[chat_id]
+        if text == YES:
+            values[chat_id] = chat_context[1]
+            bot.sendMessage(chat_id, text="Changed value to %s." % values[chat_id])
+        else:
+            bot.sendMessage(chat_id,
+                            text="Value not changed: %s." % values.get(chat_id, '<not set>'))
+
+
+# Handler for the /cancel command.
+# Sets the state back to MENU and clears the context
+def cancel(bot, update):
+    chat_id = update.message.chat_id
+    del state[chat_id]
+    del context[chat_id]
+
+
+def help(bot, update):
+    bot.sendMessage(update.message.chat_id, text="Use /set to test this bot.")
+
+# Create the Updater and pass it your bot's token.
+updater = Updater("TOKEN")
+
+# The command
+updater.dispatcher.add_handler(CommandHandler('set', set_value))
+# The answer and confirmation
+updater.dispatcher.add_handler(MessageHandler([Filters.text], set_value))
+updater.dispatcher.add_handler(CommandHandler('cancel', cancel))
+updater.dispatcher.add_handler(CommandHandler('start', help))
+updater.dispatcher.add_handler(CommandHandler('help', help))
+
+# Start the Bot
+updater.start_polling()
+
+# Run the bot until the user presses Ctrl-C or the process receives SIGINT,
+# SIGTERM or SIGABRT
+updater.idle()

examples/timerbot.py

@@ -17,7 +17,7 @@ Press Ctrl-C on the command line or send a signal to the process to stop the
 bot.
 """
 
-from telegram.ext import Updater, CommandHandler, Job
+from telegram.ext import Updater, CommandHandler
 import logging
 
 # Enable logging
@@ -25,59 +25,47 @@ logging.basicConfig(format='%(asctime)s - %(name)s - %(levelname)s - %(message)s
                     level=logging.INFO)
 
 logger = logging.getLogger(__name__)
+job_queue = None
 
 
 # Define a few command handlers. These usually take the two arguments bot and
 # update. Error handlers also receive the raised TelegramError object in error.
 def start(bot, update):
-    update.message.reply_text('Hi! Use /set <seconds> to set a timer')
+    bot.sendMessage(update.message.chat_id, text='Hi! Use /set <seconds> to ' 'set a timer')
 
 
-def alarm(bot, job):
-    """Function to send the alarm message"""
-    bot.send_message(job.context, text='Beep!')
-
-
-def set(bot, update, args, job_queue, chat_data):
-    """Adds a job to the queue"""
+def set(bot, update, args):
+    """ Adds a job to the queue """
     chat_id = update.message.chat_id
     try:
         # args[0] should contain the time for the timer in seconds
         due = int(args[0])
         if due < 0:
-            update.message.reply_text('Sorry we can not go back to future!')
-            return
+            bot.sendMessage(chat_id, text='Sorry we can not go back to future!')
+
+        def alarm(bot):
+            """ Inner function to send the alarm message """
+            bot.sendMessage(chat_id, text='Beep!')
 
         # Add job to queue
-        job = job_queue.run_once(alarm, due, context=chat_id)
-        chat_data['job'] = job
+        job_queue.put(alarm, due, repeat=False)
+        bot.sendMessage(chat_id, text='Timer successfully set!')
 
-        update.message.reply_text('Timer successfully set!')
-
-    except (IndexError, ValueError):
-        update.message.reply_text('Usage: /set <seconds>')
-
-
-def unset(bot, update, chat_data):
-    """Removes the job if the user changed their mind"""
-
-    if 'job' not in chat_data:
-        update.message.reply_text('You have no active timer')
-        return
-
-    job = chat_data['job']
-    job.schedule_removal()
-    del chat_data['job']
-
-    update.message.reply_text('Timer successfully unset!')
+    except IndexError:
+        bot.sendMessage(chat_id, text='Usage: /set <seconds>')
+    except ValueError:
+        bot.sendMessage(chat_id, text='Usage: /set <seconds>')
 
 
 def error(bot, update, error):
-    logger.warning('Update "%s" caused error "%s"' % (update, error))
+    logger.warn('Update "%s" caused error "%s"' % (update, error))
 
 
 def main():
+    global job_queue
+
     updater = Updater("TOKEN")
+    job_queue = updater.job_queue
 
     # Get the dispatcher to register handlers
     dp = updater.dispatcher
@@ -85,11 +73,7 @@ def main():
     # on different commands - answer in Telegram
     dp.add_handler(CommandHandler("start", start))
     dp.add_handler(CommandHandler("help", start))
-    dp.add_handler(CommandHandler("set", set,
-                                  pass_args=True,
-                                  pass_job_queue=True,
-                                  pass_chat_data=True))
-    dp.add_handler(CommandHandler("unset", unset, pass_chat_data=True))
+    dp.add_handler(CommandHandler("set", set, pass_args=True))
 
     # log all errors
     dp.add_error_handler(error)
@@ -97,9 +81,9 @@ def main():
     # Start the Bot
     updater.start_polling()
 
-    # Block until you press Ctrl-C or the process receives SIGINT, SIGTERM or
-    # SIGABRT. This should be used most of the time, since start_polling() is
-    # non-blocking and will stop the bot gracefully.
+    # Block until the you presses Ctrl-C or the process receives SIGINT,
+    # SIGTERM or SIGABRT. This should be used most of the time, since
+    # start_polling() is non-blocking and will stop the bot gracefully.
     updater.idle()
 
 

requirements-dev.txt

@@ -2,6 +2,7 @@ flake8
 nose
 pep257
 pylint
+unittest2
 flaky
 yapf
 pre-commit

requirements.txt

@@ -1,2 +1,3 @@
 future>=0.15.2
+urllib3>=1.10
 certifi

setup.py

@@ -2,7 +2,7 @@
 """The setup and build script for the python-telegram-bot library."""
 
 import codecs
-import os
+import telegram
 from setuptools import setup, find_packages
 
 
@@ -16,30 +16,18 @@ def requirements():
 
     return requirements_list
 
-
-packages = find_packages(exclude=['tests*'])
-
 with codecs.open('README.rst', 'r', 'utf-8') as fd:
-    fn = os.path.join('telegram', 'version.py')
-    with open(fn) as fh:
-        code = compile(fh.read(), fn, 'exec')
-        exec(code)
-
     setup(name='python-telegram-bot',
-          version=__version__,
+          version=telegram.__version__,
           author='Leandro Toledo',
           author_email='devs@python-telegram-bot.org',
           license='LGPLv3',
-          url='https://python-telegram-bot.org/',
+          url='https://github.com/python-telegram-bot/python-telegram-bot',
           keywords='python telegram bot api wrapper',
-          description="We have made you a wrapper you can't refuse",
+          description='Not just a Python wrapper around the Telegram Bot API',
           long_description=fd.read(),
-          packages=packages,
+          packages=find_packages(exclude=['tests*']),
           install_requires=requirements(),
-          extras_require={
-              'json': 'ujson',
-              'socks': 'PySocks'
-          },
           include_package_data=True,
           classifiers=[
               'Development Status :: 5 - Production/Stable',
@@ -51,10 +39,10 @@ with codecs.open('README.rst', 'r', 'utf-8') as fd:
               'Topic :: Internet',
               'Programming Language :: Python',
               'Programming Language :: Python :: 2',
+              'Programming Language :: Python :: 2.6',
               'Programming Language :: Python :: 2.7',
               'Programming Language :: Python :: 3',
               'Programming Language :: Python :: 3.3',
               'Programming Language :: Python :: 3.4',
               'Programming Language :: Python :: 3.5',
-              'Programming Language :: Python :: 3.6'
           ],)

telegram/__init__.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 #
 # A library that provides a Python interface to the Telegram Bot API
-# Copyright (C) 2015-2017
+# Copyright (C) 2015-2016
 # Leandro Toledo de Souza <devs@python-telegram-bot.org>
 #
 # This program is free software: you can redistribute it and/or modify
@@ -19,8 +19,6 @@
 """A library that provides a Python interface to the Telegram Bot API"""
 
 from sys import version_info
-import sys
-import os
 
 from .base import TelegramObject
 from .user import User
@@ -40,20 +38,15 @@ from .userprofilephotos import UserProfilePhotos
 from .keyboardbutton import KeyboardButton
 from .replymarkup import ReplyMarkup
 from .replykeyboardmarkup import ReplyKeyboardMarkup
-from .replykeyboardremove import ReplyKeyboardRemove, ReplyKeyboardHide
+from .replykeyboardhide import ReplyKeyboardHide
 from .forcereply import ForceReply
 from .error import TelegramError
 from .inputfile import InputFile
 from .file import File
+from .nullhandler import NullHandler
 from .emoji import Emoji
 from .parsemode import ParseMode
 from .messageentity import MessageEntity
-from .animation import Animation
-from .game import Game
-from .shippingaddress import ShippingAddress
-from .orderinfo import OrderInfo
-from .successfulpayment import SuccessfulPayment
-from .invoice import Invoice
 from .message import Message
 from .inputmessagecontent import InputMessageContent
 from .callbackquery import CallbackQuery
@@ -81,47 +74,34 @@ from .inlinequeryresultphoto import InlineQueryResultPhoto
 from .inlinequeryresultvenue import InlineQueryResultVenue
 from .inlinequeryresultvideo import InlineQueryResultVideo
 from .inlinequeryresultvoice import InlineQueryResultVoice
-from .inlinequeryresultgame import InlineQueryResultGame
 from .inputtextmessagecontent import InputTextMessageContent
 from .inputlocationmessagecontent import InputLocationMessageContent
 from .inputvenuemessagecontent import InputVenueMessageContent
 from .inputcontactmessagecontent import InputContactMessageContent
-from .labeledprice import LabeledPrice
-from .shippingoption import ShippingOption
-from .precheckoutquery import PreCheckoutQuery
-from .shippingquery import ShippingQuery
-from .webhookinfo import WebhookInfo
-from .gamehighscore import GameHighScore
-from .videonote import VideoNote
 from .update import Update
 from .bot import Bot
-from .constants import (MAX_MESSAGE_LENGTH, MAX_CAPTION_LENGTH, SUPPORTED_WEBHOOK_PORTS,
-                        MAX_FILESIZE_DOWNLOAD, MAX_FILESIZE_UPLOAD,
-                        MAX_MESSAGES_PER_SECOND_PER_CHAT, MAX_MESSAGES_PER_SECOND,
-                        MAX_MESSAGES_PER_MINUTE_PER_GROUP)
-from .version import __version__  # flake8: noqa
 
 __author__ = 'devs@python-telegram-bot.org'
+__version__ = '4.3.4'
+__all__ = ['Audio', 'Bot', 'Chat', 'ChatMember', 'ChatAction', 'ChosenInlineResult',
+           'CallbackQuery', 'Contact', 'Document', 'Emoji', 'File', 'ForceReply',
+           'InlineKeyboardButton', 'InlineKeyboardMarkup', 'InlineQuery', 'InlineQueryResult',
+           'InlineQueryResult', 'InlineQueryResultArticle', 'InlineQueryResultAudio',
+           'InlineQueryResultCachedAudio', 'InlineQueryResultCachedDocument',
+           'InlineQueryResultCachedGif', 'InlineQueryResultCachedMpeg4Gif',
+           'InlineQueryResultCachedPhoto', 'InlineQueryResultCachedSticker',
+           'InlineQueryResultCachedVideo', 'InlineQueryResultCachedVoice',
+           'InlineQueryResultContact', 'InlineQueryResultDocument', 'InlineQueryResultGif',
+           'InlineQueryResultLocation', 'InlineQueryResultMpeg4Gif', 'InlineQueryResultPhoto',
+           'InlineQueryResultVenue', 'InlineQueryResultVideo', 'InlineQueryResultVoice',
+           'InputContactMessageContent', 'InputFile', 'InputLocationMessageContent',
+           'InputMessageContent', 'InputTextMessageContent', 'InputVenueMessageContent',
+           'KeyboardButton', 'Location', 'Message', 'MessageEntity', 'NullHandler', 'ParseMode',
+           'PhotoSize', 'ReplyKeyboardHide', 'ReplyKeyboardMarkup', 'ReplyMarkup', 'Sticker',
+           'TelegramError', 'TelegramObject', 'Update', 'User', 'UserProfilePhotos', 'Venue',
+           'Video', 'Voice']
 
-__all__ = [
-    'Audio', 'Bot', 'Chat', 'ChatMember', 'ChatAction', 'ChosenInlineResult', 'CallbackQuery',
-    'Contact', 'Document', 'Emoji', 'File', 'ForceReply', 'InlineKeyboardButton',
-    'InlineKeyboardMarkup', 'InlineQuery', 'InlineQueryResult', 'InlineQueryResult',
-    'InlineQueryResultArticle', 'InlineQueryResultAudio', 'InlineQueryResultCachedAudio',
-    'InlineQueryResultCachedDocument', 'InlineQueryResultCachedGif',
-    'InlineQueryResultCachedMpeg4Gif', 'InlineQueryResultCachedPhoto',
-    'InlineQueryResultCachedSticker', 'InlineQueryResultCachedVideo',
-    'InlineQueryResultCachedVoice', 'InlineQueryResultContact', 'InlineQueryResultDocument',
-    'InlineQueryResultGif', 'InlineQueryResultLocation', 'InlineQueryResultMpeg4Gif',
-    'InlineQueryResultPhoto', 'InlineQueryResultVenue', 'InlineQueryResultVideo',
-    'InlineQueryResultVoice', 'InlineQueryResultGame', 'InputContactMessageContent', 'InputFile',
-    'InputLocationMessageContent', 'InputMessageContent', 'InputTextMessageContent',
-    'InputVenueMessageContent', 'KeyboardButton', 'Location', 'Message', 'MessageEntity',
-    'ParseMode', 'PhotoSize', 'ReplyKeyboardRemove', 'ReplyKeyboardMarkup', 'ReplyMarkup',
-    'Sticker', 'TelegramError', 'TelegramObject', 'Update', 'User', 'UserProfilePhotos', 'Venue',
-    'Video', 'Voice', 'MAX_MESSAGE_LENGTH', 'MAX_CAPTION_LENGTH', 'SUPPORTED_WEBHOOK_PORTS',
-    'MAX_FILESIZE_DOWNLOAD', 'MAX_FILESIZE_UPLOAD', 'MAX_MESSAGES_PER_SECOND_PER_CHAT',
-    'MAX_MESSAGES_PER_SECOND', 'MAX_MESSAGES_PER_MINUTE_PER_GROUP', 'WebhookInfo', 'Animation',
-    'Game', 'GameHighScore', 'VideoNote', 'LabeledPrice', 'SuccessfulPayment', 'ShippingOption',
-    'ShippingAddress', 'PreCheckoutQuery', 'OrderInfo', 'Invoice', 'ShippingQuery'
-]
+if version_info < (2, 7):
+    from warnings import warn
+    warn("python-telegram-bot will stop supporting Python 2.6 in a future release. "
+         "Please upgrade your Python version to at least Python 2.7!")

telegram/__main__.py

@@ -1,23 +0,0 @@
-import sys
-
-import urllib3
-import certifi
-import future
-
-from . import __version__ as telegram_ver
-
-
-def print_ver_info():
-    print('python-telegram-bot {0}'.format(telegram_ver))
-    print('urllib3 {0}'.format(urllib3.__version__))
-    print('certifi {0}'.format(certifi.__version__))
-    print('future {0}'.format(future.__version__))
-    print('Python {0}'.format(sys.version.replace('\n', ' ')))
-
-
-def main():
-    print_ver_info()
-
-
-if __name__ == '__main__':
-    main()

telegram/animation.py

@@ -1,70 +0,0 @@
-#!/usr/bin/env python
-#
-# A library that provides a Python interface to the Telegram Bot API
-# Copyright (C) 2015-2017
-# Leandro Toledo de Souza <devs@python-telegram-bot.org>
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser Public License for more details.
-#
-# You should have received a copy of the GNU Lesser Public License
-# along with this program.  If not, see [http://www.gnu.org/licenses/].
-"""This module contains an object that represents a Telegram Animation."""
-from telegram import PhotoSize
-from telegram import TelegramObject
-
-
-class Animation(TelegramObject):
-    """This object represents a Telegram Animation.
-
-    Attributes:
-        file_id (str): Unique file identifier.
-
-    Keyword Args:
-        thumb (Optional[:class:`telegram.PhotoSize`]): Animation thumbnail as defined by sender.
-        file_name (Optional[str]): Original animation filename as defined by sender.
-        mime_type (Optional[str]): MIME type of the file as defined by sender.
-        file_size (Optional[int]): File size.
-
-    """
-
-    def __init__(self,
-                 file_id,
-                 thumb=None,
-                 file_name=None,
-                 mime_type=None,
-                 file_size=None,
-                 **kwargs):
-        self.file_id = file_id
-        self.thumb = thumb
-        self.file_name = file_name
-        self.mime_type = mime_type
-        self.file_size = file_size
-
-        self._id_attrs = (self.file_id,)
-
-    @staticmethod
-    def de_json(data, bot):
-        """
-        Args:
-            data (dict):
-            bot (telegram.Bot):
-
-        Returns:
-            telegram.Game:
-        """
-        if not data:
-            return None
-
-        data = super(Animation, Animation).de_json(data, bot)
-
-        data['thumb'] = PhotoSize.de_json(data.get('thumb'), bot)
-
-        return Animation(**data)

telegram/audio.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 #
 # A library that provides a Python interface to the Telegram Bot API
-# Copyright (C) 2015-2017
+# Copyright (C) 2015-2016
 # Leandro Toledo de Souza <devs@python-telegram-bot.org>
 #
 # This program is free software: you can redistribute it and/or modify
@@ -16,7 +16,7 @@
 #
 # You should have received a copy of the GNU Lesser Public License
 # along with this program.  If not, see [http://www.gnu.org/licenses/].
-"""This module contains an object that represents a Telegram Audio."""
+"""This module contains a object that represents a Telegram Audio."""
 
 from telegram import TelegramObject
 
@@ -35,39 +35,30 @@ class Audio(TelegramObject):
     Args:
         file_id (str):
         duration (int):
+        **kwargs: Arbitrary keyword arguments.
+
+    Keyword Args:
         performer (Optional[str]):
         title (Optional[str]):
         mime_type (Optional[str]):
         file_size (Optional[int]):
-        **kwargs: Arbitrary keyword arguments.
-
     """
 
-    def __init__(self,
-                 file_id,
-                 duration,
-                 performer=None,
-                 title=None,
-                 mime_type=None,
-                 file_size=None,
-                 **kwargs):
+    def __init__(self, file_id, duration, **kwargs):
         # Required
         self.file_id = str(file_id)
         self.duration = int(duration)
         # Optionals
-        self.performer = performer
-        self.title = title
-        self.mime_type = mime_type
-        self.file_size = file_size
-
-        self._id_attrs = (self.file_id,)
+        self.performer = kwargs.get('performer', '')
+        self.title = kwargs.get('title', '')
+        self.mime_type = str(kwargs.get('mime_type', ''))
+        self.file_size = int(kwargs.get('file_size', 0))
 
     @staticmethod
-    def de_json(data, bot):
+    def de_json(data):
         """
         Args:
-            data (dict):
-            bot (telegram.Bot):
+            data (str):
 
         Returns:
             telegram.Audio:

telegram/base.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 #
 # A library that provides a Python interface to the Telegram Bot API
-# Copyright (C) 2015-2017
+# Copyright (C) 2015-2016
 # Leandro Toledo de Souza <devs@python-telegram-bot.org>
 #
 # This program is free software: you can redistribute it and/or modify
@@ -18,18 +18,14 @@
 # along with this program.  If not, see [http://www.gnu.org/licenses/].
 """Base class for Telegram Objects."""
 
-try:
-    import ujson as json
-except ImportError:
-    import json
-
+import json
 from abc import ABCMeta
 
 
 class TelegramObject(object):
     """Base class for most telegram objects."""
+
     __metaclass__ = ABCMeta
-    _id_attrs = ()
 
     def __str__(self):
         return str(self.to_dict())
@@ -38,14 +34,13 @@ class TelegramObject(object):
         return self.__dict__[item]
 
     @staticmethod
-    def de_json(data, bot):
+    def de_json(data):
         """
         Args:
-            data (dict):
-            bot (telegram.Bot):
+            data (str):
 
         Returns:
-            dict:
+            telegram.TelegramObject:
         """
         if not data:
             return None
@@ -69,9 +64,6 @@ class TelegramObject(object):
         data = dict()
 
         for key in iter(self.__dict__):
-            if key in ('bot', '_id_attrs'):
-                continue
-
             value = self.__dict__[key]
             if value is not None:
                 if hasattr(value, 'to_dict'):
@@ -80,13 +72,3 @@ class TelegramObject(object):
                     data[key] = value
 
         return data
-
-    def __eq__(self, other):
-        if isinstance(other, self.__class__):
-            return self._id_attrs == other._id_attrs
-        return super(TelegramObject, self).__eq__(other)
-
-    def __hash__(self):
-        if self._id_attrs:
-            return hash((self.__class__, self._id_attrs))
-        return super(TelegramObject, self).__hash__()

telegram/callbackquery.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 #
 # A library that provides a Python interface to the Telegram Bot API
-# Copyright (C) 2015-2017
+# Copyright (C) 2015-2016
 # Leandro Toledo de Souza <devs@python-telegram-bot.org>
 #
 # This program is free software: you can redistribute it and/or modify
@@ -16,7 +16,8 @@
 #
 # You should have received a copy of the GNU Lesser Public License
 # along with this program.  If not, see [http://www.gnu.org/licenses/].
-"""This module contains an object that represents a Telegram CallbackQuery"""
+"""This module contains a object that represents a Telegram
+CallbackQuery"""
 
 from telegram import TelegramObject, Message, User
 
@@ -24,48 +25,24 @@ from telegram import TelegramObject, Message, User
 class CallbackQuery(TelegramObject):
     """This object represents a Telegram CallbackQuery."""
 
-    def __init__(self,
-                 id,
-                 from_user,
-                 chat_instance,
-                 message=None,
-                 data=None,
-                 inline_message_id=None,
-                 game_short_name=None,
-                 bot=None,
-                 **kwargs):
+    def __init__(self, id, from_user, data, **kwargs):
         # Required
         self.id = id
         self.from_user = from_user
-        self.chat_instance = chat_instance
-        # Optionals
-        self.message = message
         self.data = data
-        self.inline_message_id = inline_message_id
-        self.game_short_name = game_short_name
-
-        self.bot = bot
+        # Optionals
+        self.message = kwargs.get('message')
+        self.inline_message_id = kwargs.get('inline_message_id', '')
 
     @staticmethod
-    def de_json(data, bot):
-        """
-        Args:
-            data (dict):
-            bot (telegram.Bot):
-
-        Returns:
-            telegram.CallbackQuery:
-        """
-
+    def de_json(data):
         if not data:
             return None
 
-        data = super(CallbackQuery, CallbackQuery).de_json(data, bot)
+        data['from_user'] = User.de_json(data.get('from'))
+        data['message'] = Message.de_json(data.get('message'))
 
-        data['from_user'] = User.de_json(data.get('from'), bot)
-        data['message'] = Message.de_json(data.get('message'), bot)
-
-        return CallbackQuery(bot=bot, **data)
+        return CallbackQuery(**data)
 
     def to_dict(self):
         """
@@ -77,56 +54,3 @@ class CallbackQuery(TelegramObject):
         # Required
         data['from'] = data.pop('from_user', None)
         return data
-
-    def answer(self, *args, **kwargs):
-        """Shortcut for ``bot.answerCallbackQuery(update.callback_query.id, *args, **kwargs)``"""
-        return self.bot.answerCallbackQuery(self.id, *args, **kwargs)
-
-    def edit_message_text(self, *args, **kwargs):
-        """
-        Shortcut for either ``bot.editMessageText(chat_id=update.callback_query.message.chat_id, \
-message_id=update.callback_query.message.message_id, \
-*args, **kwargs)``
-        or ``bot.editMessageText(inline_message_id=update.callback_query.inline_message_id, \
-*args, **kwargs)``
-        """
-        if self.inline_message_id:
-            return self.bot.edit_message_text(
-                inline_message_id=self.inline_message_id, *args, **kwargs)
-        else:
-            return self.bot.edit_message_text(
-                chat_id=self.message.chat_id, message_id=self.message.message_id, *args, **kwargs)
-
-    def edit_message_caption(self, *args, **kwargs):
-        """
-        Shortcut for either
-        ``bot.editMessageCaption(chat_id=update.callback_query.message.chat_id, \
-message_id=update.callback_query.message.message_id, \
-*args, **kwargs)``
-        or
-        ``bot.editMessageCaption(inline_message_id=update.callback_query.inline_message_id, \
-*args, **kwargs)``
-        """
-        if self.inline_message_id:
-            return self.bot.edit_message_caption(
-                inline_message_id=self.inline_message_id, *args, **kwargs)
-        else:
-            return self.bot.edit_message_caption(
-                chat_id=self.message.chat_id, message_id=self.message.message_id, *args, **kwargs)
-
-    def edit_message_reply_markup(self, *args, **kwargs):
-        """
-        Shortcut for either
-        ``bot.editMessageReplyMarkup(chat_id=update.callback_query.message.chat_id, \
-message_id=update.callback_query.message.message_id, \
-*args, **kwargs)``
-        or
-        ``bot.editMessageReplyMarkup(inline_message_id=update.callback_query.inline_message_id, \
-*args, **kwargs)``
-        """
-        if self.inline_message_id:
-            return self.bot.edit_message_reply_markup(
-                inline_message_id=self.inline_message_id, *args, **kwargs)
-        else:
-            return self.bot.edit_message_reply_markup(
-                chat_id=self.message.chat_id, message_id=self.message.message_id, *args, **kwargs)

telegram/chat.py

@@ -2,7 +2,7 @@
 # pylint: disable=C0103,W0622
 #
 # A library that provides a Python interface to the Telegram Bot API
-# Copyright (C) 2015-2017
+# Copyright (C) 2015-2016
 # Leandro Toledo de Souza <devs@python-telegram-bot.org>
 #
 # This program is free software: you can redistribute it and/or modify
@@ -17,7 +17,7 @@
 #
 # You should have received a copy of the GNU Lesser Public License
 # along with this program.  If not, see [http://www.gnu.org/licenses/].
-"""This module contains an object that represents a Telegram Chat."""
+"""This module contains a object that represents a Telegram Chat."""
 
 from telegram import TelegramObject
 
@@ -32,53 +32,36 @@ class Chat(TelegramObject):
         username (str): Username, for private chats and channels if available
         first_name (str): First name of the other party in a private chat
         last_name (str): Last name of the other party in a private chat
-        all_members_are_administrators (bool): True if group has 'All Members Are Administrators'
 
     Args:
         id (int):
         type (str):
-        title (Optional[str]):
-        username(Optional[str]):
-        first_name(Optional[str]):
-        last_name(Optional[str]):
-        bot (Optional[telegram.Bot]): The Bot to use for instance methods
-        **kwargs (dict): Arbitrary keyword arguments.
+        **kwargs: Arbitrary keyword arguments.
 
+    Keyword Args:
+        type (Optional[str]):
     """
+
     PRIVATE = 'private'
     GROUP = 'group'
     SUPERGROUP = 'supergroup'
     CHANNEL = 'channel'
 
-    def __init__(self,
-                 id,
-                 type,
-                 title=None,
-                 username=None,
-                 first_name=None,
-                 last_name=None,
-                 all_members_are_administrators=None,
-                 bot=None,
-                 **kwargs):
+    def __init__(self, id, type, **kwargs):
         # Required
         self.id = int(id)
         self.type = type
         # Optionals
-        self.title = title
-        self.username = username
-        self.first_name = first_name
-        self.last_name = last_name
-        self.all_members_are_administrators = all_members_are_administrators
-
-        self.bot = bot
-        self._id_attrs = (self.id,)
+        self.title = kwargs.get('title', '')
+        self.username = kwargs.get('username', '')
+        self.first_name = kwargs.get('first_name', '')
+        self.last_name = kwargs.get('last_name', '')
 
     @staticmethod
-    def de_json(data, bot):
+    def de_json(data):
         """
         Args:
             data (dict):
-            bot (telegram.Bot):
 
         Returns:
             telegram.Chat:
@@ -86,32 +69,4 @@ class Chat(TelegramObject):
         if not data:
             return None
 
-        return Chat(bot=bot, **data)
-
-    def send_action(self, *args, **kwargs):
-        """Shortcut for ``bot.send_chat_action(update.message.chat.id, *args, **kwargs)``"""
-        return self.bot.send_chat_action(self.id, *args, **kwargs)
-
-    def leave(self, *args, **kwargs):
-        """Shortcut for ``bot.leave_chat(update.message.chat.id, *args, **kwargs)``"""
-        return self.bot.leave_chat(self.id, *args, **kwargs)
-
-    def get_administrators(self, *args, **kwargs):
-        """Shortcut for ``bot.get_chat_administrators(update.message.chat.id, *args, **kwargs)``"""
-        return self.bot.get_chat_administrators(self.id, *args, **kwargs)
-
-    def get_members_count(self, *args, **kwargs):
-        """Shortcut for ``bot.get_chat_members_count(update.message.chat.id, *args, **kwargs)``"""
-        return self.bot.get_chat_members_count(self.id, *args, **kwargs)
-
-    def get_member(self, *args, **kwargs):
-        """Shortcut for ``bot.get_chat_member(update.message.chat.id, *args, **kwargs)``"""
-        return self.bot.get_chat_member(self.id, *args, **kwargs)
-
-    def kick_member(self, *args, **kwargs):
-        """Shortcut for ``bot.kick_chat_member(update.message.chat.id, *args, **kwargs)``"""
-        return self.bot.kick_chat_member(self.id, *args, **kwargs)
-
-    def unban_member(self, *args, **kwargs):
-        """Shortcut for ``bot.unban_chat_member(update.message.chat.id, *args, **kwargs)``"""
-        return self.bot.unban_chat_member(self.id, *args, **kwargs)
+        return Chat(**data)

telegram/chataction.py

@@ -2,7 +2,7 @@
 # pylint: disable=R0903
 #
 # A library that provides a Python interface to the Telegram Bot API
-# Copyright (C) 2015-2017
+# Copyright (C) 2015-2016
 # Leandro Toledo de Souza <devs@python-telegram-bot.org>
 #
 # This program is free software: you can redistribute it and/or modify
@@ -17,7 +17,7 @@
 #
 # You should have received a copy of the GNU Lesser Public License
 # along with this program.  If not, see [http://www.gnu.org/licenses/].
-"""This module contains an object that represents a Telegram ChatAction."""
+"""This module contains a object that represents a Telegram ChatAction."""
 
 
 class ChatAction(object):
@@ -31,5 +31,3 @@ class ChatAction(object):
     UPLOAD_AUDIO = 'upload_audio'
     UPLOAD_DOCUMENT = 'upload_document'
     FIND_LOCATION = 'find_location'
-    RECORD_VIDEO_NOTE = 'record_video_note'
-    UPLOAD_VIDEO_NOTE = 'upload_video_note'

telegram/chatmember.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 #
 # A library that provides a Python interface to the Telegram Bot API
-# Copyright (C) 2015-2017
+# Copyright (C) 2015-2016
 # Leandro Toledo de Souza <devs@python-telegram-bot.org>
 #
 # This program is free software: you can redistribute it and/or modify
@@ -16,7 +16,7 @@
 #
 # You should have received a copy of the GNU Lesser Public License
 # along with this program.  If not, see [http://www.gnu.org/licenses/].
-"""This module contains an object that represents a Telegram ChatMember."""
+"""This module contains a object that represents a Telegram ChatMember."""
 
 from telegram import User, TelegramObject
 
@@ -32,9 +32,8 @@ class ChatMember(TelegramObject):
     Args:
         user (:class:`telegram.User`):
         status (str):
-        **kwargs (dict): Arbitrary keyword arguments.
-
     """
+
     CREATOR = 'creator'
     ADMINISTRATOR = 'administrator'
     MEMBER = 'member'
@@ -46,14 +45,11 @@ class ChatMember(TelegramObject):
         self.user = user
         self.status = status
 
-        self._id_attrs = (self.user, self.status)
-
     @staticmethod
-    def de_json(data, bot):
+    def de_json(data):
         """
         Args:
             data (dict):
-            bot (telegram.Bot):
 
         Returns:
             telegram.ChatMember:
@@ -61,8 +57,6 @@ class ChatMember(TelegramObject):
         if not data:
             return None
 
-        data = super(ChatMember, ChatMember).de_json(data, bot)
-
-        data['user'] = User.de_json(data.get('user'), bot)
+        data['user'] = User.de_json(data.get('user'))
 
         return ChatMember(**data)

telegram/choseninlineresult.py

@@ -2,8 +2,7 @@
 # pylint: disable=R0902,R0912,R0913
 #
 # A library that provides a Python interface to the Telegram Bot API
-# Copyright (C) 2015-2017
-# Leandro Toledo de Souza <devs@python-telegram-bot.org>
+# Copyright (C) 2015 Leandro Toledo de Souza <devs@python-telegram-bot.org>
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser Public License as published by
@@ -18,7 +17,7 @@
 # You should have received a copy of the GNU Lesser Public License
 # along with this program.  If not, see [http://www.gnu.org/licenses/].
 """
-This module contains an object that represents a Telegram ChosenInlineResult
+This module contains a object that represents a Telegram ChosenInlineResult
 """
 
 from telegram import TelegramObject, User, Location
@@ -34,16 +33,11 @@ class ChosenInlineResult(TelegramObject):
         result_id (str):
         from_user (:class:`telegram.User`):
         query (str):
-        location (:class:`telegram.Location`):
-        inline_message_id (str):
 
     Args:
         result_id (str):
         from_user (:class:`telegram.User`):
         query (str):
-        location (Optional[:class:`telegram.Location`]):
-        inline_message_id (Optional[str]):
-        **kwargs (dict): Arbitrary keyword arguments.
 
     """
 
@@ -62,14 +56,11 @@ class ChosenInlineResult(TelegramObject):
         self.location = location
         self.inline_message_id = inline_message_id
 
-        self._id_attrs = (self.result_id,)
-
     @staticmethod
-    def de_json(data, bot):
+    def de_json(data):
         """
         Args:
             data (dict):
-            bot (telegram.Bot):
 
         Returns:
             telegram.ChosenInlineResult:
@@ -77,11 +68,10 @@ class ChosenInlineResult(TelegramObject):
         if not data:
             return None
 
-        data = super(ChosenInlineResult, ChosenInlineResult).de_json(data, bot)
         # Required
-        data['from_user'] = User.de_json(data.pop('from'), bot)
+        data['from_user'] = User.de_json(data.pop('from'))
         # Optionals
-        data['location'] = Location.de_json(data.get('location'), bot)
+        data['location'] = Location.de_json(data.get('location'))
 
         return ChosenInlineResult(**data)
 

telegram/constants.py

@@ -1,56 +0,0 @@
-# python-telegram-bot - a Python interface to the Telegram Bot API
-# Copyright (C) 2015-2017
-# by the python-telegram-bot contributors <devs@python-telegram-bot.org>
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser Public License for more details.
-#
-# You should have received a copy of the GNU Lesser Public License
-# along with this program.  If not, see [http://www.gnu.org/licenses/].
-"""Constants in the Telegram network.
-
-Attributes:
-    MAX_MESSAGE_LENGTH (int): from
-        https://core.telegram.org/method/messages.sendMessage#return-errors
-    MAX_CAPTION_LENGTH (int): from https://core.telegram.org/bots/api#sendphoto
-
-The following constants were extracted from the
-`Telegram Bots FAQ <https://core.telegram.org/bots/faq>`_.
-
-Attributes:
-    SUPPORTED_WEBHOOK_PORTS (List[int])
-    MAX_FILESIZE_DOWNLOAD (int): In bytes.
-    MAX_FILESIZE_UPLOAD (int): Official limit, the actual limit can be a bit higher.
-    MAX_MESSAGES_PER_SECOND_PER_CHAT (int): Telegram may allow short bursts that go over this
-        limit, but eventually you'll begin receiving 429 errors.
-    MAX_MESSAGES_PER_SECOND (int)
-    MAX_MESSAGES_PER_MINUTE_PER_GROUP (int)
-    MAX_INLINE_QUERY_RESULTS (int)
-
-The following constant have been found by experimentation:
-
-Attributes:
-    MAX_MESSAGE_ENTITIES (int): Max number of entities that can be in a message.
-        (Beyond this cap telegram will simply ignore further formatting styles)
-"""
-
-MAX_MESSAGE_LENGTH = 4096
-MAX_CAPTION_LENGTH = 200
-
-# constants above this line are tested
-
-SUPPORTED_WEBHOOK_PORTS = [443, 80, 88, 8443]
-MAX_FILESIZE_DOWNLOAD = int(20E6)  # (20MB)
-MAX_FILESIZE_UPLOAD = int(50E6)  # (50MB)
-MAX_MESSAGES_PER_SECOND_PER_CHAT = 1
-MAX_MESSAGES_PER_SECOND = 30
-MAX_MESSAGES_PER_MINUTE_PER_GROUP = 20
-MAX_MESSAGE_ENTITIES = 100
-MAX_INLINE_QUERY_RESULTS = 50

telegram/contact.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 #
 # A library that provides a Python interface to the Telegram Bot API
-# Copyright (C) 2015-2017
+# Copyright (C) 2015-2016
 # Leandro Toledo de Souza <devs@python-telegram-bot.org>
 #
 # This program is free software: you can redistribute it and/or modify
@@ -16,7 +16,7 @@
 #
 # You should have received a copy of the GNU Lesser Public License
 # along with this program.  If not, see [http://www.gnu.org/licenses/].
-"""This module contains an object that represents a Telegram Contact."""
+"""This module contains a object that represents a Telegram Contact."""
 
 from telegram import TelegramObject
 
@@ -33,28 +33,26 @@ class Contact(TelegramObject):
     Args:
         phone_number (str):
         first_name (str):
-        last_name (Optional[str]):
-        user_id (Optional[int]):
         **kwargs: Arbitrary keyword arguments.
 
+    Keyword Args:
+        last_name (Optional[str]):
+        user_id (Optional[int]):
     """
 
-    def __init__(self, phone_number, first_name, last_name=None, user_id=None, **kwargs):
+    def __init__(self, phone_number, first_name, **kwargs):
         # Required
         self.phone_number = str(phone_number)
         self.first_name = first_name
         # Optionals
-        self.last_name = last_name
-        self.user_id = user_id
-
-        self._id_attrs = (self.phone_number,)
+        self.last_name = kwargs.get('last_name', '')
+        self.user_id = int(kwargs.get('user_id', 0))
 
     @staticmethod
-    def de_json(data, bot):
+    def de_json(data):
         """
         Args:
-            data (dict):
-            bot (telegram.Bot):
+            data (str):
 
         Returns:
             telegram.Contact:

telegram/contrib/botan.py

@@ -1,10 +1,11 @@
 import logging
+from telegram import NullHandler
 
 from future.moves.urllib.parse import quote
 from future.moves.urllib.error import HTTPError, URLError
 from future.moves.urllib.request import urlopen, Request
 
-logging.getLogger(__name__).addHandler(logging.NullHandler())
+logging.getLogger(__name__).addHandler(NullHandler())
 
 
 class Botan(object):
@@ -28,10 +29,12 @@ class Botan(object):
             return False
         data = message.to_json()
         try:
-            url = self.url_template.format(
-                token=str(self.token), uid=str(uid), name=quote(event_name))
-            request = Request(
-                url, data=data.encode(), headers={'Content-Type': 'application/json'})
+            url = self.url_template.format(token=str(self.token),
+                                           uid=str(uid),
+                                           name=quote(event_name))
+            request = Request(url,
+                              data=data.encode(),
+                              headers={'Content-Type': 'application/json'})
             urlopen(request)
             return True
         except HTTPError as error:

telegram/document.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 #
 # A library that provides a Python interface to the Telegram Bot API
-# Copyright (C) 2015-2017
+# Copyright (C) 2015-2016
 # Leandro Toledo de Souza <devs@python-telegram-bot.org>
 #
 # This program is free software: you can redistribute it and/or modify
@@ -16,7 +16,7 @@
 #
 # You should have received a copy of the GNU Lesser Public License
 # along with this program.  If not, see [http://www.gnu.org/licenses/].
-"""This module contains an object that represents a Telegram Document."""
+"""This module contains a object that represents a Telegram Document."""
 
 from telegram import PhotoSize, TelegramObject
 
@@ -33,39 +33,29 @@ class Document(TelegramObject):
 
     Args:
         file_id (str):
+        **kwargs: Arbitrary keyword arguments.
+
+    Keyword Args:
         thumb (Optional[:class:`telegram.PhotoSize`]):
         file_name (Optional[str]):
         mime_type (Optional[str]):
         file_size (Optional[int]):
-        **kwargs (dict): Arbitrary keyword arguments.
-
     """
 
-    _id_keys = ('file_id',)
-
-    def __init__(self,
-                 file_id,
-                 thumb=None,
-                 file_name=None,
-                 mime_type=None,
-                 file_size=None,
-                 **kwargs):
+    def __init__(self, file_id, **kwargs):
         # Required
         self.file_id = str(file_id)
         # Optionals
-        self.thumb = thumb
-        self.file_name = file_name
-        self.mime_type = mime_type
-        self.file_size = file_size
-
-        self._id_attrs = (self.file_id,)
+        self.thumb = kwargs.get('thumb')
+        self.file_name = kwargs.get('file_name', '')
+        self.mime_type = str(kwargs.get('mime_type', ''))
+        self.file_size = int(kwargs.get('file_size', 0))
 
     @staticmethod
-    def de_json(data, bot):
+    def de_json(data):
         """
         Args:
-            data (dict):
-            bot (telegram.Bot):
+            data (str):
 
         Returns:
             telegram.Document:
@@ -73,8 +63,6 @@ class Document(TelegramObject):
         if not data:
             return None
 
-        data = super(Document, Document).de_json(data, bot)
-
-        data['thumb'] = PhotoSize.de_json(data.get('thumb'), bot)
+        data['thumb'] = PhotoSize.de_json(data.get('thumb'))
 
         return Document(**data)

telegram/emoji.py

@@ -1,9 +1,9 @@
 #!/usr/bin/env python
 # flake8: noqa
-# pylint: disable=C0103,R0903,E0213
+# pylint: disable=C0103,R0903
 #
 # A library that provides a Python interface to the Telegram Bot API
-# Copyright (C) 2015-2017
+# Copyright (C) 2015-2016
 # Leandro Toledo de Souza <devs@python-telegram-bot.org>
 #
 # This program is free software: you can redistribute it and/or modify
@@ -18,27 +18,14 @@
 #
 # You should have received a copy of the GNU Lesser Public License
 # along with this program.  If not, see [http://www.gnu.org/licenses/].
-"""This module contains an object that represents an Emoji.
+"""This module contains a object that represents an Emoji."""
 
-This module will be removed in the future.
-"""
-
-import warnings
-
-from future.utils import bytes_to_native_str
+from future.utils import bytes_to_native_str as n
 
 
-class Emoji2(object):
+class Emoji(object):
     """This object represents an Emoji."""
 
-    def n(b):
-
-        def e(cls):
-            warnings.warn("telegram.Emoji is being deprecated, please see https://git.io/v6DeB")
-            return bytes_to_native_str(b)
-
-        return property(e)
-
     GRINNING_FACE_WITH_SMILING_EYES = n(b'\xF0\x9F\x98\x81')
     FACE_WITH_TEARS_OF_JOY = n(b'\xF0\x9F\x98\x82')
     SMILING_FACE_WITH_OPEN_MOUTH = n(b'\xF0\x9F\x98\x83')
@@ -892,6 +879,3 @@ class Emoji2(object):
     CLOCK_FACE_TEN_THIRTY = n(b'\xF0\x9F\x95\xA5')
     CLOCK_FACE_ELEVEN_THIRTY = n(b'\xF0\x9F\x95\xA6')
     CLOCK_FACE_TWELVE_THIRTY = n(b'\xF0\x9F\x95\xA7')
-
-
-Emoji = Emoji2()

telegram/error.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 #
 # A library that provides a Python interface to the Telegram Bot API
-# Copyright (C) 2015-2017
+# Copyright (C) 2015-2016
 # Leandro Toledo de Souza <devs@python-telegram-bot.org>
 #
 # This program is free software: you can redistribute it and/or modify
@@ -16,7 +16,7 @@
 #
 # You should have received a copy of the GNU Lesser Public License
 # along with this program.  If not, see [http://www.gnu.org/licenses/].
-"""This module contains an object that represents a Telegram Error."""
+"""This module contains a object that represents a Telegram Error."""
 
 
 def _lstrip_str(in_s, lstr):
@@ -62,7 +62,9 @@ class TelegramError(Exception):
 
 
 class Unauthorized(TelegramError):
-    pass
+
+    def __init__(self):
+        super(Unauthorized, self).__init__('Unauthorized')
 
 
 class InvalidToken(TelegramError):
@@ -83,29 +85,3 @@ class TimedOut(NetworkError):
 
     def __init__(self):
         super(TimedOut, self).__init__('Timed out')
-
-
-class ChatMigrated(TelegramError):
-
-    def __init__(self, new_chat_id):
-        """
-        Args:
-            new_chat_id (int):
-
-        """
-        super(ChatMigrated,
-              self).__init__('Group migrated to supergroup. New chat id: {}'.format(new_chat_id))
-        self.new_chat_id = new_chat_id
-
-
-class RetryAfter(TelegramError):
-
-    def __init__(self, retry_after):
-        """
-        Args:
-            retry_after (int):
-
-        """
-        super(RetryAfter,
-              self).__init__('Flood control exceeded. Retry in {} seconds'.format(retry_after))
-        self.retry_after = float(retry_after)

telegram/ext/__init__.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 #
 # A library that provides a Python interface to the Telegram Bot API
-# Copyright (C) 2015-2017
+# Copyright (C) 2015-2016
 # Leandro Toledo de Souza <devs@python-telegram-bot.org>
 #
 # This program is free software: you can redistribute it and/or modify
@@ -19,25 +19,20 @@
 """Extensions over the Telegram Bot API to facilitate bot making"""
 
 from .dispatcher import Dispatcher
-from .jobqueue import JobQueue, Job
+from .jobqueue import JobQueue
 from .updater import Updater
 from .callbackqueryhandler import CallbackQueryHandler
 from .choseninlineresulthandler import ChosenInlineResultHandler
 from .commandhandler import CommandHandler
 from .handler import Handler
 from .inlinequeryhandler import InlineQueryHandler
-from .messagehandler import MessageHandler
-from .filters import BaseFilter, Filters
+from .messagehandler import MessageHandler, Filters
 from .regexhandler import RegexHandler
 from .stringcommandhandler import StringCommandHandler
 from .stringregexhandler import StringRegexHandler
 from .typehandler import TypeHandler
-from .conversationhandler import ConversationHandler
-from .precheckoutqueryhandler import PreCheckoutQueryHandler
-from .shippingqueryhandler import ShippingQueryHandler
 
-__all__ = ('Dispatcher', 'JobQueue', 'Job', 'Updater', 'CallbackQueryHandler',
+__all__ = ('Dispatcher', 'JobQueue', 'Updater', 'CallbackQueryHandler',
            'ChosenInlineResultHandler', 'CommandHandler', 'Handler', 'InlineQueryHandler',
-           'MessageHandler', 'BaseFilter', 'Filters', 'RegexHandler', 'StringCommandHandler',
-           'StringRegexHandler', 'TypeHandler', 'ConversationHandler',
-           'PreCheckoutQueryHandler', 'ShippingQueryHandler')
+           'MessageHandler', 'Filters', 'RegexHandler', 'StringCommandHandler',
+           'StringRegexHandler', 'TypeHandler')

telegram/ext/callbackqueryhandler.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 #
 # A library that provides a Python interface to the Telegram Bot API
-# Copyright (C) 2015-2017
+# Copyright (C) 2015-2016
 # Leandro Toledo de Souza <devs@python-telegram-bot.org>
 #
 # This program is free software: you can redistribute it and/or modify
@@ -18,89 +18,36 @@
 # along with this program.  If not, see [http://www.gnu.org/licenses/].
 """ This module contains the CallbackQueryHandler class """
 
-import re
-
-from future.utils import string_types
-
-from telegram import Update
 from .handler import Handler
+from telegram import Update
+from telegram.utils.deprecate import deprecate
 
 
 class CallbackQueryHandler(Handler):
     """
-    Handler class to handle Telegram callback queries. Optionally based on a regex.
-    Read the documentation of the ``re`` module for more information.
+    Handler class to handle Telegram callback queries.
 
     Args:
         callback (function): A function that takes ``bot, update`` as
             positional arguments. It will be called when the ``check_update``
             has determined that an update should be processed by this handler.
-        pass_update_queue (optional[bool]): If set to ``True``, a keyword argument called
-            ``update_queue`` will be passed to the callback function. It will be the ``Queue``
-            instance used by the ``Updater`` and ``Dispatcher`` that contains new updates which can
-            be used to insert updates. Default is ``False``.
-        pass_job_queue (optional[bool]): If set to ``True``, a keyword argument called
-            ``job_queue`` will be passed to the callback function. It will be a ``JobQueue``
-            instance created by the ``Updater`` which can be used to schedule new jobs.
-            Default is ``False``.
-        pattern (optional[str or Pattern]): Optional regex pattern. If not ``None`` ``re.match``
-            is used to determine if an update should be handled by this handler.
-        pass_groups (optional[bool]): If the callback should be passed the
-            result of ``re.match(pattern, data).groups()`` as a keyword
-            argument called ``groups``. Default is ``False``
-        pass_groupdict (optional[bool]): If the callback should be passed the
-            result of ``re.match(pattern, data).groupdict()`` as a keyword
-            argument called ``groupdict``. Default is ``False``
-        pass_user_data (optional[bool]): If set to ``True``, a keyword argument called
-            ``user_data`` will be passed to the callback function. It will be a ``dict`` you
-            can use to keep any data related to the user that sent the update. For each update of
-            the same user, it will be the same ``dict``. Default is ``False``.
-        pass_chat_data (optional[bool]): If set to ``True``, a keyword argument called
-            ``chat_data`` will be passed to the callback function. It will be a ``dict`` you
-            can use to keep any data related to the chat that the update was sent in.
-            For each update in the same chat, it will be the same ``dict``. Default is ``False``.
+        pass_update_queue (optional[bool]): If the handler should be passed the
+            update queue as a keyword argument called ``update_queue``. It can
+            be used to insert updates. Default is ``False``
     """
 
-    def __init__(self,
-                 callback,
-                 pass_update_queue=False,
-                 pass_job_queue=False,
-                 pattern=None,
-                 pass_groups=False,
-                 pass_groupdict=False,
-                 pass_user_data=False,
-                 pass_chat_data=False):
-        super(CallbackQueryHandler, self).__init__(
-            callback,
-            pass_update_queue=pass_update_queue,
-            pass_job_queue=pass_job_queue,
-            pass_user_data=pass_user_data,
-            pass_chat_data=pass_chat_data)
-
-        if isinstance(pattern, string_types):
-            pattern = re.compile(pattern)
-
-        self.pattern = pattern
-        self.pass_groups = pass_groups
-        self.pass_groupdict = pass_groupdict
+    def __init__(self, callback, pass_update_queue=False):
+        super(CallbackQueryHandler, self).__init__(callback, pass_update_queue)
 
     def check_update(self, update):
-        if isinstance(update, Update) and update.callback_query:
-            if self.pattern:
-                if update.callback_query.data:
-                    match = re.match(self.pattern, update.callback_query.data)
-                    return bool(match)
-            else:
-                return True
+        return isinstance(update, Update) and update.callback_query
 
     def handle_update(self, update, dispatcher):
-        optional_args = self.collect_optional_args(dispatcher, update)
-        if self.pattern:
-            match = re.match(self.pattern, update.callback_query.data)
+        optional_args = self.collect_optional_args(dispatcher)
 
-            if self.pass_groups:
-                optional_args['groups'] = match.groups()
-            if self.pass_groupdict:
-                optional_args['groupdict'] = match.groupdict()
+        self.callback(dispatcher.bot, update, **optional_args)
 
-        return self.callback(dispatcher.bot, update, **optional_args)
+    # old non-PEP8 Handler methods
+    m = "telegram.CallbackQueryHandler."
+    checkUpdate = deprecate(check_update, m + "checkUpdate", m + "check_update")
+    handleUpdate = deprecate(handle_update, m + "handleUpdate", m + "handle_update")