telegram.ext.stringregexhandler module

This module contains the StringRegexHandler class

class telegram.ext.stringregexhandler.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. It uses a regular expression to check 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.

Parameters:
  • pattern (str or Pattern) – The regex pattern.
  • 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_groups (optional[bool]) – If the callback should be passed the result of re.match(pattern, update).groups() as a keyword argument called groups. Default is False
  • pass_groupdict (optional[bool]) – If the callback should be passed the result of re.match(pattern, update).groupdict() as a keyword argument called groupdict. Default is False
  • 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.
check_update(update)
handle_update(update, dispatcher)