2016-04-14 23:57:40 +02:00
|
|
|
#!/usr/bin/env python
|
|
|
|
#
|
|
|
|
# A library that provides a Python interface to the Telegram Bot API
|
2023-01-01 21:31:29 +01:00
|
|
|
# Copyright (C) 2015-2023
|
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/].
|
2022-11-22 10:39:20 +01:00
|
|
|
"""This module contains the CommandHandler class."""
|
2018-09-21 08:57:43 +02:00
|
|
|
import re
|
2023-02-02 18:55:07 +01:00
|
|
|
from typing import TYPE_CHECKING, Any, FrozenSet, List, Optional, Tuple, TypeVar, Union
|
2018-09-21 08:57:43 +02:00
|
|
|
|
2020-10-31 16:33:34 +01:00
|
|
|
from telegram import MessageEntity, Update
|
2022-04-24 12:38:09 +02:00
|
|
|
from telegram._utils.defaultvalue import DEFAULT_TRUE
|
2023-02-02 18:55:07 +01:00
|
|
|
from telegram._utils.types import SCT, DVType
|
2022-05-05 09:27:54 +02:00
|
|
|
from telegram.ext import filters as filters_module
|
2023-06-25 15:08:26 +02:00
|
|
|
from telegram.ext._basehandler import BaseHandler
|
2023-02-02 18:55:07 +01:00
|
|
|
from telegram.ext._utils.types import CCT, FilterDataDict, HandlerCallback
|
2016-04-14 23:57:40 +02:00
|
|
|
|
2020-10-06 19:28:40 +02:00
|
|
|
if TYPE_CHECKING:
|
2022-04-24 12:38:09 +02:00
|
|
|
from telegram.ext import Application
|
2020-10-06 19:28:40 +02:00
|
|
|
|
|
|
|
RT = TypeVar("RT")
|
|
|
|
|
2016-04-14 23:57:40 +02:00
|
|
|
|
2022-05-12 18:18:40 +02:00
|
|
|
class CommandHandler(BaseHandler[Update, CCT]):
|
|
|
|
"""BaseHandler class to handle Telegram commands.
|
2017-09-01 08:43:08 +02:00
|
|
|
|
|
|
|
Commands are Telegram messages that start with ``/``, optionally followed by an ``@`` and the
|
2022-04-24 12:38:09 +02:00
|
|
|
bot's name and/or some additional text. The handler will add a :obj:`list` to the
|
2018-09-21 08:57:43 +02:00
|
|
|
:class:`CallbackContext` named :attr:`CallbackContext.args`. It will contain a list of strings,
|
|
|
|
which is the text following the command split on single or consecutive whitespace characters.
|
2016-04-16 16:36:12 +02:00
|
|
|
|
2022-04-24 12:38:09 +02:00
|
|
|
By default, the handler listens to messages as well as edited messages. To change this behavior
|
|
|
|
use :attr:`~filters.UpdateType.EDITED_MESSAGE <telegram.ext.filters.UpdateType.EDITED_MESSAGE>`
|
|
|
|
in the filter argument.
|
2019-02-13 12:07:25 +01:00
|
|
|
|
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
|
|
|
Note:
|
2022-06-09 17:08:54 +02:00
|
|
|
:class:`CommandHandler` does *not* handle (edited) channel posts and does *not* handle
|
|
|
|
commands that are part of a caption. Please use :class:`~telegram.ext.MessageHandler`
|
|
|
|
with a suitable combination of filters (e.g.
|
|
|
|
:attr:`telegram.ext.filters.UpdateType.CHANNEL_POSTS`,
|
|
|
|
:attr:`telegram.ext.filters.CAPTION` and :class:`telegram.ext.filters.Regex`) to handle
|
|
|
|
those messages.
|
2018-09-21 08:57:01 +02:00
|
|
|
|
2020-10-04 17:20:33 +02:00
|
|
|
Warning:
|
2022-04-24 12:38:09 +02:00
|
|
|
When setting :paramref:`block` to :obj:`False`, you cannot rely on adding custom
|
2020-10-04 17:20:33 +02:00
|
|
|
attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info.
|
|
|
|
|
Documentation Improvements (#3214, #3217, #3218, #3271, #3289, #3292, #3303, #3312, #3306, #3319, #3326, #3314)
Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>
Co-authored-by: Simon Fong <44134941+simonfongnt@users.noreply.github.com>
Co-authored-by: Piotr Rogulski <rivinek@gmail.com>
Co-authored-by: poolitzer <25934244+Poolitzer@users.noreply.github.com>
Co-authored-by: Or Bin <or@raftt.io>
Co-authored-by: Sandro <j32g7f67hb@liamekaens.com>
Co-authored-by: Hatim Zahid <63000127+HatimZ@users.noreply.github.com>
Co-authored-by: Robi <53259730+RobiMez@users.noreply.github.com>
Co-authored-by: Dmitry Kolomatskiy <58207913+lemontree210@users.noreply.github.com>
2022-11-15 09:06:23 +01:00
|
|
|
Examples:
|
|
|
|
* :any:`Timer Bot <examples.timerbot>`
|
|
|
|
* :any:`Error Handler Bot <examples.errorhandlerbot>`
|
|
|
|
|
2022-05-26 11:10:00 +02:00
|
|
|
.. versionchanged:: 20.0
|
|
|
|
|
|
|
|
* Renamed the attribute ``command`` to :attr:`commands`, which now is always a
|
|
|
|
:class:`frozenset`
|
|
|
|
* Updating the commands this handler listens to is no longer possible.
|
|
|
|
|
2016-04-16 16:36:12 +02:00
|
|
|
Args:
|
2022-05-13 16:41:34 +02:00
|
|
|
command (:obj:`str` | Collection[:obj:`str`]):
|
2022-05-26 11:10:00 +02:00
|
|
|
The command or list of commands this handler should listen for. Case-insensitive.
|
2023-01-01 13:48:24 +01:00
|
|
|
Limitations are the same as for :attr:`telegram.BotCommand.command`.
|
2022-04-24 12:38:09 +02:00
|
|
|
callback (:term:`coroutine function`): The callback function for this handler. Will be
|
|
|
|
called when :meth:`check_update` has determined that an update should be processed by
|
|
|
|
this handler. Callback signature::
|
|
|
|
|
|
|
|
async 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`.
|
2022-02-09 17:30:16 +01:00
|
|
|
filters (:class:`telegram.ext.filters.BaseFilter`, optional): A filter inheriting from
|
2017-02-28 15:44:55 +01:00
|
|
|
:class:`telegram.ext.filters.BaseFilter`. Standard filters can be found in
|
2021-11-20 11:36:18 +01:00
|
|
|
:mod:`telegram.ext.filters`. Filters can be combined using bitwise
|
2022-04-24 12:38:09 +02:00
|
|
|
operators (``&`` for :keyword:`and`, ``|`` for :keyword:`or`, ``~`` for :keyword:`not`)
|
|
|
|
block (:obj:`bool`, optional): Determines whether the return value of the callback should
|
|
|
|
be awaited before processing the next handler in
|
|
|
|
:meth:`telegram.ext.Application.process_update`. Defaults to :obj:`True`.
|
2017-09-01 08:43:08 +02:00
|
|
|
|
2023-01-01 16:24:00 +01:00
|
|
|
.. seealso:: :wiki:`Concurrency`
|
Documentation Improvements (#3214, #3217, #3218, #3271, #3289, #3292, #3303, #3312, #3306, #3319, #3326, #3314)
Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>
Co-authored-by: Simon Fong <44134941+simonfongnt@users.noreply.github.com>
Co-authored-by: Piotr Rogulski <rivinek@gmail.com>
Co-authored-by: poolitzer <25934244+Poolitzer@users.noreply.github.com>
Co-authored-by: Or Bin <or@raftt.io>
Co-authored-by: Sandro <j32g7f67hb@liamekaens.com>
Co-authored-by: Hatim Zahid <63000127+HatimZ@users.noreply.github.com>
Co-authored-by: Robi <53259730+RobiMez@users.noreply.github.com>
Co-authored-by: Dmitry Kolomatskiy <58207913+lemontree210@users.noreply.github.com>
2022-11-15 09:06:23 +01:00
|
|
|
|
2018-09-21 08:57:43 +02:00
|
|
|
Raises:
|
2022-04-24 12:38:09 +02:00
|
|
|
:exc:`ValueError`: When the command is too long or has illegal chars.
|
2020-12-30 15:59:50 +01:00
|
|
|
|
|
|
|
Attributes:
|
2022-05-26 11:10:00 +02:00
|
|
|
commands (FrozenSet[:obj:`str`]): The set of commands this handler should listen for.
|
2022-04-24 12:38:09 +02:00
|
|
|
callback (:term:`coroutine function`): The callback function for this handler.
|
2022-02-09 17:30:16 +01:00
|
|
|
filters (:class:`telegram.ext.filters.BaseFilter`): Optional. Only allow updates with these
|
2020-12-30 15:59:50 +01:00
|
|
|
Filters.
|
2022-04-24 12:38:09 +02:00
|
|
|
block (:obj:`bool`): Determines whether the return value of the callback should be
|
|
|
|
awaited before processing the next handler in
|
|
|
|
:meth:`telegram.ext.Application.process_update`.
|
2016-04-16 16:36:12 +02:00
|
|
|
"""
|
2016-04-14 23:57:40 +02:00
|
|
|
|
2022-05-26 11:10:00 +02:00
|
|
|
__slots__ = ("commands", "filters")
|
2021-05-29 16:18:16 +02:00
|
|
|
|
2016-05-26 14:39:11 +02:00
|
|
|
def __init__(
|
|
|
|
self,
|
2022-05-13 16:41:34 +02:00
|
|
|
command: SCT[str],
|
2022-04-24 12:38:09 +02:00
|
|
|
callback: HandlerCallback[Update, CCT, RT],
|
2023-05-18 07:57:59 +02:00
|
|
|
filters: Optional[filters_module.BaseFilter] = None,
|
2023-02-02 18:55:07 +01:00
|
|
|
block: DVType[bool] = DEFAULT_TRUE,
|
2020-10-06 19:28:40 +02:00
|
|
|
):
|
2022-04-24 12:38:09 +02:00
|
|
|
super().__init__(callback, block=block)
|
2017-05-19 20:21:37 +02:00
|
|
|
|
2020-06-15 18:20:51 +02:00
|
|
|
if isinstance(command, str):
|
2022-05-26 11:10:00 +02:00
|
|
|
commands = frozenset({command.lower()})
|
2017-05-19 20:21:37 +02:00
|
|
|
else:
|
2022-05-26 11:10:00 +02:00
|
|
|
commands = frozenset(x.lower() for x in command)
|
|
|
|
for comm in commands:
|
2018-09-21 08:57:43 +02:00
|
|
|
if not re.match(r"^[\da-z_]{1,32}$", comm):
|
2021-12-31 16:04:21 +01:00
|
|
|
raise ValueError(f"Command `{comm}` is not a valid bot command")
|
2023-02-02 18:55:07 +01:00
|
|
|
self.commands: FrozenSet[str] = commands
|
2018-09-21 08:57:43 +02:00
|
|
|
|
2023-02-02 18:55:07 +01:00
|
|
|
self.filters: filters_module.BaseFilter = (
|
|
|
|
filters if filters is not None else filters_module.UpdateType.MESSAGES
|
|
|
|
)
|
2019-02-13 12:07:25 +01:00
|
|
|
|
2020-10-06 19:28:40 +02:00
|
|
|
def check_update(
|
2021-01-30 11:38:54 +01:00
|
|
|
self, update: object
|
2023-02-02 18:55:07 +01:00
|
|
|
) -> Optional[Union[bool, Tuple[List[str], Optional[Union[bool, FilterDataDict]]]]]:
|
2022-04-24 12:38:09 +02:00
|
|
|
"""Determines whether an update should be passed to this handler's :attr:`callback`.
|
2017-07-23 22:33:08 +02:00
|
|
|
|
|
|
|
Args:
|
2020-12-16 17:34:57 +01:00
|
|
|
update (:class:`telegram.Update` | :obj:`object`): Incoming update.
|
2017-07-23 22:33:08 +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
|
|
|
:obj:`list`: The list of args for the handler.
|
2017-07-23 22:33:08 +02:00
|
|
|
|
2017-09-01 08:43:08 +02:00
|
|
|
"""
|
2019-02-13 12:07:25 +01:00
|
|
|
if isinstance(update, Update) and update.effective_message:
|
2018-09-21 08:57:43 +02:00
|
|
|
message = update.effective_message
|
2016-05-27 11:06:29 +02:00
|
|
|
|
2019-02-08 20:55:40 +01:00
|
|
|
if (
|
|
|
|
message.entities
|
|
|
|
and message.entities[0].type == MessageEntity.BOT_COMMAND
|
2020-10-06 19:28:40 +02:00
|
|
|
and message.entities[0].offset == 0
|
|
|
|
and message.text
|
2021-10-21 11:17:12 +02:00
|
|
|
and message.get_bot()
|
2020-10-06 19:28:40 +02:00
|
|
|
):
|
2018-09-21 08:57:43 +02:00
|
|
|
command = message.text[1 : message.entities[0].length]
|
|
|
|
args = message.text.split()[1:]
|
2020-10-06 19:28:40 +02:00
|
|
|
command_parts = command.split("@")
|
2021-10-21 11:17:12 +02:00
|
|
|
command_parts.append(message.get_bot().username)
|
2018-03-01 09:11:16 +01:00
|
|
|
|
2020-10-06 19:28:40 +02:00
|
|
|
if not (
|
2022-05-26 11:10:00 +02:00
|
|
|
command_parts[0].lower() in self.commands
|
2021-10-21 11:17:12 +02:00
|
|
|
and command_parts[1].lower() == message.get_bot().username.lower()
|
2020-10-06 19:28:40 +02:00
|
|
|
):
|
2018-09-21 08:57:43 +02:00
|
|
|
return None
|
2016-04-14 23:57:40 +02:00
|
|
|
|
2021-11-20 11:36:18 +01:00
|
|
|
filter_result = self.filters.check_update(update)
|
2019-02-13 12:07:25 +01:00
|
|
|
if filter_result:
|
|
|
|
return args, filter_result
|
2020-10-31 16:33:34 +01:00
|
|
|
return False
|
2020-10-06 19:28:40 +02:00
|
|
|
return None
|
|
|
|
|
|
|
|
def collect_additional_context(
|
|
|
|
self,
|
2021-06-06 10:37:53 +02:00
|
|
|
context: CCT,
|
2022-11-11 18:18:42 +01:00
|
|
|
update: Update, # skipcq: BAN-B301
|
2023-02-02 18:55:07 +01:00
|
|
|
application: "Application[Any, CCT, Any, Any, Any, Any]", # skipcq: BAN-B301
|
2020-10-06 19:28:40 +02:00
|
|
|
check_result: Optional[Union[bool, Tuple[List[str], Optional[bool]]]],
|
|
|
|
) -> None:
|
2021-05-27 09:38:17 +02:00
|
|
|
"""Add text after the command to :attr:`CallbackContext.args` as list, split on single
|
|
|
|
whitespaces and add output of data filters to :attr:`CallbackContext` as well.
|
|
|
|
"""
|
2020-10-06 19:28:40 +02:00
|
|
|
if isinstance(check_result, tuple):
|
|
|
|
context.args = check_result[0]
|
|
|
|
if isinstance(check_result[1], dict):
|
|
|
|
context.update(check_result[1])
|