telegram.ext.Handler

class telegram.ext.Handler(callback, pass_update_queue=False, pass_job_queue=False, pass_user_data=False, pass_chat_data=False)

Bases: object

The base class for all update handlers. Create custom handlers by inheriting from it.

callback

callable – The callback function for this handler.

pass_update_queue

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

pass_job_queue

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

pass_user_data

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

pass_chat_data

bool – Optional. 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.

Parameters:
  • callback (callable) – 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.
  • 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.
  • 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.
  • 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.
  • 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.
check_update(update)

This method is called to determine if an update should be handled by this handler instance. It should always be overridden.

Parameters:update (str | telegram.Update) – The update to be tested.
Returns:bool
collect_optional_args(dispatcher, update=None)

Prepares the optional arguments that are the same for all types of handlers.

Parameters:dispatcher (telegram.ext.Dispatcher) – The dispatcher.
handle_update(update, dispatcher)

This method is called if it was determined that an update should indeed be handled by this instance. It should also be overridden, but in most cases call self.callback(dispatcher.bot, update), possibly along with optional arguments. To work with the ConversationHandler, this method should return the value returned from self.callback

Parameters: