Merge e193e5b into 1bff367

docs/conf.py

@@ -36,7 +36,7 @@
 templates_path = ['_templates']
 
 intersphinx_mapping = {'telegram': ('http://python-telegram-bot.readthedocs.io/en/latest/', None)}
-# The suffix(es) of source filenames.
+# The suffix(es) of source file names.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']

examples/test_conversationbot2.py

@@ -1,7 +1,7 @@
 from __future__ import absolute_import
+
 import unittest
 
-from ptbtest import UserGenerator
 from telegram import ReplyKeyboardMarkup
 from telegram.ext import CommandHandler
 from telegram.ext import ConversationHandler
@@ -13,6 +13,7 @@
 from ptbtest import ChatGenerator
 from ptbtest import MessageGenerator
 from ptbtest import Mockbot
+from ptbtest import UserGenerator
 
 """
 This is an example to show how the ptbtest suite can be used.
@@ -112,7 +113,7 @@ def done(bot, update, user_data):
         self.updater.start_polling()
 
         # We are going to test a conversationhandler. Since this is tied in with user and chat we need to
-        # create both for consistancy
+        # create both for consistency
         user = self.ug.get_user()
         chat = self.cg.get_chat(type="group")
         user2 = self.ug.get_user()

examples/test_echobot2.py

@@ -1,4 +1,5 @@
 from __future__ import absolute_import
+
 import unittest
 
 from telegram.ext import CommandHandler
@@ -17,6 +18,8 @@
 https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/echobot2.py
 
 """
+
+
 class TestEchobot2(unittest.TestCase):
     def setUp(self):
         # For use within the tests we nee some stuff. Starting with a Mockbot
@@ -28,6 +31,10 @@ def setUp(self):
         self.mg = MessageGenerator(self.bot)
         self.updater = Updater(bot=self.bot)
 
+    def tearDown(self):
+        # Always stop the updater at the end of a test case so it won't hang.
+        self.updater.stop()
+
     def test_help(self):
         # this tests the help handler. So first insert the handler
         def help(bot, update):
@@ -36,7 +43,7 @@ def help(bot, update):
         # Then register the handler with he updater's dispatcher and start polling
         self.updater.dispatcher.add_handler(CommandHandler("help", help))
         self.updater.start_polling()
-        # We want to simulate a message. Since we don't care wich user sends it we let the MessageGenerator
+        # We want to simulate a message. Since we don't care which user sends it we let the MessageGenerator
         # create random ones
         update = self.mg.get_message(text="/help")
         # We insert the update with the bot so the updater can retrieve it.
@@ -47,8 +54,6 @@ def help(bot, update):
         sent = self.bot.sent_messages[0]
         self.assertEqual(sent['method'], "sendMessage")
         self.assertEqual(sent['text'], "Help!")
-        # Always stop the updater at the end of a testcase so it won't hang.
-        self.updater.stop()
 
     def test_start(self):
         def start(bot, update):
@@ -65,7 +70,6 @@ def start(bot, update):
         sent = self.bot.sent_messages[0]
         self.assertEqual(sent['method'], "sendMessage")
         self.assertEqual(sent['text'], "Hi!")
-        self.updater.stop()
 
     def test_echo(self):
         def echo(bot, update):
@@ -82,7 +86,6 @@ def echo(bot, update):
         self.assertEqual(sent[0]['method'], "sendMessage")
         self.assertEqual(sent[0]['text'], "first message")
         self.assertEqual(sent[1]['text'], "second message")
-        self.updater.stop()
 
 
 if __name__ == '__main__':

examples/test_inlinekeyboard.py

@@ -1,12 +1,13 @@
 from __future__ import absolute_import
+
 import unittest
 
-from ptbtest import CallbackQueryGenerator
 from telegram import InlineKeyboardButton
 from telegram import InlineKeyboardMarkup
 from telegram.ext import CallbackQueryHandler
 from telegram.ext import Updater
 
+from ptbtest import CallbackQueryGenerator
 from ptbtest import ChatGenerator
 from ptbtest import MessageGenerator
 from ptbtest import Mockbot
@@ -18,6 +19,8 @@
 We will skip the start and help callbacks and focus on the callback query.
 
 """
+
+
 class TestInlineKeyboard(unittest.TestCase):
     def setUp(self):
         # For use within the tests we nee some stuff. Starting with a Mockbot
@@ -37,11 +40,12 @@ def button(bot, update):
             bot.editMessageText(text="Selected option: %s" % query.data,
                                 chat_id=query.message.chat_id,
                                 message_id=query.message.message_id)
+
         dp = self.updater.dispatcher
         dp.add_handler(CallbackQueryHandler(button))
         self.updater.start_polling()
 
-        # the start callback in this example generates a message that will be edited, so let's mimick that message
+        # the start callback in this example generates a message that will be edited, so let's mimic that message
         # for future reference
         keyboard = [[InlineKeyboardButton("Option 1", callback_data='1'),
                      InlineKeyboardButton("Option 2", callback_data='2')],

examples/test_timerbot.py

@@ -1,7 +1,7 @@
 from __future__ import absolute_import
-import unittest
 
 import time
+import unittest
 
 from telegram.ext import CommandHandler
 from telegram.ext import Job
@@ -18,6 +18,8 @@
 We will skip the start and help handlers and focus on the timer.
 
 """
+
+
 class Testtimerbot(unittest.TestCase):
     def setUp(self):
         # For use within the tests we nee some stuff. Starting with a Mockbot
@@ -66,6 +68,7 @@ def unset(bot, update, chat_data):
             del chat_data['job']
 
             update.message.reply_text('Timer successfully unset!')
+
         # Now add those handlers to the updater and start polling
         dp = self.updater.dispatcher
         dp.add_handler(CommandHandler("set", set,
@@ -122,4 +125,4 @@ def unset(bot, update, chat_data):
 
 
 if __name__ == '__main__':
-    unittest.main()
+    unittest.main()

ptbtest/callbackquerygenerator.py

@@ -2,7 +2,7 @@
 # pylint: disable=E0611,E0213,E1102,C0103,E1101,W0613,R0913,R0904
 #
 # A library that provides a testing suite fot python-telegram-bot
-# wich can be found on https://github.com/python-telegram-bot/python-telegram-bot
+# which can be found on https://github.com/python-telegram-bot/python-telegram-bot
 # Copyright (C) 2017
 # Pieter Schutz - https://github.com/eldinnie
 #
@@ -21,12 +21,13 @@
 """This module provides a class to generate telegram callback queries"""
 import uuid
 
-from .updategenerator import update
-from .ptbgenerator import PtbGenerator
+from telegram import (CallbackQuery, Message, User)
+
 from ptbtest import (ChatGenerator, MessageGenerator, Mockbot, UserGenerator)
 from ptbtest.errors import (BadBotException, BadCallbackQueryException,
                             BadMessageException, BadUserException)
-from telegram import (CallbackQuery, Message, User)
+from .ptbgenerator import PtbGenerator
+from .updategenerator import update
 
 
 class CallbackQueryGenerator(PtbGenerator):
@@ -37,7 +38,7 @@ class CallbackQueryGenerator(PtbGenerator):
             bot (ptbtest.Mockbot): Bot to encode with the messages
 
         Args:
-            bot (Optional[ptbtest.Mockbot]): supply your own for a custom botname
+            bot (Optional[ptbtest.Mockbot]): supply your own for a custom bot name
     """
 
     def __init__(self, bot=None):
@@ -118,5 +119,6 @@ def get_callback_query(self,
                              data, inline_message_id, game_short_name,
                              self.bot)
 
-    def _gen_id(self):
+    @staticmethod
+    def _gen_id():
         return str(uuid.uuid4())

ptbtest/chatgenerator.py

@@ -2,7 +2,7 @@
 # pylint: disable=E0611,E0213,E1102,C0103,E1101,W0613,R0913,R0904
 #
 # A library that provides a testing suite fot python-telegram-bot
-# wich can be found on https://github.com/python-telegram-bot/python-telegram-bot
+# which can be found on https://github.com/python-telegram-bot/python-telegram-bot
 # Copyright (C) 2017
 # Pieter Schutz - https://github.com/eldinnie
 #
@@ -21,10 +21,11 @@
 """This module provides a class to generate telegram chats"""
 import random
 
-from .ptbgenerator import PtbGenerator
-from ptbtest import UserGenerator
 from telegram import (Chat, User)
 
+from ptbtest import UserGenerator
+from .ptbgenerator import PtbGenerator
+
 
 class ChatGenerator(PtbGenerator):
     """

ptbtest/entityparser.py

@@ -2,7 +2,7 @@
 # pylint: disable=E0611,E0213,E1102,C0103,E1101,W0613,R0913,R0904
 #
 # A library that provides a testing suite fot python-telegram-bot
-# wich can be found on https://github.com/python-telegram-bot/python-telegram-bot
+# which can be found on https://github.com/python-telegram-bot/python-telegram-bot
 # Copyright (C) 2017
 # Pieter Schutz - https://github.com/eldinnie
 #
@@ -18,14 +18,15 @@
 #
 # 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 provides a helperclass to transform marked_up messages to plaintext with entities"""
+"""This module provides a helper class to transform marked_up messages to plaintext with entities"""
 import re
 
-from ptbtest.errors import BadMarkupException
 from telegram import MessageEntity
 
+from ptbtest.errors import BadMarkupException
+
 
-class EntityParser():
+class EntityParser:
     """
     Placeholder class for the static parser methods
     """
@@ -45,9 +46,8 @@ def parse_markdown(message):
             the message after parsing.
         """
         invalids = re.compile(
-            r'''(\*_|\*```|\*`|\*\[.*?\]\(.*?\)|_\*|_```|_`|_\[.*?\]\(.*?\)|```\*|```_|
-                                  ```\[.*?\]\(.*?\)|`\*|`_|`\[.*?\]\(.*?\)|\[.*?\]\(.*?\)\*|
-                                  \[.*?\]\(.*?\)_|\[.*?\]\(.*?\)```|\[.*?\]\(.*?\)`)'''
+            r'(\*_|\*```|\*`|\*\[.*?\]\(.*?\)|_\*|_```|_`|_\[.*?\]\(.*?\)|```\*|```_|```\[.*?\]\(.*?\)'
+            r'|`\*|`_|`\[.*?\]\(.*?\)|\[.*?\]\(.*?\)\*|\[.*?\]\(.*?\)_|\[.*?\]\(.*?\)```|\[.*?\]\(.*?\)`)'
         )
         tags = re.compile(r'(([`]{3}|\*|_|`)(.*?)(\2))')
         text_links = re.compile(r'(\[(?P<text>.*?)\]\((?P<url>.*?)\))')
@@ -66,25 +66,25 @@ def parse_html(message):
             (message(str), entities(list(telegram.MessageEntity))): The entities found in the message and
             the message after parsing.
         """
-        invalids = re.compile(r'''(<b><i>|<b><pre>|<b><code>|<b>(<a.*?>)|
-                                   <i><b>|<i><pre>|<i><code>|<i>(<a.*?>)|
-                                   <pre><b>|<pre><i>|<pre><code>|<pre>(<a.*?>)|
-                                   <code><b>|<code><i>|<code><pre>|<code>(<a.*?>)|
-                                   (<a.*>)?<b>|(<a.*?>)<i>|(<a.*?>)<pre>|(<a.*?>)<code>)'''
+        invalids = re.compile(r'(<b><i>|<b><pre>|<b><code>|<b>(<a.*?>)|<i><b>|<i><pre>'
+                              r'|<i><code>|<i>(<a.*?>)|<pre><b>|<pre><i>|<pre><code>|<pre>(<a.*?>)'
+                              r'|<code><b>|<code><i>|<code><pre>|<code>(<a.*?>)'
+                              r'| {35}(<a.*>)?<b>|(<a.*?>)<i>|(<a.*?>)<pre>|(<a.*?>)<code>)'
+                              # TODO: Without the ` {35}` a test breaks. Please investigate the tag for typos.
                               )
-        tags = re.compile(r'(<(b|i|pre|code)>(.*?)<\/\2>)')
+        tags = re.compile(r'(<(b|i|pre|code)>(.*?)</\2>)')
         text_links = re.compile(
-            r'<a href=[\'\"](?P<url>.*?)[\'\"]>(?P<text>.*?)<\/a>')
+            r'<a href=[\'\"](?P<url>.*?)[\'\"]>(?P<text>.*?)</a>')
 
         return EntityParser.__parse_text("HTML", message, invalids, tags,
                                          text_links)
 
     @staticmethod
     def __parse_text(ptype, message, invalids, tags, text_links):
         entities = []
-        mentions = re.compile(r'@[a-zA-Z0-9]{1,}\b')
-        hashtags = re.compile(r'#[a-zA-Z0-9]{1,}\b')
-        botcommands = re.compile(r'(?<!\/|\w)\/[a-zA-Z0-0_\-]{1,}\b')
+        mentions = re.compile(r'@[a-zA-Z0-9]+\b')
+        hashtags = re.compile(r'#[a-zA-Z0-9]+\b')
+        botcommands = re.compile(r'(?<!/|\w)/[a-zA-Z0_\-]+\b')
         urls = re.compile(
             r'(([hHtTpP]{4}[sS]?|[fFtTpP]{3})://)?([\w_-]+(?:(?:\.[\w_-]+)+))([\w.,@?^=%&:/~+#-]*[\w@?^=%&/~+#-])?'
         )
@@ -105,7 +105,8 @@ def __parse_text(ptype, message, invalids, tags, text_links):
                 parse_type = "code"
             elif tag.groups()[1] in ["pre", "```"]:
                 parse_type = "pre"
-            entities.append(MessageEntity(parse_type, start, len(text)))
+            entities.append(MessageEntity(parse_type, start, len(
+                text)))  # TODO: What if an invalid tag gets passed? Should probably throw exception.
             message = tags.sub(r'\3', message, count=1)
         while text_links.search(message):
             link = text_links.search(message)
@@ -121,13 +122,15 @@ def __parse_text(ptype, message, invalids, tags, text_links):
         for mention in mentions.finditer(message):
             entities.append(
                 MessageEntity('mention',
-                              mention.start(), mention.end() - mention.start(
-                              )))
+                              mention.start(), mention.end() - mention.start()
+                              )
+            )
         for hashtag in hashtags.finditer(message):
             entities.append(
                 MessageEntity('hashtag',
-                              hashtag.start(), hashtag.end() - hashtag.start(
-                              )))
+                              hashtag.start(), hashtag.end() - hashtag.start()
+                              )
+            )
         for botcommand in botcommands.finditer(message):
             entities.append(
                 MessageEntity('bot_command',

ptbtest/errors.py

@@ -2,7 +2,7 @@
 # pylint: disable=E0611,E0213,E1102,C0103,E1101,W0613,R0913,R0904
 #
 # A library that provides a testing suite fot python-telegram-bot
-# wich can be found on https://github.com/python-telegram-bot/python-telegram-bot
+# which can be found on https://github.com/python-telegram-bot/python-telegram-bot
 # Copyright (C) 2017
 # Pieter Schutz - https://github.com/eldinnie
 #

ptbtest/inlinequerygenerator.py

@@ -2,7 +2,7 @@
 # pylint: disable=E0611,E0213,E1102,C0103,E1101,W0613,R0913,R0904
 #
 # A library that provides a testing suite fot python-telegram-bot
-# wich can be found on https://github.com/python-telegram-bot/python-telegram-bot
+# which can be found on https://github.com/python-telegram-bot/python-telegram-bot
 # Copyright (C) 2017
 # Pieter Schutz - https://github.com/eldinnie
 #
@@ -22,11 +22,12 @@
 import uuid
 
 from telegram import ChosenInlineResult
-from .updategenerator import update
-from .ptbgenerator import PtbGenerator
+from telegram import (InlineQuery, Location, User)
+
 from ptbtest import (Mockbot, UserGenerator)
 from ptbtest.errors import (BadBotException, BadUserException)
-from telegram import (InlineQuery, Location, User)
+from .ptbgenerator import PtbGenerator
+from .updategenerator import update
 
 
 class InlineQueryGenerator(PtbGenerator):
@@ -37,7 +38,7 @@ class InlineQueryGenerator(PtbGenerator):
             bot (ptbtest.Mockbot): Bot to encode with the messages
 
         Args:
-            bot (Optional[ptbtest.Mockbot]): supply your own for a custom botname
+            bot (Optional[ptbtest.Mockbot]): supply your own for a custom bot name
     """
 
     def __init__(self, bot=None):
@@ -160,5 +161,6 @@ def get_chosen_inline_result(self,
             location=location,
             inline_message_id=inline_message_id)
 
-    def _gen_id(self):
+    @staticmethod
+    def _gen_id():
         return str(uuid.uuid4())