2016-04-14 23:57:40 +02:00
|
|
|
#!/usr/bin/env python
|
|
|
|
#
|
|
|
|
# A library that provides a Python interface to the Telegram Bot API
|
2017-05-14 12:18:29 +02:00
|
|
|
# Copyright (C) 2015-2017
|
2016-04-14 23:57:40 +02:00
|
|
|
# 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/].
|
2017-09-01 08:43:08 +02:00
|
|
|
"""This module contains the base class for handlers as used by the Dispatcher."""
|
2016-04-14 23:57:40 +02:00
|
|
|
|
|
|
|
|
|
|
|
class Handler(object):
|
2017-09-01 08:43:08 +02:00
|
|
|
"""The base class for all update handlers. Create custom handlers by inheriting from it.
|
2017-07-23 22:33:08 +02:00
|
|
|
|
|
|
|
Attributes:
|
|
|
|
callback (:obj:`callable`): The callback function for this handler.
|
|
|
|
pass_update_queue (:obj:`bool`): Optional. Determines whether ``update_queue`` will be
|
|
|
|
passed to the callback function.
|
|
|
|
pass_job_queue (:obj:`bool`): Optional. Determines whether ``job_queue`` will be passed to
|
|
|
|
the callback function.
|
|
|
|
pass_user_data (:obj:`bool`): Optional. Determines whether ``user_data`` will be passed to
|
|
|
|
the callback function.
|
|
|
|
pass_chat_data (:obj:`bool`): Optional. Determines whether ``chat_data`` will be passed to
|
|
|
|
the callback function.
|
|
|
|
|
|
|
|
Note:
|
|
|
|
:attr:`pass_user_data` and :attr:`pass_chat_data` determine whether a ``dict`` you
|
|
|
|
can use to keep any data in will be sent to the :attr:`callback` function.. Related to
|
|
|
|
either the user or the chat that the update was sent in. For each update from the same user
|
|
|
|
or in the same chat, it will be the same ``dict``.
|
2016-04-16 16:36:12 +02:00
|
|
|
|
|
|
|
Args:
|
2017-07-23 22:33:08 +02:00
|
|
|
callback (:obj:`callable`): A function that takes ``bot, update`` as positional arguments.
|
|
|
|
It will be called when the :attr:`check_update` has determined that an update should be
|
|
|
|
processed by this handler.
|
|
|
|
pass_update_queue (:obj:`bool`, optional): If set to ``True``, a keyword argument called
|
2016-05-28 16:04:19 +02:00
|
|
|
``update_queue`` will be passed to the callback function. It will be the ``Queue``
|
2017-07-23 22:33:08 +02:00
|
|
|
instance used by the :class:`telegram.ext.Updater` and :class:`telegram.ext.Dispatcher`
|
|
|
|
that contains new updates which can be used to insert updates. Default is ``False``.
|
|
|
|
pass_job_queue (:obj:`bool`, optional): If set to ``True``, a keyword argument called
|
|
|
|
``job_queue`` will be passed to the callback function. It will be a
|
|
|
|
:class:`telegram.ext.JobQueue` instance created by the :class:`telegram.ext.Updater`
|
|
|
|
which can be used to schedule new jobs. Default is ``False``.
|
|
|
|
pass_user_data (:obj:`bool`, optional): If set to ``True``, a keyword argument called
|
|
|
|
``user_data`` will be passed to the callback function. Default is ``False``.
|
|
|
|
pass_chat_data (:obj:`bool`, optional): If set to ``True``, a keyword argument called
|
|
|
|
``chat_data`` will be passed to the callback function. Default is ``False``.
|
2017-09-01 08:43:08 +02:00
|
|
|
|
2016-04-16 16:36:12 +02:00
|
|
|
"""
|
2016-04-14 23:57:40 +02:00
|
|
|
|
2016-10-25 19:28:34 +02:00
|
|
|
def __init__(self,
|
|
|
|
callback,
|
|
|
|
pass_update_queue=False,
|
|
|
|
pass_job_queue=False,
|
|
|
|
pass_user_data=False,
|
|
|
|
pass_chat_data=False):
|
2016-04-14 23:57:40 +02:00
|
|
|
self.callback = callback
|
|
|
|
self.pass_update_queue = pass_update_queue
|
2016-05-26 14:39:11 +02:00
|
|
|
self.pass_job_queue = pass_job_queue
|
2016-10-25 19:28:34 +02:00
|
|
|
self.pass_user_data = pass_user_data
|
|
|
|
self.pass_chat_data = pass_chat_data
|
2016-04-14 23:57:40 +02:00
|
|
|
|
2016-04-28 14:29:27 +02:00
|
|
|
def check_update(self, update):
|
2016-04-14 23:57:40 +02:00
|
|
|
"""
|
|
|
|
This method is called to determine if an update should be handled by
|
|
|
|
this handler instance. It should always be overridden.
|
|
|
|
|
|
|
|
Args:
|
2017-07-23 22:33:08 +02:00
|
|
|
update (:obj:`str` | :class:`telegram.Update`): The update to be tested.
|
2016-04-25 09:19:50 +02:00
|
|
|
|
|
|
|
Returns:
|
2017-07-23 22:33:08 +02:00
|
|
|
:obj:`bool`
|
2017-09-01 08:43:08 +02:00
|
|
|
|
2016-04-14 23:57:40 +02:00
|
|
|
"""
|
|
|
|
raise NotImplementedError
|
|
|
|
|
2016-04-28 14:29:27 +02:00
|
|
|
def handle_update(self, update, dispatcher):
|
2016-04-14 23:57:40 +02:00
|
|
|
"""
|
|
|
|
This method is called if it was determined that an update should indeed
|
|
|
|
be handled by this instance. It should also be overridden, but in most
|
2016-07-15 01:30:54 +02:00
|
|
|
cases call ``self.callback(dispatcher.bot, update)``, possibly along with
|
|
|
|
optional arguments. To work with the ``ConversationHandler``, this method should return the
|
|
|
|
value returned from ``self.callback``
|
2016-04-14 23:57:40 +02:00
|
|
|
|
|
|
|
Args:
|
2017-07-23 22:33:08 +02:00
|
|
|
update (:obj:`str` | :class:`telegram.Update`): The update to be handled.
|
|
|
|
dispatcher (:class:`telegram.ext.Dispatcher`): The dispatcher to collect optional args.
|
2016-04-14 23:57:40 +02:00
|
|
|
|
|
|
|
"""
|
|
|
|
raise NotImplementedError
|
|
|
|
|
2016-10-25 19:28:34 +02:00
|
|
|
def collect_optional_args(self, dispatcher, update=None):
|
2017-09-01 08:43:08 +02:00
|
|
|
"""Prepares the optional arguments that are the same for all types of handlers.
|
2016-04-14 23:57:40 +02:00
|
|
|
|
|
|
|
Args:
|
2017-07-23 22:33:08 +02:00
|
|
|
dispatcher (:class:`telegram.ext.Dispatcher`): The dispatcher.
|
2017-09-01 08:43:08 +02:00
|
|
|
|
2016-04-14 23:57:40 +02:00
|
|
|
"""
|
|
|
|
optional_args = dict()
|
2016-10-25 19:28:34 +02:00
|
|
|
|
2016-04-14 23:57:40 +02:00
|
|
|
if self.pass_update_queue:
|
|
|
|
optional_args['update_queue'] = dispatcher.update_queue
|
2016-05-26 14:39:11 +02:00
|
|
|
if self.pass_job_queue:
|
|
|
|
optional_args['job_queue'] = dispatcher.job_queue
|
2016-10-25 19:28:34 +02:00
|
|
|
if self.pass_user_data or self.pass_chat_data:
|
2017-03-26 14:36:34 +02:00
|
|
|
chat = update.effective_chat
|
|
|
|
user = update.effective_user
|
2016-10-25 19:28:34 +02:00
|
|
|
|
|
|
|
if self.pass_user_data:
|
2017-03-26 14:36:34 +02:00
|
|
|
optional_args['user_data'] = dispatcher.user_data[user.id if user else None]
|
2016-10-25 19:28:34 +02:00
|
|
|
|
|
|
|
if self.pass_chat_data:
|
|
|
|
optional_args['chat_data'] = dispatcher.chat_data[chat.id if chat else None]
|
2016-04-14 23:57:40 +02:00
|
|
|
|
|
|
|
return optional_args
|