telegram.ext.commandhandler module

This module contains the CommandHandler class

class telegram.ext.commandhandler.CommandHandler(command, callback, filters=None, allow_edited=False, 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.

Parameters:
  • command (str|list) – The name of the command or list of command this handler should listen for.
  • callback (function) – A function that takes bot, update as positional arguments. It will be called when the check_update has determined that an update should be processed by this handler.
  • filters (telegram.ext.BaseFilter) – 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).
  • allow_edited (Optional[bool]) – If the handler should also accept edited messages. Default is False
  • pass_args (optional[bool]) – If 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
  • pass_update_queue (optional[bool]) – 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 Updater and Dispatcher that contains new updates which can be used to insert updates. Default is False.
  • pass_job_queue (optional[bool]) – If set to True, a keyword argument called job_queue will be passed to the callback function. It will be a JobQueue instance created by the Updater which can be used to schedule new jobs. Default is False.
  • pass_user_data (optional[bool]) – If set to True, a keyword argument called user_data will be passed to the callback function. It will be a dict you can use to keep any data related to the user that sent the update. For each update of the same user, it will be the same dict. Default is False.
  • pass_chat_data (optional[bool]) – If set to True, a keyword argument called chat_data will be passed to the callback function. It will be a dict you can use to keep any data related to the chat that the update was sent in. For each update in the same chat, it will be the same dict. Default is False.
check_update(update)
handle_update(update, dispatcher)