telegram.ext.StringRegexHandler

class telegram.ext.StringRegexHandler(pattern, callback, pass_groups=False, pass_groupdict=False, pass_update_queue=False, pass_job_queue=False)

Bases: telegram.ext.handler.Handler

Handler class to handle string updates based on a regex which checks the update content.

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.

Note

This handler is not used to handle Telegram telegram.Update, but strings manually put in the queue. For example to send messages with the bot using command line or API.

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.

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.
check_update(update)

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

Parameters:update (str) – An incomming command.
Returns:bool
handle_update(update, dispatcher)

Send the update to the callback.

Parameters:
  • update (str) – An incomming command.
  • dispatcher (telegram.ext.Dispatcher) – Dispatcher that originated the command.