telegram.ext.handler module

This module contains the base class for handlers as used by the Dispatcher

class telegram.ext.handler.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. You can create your own handlers by inheriting from this class.

Parameters:
  • 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.
  • 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)

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

Parameters:update (object) – 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) –
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:
  • update (object) – The update to be handled
  • dispatcher (telegram.ext.Dispatcher) – The dispatcher to collect optional args