python-telegram-bot/telegram/replykeyboardremove.py
Noam Meltzer acf1541395 Botapi2.3 (#471)
* New fields channel_post and edited_channel_post for Update

refs #468

* setGameScore() changes

 - Changed behaviour: messages with high scores will be update with new
   high scores by default. (documentation fix)
 - Use (new) disable_edit_message in setGameScore to disable the above new
   behaviour.
 - The edit_message parameter from setGameScore is no longer in use. For
   backward compatibility, it will be taken into account for a while,
   unless disable_edit_message is passed explicitly.

refs #468

* New field forward_from_message_id for Message.

refs #468

* New parameter cache_time for answerCallbackQuery

refs #468

* replykeyboardhide renamed to replykeyboardremove

refs #468

* Unitests for updated setGameScore semantics

refs #468

* Backward compatibility for ReplyKeyboardHide

refs #468

* Fix docstrings of wrapper methods in Message

* Unitest new field forward_from_message_id of Message

refs #468

* Fix testMaxCaptionLength

Telegram servers changed their behaviour - now they truncate a long
caption instead of returning an error.

* MessageHandler: Added support for channel posts

* Fix flake8 complaints in a manner which yapf will like it too.

* fix rst markup
2016-12-11 22:44:52 +01:00

70 lines
2.3 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 an object that represents a Telegram ReplyKeyboardRemove."""
from telegram import ReplyMarkup
from telegram.utils.deprecate import warn_deprecate_obj
class ReplyKeyboardRemove(ReplyMarkup):
"""This object represents a Telegram ReplyKeyboardRemove.
Attributes:
remove_keyboard (bool): Always True.
selective (bool):
Args:
selective (Optional[bool]): Use this parameter if you want to remove the keyboard for
specific users only. Targets:
1) users that are @mentioned in the text of the Message object;
2) if the bot's message is a reply (has reply_to_message_id), sender of the
original message.
**kwargs: Arbitrary keyword arguments.
"""
def __init__(self, selective=False, **kwargs):
# Required
self.remove_keyboard = True
# Optionals
self.selective = bool(selective)
@staticmethod
def de_json(data, bot):
"""
Args:
data (dict):
bot(telegram.Bot):
Returns:
telegram.ReplyKeyboardRemove
"""
if not data:
return None
return ReplyKeyboardRemove(**data)
class ReplyKeyboardHide(object):
def __new__(cls, hide_keyboard=True, selective=False, **kwargs):
warn_deprecate_obj(ReplyKeyboardHide.__name__, ReplyKeyboardRemove.__name__)
obj = ReplyKeyboardRemove.__new__(ReplyKeyboardRemove, selective)
obj.__init__(selective)
return obj