mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-10-24 09:56:30 +02:00
aa3ca38837
* update sphinx source files to properly build latexpdf and improve html build * fix docstrings and sphinx sources to get rid of warnings * add telegram.contrib.rst
91 lines
4 KiB
Python
91 lines
4 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2016
|
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Lesser Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Lesser Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Lesser Public License
|
|
# along with this program. If not, see [http://www.gnu.org/licenses/].
|
|
""" This module contains the StringRegexHandler class """
|
|
|
|
import re
|
|
|
|
from future.utils import string_types
|
|
|
|
from .handler import Handler
|
|
from telegram.utils.deprecate import deprecate
|
|
|
|
|
|
class StringRegexHandler(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.
|
|
|
|
Args:
|
|
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``.
|
|
"""
|
|
|
|
def __init__(self,
|
|
pattern,
|
|
callback,
|
|
pass_groups=False,
|
|
pass_groupdict=False,
|
|
pass_update_queue=False,
|
|
pass_job_queue=False):
|
|
super(StringRegexHandler, self).__init__(
|
|
callback, pass_update_queue=pass_update_queue, pass_job_queue=pass_job_queue)
|
|
|
|
if isinstance(pattern, string_types):
|
|
pattern = re.compile(pattern)
|
|
|
|
self.pattern = pattern
|
|
self.pass_groups = pass_groups
|
|
self.pass_groupdict = pass_groupdict
|
|
|
|
def check_update(self, update):
|
|
return isinstance(update, string_types) and bool(re.match(self.pattern, update))
|
|
|
|
def handle_update(self, update, dispatcher):
|
|
optional_args = self.collect_optional_args(dispatcher)
|
|
match = re.match(self.pattern, update)
|
|
|
|
if self.pass_groups:
|
|
optional_args['groups'] = match.groups()
|
|
if self.pass_groupdict:
|
|
optional_args['groupdict'] = match.groupdict()
|
|
|
|
return self.callback(dispatcher.bot, update, **optional_args)
|
|
|
|
# old non-PEP8 Handler methods
|
|
m = "telegram.StringRegexHandler."
|
|
checkUpdate = deprecate(check_update, m + "checkUpdate", m + "check_update")
|
|
handleUpdate = deprecate(handle_update, m + "handleUpdate", m + "handle_update")
|