mirror of
https://github.com/eternnoir/pyTelegramBotAPI.git
synced 2023-08-10 21:12:57 +03:00
Minor keyboard code redesign
This commit is contained in:
parent
9a3f370dce
commit
5823ca5613
@ -66,9 +66,9 @@ class JsonDeserializable(object):
|
|||||||
:param json_type:
|
:param json_type:
|
||||||
:return:
|
:return:
|
||||||
"""
|
"""
|
||||||
if isinstance(json_type, dict):
|
if util.is_dict(json_type):
|
||||||
return json_type
|
return json_type
|
||||||
elif isinstance(json_type, str):
|
elif util.is_string(json_type):
|
||||||
return json.loads(json_type)
|
return json.loads(json_type)
|
||||||
else:
|
else:
|
||||||
raise ValueError("json_type should be a json dict or string.")
|
raise ValueError("json_type should be a json dict or string.")
|
||||||
@ -806,36 +806,44 @@ class ReplyKeyboardRemove(JsonSerializable):
|
|||||||
|
|
||||||
class ReplyKeyboardMarkup(JsonSerializable):
|
class ReplyKeyboardMarkup(JsonSerializable):
|
||||||
def __init__(self, resize_keyboard=None, one_time_keyboard=None, selective=None, row_width=3):
|
def __init__(self, resize_keyboard=None, one_time_keyboard=None, selective=None, row_width=3):
|
||||||
|
if row_width>12:
|
||||||
|
raise ValueError('Telegram does not support reply keyboard row width over 12')
|
||||||
|
|
||||||
self.resize_keyboard = resize_keyboard
|
self.resize_keyboard = resize_keyboard
|
||||||
self.one_time_keyboard = one_time_keyboard
|
self.one_time_keyboard = one_time_keyboard
|
||||||
self.selective = selective
|
self.selective = selective
|
||||||
self.row_width = row_width
|
self.row_width = row_width
|
||||||
self.keyboard = []
|
self.keyboard = []
|
||||||
|
|
||||||
def add(self, *args):
|
def add(self, *args, row_width=None):
|
||||||
"""
|
"""
|
||||||
This function adds strings to the keyboard, while not exceeding row_width.
|
This function adds strings to the keyboard, while not exceeding row_width.
|
||||||
E.g. ReplyKeyboardMarkup#add("A", "B", "C") yields the json result {keyboard: [["A"], ["B"], ["C"]]}
|
E.g. ReplyKeyboardMarkup#add("A", "B", "C") yields the json result {keyboard: [["A"], ["B"], ["C"]]}
|
||||||
when row_width is set to 1.
|
when row_width is set to 1.
|
||||||
When row_width is set to 2, the following is the result of this function: {keyboard: [["A", "B"], ["C"]]}
|
When row_width is set to 2, the following is the result of this function: {keyboard: [["A", "B"], ["C"]]}
|
||||||
See https://core.telegram.org/bots/api#replykeyboardmarkup
|
See https://core.telegram.org/bots/api#replykeyboardmarkup
|
||||||
|
:raises ValueError: If row_width > 12
|
||||||
:param args: KeyboardButton to append to the keyboard
|
:param args: KeyboardButton to append to the keyboard
|
||||||
|
:param row_width: width of row
|
||||||
|
:return: self, to allow function chaining.
|
||||||
"""
|
"""
|
||||||
i = 1
|
row_width = row_width or self.row_width
|
||||||
row = []
|
|
||||||
for button in args:
|
if row_width>12:
|
||||||
if util.is_string(button):
|
raise ValueError('Telegram does not support reply keyboard row width over 12')
|
||||||
row.append({'text': button})
|
|
||||||
elif isinstance(button, bytes):
|
for row in util.chunks(args, row_width):
|
||||||
row.append({'text': button.decode('utf-8')})
|
button_array = []
|
||||||
else:
|
for button in row:
|
||||||
row.append(button.to_dict())
|
if util.is_string(button):
|
||||||
if i % self.row_width == 0:
|
button_array.append({'text': button})
|
||||||
self.keyboard.append(row)
|
elif util.is_bytes(button):
|
||||||
row = []
|
button_array.append({'text': button.decode('utf-8')})
|
||||||
i += 1
|
else:
|
||||||
if len(row) > 0:
|
button_array.append(button.to_dict())
|
||||||
self.keyboard.append(row)
|
self.keyboard.append(button_array)
|
||||||
|
|
||||||
|
return self
|
||||||
|
|
||||||
def row(self, *args):
|
def row(self, *args):
|
||||||
"""
|
"""
|
||||||
@ -845,14 +853,8 @@ class ReplyKeyboardMarkup(JsonSerializable):
|
|||||||
:param args: strings
|
:param args: strings
|
||||||
:return: self, to allow function chaining.
|
:return: self, to allow function chaining.
|
||||||
"""
|
"""
|
||||||
btn_array = []
|
|
||||||
for button in args:
|
return self.add(args, 12)
|
||||||
if util.is_string(button):
|
|
||||||
btn_array.append({'text': button})
|
|
||||||
else:
|
|
||||||
btn_array.append(button.to_dict())
|
|
||||||
self.keyboard.append(btn_array)
|
|
||||||
return self
|
|
||||||
|
|
||||||
def to_json(self):
|
def to_json(self):
|
||||||
"""
|
"""
|
||||||
@ -904,13 +906,17 @@ class InlineKeyboardMarkup(Dictionaryable, JsonSerializable):
|
|||||||
"""
|
"""
|
||||||
This object represents an inline keyboard that appears
|
This object represents an inline keyboard that appears
|
||||||
right next to the message it belongs to.
|
right next to the message it belongs to.
|
||||||
|
|
||||||
|
:raises ValueError: If row_width > 8
|
||||||
:return:
|
:return:
|
||||||
"""
|
"""
|
||||||
|
if row_width>8:
|
||||||
|
raise ValueError('Telegram does not support inline keyboard row width over 8')
|
||||||
|
|
||||||
self.row_width = row_width
|
self.row_width = row_width
|
||||||
self.keyboard = []
|
self.keyboard = []
|
||||||
|
|
||||||
def add(self, *args):
|
def add(self, *args, row_width=None):
|
||||||
"""
|
"""
|
||||||
This method adds buttons to the keyboard without exceeding row_width.
|
This method adds buttons to the keyboard without exceeding row_width.
|
||||||
|
|
||||||
@ -920,20 +926,23 @@ class InlineKeyboardMarkup(Dictionaryable, JsonSerializable):
|
|||||||
When row_width is set to 2, the result:
|
When row_width is set to 2, the result:
|
||||||
{keyboard: [["A", "B"], ["C"]]}
|
{keyboard: [["A", "B"], ["C"]]}
|
||||||
See https://core.telegram.org/bots/api#inlinekeyboardmarkup
|
See https://core.telegram.org/bots/api#inlinekeyboardmarkup
|
||||||
|
|
||||||
|
:raises ValueError: If row_width > 8
|
||||||
:param args: Array of InlineKeyboardButton to append to the keyboard
|
:param args: Array of InlineKeyboardButton to append to the keyboard
|
||||||
|
:param row_width: width of row
|
||||||
|
:return: self, to allow function chaining.
|
||||||
"""
|
"""
|
||||||
i = 1
|
row_width = row_width or self.row_width
|
||||||
row = []
|
|
||||||
for button in args:
|
if row_width>8:
|
||||||
row.append(button.to_dict())
|
raise ValueError('Telegram does not support inline keyboard row width over 8')
|
||||||
if i % self.row_width == 0:
|
|
||||||
self.keyboard.append(row)
|
for row in util.chunks(args, row_width):
|
||||||
row = []
|
button_array = [button.to_dict() for button in row]
|
||||||
i += 1
|
self.keyboard.append(button_array)
|
||||||
if len(row) > 0:
|
|
||||||
self.keyboard.append(row)
|
return self
|
||||||
|
|
||||||
def row(self, *args):
|
def row(self, *args):
|
||||||
"""
|
"""
|
||||||
Adds a list of InlineKeyboardButton to the keyboard.
|
Adds a list of InlineKeyboardButton to the keyboard.
|
||||||
@ -942,13 +951,12 @@ class InlineKeyboardMarkup(Dictionaryable, JsonSerializable):
|
|||||||
InlineKeyboardMarkup.row("A").row("B", "C").to_json() outputs:
|
InlineKeyboardMarkup.row("A").row("B", "C").to_json() outputs:
|
||||||
'{keyboard: [["A"], ["B", "C"]]}'
|
'{keyboard: [["A"], ["B", "C"]]}'
|
||||||
See https://core.telegram.org/bots/api#inlinekeyboardmarkup
|
See https://core.telegram.org/bots/api#inlinekeyboardmarkup
|
||||||
|
|
||||||
:param args: Array of InlineKeyboardButton to append to the keyboard
|
:param args: Array of InlineKeyboardButton to append to the keyboard
|
||||||
:return: self, to allow function chaining.
|
:return: self, to allow function chaining.
|
||||||
"""
|
"""
|
||||||
button_array = [button.to_dict() for button in args]
|
|
||||||
self.keyboard.append(button_array)
|
return self.add(args, 8)
|
||||||
return self
|
|
||||||
|
|
||||||
def to_json(self):
|
def to_json(self):
|
||||||
"""
|
"""
|
||||||
|
Loading…
Reference in New Issue
Block a user