mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-10-24 01:46:22 +02:00
91 lines
2.7 KiB
Python
91 lines
2.7 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015 Leandro Toledo de Souza <leandrotoeldodesouza@gmail.com>
|
|
#
|
|
# 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 a object that represents a Telegram
|
|
ReplyKeyboardMarkup"""
|
|
|
|
from telegram import ReplyMarkup
|
|
|
|
|
|
class ReplyKeyboardMarkup(ReplyMarkup):
|
|
"""This object represents a Telegram ReplyKeyboardMarkup.
|
|
|
|
Attributes:
|
|
keyboard (List[List[str]]):
|
|
resize_keyboard (bool):
|
|
one_time_keyboard (bool):
|
|
selective (bool):
|
|
|
|
Args:
|
|
keyboard (List[List[str]]):
|
|
**kwargs: Arbitrary keyword arguments.
|
|
|
|
Keyword Args:
|
|
resize_keyboard (Optional[bool]):
|
|
one_time_keyboard (Optional[bool]):
|
|
selective (Optional[bool]):
|
|
"""
|
|
|
|
def __init__(self,
|
|
keyboard,
|
|
**kwargs):
|
|
# Required
|
|
self.keyboard = keyboard
|
|
# Optionals
|
|
self.resize_keyboard = bool(kwargs.get('resize_keyboard', False))
|
|
self.one_time_keyboard = bool(kwargs.get('one_time_keyboard', False))
|
|
self.selective = bool(kwargs.get('selective', False))
|
|
|
|
@staticmethod
|
|
def de_json(data):
|
|
"""
|
|
Args:
|
|
data (str):
|
|
|
|
Returns:
|
|
telegram.ReplyKeyboardMarkup:
|
|
"""
|
|
rkm = dict()
|
|
|
|
# Required
|
|
rkm['keyboard'] = data['keyboard']
|
|
# Optionals
|
|
rkm['resize_keyboard'] = data.get('resize_keyboard', False)
|
|
rkm['one_time_keyboard'] = data.get('one_time_keyboard', False)
|
|
rkm['selective'] = data.get('selective', False)
|
|
|
|
return ReplyKeyboardMarkup(**rkm)
|
|
|
|
def to_dict(self):
|
|
"""
|
|
Returns:
|
|
dict:
|
|
"""
|
|
data = dict()
|
|
|
|
# Required
|
|
data['keyboard'] = self.keyboard
|
|
# Optionals
|
|
if self.resize_keyboard:
|
|
data['resize_keyboard'] = self.resize_keyboard
|
|
if self.one_time_keyboard:
|
|
data['one_time_keyboard'] = self.one_time_keyboard
|
|
if self.selective:
|
|
data['selective'] = self.selective
|
|
|
|
return data
|