mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-11-26 09:07:43 +01:00
425716f966
* Add Defaults.run_async support Signed-off-by: starry69 <starry369126@outlook.com> * Address some requested changes. Signed-off-by: starry69 <starry369126@outlook.com> * Add tests for defaults.run_async Signed-off-by: starry69 <starry369126@outlook.com> * Fix tests logic & add default value support for dp.add_error_handler Signed-off-by: starry69 <starry369126@outlook.com> * Fix tests, with requested changes Signed-off-by: starry69 <starry369126@outlook.com> * Add tests for error_handler Signed-off-by: starry69 <starry369126@outlook.com> * try to fix pre-commit Signed-off-by: starry69 <starry369126@outlook.com> * Enhance tests & address suggested changes Signed-off-by: starry69 <starry369126@outlook.com> * Improve docs Signed-off-by: starry69 <starry369126@outlook.com>
107 lines
4.6 KiB
Python
107 lines
4.6 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2020
|
|
# 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 typing import TYPE_CHECKING, Any, Callable, Type, TypeVar, Union
|
|
from telegram.utils.helpers import DefaultValue, DEFAULT_FALSE
|
|
|
|
from .handler import Handler
|
|
|
|
if TYPE_CHECKING:
|
|
from telegram.ext import CallbackContext
|
|
|
|
RT = TypeVar('RT')
|
|
|
|
|
|
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 :obj:`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.
|
|
run_async (:obj:`bool`): Determines whether the callback will run asynchronously.
|
|
|
|
Warning:
|
|
When setting ``run_async`` to :obj:`True`, you cannot rely on adding custom
|
|
attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info.
|
|
|
|
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 :obj:`False`
|
|
pass_update_queue (:obj:`bool`, optional): If set to :obj:`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 :obj:`False`.
|
|
DEPRECATED: Please switch to context based callbacks.
|
|
pass_job_queue (:obj:`bool`, optional): If set to :obj:`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 :obj:`False`.
|
|
DEPRECATED: Please switch to context based callbacks.
|
|
run_async (:obj:`bool`): Determines whether the callback will run asynchronously.
|
|
Defaults to :obj:`False`.
|
|
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
type: Type, # pylint: disable=W0622
|
|
callback: Callable[[Any, 'CallbackContext'], RT],
|
|
strict: bool = False,
|
|
pass_update_queue: bool = False,
|
|
pass_job_queue: bool = False,
|
|
run_async: Union[bool, DefaultValue] = DEFAULT_FALSE,
|
|
):
|
|
super().__init__(
|
|
callback,
|
|
pass_update_queue=pass_update_queue,
|
|
pass_job_queue=pass_job_queue,
|
|
run_async=run_async,
|
|
)
|
|
self.type = type
|
|
self.strict = strict
|
|
|
|
def check_update(self, update: Any) -> bool:
|
|
"""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)
|
|
return type(update) is self.type # pylint: disable=C0123
|