Skip to content

Improved CommandHandler #613

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jh0ker merged 5 commits into from
May 19, 2017
Merged

Improved CommandHandler #613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ec59044
Improved CommandHandler
evgfilim1 May 16, 2017
b46f2f6
Added tests for list of commands
evgfilim1 May 18, 2017
978bfd0
Return backward compatibility
evgfilim1 May 19, 2017
f067de4
Added test for a command not in the list
evgfilim1 May 19, 2017
7fe968d
Fixed py2 unicode command support in `CommandHandler`
evgfilim1 May 19, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions telegram/ext/commandhandler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ class CommandHandler(Handler):
name and/or some additional text.

Args:
command (str): The name of the command this handler should listen for.
command (str|list): The name of the command or list of command this handler should
listen for.
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.
Expand Down Expand Up @@ -79,7 +80,15 @@ def __init__(self,
pass_job_queue=pass_job_queue,
pass_user_data=pass_user_data,
pass_chat_data=pass_chat_data)
self.command = command
try:
_str = basestring # Python 2
except NameError:
_str = str # Python 3

if isinstance(command, _str):
self.command = [command]
else:
self.command = command
self.filters = filters
self.allow_edited = allow_edited
self.pass_args = pass_args
Expand Down Expand Up @@ -108,7 +117,7 @@ def check_update(self, update):
else:
res = self.filters(message)

return res and (message.text.startswith('/') and command[0] == self.command
return res and (message.text.startswith('/') and command[0] in self.command
and command[1].lower() == message.bot.username.lower())
else:
return False
Expand Down
29 changes: 29 additions & 0 deletions tests/test_updater.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,35 @@ def test_filterNotPassTelegramCommandHandler(self):
sleep(.1)
self.assertTrue(None is self.received_message)

def test_CommandHandler_commandList(self):
self._setup_updater('', messages=0)
handler = CommandHandler(['foo', 'bar', 'spameggs'], self.telegramHandlerTest)
self.updater.dispatcher.add_handler(handler)
bot = self.updater.bot
user = User(0, 'TestUser')
queue = self.updater.start_polling(0.01)

message = Message(0, user, 0, None, text='/foo', bot=bot)
queue.put(Update(0, message=message))
sleep(.1)
self.assertEqual(self.received_message, '/foo')

message.text = '/bar'
queue.put(Update(1, message=message))
sleep(.1)
self.assertEqual(self.received_message, '/bar')

message.text = '/spameggs'
queue.put(Update(2, message=message))
sleep(.1)
self.assertEqual(self.received_message, '/spameggs')

self.reset()
message.text = '/not_in_list'
queue.put(Update(3, message=message))
sleep(.1)
self.assertTrue(self.received_message is None)

def test_addRemoveStringRegexHandler(self):
self._setup_updater('', messages=0)
d = self.updater.dispatcher
Expand Down