Skip to content

Update keyboard.py #351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ghost wants to merge 1 commit into from
Closed

Update keyboard.py #351

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 25 additions & 24 deletions vk_api/keyboard.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@
from .utils import sjson_dumps



MAX_BUTTONS_ON_LINE = 5
MAX_DEFAULT_LINES = 10
MAX_INLINE_LINES = 6


class VkKeyboardColor(Enum):
Expand All @@ -22,14 +24,15 @@ class VkKeyboardColor(Enum):
PRIMARY = 'primary'

#: Белая
DEFAULT = 'default'
SECONDARY = 'secondary'

#: Красная
NEGATIVE = 'negative'

#: Зелёная
POSITIVE = 'positive'


class VkKeyboardButton(Enum):
""" Возможные типы кнопки """

Expand All @@ -44,12 +47,11 @@ class VkKeyboardButton(Enum):

#: Кнопка с приложением VK Apps
VKAPPS = "open_app"

#: Кнопка с ссылкой
OPENLINK = "open_link"



class VkKeyboard(object):
""" Класс для создания клавиатуры для бота (https://vk.com/dev/bots_docs_3)
:param one_time: Если True, клавиатура исчезнет после нажатия на кнопку
Expand Down Expand Up @@ -82,9 +84,8 @@ def get_empty_keyboard(cls):
keyboard.keyboard['buttons'] = []
return keyboard.get_keyboard()

def add_button(self, label, color=VkKeyboardColor.DEFAULT, payload=None):
def add_button(self, label, color=VkKeyboardColor.SECONDARY, payload=None):
""" Добавить кнопку с текстом.
Максимальное количество кнопок на строке - 4

:param label: Надпись на кнопке и текст, отправляющийся при её нажатии.
:type label: str
Expand All @@ -96,8 +97,8 @@ def add_button(self, label, color=VkKeyboardColor.DEFAULT, payload=None):

current_line = self.lines[-1]

if len(current_line) >= 4:
raise ValueError('Max 4 buttons on a line')
if len(current_line) >= MAX_BUTTONS_ON_LINE:
raise ValueError('Max 5 buttons on a line')

color_value = color

Expand Down Expand Up @@ -130,8 +131,8 @@ def add_location_button(self, payload=None):

if len(current_line) != 0:
raise ValueError(
'This type of button takes the entire width of the line'
)
'This type of button takes the entire width of the line'
)

if payload is not None and not isinstance(payload, six.string_types):
payload = sjson_dumps(payload)
Expand Down Expand Up @@ -160,8 +161,8 @@ def add_vkpay_button(self, hash, payload=None):

if len(current_line) != 0:
raise ValueError(
'This type of button takes the entire width of the line'
)
'This type of button takes the entire width of the line'
)

if payload is not None and not isinstance(payload, six.string_types):
payload = sjson_dumps(payload)
Expand Down Expand Up @@ -198,8 +199,8 @@ def add_vkapps_button(self, app_id, owner_id, label, hash, payload=None):

if len(current_line) != 0:
raise ValueError(
'This type of button takes the entire width of the line'
)
'This type of button takes the entire width of the line'
)

if payload is not None and not isinstance(payload, six.string_types):
payload = sjson_dumps(payload)
Expand All @@ -216,10 +217,9 @@ def add_vkapps_button(self, app_id, owner_id, label, hash, payload=None):
'hash': hash
}
})

def add_openlink_button(self, label, link, payload=None):
""" Добавить кнопку с ссылкой
Максимальное количество кнопок на строке - 4

:param label: Надпись на кнопке
:type label: str
Expand All @@ -230,8 +230,8 @@ def add_openlink_button(self, label, link, payload=None):
"""
current_line = self.lines[-1]

if len(current_line) >= 4:
raise ValueError('Max 4 buttons on a line')
if len(current_line) >= MAX_BUTTONS_ON_LINE:
raise ValueError('Max 5 buttons on a line')

if payload is not None and not isinstance(payload, six.string_types):
payload = sjson_dumps(payload)
Expand All @@ -241,19 +241,20 @@ def add_openlink_button(self, label, link, payload=None):
current_line.append({
'action': {
'type': button_type,
'link' : link,
'link': link,
'label': label,
'payload': payload
}
})


def add_line(self):
""" Создаёт новую строку, на которой можно размещать кнопки.
Максимальное количество строк - 10.
"""

if len(self.lines) >= 10:
raise ValueError('Max 10 lines')
if self.inline:
if len(self.lines) >= MAX_INLINE_LINES:
raise ValueError('Max 6 lines for inline keyboard')
else:
if len(self.lines) >= MAX_DEFAULT_LINES:
raise ValueError('Max 10 lines for default keyboard')

self.lines.append([])