VkKeyboard (#148)

* VkKeyboard + api version 5.80
* Refactor; Use six module

Author: Igor

docs/keyboard.rst

@@ -0,0 +1,10 @@
+VkKeyboard
+=======
+
+Модуль для удобного создания клавиатур для ботов
+
+.. module:: vk_api.keyboard
+.. autoclass:: VkKeyboard
+    :members:
+.. autoclass:: KeyboardColor
+    :members:

examples/keyboard.py

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+import vk_api
+from vk_api.keyboard import KeyboardColor
+
+
+def main():
+    """ Пример создания клавиатуры для отправки ботом """
+
+    vk_session = vk_api.VkApi(token='bot_api_token')
+    vk = vk_session.get_api()
+
+    keyboard = vk_api.VkKeyboard(one_time=True)
+
+    keyboard.add_button('Белая кнопка', color=KeyboardColor.DEFAULT)
+    keyboard.add_button('Зелёная кнопка', color=KeyboardColor.POSITIVE)
+
+    keyboard.add_line()  # Переход на вторую строку
+    keyboard.add_button('Красная кнопка', color=KeyboardColor.NEGATIVE)
+
+    keyboard.add_line()
+    keyboard.add_button('Синяя кнопка', color=KeyboardColor.PRIMARY)
+
+    vk.messages.send(
+        peer_id=123456,
+        message='Пример клавиатуры',
+        keyboard=keyboard.get_keyboard()
+    )
+
+
+if __name__ == '__main__':
+    main()

requirements.txt

@@ -1,3 +1,4 @@
 beautifulsoup4
 requests
 enum34
+six

vk_api/__init__.py

@@ -3,6 +3,7 @@
 from .exceptions import *
 from .requests_pool import VkRequestsPool, vk_request_one_param_pool
 from .tools import VkTools
+from .keyboard import VkKeyboard
 from .upload import VkUpload
 from .vk_api import VkApi
 

vk_api/audio_url_decoder.py

@@ -1,4 +1,6 @@
 # -*- coding: utf-8 -*-
+from six.moves import range
+
 from .exceptions import VkAudioUrlDecodeError
 
 VK_STR = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMN0PQRSTUVWXYZO123456789+/="

vk_api/execute.py

@@ -7,6 +7,8 @@
 :copyright: (c) 2018 python273
 """
 
+import six
+
 from .utils import sjson_dumps
 from .vk_api import VkApi, VkApiMethod
 
@@ -35,7 +37,7 @@ def __init__(self, code, args=None, clean_args=None, return_raw=False):
     def compile(self, args):
         compiled_args = {}
 
-        for key, value in args.items():
+        for key, value in six.iteritems(args):
             if key in self.clean_args:
                 compiled_args[key] = str(value)
             else:
@@ -74,7 +76,7 @@ def minify(code):
 def parse_args(function_args, args, kwargs):
     parsed_args = {}
 
-    for arg_name in kwargs.keys():
+    for arg_name in six.iterkeys(kwargs):
         if arg_name in function_args:
             parsed_args[arg_name] = kwargs[arg_name]
         else:

vk_api/keyboard.py

@@ -0,0 +1,90 @@
+from enum import Enum
+
+import six
+
+from .utils import sjson_dumps
+
+
+class KeyboardColor(Enum):
+    """ Возможные цвета кнопок """
+    PRIMARY = 'primary'  # синяя
+    DEFAULT = 'default'  # белая
+    NEGATIVE = 'negative'  # красная
+    POSITIVE = 'positive'  # зелёная
+
+
+class VkKeyboard(object):
+    """ Класс для создания клавиатуры для бота (https://vk.com/dev/bots_docs_3)
+
+    :param one_time: Если True, клавиатура исчезнет после нажатия на кнопку
+    :type one_time: bool
+    """
+
+    __slots__ = ('one_time', 'lines', 'keyboard')
+
+    def __init__(self, one_time=False):
+        self.one_time = one_time
+        self.lines = [[]]
+
+        self.keyboard = {
+            'one_time': self.one_time,
+            'buttons': self.lines
+        }
+
+    def get_keyboard(self):
+        """ Получить json клавиатуры """
+        return sjson_dumps(self.keyboard)
+
+    @classmethod
+    def get_empty_keyboard(cls):
+        """ Получить json пустой клавиатуры.
+            Если отправить пустую клавиатуру, текущая у пользователя исчезнет.
+        """
+        keyboard = cls()
+        keyboard.keyboard['buttons'] = []
+        return keyboard.get_keyboard()
+
+    def add_button(self, label, color=KeyboardColor.DEFAULT, payload=None):
+        """ Добавить кнопку. Максимальное количество кнопок на строке - 4
+
+        :param label: Надпись на кнопке и текст, отправляющийся при её нажатии.
+        :type: str
+
+        :param color: цвет кнопки.
+        :type color: KeyboardColor or str
+
+        :param payload: Параметр для callback api
+        :type payload: str or list or dict
+        """
+
+        current_line = self.lines[-1]
+
+        if len(current_line) >= 4:
+            raise ValueError('Max 4 buttons on a line')
+
+        color_value = color
+
+        if isinstance(color, KeyboardColor):
+            color_value = color_value.value
+
+        if payload is not None and not isinstance(payload, six.string_types):
+            payload = sjson_dumps(payload)
+
+        current_line.append({
+            'color': color_value,
+            'action': {
+                'type': 'text',
+                'payload': payload,
+                'label': label,
+            }
+        })
+
+    def add_line(self):
+        """ Создаёт новую строчку, на которой можно размещать кнопки.
+            Максимальное количество строк - 10
+        """
+
+        if len(self.lines) >= 10:
+            raise ValueError('Max 10 lines')
+
+        self.lines.append([])

vk_api/longpoll.py

@@ -9,9 +9,11 @@
 
 from collections import defaultdict
 from datetime import datetime
-from enum import Enum, IntEnum
+from enum import IntEnum
 
 import requests
+import six
+from six.moves import range
 
 CHAT_START_ID = int(2E9)  # id с которого начинаются беседы
 
@@ -228,7 +230,7 @@ class VkPeerFlag(IntEnum):
 def get_all_event_attrs():
     keys = set()
 
-    for l in EVENT_ATTRS_MAPPING.values():
+    for l in six.itervalues(EVENT_ATTRS_MAPPING):
         keys.update(l)
 
     return tuple(keys)
@@ -237,7 +239,7 @@ def get_all_event_attrs():
 ALL_EVENT_ATTRS = get_all_event_attrs()
 
 PARSE_PEER_ID_EVENTS = [
-    k for k, v in EVENT_ATTRS_MAPPING.items() if 'peer_id' in v
+    k for k, v in six.iteritems(EVENT_ATTRS_MAPPING) if 'peer_id' in v
 ]
 PARSE_MESSAGE_FLAGS_EVENTS = [
     VkEventType.MESSAGE_FLAGS_REPLACE,

vk_api/requests_pool.py

@@ -7,17 +7,14 @@
 :copyright: (c) 2018 python273
 """
 
-import sys
 from collections import namedtuple
 
+from six.moves import range
+
 from .exceptions import VkRequestsPoolException
 from .execute import VkFunction
 from .utils import sjson_dumps
 
-if sys.version_info.major == 2:
-    range = xrange
-
-
 PoolRequest = namedtuple('PoolRequest', ['method', 'values', 'result'])
 
 

vk_api/tools.py

@@ -12,8 +12,7 @@
 from .exceptions import ApiError, VkToolsException
 from .execute import VkFunction
 
-if sys.version_info.major == 2:
-    range = xrange
+from six.moves import range
 
 
 class VkTools(object):