mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2025-01-24 09:16:00 +01:00
247577b2e2
See https://github.com/python-telegram-bot/python-telegram-bot/wiki/Transition-guide-to-Version-11.0 under Context based callbacks and Filters in handlers for a good guide on the changes in this commit. * Change handlers so context is supported * Attempt to make parameter "guessing" work on py < 3.5 * Document use_context in all handlers * Add Context to docs * Minor fixes to context handling * Add tests for context stuff * Allow the signature check to work on py<3.5 with methods * Fix order of operations * Address most issues raised in CR * Make CommandHandler no longer support filter lists * Fix indent (pycharm can be an arse sometimes) * Improve readability in conversationhandler * Make context have Match instead of groups & groupdict * Remove filter list support from messagehandler too * Small fix to StringCommandHandler * More small fixes to handlers * Amend CHANGES * Fix tests and fix bugs raised by tests * Don't allow users to ignore errors without messing with the warning filters themselves * Ignore our own deprecation warnings when testing * Skipping deprecationwarning test on py2 * Forgot some changes * Handler: Improved documentation and text of deprecation warnings * HandlerContext: Keep only dispatcher and use properties; improved doc * Complete fixing the documentation. - Fixes per Eldinnie's comments. - Fixes per warnings when running sphinx. * Some small doc fixes (interlinks and optionals) * Change add_error_handler to use HandlerContext too * More context based changes Context Based Handlers -> Context Based Callbacks No longer use_context args on every single Handler Instead set dispatcher/updater .use_context=True to use Works with - Handler callbacks - Error handler callbacks - Job callbacks Change examples to context based callbacks so new users are not confused Rename and move the context object from Handlers.HandlerContext to CallbackContext, since it doesn't only apply to handlers anymore. Fix tests by adding a new fixture `cpd` which is a dispatcher with use_context=True * Forgot about conversationhandler * Forgot jobqueue * Add tests for callbackcontext & for context based callback job * Fix as per review :)
88 lines
3.8 KiB
Python
88 lines
3.8 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2018
|
|
# 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 TypeHandler class."""
|
|
|
|
from .handler import Handler
|
|
|
|
|
|
class TypeHandler(Handler):
|
|
"""Handler class to handle updates of custom types.
|
|
|
|
Attributes:
|
|
type (:obj:`type`): The ``type`` of updates this handler should process.
|
|
callback (:obj:`callable`): The callback function for this handler.
|
|
strict (:obj:`bool`): Use ``type`` instead of ``isinstance``. Default is ``False``.
|
|
pass_update_queue (:obj:`bool`): Determines whether ``update_queue`` will be
|
|
passed to the callback function.
|
|
pass_job_queue (:obj:`bool`): Determines whether ``job_queue`` will be passed to
|
|
the callback function.
|
|
|
|
Args:
|
|
type (:obj:`type`): The ``type`` of updates this handler should process, as
|
|
determined by ``isinstance``
|
|
callback (:obj:`callable`): The callback function for this handler. Will be called when
|
|
:attr:`check_update` has determined that an update should be processed by this handler.
|
|
Callback signature for context based API:
|
|
|
|
``def callback(update: Update, context: CallbackContext)``
|
|
|
|
The return value of the callback is usually ignored except for the special case of
|
|
:class:`telegram.ext.ConversationHandler`.
|
|
strict (:obj:`bool`, optional): Use ``type`` instead of ``isinstance``.
|
|
Default is ``False``
|
|
pass_update_queue (:obj:`bool`, optional): If set to ``True``, a keyword argument called
|
|
``update_queue`` will be passed to the callback function. It will be the ``Queue``
|
|
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``.
|
|
DEPRECATED: Please switch to context based callbacks.
|
|
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``.
|
|
DEPRECATED: Please switch to context based callbacks.
|
|
|
|
"""
|
|
|
|
def __init__(self,
|
|
type,
|
|
callback,
|
|
strict=False,
|
|
pass_update_queue=False,
|
|
pass_job_queue=False):
|
|
super(TypeHandler, self).__init__(
|
|
callback,
|
|
pass_update_queue=pass_update_queue,
|
|
pass_job_queue=pass_job_queue)
|
|
self.type = type
|
|
self.strict = strict
|
|
|
|
def check_update(self, update):
|
|
"""Determines whether an update should be passed to this handlers :attr:`callback`.
|
|
|
|
Args:
|
|
update (:class:`telegram.Update`): Incoming telegram update.
|
|
|
|
Returns:
|
|
:obj:`bool`
|
|
|
|
"""
|
|
if not self.strict:
|
|
return isinstance(update, self.type)
|
|
else:
|
|
return type(update) is self.type
|