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. There.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 whethergroups
will be passed to the callback function.
-
pass_groupdict
¶ bool
– Optional. Determines whethergroupdict
. will be passed to the callback function.
-
pass_update_queue
¶ bool
– Optional. Determines whetherupdate_queue
will be passed to the callback function.
-
pass_job_queue
¶ bool
– Optional. Determines whetherjob_queue
will be passed to the callback function.
Parameters: - pattern (
str
|Pattern
) – The regex pattern. - callback (
callable
) – A function that takesbot, update
as positional arguments. It will be called when thecheck_update
has determined that an update should be processed by this handler. - pass_groups (
bool
, optional) – If the callback should be passed the result ofre.match(pattern, data).groups()
as a keyword argument calledgroups
. Default isFalse
- pass_groupdict (
bool
, optional) – If the callback should be passed the result ofre.match(pattern, data).groupdict()
as a keyword argument calledgroupdict
. Default isFalse
- pass_update_queue (
bool
, optional) – If set toTrue
, a keyword argument calledupdate_queue
will be passed to the callback function. It will be theQueue
instance used by thetelegram.ext.Updater
andtelegram.ext.Dispatcher
that contains new updates which can be used to insert updates. Default isFalse
. - pass_job_queue (
bool
, optional) – If set toTrue
, a keyword argument calledjob_queue
will be passed to the callback function. It will be atelegram.ext.JobQueue
instance created by thetelegram.ext.Updater
which can be used to schedule new jobs. Default isFalse
.
-
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.
- update (
-