telegram.ext.CommandHandler¶
- class telegram.ext.CommandHandler(command, callback, filters=None, block=True)[source]¶
Bases:
telegram.ext.BaseHandler
BaseHandler class to handle Telegram commands.
Commands are Telegram messages that start with
/
, optionally followed by an@
and the bot’s name and/or some additional text. The handler will add alist
to theCallbackContext
namedCallbackContext.args
. It will contain a list of strings, which is the text following the command split on single or consecutive whitespace characters.By default, the handler listens to messages as well as edited messages. To change this behavior use
~filters.UpdateType.EDITED_MESSAGE
in the filter argument.Note
CommandHandler
does not handle (edited) channel posts and does not handle commands that are part of a caption. Please useMessageHandler
with a suitable combination of filters (e.g.telegram.ext.filters.UpdateType.CHANNEL_POSTS
,telegram.ext.filters.CAPTION
andtelegram.ext.filters.Regex
) to handle those messages.Warning
When setting
block
toFalse
, you cannot rely on adding custom attributes totelegram.ext.CallbackContext
. See its docs for more info.Examples
Changed in version 20.0:
- Parameters
command (
str
| Collection[str
]) – The command or list of commands this handler should listen for. Case-insensitive. Limitations are the same as described herecallback (coroutine function) –
The callback function for this handler. Will be called when
check_update()
has determined that an update should be processed by this handler. Callback signature:async def callback(update: Update, context: CallbackContext)
The return value of the callback is usually ignored except for the special case of
telegram.ext.ConversationHandler
.filters (
telegram.ext.filters.BaseFilter
, optional) – A filter inheriting fromtelegram.ext.filters.BaseFilter
. Standard filters can be found intelegram.ext.filters
. Filters can be combined using bitwise operators (&
forand
,|
foror
,~
fornot
)Determines whether the return value of the callback should be awaited before processing the next handler in
telegram.ext.Application.process_update()
. Defaults toTrue
.See also
- Raises
ValueError – When the command is too long or has illegal chars.
- block[source]¶
Determines whether the return value of the callback should be awaited before processing the next handler in
telegram.ext.Application.process_update()
.- Type
- check_update(update)[source]¶
Determines whether an update should be passed to this handler’s
callback
.- Parameters
update (
telegram.Update
|object
) – Incoming update.- Returns
The list of args for the handler.
- Return type
- collect_additional_context(context, update, application, check_result)[source]¶
Add text after the command to
CallbackContext.args
as list, split on single whitespaces and add output of data filters toCallbackContext
as well.