mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-11-22 23:27:49 +01:00
149 lines
6.8 KiB
Python
149 lines
6.8 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2017
|
|
# 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 InlineQueryHandler class """
|
|
import re
|
|
|
|
from future.utils import string_types
|
|
|
|
from telegram import Update
|
|
from telegram.utils.deprecate import deprecate
|
|
from .handler import Handler
|
|
|
|
|
|
class InlineQueryHandler(Handler):
|
|
"""
|
|
Handler class to handle Telegram inline queries. Optionally based on a regex. Read the
|
|
documentation of the ``re`` module for more information.
|
|
|
|
Attributes:
|
|
callback (:obj:`callable`): The callback function for this handler.
|
|
pass_update_queue (:obj:`bool`): Optional. Determines whether ``update_queue`` will be
|
|
passed to the callback function.
|
|
pass_job_queue (:obj:`bool`): Optional. Determines whether ``job_queue`` will be passed to
|
|
the callback function.
|
|
pattern (:obj:`str` | :obj:`Pattern`): Optional. Regex pattern to test
|
|
:attr:`telegram.InlineQuery.query` against.
|
|
pass_groups (:obj:`bool`): Optional. Determines whether ``groups`` will be passed to the
|
|
callback function.
|
|
pass_groupdict (:obj:`bool`): Optional. Determines whether ``groupdict``. will be passed to
|
|
the callback function.
|
|
pass_user_data (:obj:`bool`): Optional. Determines whether ``user_data`` will be passed to
|
|
the callback function.
|
|
pass_chat_data (:obj:`bool`): Optional. Determines whether ``chat_data`` will be passed to
|
|
the callback function.
|
|
|
|
Note:
|
|
:attr:`pass_user_data` and :attr:`pass_chat_data` determine whether a ``dict`` you
|
|
can use to keep any data in will be sent to the :attr:`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``.
|
|
|
|
Args:
|
|
callback (:obj:`callable`): A function that takes ``bot, update`` as positional arguments.
|
|
It will be called when the :attr:`check_update` has determined that an update should be
|
|
processed by this handler.
|
|
pass_update_queue (:obj:`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 :class:`telegram.ext.Updater` and :class:`telegram.ext.Dispatcher`
|
|
that contains new updates which can be used to insert updates. Default is ``False``.
|
|
pass_job_queue (:obj:`bool`, optional): If set to ``True``, a keyword argument called
|
|
``job_queue`` will be passed to the callback function. It will be a
|
|
:class:`telegram.ext.JobQueue` instance created by the :class:`telegram.ext.Updater`
|
|
which can be used to schedule new jobs. Default is ``False``.
|
|
pattern (:obj:`str` | :obj:`Pattern`, optional): Regex pattern. If not ``None``,
|
|
``re.match`` is used on :attr:`telegram.InlineQuery.query` to determine if an update
|
|
should be handled by this handler.
|
|
pass_groups (:obj:`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 (:obj:`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_user_data (:obj:`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 (:obj:`bool`, optional): If set to ``True``, a keyword argument called
|
|
``chat_data`` will be passed to the callback function. Default is ``False``.
|
|
"""
|
|
|
|
def __init__(self,
|
|
callback,
|
|
pass_update_queue=False,
|
|
pass_job_queue=False,
|
|
pattern=None,
|
|
pass_groups=False,
|
|
pass_groupdict=False,
|
|
pass_user_data=False,
|
|
pass_chat_data=False):
|
|
super(InlineQueryHandler, self).__init__(
|
|
callback,
|
|
pass_update_queue=pass_update_queue,
|
|
pass_job_queue=pass_job_queue,
|
|
pass_user_data=pass_user_data,
|
|
pass_chat_data=pass_chat_data)
|
|
|
|
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):
|
|
"""
|
|
Determines whether an update should be passed to this handlers :attr:`callback`.
|
|
|
|
Args:
|
|
update (:class:`telegram.Update`): Incoming telegram update.
|
|
|
|
Returns:
|
|
:obj:`bool`
|
|
"""
|
|
|
|
if isinstance(update, Update) and update.inline_query:
|
|
if self.pattern:
|
|
if update.inline_query.query:
|
|
match = re.match(self.pattern, update.inline_query.query)
|
|
return bool(match)
|
|
else:
|
|
return True
|
|
|
|
def handle_update(self, update, dispatcher):
|
|
"""
|
|
Send the update to the :attr:`callback`.
|
|
|
|
Args:
|
|
update (:class:`telegram.Update`): Incoming telegram update.
|
|
dispatcher (:class:`telegram.ext.Dispatcher`): Dispatcher that originated the Update.
|
|
"""
|
|
|
|
optional_args = self.collect_optional_args(dispatcher, update)
|
|
if self.pattern:
|
|
match = re.match(self.pattern, update.inline_query.query)
|
|
|
|
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.InlineQueryHandler."
|
|
checkUpdate = deprecate(check_update, m + "checkUpdate", m + "check_update")
|
|
handleUpdate = deprecate(handle_update, m + "handleUpdate", m + "handle_update")
|