2016-04-14 23:57:40 +02:00
|
|
|
#!/usr/bin/env python
|
|
|
|
#
|
|
|
|
# A library that provides a Python interface to the Telegram Bot API
|
2022-01-03 08:15:18 +01:00
|
|
|
# Copyright (C) 2015-2022
|
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."""
|
2020-05-01 20:27:34 +02:00
|
|
|
from abc import ABC, abstractmethod
|
2021-08-29 18:15:04 +02:00
|
|
|
from typing import TYPE_CHECKING, Any, Callable, Optional, TypeVar, Union, Generic
|
2016-04-14 23:57:40 +02:00
|
|
|
|
2021-10-10 15:10:21 +02:00
|
|
|
from telegram._utils.defaultvalue import DefaultValue, DEFAULT_FALSE
|
|
|
|
from telegram.ext._utils.promise import Promise
|
|
|
|
from telegram.ext._utils.types import CCT
|
|
|
|
from telegram.ext._extbot import ExtBot
|
2020-10-09 17:22:07 +02:00
|
|
|
|
2020-10-06 19:28:40 +02:00
|
|
|
if TYPE_CHECKING:
|
2021-06-06 10:37:53 +02:00
|
|
|
from telegram.ext import Dispatcher
|
2020-10-06 19:28:40 +02:00
|
|
|
|
|
|
|
RT = TypeVar('RT')
|
2020-12-16 17:34:57 +01:00
|
|
|
UT = TypeVar('UT')
|
2020-10-06 19:28:40 +02:00
|
|
|
|
2020-05-01 20:27:34 +02:00
|
|
|
|
2021-06-06 10:37:53 +02:00
|
|
|
class Handler(Generic[UT, CCT], ABC):
|
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
|
|
|
|
2020-10-04 17:20:33 +02:00
|
|
|
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.
|
|
|
|
|
2016-04-16 16:36:12 +02:00
|
|
|
Args:
|
2018-09-21 08:57:01 +02:00
|
|
|
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.
|
2021-08-29 18:15:04 +02:00
|
|
|
Callback signature: ``def callback(update: Update, context: CallbackContext)``
|
2018-09-21 08:57:01 +02:00
|
|
|
|
|
|
|
The return value of the callback is usually ignored except for the special case of
|
|
|
|
:class:`telegram.ext.ConversationHandler`.
|
2020-10-04 17:20:33 +02:00
|
|
|
run_async (:obj:`bool`): Determines whether the callback will run asynchronously.
|
|
|
|
Defaults to :obj:`False`.
|
2017-09-01 08:43:08 +02:00
|
|
|
|
2020-12-30 15:59:50 +01:00
|
|
|
Attributes:
|
|
|
|
callback (:obj:`callable`): The callback function for this handler.
|
|
|
|
run_async (:obj:`bool`): Determines whether the callback will run asynchronously.
|
|
|
|
|
2016-04-16 16:36:12 +02:00
|
|
|
"""
|
2020-10-09 17:22:07 +02:00
|
|
|
|
2021-08-19 22:01:10 +02:00
|
|
|
__slots__ = (
|
|
|
|
'callback',
|
|
|
|
'run_async',
|
|
|
|
)
|
2021-05-29 16:18:16 +02:00
|
|
|
|
2020-10-09 17:22:07 +02:00
|
|
|
def __init__(
|
|
|
|
self,
|
2021-06-06 10:37:53 +02:00
|
|
|
callback: Callable[[UT, CCT], RT],
|
2020-11-17 21:31:01 +01:00
|
|
|
run_async: Union[bool, DefaultValue] = DEFAULT_FALSE,
|
2020-10-09 17:22:07 +02:00
|
|
|
):
|
2020-12-16 17:34:57 +01:00
|
|
|
self.callback = callback
|
2020-10-04 17:20:33 +02:00
|
|
|
self.run_async = run_async
|
2016-04-14 23:57:40 +02:00
|
|
|
|
2020-05-01 20:27:34 +02:00
|
|
|
@abstractmethod
|
2021-01-30 11:38:54 +01:00
|
|
|
def check_update(self, update: object) -> Optional[Union[bool, object]]:
|
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.
|
|
|
|
|
2020-12-16 17:34:57 +01:00
|
|
|
Note:
|
|
|
|
Custom updates types can be handled by the dispatcher. Therefore, an implementation of
|
|
|
|
this method should always check the type of :attr:`update`.
|
|
|
|
|
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 tested.
|
2016-04-25 09:19:50 +02:00
|
|
|
|
|
|
|
Returns:
|
Documentation Improvements (#2008)
* Minor doc updates, following official API docs
* Fix spelling in Defaults docstrings
* Clarify Changelog of v12.7 about aware dates
* Fix typo in CHANGES.rst (#2024)
* Fix PicklePersistence.flush() with only bot_data (#2017)
* Update pylint in pre-commit to fix CI (#2018)
* Add Filters.via_bot (#2009)
* feat: via_bot filter
also fixing a small mistake in the empty parameter of the user filter and improve docs slightly
* fix: forgot to set via_bot to None
* fix: redoing subclassing to copy paste solution
* Cosmetic changes
Co-authored-by: Hinrich Mahler <hinrich.mahler@freenet.de>
* Update CHANGES.rst
Fixed Typo
Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
* Update downloads badge, add info on IRC Channel to Getting Help section
* Remove RegexHandler from ConversationHandlers Docs (#1973)
Replaced RegexHandler with MessageHandler, since the former is deprecated
* Fix Filters.via_bot docstrings
* Add notes on Markdown v1 being legacy mode
* Fixed typo in the Regex doc.. (#2036)
* Typo: Spelling
* Minor cleanup from #2043
* Document CommandHandler ignoring channel posts
* Doc fixes for a few telegram.ext classes
* Doc fixes for most `telegram` classes.
* pep-8
forgot the hard wrap is at 99 chars, not 100!
fixed a few spelling mistakes too.
* Address review and made rendering of booleans consistent
True, False, None are now rendered with ``bool`` wherever they weren't in telegram and telegram.ext classes.
* Few doc fixes for inline* classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram/files classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram.Game
Mostly just added hyperlinks. And fixed message length doc.
As usual, docs were cross-checked with official tg api docs.
* Very minor doc fix for passportfile.py and passportelementerrors.py
Didn't bother changing too much since this seems to be a custom implementation.
* Doc fixes for telegram.payments
As usual, cross-checked with official bot api docs.
* Address review 2
Few tiny other fixes too.
* Changed from ``True/False/None`` to :obj:`True/False/None` project-wide.
Few tiny other doc fixes too.
Co-authored-by: Robert Geislinger <mitachundkrach@gmail.com>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
Co-authored-by: GauthamramRavichandran <30320759+GauthamramRavichandran@users.noreply.github.com>
Co-authored-by: Mahesh19 <maheshvagicherla99438@gmail.com>
Co-authored-by: hoppingturtles <ilovebhagwan@gmail.com>
2020-08-24 19:35:57 +02:00
|
|
|
Either :obj:`None` or :obj:`False` if the update should not be handled. Otherwise an
|
|
|
|
object that will be passed to :meth:`handle_update` and
|
|
|
|
:meth:`collect_additional_context` when the update gets handled.
|
2017-09-01 08:43:08 +02:00
|
|
|
|
2016-04-14 23:57:40 +02:00
|
|
|
"""
|
|
|
|
|
2020-10-09 17:22:07 +02:00
|
|
|
def handle_update(
|
|
|
|
self,
|
2020-12-16 17:34:57 +01:00
|
|
|
update: UT,
|
2020-10-09 17:22:07 +02:00
|
|
|
dispatcher: 'Dispatcher',
|
|
|
|
check_result: object,
|
2021-08-29 18:15:04 +02:00
|
|
|
context: CCT,
|
2020-10-09 17:22:07 +02:00
|
|
|
) -> Union[RT, Promise]:
|
2016-04-14 23:57:40 +02:00
|
|
|
"""
|
|
|
|
This method is called if it was determined that an update should indeed
|
Documentation Improvements (#2008)
* Minor doc updates, following official API docs
* Fix spelling in Defaults docstrings
* Clarify Changelog of v12.7 about aware dates
* Fix typo in CHANGES.rst (#2024)
* Fix PicklePersistence.flush() with only bot_data (#2017)
* Update pylint in pre-commit to fix CI (#2018)
* Add Filters.via_bot (#2009)
* feat: via_bot filter
also fixing a small mistake in the empty parameter of the user filter and improve docs slightly
* fix: forgot to set via_bot to None
* fix: redoing subclassing to copy paste solution
* Cosmetic changes
Co-authored-by: Hinrich Mahler <hinrich.mahler@freenet.de>
* Update CHANGES.rst
Fixed Typo
Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
* Update downloads badge, add info on IRC Channel to Getting Help section
* Remove RegexHandler from ConversationHandlers Docs (#1973)
Replaced RegexHandler with MessageHandler, since the former is deprecated
* Fix Filters.via_bot docstrings
* Add notes on Markdown v1 being legacy mode
* Fixed typo in the Regex doc.. (#2036)
* Typo: Spelling
* Minor cleanup from #2043
* Document CommandHandler ignoring channel posts
* Doc fixes for a few telegram.ext classes
* Doc fixes for most `telegram` classes.
* pep-8
forgot the hard wrap is at 99 chars, not 100!
fixed a few spelling mistakes too.
* Address review and made rendering of booleans consistent
True, False, None are now rendered with ``bool`` wherever they weren't in telegram and telegram.ext classes.
* Few doc fixes for inline* classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram/files classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram.Game
Mostly just added hyperlinks. And fixed message length doc.
As usual, docs were cross-checked with official tg api docs.
* Very minor doc fix for passportfile.py and passportelementerrors.py
Didn't bother changing too much since this seems to be a custom implementation.
* Doc fixes for telegram.payments
As usual, cross-checked with official bot api docs.
* Address review 2
Few tiny other fixes too.
* Changed from ``True/False/None`` to :obj:`True/False/None` project-wide.
Few tiny other doc fixes too.
Co-authored-by: Robert Geislinger <mitachundkrach@gmail.com>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
Co-authored-by: GauthamramRavichandran <30320759+GauthamramRavichandran@users.noreply.github.com>
Co-authored-by: Mahesh19 <maheshvagicherla99438@gmail.com>
Co-authored-by: hoppingturtles <ilovebhagwan@gmail.com>
2020-08-24 19:35:57 +02:00
|
|
|
be handled by this instance. Calls :attr:`callback` along with its respectful
|
2018-09-21 08:57:01 +02:00
|
|
|
arguments. To work with the :class:`telegram.ext.ConversationHandler`, this method
|
Documentation Improvements (#2008)
* Minor doc updates, following official API docs
* Fix spelling in Defaults docstrings
* Clarify Changelog of v12.7 about aware dates
* Fix typo in CHANGES.rst (#2024)
* Fix PicklePersistence.flush() with only bot_data (#2017)
* Update pylint in pre-commit to fix CI (#2018)
* Add Filters.via_bot (#2009)
* feat: via_bot filter
also fixing a small mistake in the empty parameter of the user filter and improve docs slightly
* fix: forgot to set via_bot to None
* fix: redoing subclassing to copy paste solution
* Cosmetic changes
Co-authored-by: Hinrich Mahler <hinrich.mahler@freenet.de>
* Update CHANGES.rst
Fixed Typo
Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
* Update downloads badge, add info on IRC Channel to Getting Help section
* Remove RegexHandler from ConversationHandlers Docs (#1973)
Replaced RegexHandler with MessageHandler, since the former is deprecated
* Fix Filters.via_bot docstrings
* Add notes on Markdown v1 being legacy mode
* Fixed typo in the Regex doc.. (#2036)
* Typo: Spelling
* Minor cleanup from #2043
* Document CommandHandler ignoring channel posts
* Doc fixes for a few telegram.ext classes
* Doc fixes for most `telegram` classes.
* pep-8
forgot the hard wrap is at 99 chars, not 100!
fixed a few spelling mistakes too.
* Address review and made rendering of booleans consistent
True, False, None are now rendered with ``bool`` wherever they weren't in telegram and telegram.ext classes.
* Few doc fixes for inline* classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram/files classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram.Game
Mostly just added hyperlinks. And fixed message length doc.
As usual, docs were cross-checked with official tg api docs.
* Very minor doc fix for passportfile.py and passportelementerrors.py
Didn't bother changing too much since this seems to be a custom implementation.
* Doc fixes for telegram.payments
As usual, cross-checked with official bot api docs.
* Address review 2
Few tiny other fixes too.
* Changed from ``True/False/None`` to :obj:`True/False/None` project-wide.
Few tiny other doc fixes too.
Co-authored-by: Robert Geislinger <mitachundkrach@gmail.com>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
Co-authored-by: GauthamramRavichandran <30320759+GauthamramRavichandran@users.noreply.github.com>
Co-authored-by: Mahesh19 <maheshvagicherla99438@gmail.com>
Co-authored-by: hoppingturtles <ilovebhagwan@gmail.com>
2020-08-24 19:35:57 +02:00
|
|
|
returns the value returned from :attr:`callback`.
|
2018-09-21 08:57:01 +02:00
|
|
|
Note that it can be overridden if needed by the subclassing handler.
|
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.
|
2018-09-21 08:57:01 +02:00
|
|
|
dispatcher (:class:`telegram.ext.Dispatcher`): The calling dispatcher.
|
2020-10-06 19:28:40 +02:00
|
|
|
check_result (:obj:`obj`): The result from :attr:`check_update`.
|
2021-08-29 18:15:04 +02:00
|
|
|
context (:class:`telegram.ext.CallbackContext`): The context as provided by
|
2020-10-06 19:28:40 +02:00
|
|
|
the dispatcher.
|
2016-04-14 23:57:40 +02:00
|
|
|
|
|
|
|
"""
|
2020-11-17 21:31:01 +01:00
|
|
|
run_async = self.run_async
|
2021-05-27 09:38:17 +02:00
|
|
|
if (
|
|
|
|
self.run_async is DEFAULT_FALSE
|
2021-10-03 15:10:13 +02:00
|
|
|
and isinstance(dispatcher.bot, ExtBot)
|
2021-05-27 09:38:17 +02:00
|
|
|
and dispatcher.bot.defaults
|
|
|
|
and dispatcher.bot.defaults.run_async
|
|
|
|
):
|
|
|
|
run_async = True
|
2020-11-17 21:31:01 +01:00
|
|
|
|
2021-08-29 18:15:04 +02:00
|
|
|
self.collect_additional_context(context, update, dispatcher, check_result)
|
2020-11-17 21:31:01 +01:00
|
|
|
if run_async:
|
2021-08-29 18:15:04 +02:00
|
|
|
return dispatcher.run_async(self.callback, update, context, update=update)
|
|
|
|
return self.callback(update, context)
|
2018-09-21 08:57:01 +02:00
|
|
|
|
2020-10-09 17:22:07 +02:00
|
|
|
def collect_additional_context(
|
|
|
|
self,
|
2021-06-06 10:37:53 +02:00
|
|
|
context: CCT,
|
2020-12-16 17:34:57 +01:00
|
|
|
update: UT,
|
2020-10-09 17:22:07 +02:00
|
|
|
dispatcher: 'Dispatcher',
|
|
|
|
check_result: Any,
|
|
|
|
) -> None:
|
2018-09-21 08:57:01 +02:00
|
|
|
"""Prepares additional arguments for the context. Override if needed.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
context (:class:`telegram.ext.CallbackContext`): The context object.
|
|
|
|
update (:class:`telegram.Update`): The update to gather chat/user id from.
|
|
|
|
dispatcher (:class:`telegram.ext.Dispatcher`): The calling dispatcher.
|
|
|
|
check_result: The result (return value) from :attr:`check_update`.
|
|
|
|
|
|
|
|
"""
|