python-telegram-bot · Eldinnie · Jul 29, 2017 · Jul 29, 2017 · Jul 29, 2017 · Jul 29, 2017
diff --git a/.coveragerc b/.coveragerc
diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst
@@ -1,10 +1,10 @@
 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.
 
@@ -35,7 +35,7 @@ Setting things up
       $ 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 +44,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``.
 
@@ -89,7 +89,7 @@ Here's how to make a one-off code change.
 
      .. code-block::
 
-        $ nosetests -v
+        $ pytest -v
 
    - To actually make the commit (this will trigger tests for yapf, lint and pep8 automatically):
 
@@ -129,19 +129,19 @@ Here's how to make a one-off code change.
 
      .. code-block:: bash
 
-      	$ 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 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
 
    - If after merging you see local modified files in ``telegram/vendor/`` directory, that you didn't actually touch, that means you need to update submodules with this command:
 
      .. code-block:: bash
 
-      	$ git submodule update --init --recursive
+        $ git submodule update --init --recursive
 
    - At the end, the reviewer will merge the pull request.
 
@@ -155,20 +155,29 @@ Here's how to make a one-off code change.
 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
-######################
+Assert comparison order
+#######################
 
-- assertEqual method's arguments should be in ('actual', 'expected') order.
+- assert statements should compare in **actual** == **expected** order.
+For example (assuming ``test_call`` is the thing being tested):
+
+.. code-block:: python
+
+    # GOOD
+    assert test_call() == 5
+
+    # BAD
+    assert 5 == test_call()
 
 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
@@ -186,7 +195,7 @@ 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

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -17,4 +17,4 @@
         files: ^telegram/.*\.py$
         args:
         - --errors-only
-        - --disable=no-name-in-module,import-error
+        - --disable=import-error
diff --git a/.travis.yml b/.travis.yml
@@ -18,18 +18,20 @@ branches:
 cache:
   directories:
     - $HOME/.cache/pip
+    - $HOME/.pre-commit
 before_cache:
   - rm -f $HOME/.cache/pip/log/debug.log
+  - rm -f $HOME/.pre-commit/pre-commit.log
 
 install:
-  - pip install coveralls
+  - pip install coveralls pytest-cov
   - pip install -U wheel
-  - pip install -r requirements.txt
-  - pip install -r requirements-dev.txt
+  - pip install -U -r requirements.txt
+  - pip install -U -r requirements-dev.txt
   - if [[ $TRAVIS_PYTHON_VERSION != 'pypy'* ]]; then pip install ujson; fi
 
 script:
-  - python travis.py
+  - pytest -v --cov=telegram
 
 after_success:
   coveralls
diff --git a/Makefile b/Makefile
@@ -2,7 +2,7 @@
 .PHONY: clean pep257 pep8 yapf lint test install
 
 PYLINT          := pylint
-NOSETESTS       := nosetests
+PYTEST          := pytest
 PEP257          := pep257
 PEP8            := flake8
 YAPF            := yapf
@@ -29,7 +29,7 @@ lint:
 	$(PYLINT) -E telegram --disable=no-name-in-module,import-error
 
 test:
-	$(NOSETESTS) -v
+	$(PYTEST) -v
 
 install:
 	$(PIP)  install -r requirements.txt -r requirements-dev.txt
@@ -41,11 +41,11 @@ help:
 	@echo "- pep8        Check style with flake8"
 	@echo "- lint        Check style with pylint"
 	@echo "- yapf        Check style with yapf"
-	@echo "- test        Run tests"
+	@echo "- test        Run tests using pytest"
 	@echo
 	@echo "Available variables:"
 	@echo "- PYLINT      default: $(PYLINT)"
-	@echo "- NOSETESTS   default: $(NOSETESTS)"
+	@echo "- PYTEST      default: $(PYTEST)"
 	@echo "- PEP257      default: $(PEP257)"
 	@echo "- PEP8        default: $(PEP8)"
 	@echo "- YAPF        default: $(YAPF)"

diff --git a/appveyor.yml b/appveyor.yml
@@ -24,8 +24,4 @@ build: off
 cache: C:\Users\appveyor\pip\wheels
 
 test_script:
-  - "%python%\\Scripts\\nosetests -v --with-flaky --no-flaky-report tests"
-
-after_test:
-  # This step builds your wheels.
-  - "%PYTHON%\\python.exe setup.py bdist_wheel"
+  - "%python%\\Scripts\\pytest -v --cov=telegram"
diff --git a/pytest_migrate.py b/pytest_migrate.py
@@ -0,0 +1,109 @@
+"""Helper for migrating to pytests
+
+Run it like::
+
+    python pytest_migration.py test_forcereply.py
+"""
+
+import re
+import sys
+from pathlib import Path
+
+header = """#!/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/]."""
+
+CLASS = r'class (.*)Test\(BaseTest, unittest.TestCase\):(?:\r?\n)([\s\S]*)if __name__'
+JSON_DICT = r'self.json_dict = (\{[\s\S]*\})([\s\S]*?def)'
+CLASS_VARS = r'    def setUp\(self\):\n([\s\S]*?def)'
+
+if __name__ == '__main__':
+    original = Path('tests/' + sys.argv[1]).open('r', encoding='UTF-8').read()
+    new_text = header
+    new_text += '\nimport json\n\nimport pytest\n\n'
+
+    match = re.search(CLASS, original)
+    if not match:
+        match = re.search(CLASS[:-11], original)
+
+    name = match.group(1)
+    test_name = 'Test' + name
+
+    new_class = 'class {}:\n{}'.format(test_name, match.group(2))
+
+    imports = {name}
+    for find in re.finditer('telegram\.([^().]*)', new_class):
+        imports.add(find.group(1))
+    tg_imports = ', '.join(imports)
+    new_text += 'from telegram import {}{}{}\n\n'.format('(' if len(tg_imports) > 77 else '',
+                                                         tg_imports,
+                                                         ')' if len(tg_imports) > 77 else '')
+
+    new_class = re.sub(r'telegram\.', '', new_class)
+    new_class = re.sub(r'self\.assertTrue\(isinstance\((.*), (.*)\)\)',
+                       r'assert isinstance(\1, \2)', new_class)
+    new_class = re.sub(r'self\.assertTrue\(self\.is_json\((.*)\)\)', r'json.loads(\1)', new_class)
+    new_class = re.sub(r'self\.assertTrue\(self\.is_dict\((.*)\)\)',
+                       r'assert isinstance(\1, dict)', new_class)
+    new_class = re.sub(r'self\.assert(True|False)\((.*)\)', r'assert \2 is \1', new_class)
+    new_class = re.sub(r'self\.assertIsNone\((.*)\)', r'assert \1 is None', new_class)
+    new_class = re.sub(r'self\.assertIsInstance\((.*), (.*)\)',
+                       r'assert isinstance(\1, \2)', new_class)
+    new_class = re.sub(r'self\.assert(?:Dict)?Equals?\((.*), (.*)\)',
+                       r'assert \1 == \2', new_class)
+    new_class = re.sub(r'self\.assertNotEquals?\((.*), (.*)\)', r'assert \1 != \2', new_class)
+    new_class = re.sub(r'self\.assertIs\((.*), (.*)\)', r'assert \1 is \2', new_class)
+    new_class = re.sub(r'self\.assertIsNot\((.*), (.*)\)', r'assert \1 is not \2', new_class)
+    new_class = re.sub(r'self\._bot', r'bot', new_class)
+    new_class = re.sub(r'self\._chat_id,', r'chat_id,', new_class)
+    new_class = re.sub(r'self\._id', 'self.id', new_class)
+
+    new_class = re.sub(r'def test_.*_(de|to)_(json|dict)\(self\):',
+                       r'def test_\1_\2(self):', new_class)
+
+    name_lower = name.lower()
+    proper_name_lower = re.sub('(.)([A-Z][a-z]+)', r'\1_\2', name)
+    proper_name_lower = re.sub('([a-z0-9])([A-Z])', r'\1_\2', proper_name_lower).lower()
+    new_class.replace(name_lower, proper_name_lower)
+
+    json_dict = re.search(JSON_DICT, new_class)
+    if json_dict:
+        new_class = re.sub(JSON_DICT, r'\2', new_class)
+        new_text += '@pytest.fixture(scope=\'class\')\ndef json_dict():\n    return '
+        new_text += json_dict.group(1).replace('self.', test_name + '.')
+        new_text += '\n\n'
+        new_text += '@pytest.fixture(scope=\'class\')\ndef {}():\n'.format(proper_name_lower)
+        args = []
+        for line in json_dict.group(1).replace('self.', test_name + '.').split(','):
+            match = re.search(r'\'(.*)\': (.*?\.[^,\s.]*)', line)
+            if match:
+                args.append('{}={}'.format(match.group(1), match.group(2)))
+        new_text += '   return {}({})\n\n'.format(name, ', '.join(args))
+
+    class_vars = re.search(CLASS_VARS, new_class)
+    if class_vars:
+        class_vars = class_vars.group(1)
+        class_vars = class_vars.replace('    ', '')
+        class_vars = class_vars.replace('self.', '')
+        class_vars = '\n'.join(['    ' + x for x in class_vars.split('\n')])
+        new_class = re.sub(CLASS_VARS, class_vars, new_class)
+
+    new_class = re.sub(r'self.json_dict', r'json_dict', new_class)
+
+    new_text += new_class
+    new_file = Path('pytests/' + sys.argv[1]).open('w', encoding='UTF-8').write(new_text)
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -1,10 +1,9 @@
 flake8
-nose
 pep257
 pylint
 flaky
 yapf
 pre-commit
-pre-commit-hooks
 beautifulsoup4
-rednose
+pytest
+pytest-timeout
diff --git a/setup.cfg b/setup.cfg
@@ -17,3 +17,19 @@ ignore = W503
 based_on_style = google
 split_before_logical_operator = True
 column_limit = 99
+
+[tool:pytest]
+testpaths = tests
+addopts = --no-success-flaky-report -rsxX
+filterwarnings =
+    error
+    ignore::DeprecationWarning
+
+[coverage:run]
+branch = True
+source = telegram
+omit =
+    tests/
+    telegram/__main__.py
+    telegram/vendor/*
+
diff --git a/telegram/bot.py b/telegram/bot.py
@@ -1651,7 +1651,7 @@ def set_webhook(self,
         url_ = '{0}/setWebhook'.format(self.base_url)
 
         # Backwards-compatibility: 'url' used to be named 'webhook_url'
-        if 'webhook_url' in kwargs:
+        if 'webhook_url' in kwargs:  # pragma: no cover
             warnings.warn("The 'webhook_url' parameter has been renamed to 'url' in accordance "
                           "with the API")
 

diff --git a/telegram/callbackquery.py b/telegram/callbackquery.py
@@ -90,7 +90,7 @@ def __init__(self,
 
         self.bot = bot
 
-        self._id_attrs = ('id',)
+        self._id_attrs = (self.id,)
 
     @classmethod
     def de_json(cls, data, bot):

diff --git a/telegram/ext/dispatcher.py b/telegram/ext/dispatcher.py
@@ -135,12 +135,6 @@ def __init__(self, bot, update_queue, workers=4, exception_event=None, job_queue
             else:
                 self._set_singleton(None)
 
-    @classmethod
-    def _reset_singleton(cls):
-        # NOTE: This method was added mainly for test_updater benefit and specifically pypy. Never
-        #       call it in production code.
-        cls.__singleton_semaphore.release()
-
     def _init_async_threads(self, base_name, workers):
         base_name = '{}_'.format(base_name) if base_name else ''
 

diff --git a/telegram/games/game.py b/telegram/games/game.py
@@ -68,7 +68,7 @@ def __init__(self,
         self.description = description
         self.photo = photo
         self.text = text
-        self.text_entities = text_entities
+        self.text_entities = text_entities or list()
         self.animation = animation
 
     @classmethod