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)

Bases: telegram.ext.handler.Handler

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 a list to the CallbackContext named CallbackContext.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.

command

str | List[str] – The command or list of commands this handler should listen for. Limitations are the same as described here https://core.telegram.org/bots#commands

callback

callable – The callback function for this handler.

filters

telegram.ext.BaseFilter – Optional. Only allow updates with these Filters.

allow_edited

bool – Determines Whether the handler should also accept edited messages.

pass_args

bool – Determines whether the handler should be passed args.

pass_update_queue

bool – Determines whether update_queue will be passed to the callback function.

pass_job_queue

bool – Determines whether job_queue will be passed to the callback function.

pass_user_data

bool – Determines whether user_data will be passed to the callback function.

pass_chat_data

bool – Determines whether chat_data will be passed to the callback function.

Note

pass_user_data and pass_chat_data determine whether a dict you can use to keep any data in will be sent to the callback 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 same dict.

Note that this is DEPRECATED, and you should use context based callbacks. See https://git.io/fxJuV for more info.

Parameters:
  • command (str | List[str]) – The command or list of commands this handler should listen for. Limitations are the same as described here https://core.telegram.org/bots#commands
  • callback (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 from telegram.ext.filters.BaseFilter. Standard filters can be found in telegram.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 is False. 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 called args. It will contain a list of strings, which is the text following the command split on single or consecutive whitespace characters. Default is False DEPRECATED: Please switch to context based callbacks.
  • pass_update_queue (bool, optional) – If set to True, a keyword argument called update_queue will be passed to the callback function. It will be the Queue instance used by the telegram.ext.Updater and telegram.ext.Dispatcher that contains new updates which can be used to insert updates. Default is False. DEPRECATED: Please switch to context based callbacks.
  • pass_job_queue (bool, optional) – If set to True, a keyword argument called job_queue will be passed to the callback function. It will be a telegram.ext.JobQueue instance created by the telegram.ext.Updater which can be used to schedule new jobs. Default is False. DEPRECATED: Please switch to context based callbacks.
  • pass_user_data (bool, optional) – If set to True, a keyword argument called user_data will be passed to the callback function. Default is False. DEPRECATED: Please switch to context based callbacks.
  • pass_chat_data (bool, optional) – If set to True, a keyword argument called chat_data will be passed to the callback function. Default is False. DEPRECATED: Please switch to context based callbacks.
Raises:

ValueError - when command is too long or has illegal chars.

check_update(update)

Determines whether an update should be passed to this handlers callback.

Parameters:update (telegram.Update) – Incoming telegram update.
Returns:The list of args for the handler
Return type:list
collect_additional_context(context, update, dispatcher, check_result)

Prepares additional arguments for the context. Override if needed.

Parameters:
collect_optional_args(dispatcher, update=None, check_result=None)

Prepares the optional arguments. If the handler has additional optional args, it should subclass this method, but remember to call this super method.

DEPRECATED: This method is being replaced by new context based callbacks. Please see https://git.io/fxJuV for more info.

Parameters: