telegram.ext.CommandHandler¶
-
class
telegram.ext.
CommandHandler
(command, callback, filters=None, allow_edited=None, pass_args=False, pass_update_queue=False, pass_job_queue=False, pass_user_data=False, pass_chat_data=False, run_async=False)¶ Bases:
telegram.ext.handler.Handler
[telegram.update.Update
,telegram.ext.utils.types.CCT
]Handler 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.update.edited_message
in the filter argument.Note
CommandHandler
does not handle (edited) channel posts.pass_user_data
andpass_chat_data
determine whether adict
you can use to keep any data in will be sent to thecallback
function. Related to either the user or the chat that the update was sent in. For each update from the same user or in the same chat, it will be the samedict
.Note that this is DEPRECATED, and you should use context based callbacks. See https://git.io/fxJuV for more info.
Warning
When setting
run_async
toTrue
, you cannot rely on adding custom attributes totelegram.ext.CallbackContext
. See its docs for more info.- Parameters
command (
telegram.utils.types.SLT[str]
) – The command or list of commands this handler should listen for. Limitations are the same as described here https://core.telegram.org/bots#commandscallback (
callable
) –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 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
telegram.ext.ConversationHandler
.filters (
telegram.ext.BaseFilter
, optional) – A filter inheriting fromtelegram.ext.filters.BaseFilter
. Standard filters can be found intelegram.ext.filters.Filters
. Filters can be combined using bitwise operators (& for and, | for or, ~ for not).allow_edited (
bool
, optional) – Determines whether the handler should also accept edited messages. Default isFalse
. DEPRECATED: Edited is allowed by default. To change this behavior use~Filters.update.edited_message
.pass_args (
bool
, optional) – Determines whether the handler should be passed the arguments passed to the command as a keyword argument calledargs
. It will contain a list of strings, which is the text following the command split on single or consecutive whitespace characters. Default isFalse
DEPRECATED: Please switch to context based callbacks.pass_update_queue (
bool
, optional) – If set toTrue
, a keyword argument calledupdate_queue
will be passed to the callback function. It will be theQueue
instance used by thetelegram.ext.Updater
andtelegram.ext.Dispatcher
that contains new updates which can be used to insert updates. Default isFalse
. DEPRECATED: Please switch to context based callbacks.pass_job_queue (
bool
, optional) – If set toTrue
, a keyword argument calledjob_queue
will be passed to the callback function. It will be atelegram.ext.JobQueue
instance created by thetelegram.ext.Updater
which can be used to schedule new jobs. Default isFalse
. DEPRECATED: Please switch to context based callbacks.pass_user_data (
bool
, optional) – If set toTrue
, a keyword argument calleduser_data
will be passed to the callback function. Default isFalse
. DEPRECATED: Please switch to context based callbacks.pass_chat_data (
bool
, optional) – If set toTrue
, a keyword argument calledchat_data
will be passed to the callback function. Default isFalse
. DEPRECATED: Please switch to context based callbacks.run_async (
bool
) – Determines whether the callback will run asynchronously. Defaults toFalse
.
- Raises
ValueError – when command is too long or has illegal chars.
-
command
¶ The command or list of commands this handler should listen for. Limitations are the same as described here https://core.telegram.org/bots#commands
- Type
telegram.utils.types.SLT[str]
-
callback
¶ The callback function for this handler.
- Type
callable
-
filters
¶ Optional. Only allow updates with these Filters.
- Type
telegram.ext.BaseFilter
-
allow_edited
¶ Determines whether the handler should also accept edited messages.
- Type
bool
-
pass_args
¶ Determines whether the handler should be passed
args
.- Type
bool
-
pass_update_queue
¶ Determines whether
update_queue
will be passed to the callback function.- Type
bool
-
pass_job_queue
¶ Determines whether
job_queue
will be passed to the callback function.- Type
bool
-
pass_user_data
¶ Determines whether
user_data
will be passed to the callback function.- Type
bool
-
pass_chat_data
¶ Determines whether
chat_data
will be passed to the callback function.- Type
bool
-
run_async
¶ Determines whether the callback will run asynchronously.
- Type
bool
-
check_update
(update)¶ Determines whether an update should be passed to this handlers
callback
.- Parameters
update (
telegram.Update
|object
) – Incoming update.- Returns
The list of args for the handler.
- Return type
list
-
collect_additional_context
(context, update, dispatcher, check_result)¶ Add text after the command to
CallbackContext.args
as list, split on single whitespaces and add output of data filters toCallbackContext
as well.
-
collect_optional_args
(dispatcher, update=None, check_result=None)¶ Provide text after the command to the callback the
args
argument as list, split on single whitespaces.