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

The callback function for this handler.

Type:callable
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

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

  • 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.
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:Either None or False if the update should not be handled. Otherwise an object that will be passed to handle_update and collect_additional_context when the update gets handled.
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:
handle_update(update, dispatcher, check_result, context=None)

This method is called if it was determined that an update should indeed be handled by this instance. Calls self.callback along with its respectful arguments. To work with the telegram.ext.ConversationHandler, this method returns the value returned from self.callback. Note that it can be overridden if needed by the subclassing handler.

Parameters: