mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-11-26 09:07:43 +01:00
90bf26c09b
* stripping token of whitespaces before starting bot * Line feed * - Case insensitivity for commandhandler - Ignore pylint case on windows.
133 lines
6.2 KiB
Python
133 lines
6.2 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 CommandHandler class """
|
|
import warnings
|
|
|
|
from .handler import Handler
|
|
from telegram import Update
|
|
from telegram.utils.deprecate import deprecate
|
|
|
|
|
|
class CommandHandler(Handler):
|
|
"""
|
|
Handler class to handle Telegram commands. Commands are Telegram messages
|
|
that start with ``/``, optionally followed by an ``@`` and the bot's
|
|
name and/or some additional text.
|
|
|
|
Args:
|
|
command (str): The name of the command this handler should listen for.
|
|
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.
|
|
filters (telegram.ext.BaseFilter): A filter inheriting from
|
|
:class:`telegram.ext.filters.BaseFilter`. Standard filters can be found in
|
|
:class:`telegram.ext.filters.Filters`. Filters can be combined using bitwise
|
|
operators (& for and, | for or).
|
|
allow_edited (Optional[bool]): If the handler should also accept edited messages.
|
|
Default is ``False``
|
|
pass_args (optional[bool]): If the handler should be passed the
|
|
arguments passed to the command as a keyword argument called `
|
|
``args``. It will contain a list of strings, which is the text
|
|
following the command split on single or consecutive whitespace characters.
|
|
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``.
|
|
pass_user_data (optional[bool]): If set to ``True``, a keyword argument called
|
|
``user_data`` will be passed to the callback function. It will be a ``dict`` you
|
|
can use to keep any data related to the user that sent the update. For each update of
|
|
the same user, it will be the same ``dict``. Default is ``False``.
|
|
pass_chat_data (optional[bool]): If set to ``True``, a keyword argument called
|
|
``chat_data`` will be passed to the callback function. It will be a ``dict`` you
|
|
can use to keep any data related to the chat that the update was sent in.
|
|
For each update in the same chat, it will be the same ``dict``. Default is ``False``.
|
|
"""
|
|
|
|
def __init__(self,
|
|
command,
|
|
callback,
|
|
filters=None,
|
|
allow_edited=False,
|
|
pass_args=False,
|
|
pass_update_queue=False,
|
|
pass_job_queue=False,
|
|
pass_user_data=False,
|
|
pass_chat_data=False):
|
|
super(CommandHandler, 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)
|
|
self.command = command
|
|
self.filters = filters
|
|
self.allow_edited = allow_edited
|
|
self.pass_args = pass_args
|
|
|
|
# We put this up here instead of with the rest of checking code
|
|
# in check_update since we don't wanna spam a ton
|
|
if isinstance(self.filters, list):
|
|
warnings.warn('Using a list of filters in MessageHandler is getting '
|
|
'deprecated, please use bitwise operators (& and |) '
|
|
'instead. More info: https://git.io/vPTbc.')
|
|
|
|
def check_update(self, update):
|
|
if (isinstance(update, Update)
|
|
and (update.message or update.edited_message and self.allow_edited)):
|
|
message = update.message or update.edited_message
|
|
|
|
if message.text:
|
|
command = message.text[1:].split(' ')[0].split('@')
|
|
command.append(
|
|
update.message.bot.username) # in case the command was send without a username
|
|
|
|
if self.filters is None:
|
|
res = True
|
|
elif isinstance(self.filters, list):
|
|
res = any(func(message) for func in self.filters)
|
|
else:
|
|
res = self.filters(message)
|
|
|
|
return res and (message.text.startswith('/') and command[0] == self.command
|
|
and command[1].lower() == update.message.bot.username.lower())
|
|
else:
|
|
return False
|
|
|
|
else:
|
|
return False
|
|
|
|
def handle_update(self, update, dispatcher):
|
|
optional_args = self.collect_optional_args(dispatcher, update)
|
|
|
|
message = update.message or update.edited_message
|
|
|
|
if self.pass_args:
|
|
optional_args['args'] = message.text.split()[1:]
|
|
|
|
return self.callback(dispatcher.bot, update, **optional_args)
|
|
|
|
# old non-PEP8 Handler methods
|
|
m = "telegram.CommandHandler."
|
|
checkUpdate = deprecate(check_update, m + "checkUpdate", m + "check_update")
|
|
handleUpdate = deprecate(handle_update, m + "handleUpdate", m + "handle_update")
|