telegram.ext.conversationhandler module

This module contains the ConversationHandler

class telegram.ext.conversationhandler.ConversationHandler(entry_points, states, fallbacks, allow_reentry=False, run_async_timeout=None, timed_out_behavior=None, per_chat=True, per_user=True, per_message=False)

Bases: telegram.ext.handler.Handler

A handler to hold a conversation with a single user by managing four collections of other handlers. Note that neither posts in Telegram Channels, nor group interactions with multiple users are managed by instances of this class.

The first collection, a list named entry_points, is used to initiate the conversation, for example with a CommandHandler or RegexHandler.

The second collection, a dict named states, contains the different conversation steps and one or more associated handlers that should be used if the user sends a message when the conversation with them is currently in that state. You will probably use mostly MessageHandler and RegexHandler here.

The third collection, a list named fallbacks, is used if the user is currently in a conversation but the state has either no associated handler or the handler that is associated to the state is inappropriate for the update, for example if the update contains a command, but a regular text message is expected. You could use this for a /cancel command or to let the user know their message was not recognized.

The fourth, optional collection of handlers, a list named timed_out_behavior is used if the wait for run_async takes longer than defined in run_async_timeout. For example, you can let the user know that they should wait for a bit before they can continue.

To change the state of conversation, the callback function of a handler must return the new state after responding to the user. If it does not return anything (returning None by default), the state will not change. To end the conversation, the callback function must return CallbackHandler.END or -1.

Parameters:
  • entry_points (list) – A list of Handler objects that can trigger the start of the conversation. The first handler which check_update method returns True will be used. If all return False, the update is not handled.
  • states (dict) – A dict[object: list[Handler]] that defines the different states of conversation a user can be in and one or more associated Handler objects that should be used in that state. The first handler which check_update method returns True will be used.
  • fallbacks (list) – A list of handlers that might be used if the user is in a conversation, but every handler for their current state returned False on check_update. The first handler which check_update method returns True will be used. If all return False, the update is not handled.
  • allow_reentry (Optional[bool]) – If set to True, a user that is currently in a conversation can restart the conversation by triggering one of the entry points.
  • run_async_timeout (Optional[float]) – If the previous handler for this user was running asynchronously using the run_async decorator, it might not be finished when the next message arrives. This timeout defines how long the conversation handler should wait for the next state to be computed. The default is None which means it will wait indefinitely.
  • timed_out_behavior (Optional[list]) – A list of handlers that might be used if the wait for run_async timed out. The first handler which check_update method returns True will be used. If all return False, the update is not handled.
END = -1
check_update(update)
entry_points = None

type – list[telegram.ext.Handler]

fallbacks = None

type – list[telegram.ext.Handler]

handle_update(update, dispatcher)
per_message = None

type – dict[tuple: object]

states = None

type – dict[str: telegram.ext.Handler]

timed_out_behavior = None

type – list[telegram.ext.Handler]

update_state(new_state, key)