mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-10-24 09:56:30 +02:00
80 lines
2.7 KiB
Python
80 lines
2.7 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# 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
|
|
# 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 the base class for handlers as used by the
|
|
Dispatcher """
|
|
|
|
|
|
class Handler(object):
|
|
"""
|
|
The base class for all update handlers. You can create your own handlers
|
|
by inheriting from this class.
|
|
|
|
Args:
|
|
callback (function): A function that takes ``bot, update`` as
|
|
positional arguments. It will be called when the ``checkUpdate``
|
|
has determined that an update should be processed by this handler.
|
|
pass_update_queue (optional[bool]): If the callback 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):
|
|
self.callback = callback
|
|
self.pass_update_queue = pass_update_queue
|
|
|
|
def checkUpdate(self, update):
|
|
"""
|
|
This method is called to determine if an update should be handled by
|
|
this handler instance. It should always be overridden.
|
|
|
|
Args:
|
|
update (object): The update to be tested
|
|
|
|
Returns:
|
|
bool
|
|
"""
|
|
raise NotImplementedError
|
|
|
|
def handleUpdate(self, update, dispatcher):
|
|
"""
|
|
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
|
|
cases call self.callback(dispatcher.bot, update), possibly along with
|
|
optional arguments.
|
|
|
|
Args:
|
|
update (object): The update to be handled
|
|
|
|
"""
|
|
raise NotImplementedError
|
|
|
|
def collectOptionalArgs(self, dispatcher):
|
|
"""
|
|
Prepares the optional arguments that are the same for all types of
|
|
handlers
|
|
|
|
Args:
|
|
dispatcher (Dispatcher):
|
|
"""
|
|
optional_args = dict()
|
|
if self.pass_update_queue:
|
|
optional_args['update_queue'] = dispatcher.update_queue
|
|
|
|
return optional_args
|