mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-11-23 07:38:58 +01:00
95 lines
4.7 KiB
Python
95 lines
4.7 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2019-2021
|
|
# 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 PollHandler classes."""
|
|
from typing import Any
|
|
|
|
from telegram import Update
|
|
|
|
from .handler import Handler
|
|
|
|
|
|
class PollHandler(Handler[Update]):
|
|
"""Handler class to handle Telegram updates that contain a poll.
|
|
|
|
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``.
|
|
|
|
Note that this is DEPRECATED, and you should use context based callbacks. See
|
|
https://git.io/fxJuV for more info.
|
|
|
|
Warning:
|
|
When setting ``run_async`` to :obj:`True`, you cannot rely on adding custom
|
|
attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info.
|
|
|
|
Args:
|
|
callback (:obj:`callable`): The callback function for this handler. Will be called when
|
|
:attr:`check_update` has determined that an update should be processed by this handler.
|
|
Callback signature for context based API:
|
|
|
|
``def callback(update: Update, context: CallbackContext)``
|
|
|
|
The return value of the callback is usually ignored except for the special case of
|
|
:class:`telegram.ext.ConversationHandler`.
|
|
pass_update_queue (:obj:`bool`, optional): If set to :obj:`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 :obj:`False`.
|
|
DEPRECATED: Please switch to context based callbacks.
|
|
pass_job_queue (:obj:`bool`, optional): If set to :obj:`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 :obj:`False`.
|
|
DEPRECATED: Please switch to context based callbacks.
|
|
pass_user_data (:obj:`bool`, optional): If set to :obj:`True`, a keyword argument called
|
|
``user_data`` will be passed to the callback function. Default is :obj:`False`.
|
|
DEPRECATED: Please switch to context based callbacks.
|
|
pass_chat_data (:obj:`bool`, optional): If set to :obj:`True`, a keyword argument called
|
|
``chat_data`` will be passed to the callback function. Default is :obj:`False`.
|
|
DEPRECATED: Please switch to context based callbacks.
|
|
run_async (:obj:`bool`): Determines whether the callback will run asynchronously.
|
|
Defaults to :obj:`False`.
|
|
|
|
Attributes:
|
|
callback (:obj:`callable`): The callback function for this handler.
|
|
pass_update_queue (:obj:`bool`): Determines whether ``update_queue`` will be
|
|
passed to the callback function.
|
|
pass_job_queue (:obj:`bool`): Determines whether ``job_queue`` will be passed to
|
|
the callback function.
|
|
pass_user_data (:obj:`bool`): Determines whether ``user_data`` will be passed to
|
|
the callback function.
|
|
pass_chat_data (:obj:`bool`): Determines whether ``chat_data`` will be passed to
|
|
the callback function.
|
|
run_async (:obj:`bool`): Determines whether the callback will run asynchronously.
|
|
|
|
"""
|
|
|
|
def check_update(self, update: Any) -> bool:
|
|
"""Determines whether an update should be passed to this handlers :attr:`callback`.
|
|
|
|
Args:
|
|
update (:class:`telegram.Update` | :obj:`object`): Incoming update.
|
|
|
|
Returns:
|
|
:obj:`bool`
|
|
|
|
"""
|
|
return isinstance(update, Update) and bool(update.poll)
|