telegram.ext.RegexHandler

class telegram.ext.RegexHandler(pattern, callback, pass_groups=False, pass_groupdict=False, pass_update_queue=False, pass_job_queue=False, pass_user_data=False, pass_chat_data=False, allow_edited=False, message_updates=True, channel_post_updates=False, edited_updates=False)

Bases: telegram.ext.handler.Handler

Handler class to handle Telegram updates based on a regex.

It uses a regular expression to check text messages. Read the documentation of the re module for more information. The re.match function is used to determine if an update should be handled by this handler.

pattern

str | Pattern – The regex pattern.

callback

callable – The callback function for this handler.

pass_groups

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

pass_groupdict

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

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:
  • pattern (str | Pattern) – The regex pattern.
  • 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_groups (bool, optional) – If the callback should be passed the result of re.match(pattern, data).groups() as a keyword argument called groups. Default is False
  • pass_groupdict (bool, optional) – If the callback should be passed the result of re.match(pattern, data).groupdict() as a keyword argument called groupdict. Default is False
  • 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.
  • message_updates (bool, optional) – Should “normal” message updates be handled? Default is True.
  • channel_post_updates (bool, optional) – Should channel posts updates be handled? Default is True.
  • edited_updates (bool, optional) – Should “edited” message updates be handled? Default is False.
  • allow_edited (bool, optional) – If the handler should also accept edited messages. Default is False - Deprecated. use edited_updates instead.
Raises:

ValueError
check_update(update)

Determines whether an update should be passed to this handlers callback.

Parameters:update (telegram.Update) – Incoming telegram update.
Returns:bool
handle_update(update, dispatcher)

Send the update to the callback.

Parameters: