Fix docs

Author: python273

docs/bots_longpoll.rst

@@ -3,8 +3,8 @@
 
 Модуль для работы с Bots Long Poll
 
-.. module:: vk_api.bots_longpoll
+.. module:: vk_api.bot_longpoll
 .. autoclass:: VkBotLongPoll
     :members:
 .. autoclass:: BotEvent
-    :members:
+    :members:

docs/keyboard.rst

@@ -6,5 +6,5 @@ VkKeyboard
 .. module:: vk_api.keyboard
 .. autoclass:: VkKeyboard
     :members:
-.. autoclass:: KeyboardColor
+.. autoclass:: VkKeyboardColor
     :members:

docs/longpoll.rst

@@ -19,4 +19,4 @@
 .. autoclass:: VkMessageFlag
     :members:
 .. autoclass:: VkPeerFlag
-    :members:
+    :members:

examples/keyboard.py

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

jconfig/base.py

@@ -9,11 +9,11 @@
 
 
 class BaseConfig(object):
-    r"""Абстрактный базовый класс конфигурации.
-        У наследуемых классов должен быть определен `__slots__`
+    """ Абстрактный базовый класс конфигурации.
+    У наследуемых классов должен быть определен `__slots__`
 
     :param section: имя подкатегории в конфиге
-    :param \**kwargs: будут переданы в :func:`load`
+    :param \\**kwargs: будут переданы в :func:`load`
     """
 
     __slots__ = ('section_name', '_settings', '_section')

vk_api/__init__.py

@@ -3,7 +3,6 @@
 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/keyboard.py

@@ -14,12 +14,20 @@
 from .utils import sjson_dumps
 
 
-class KeyboardColor(Enum):
+class VkKeyboardColor(Enum):
     """ Возможные цвета кнопок """
-    PRIMARY = 'primary'  # синяя
-    DEFAULT = 'default'  # белая
-    NEGATIVE = 'negative'  # красная
-    POSITIVE = 'positive'  # зелёная
+
+    PRIMARY = 'primary'
+    """ Синяя """
+
+    DEFAULT = 'default'
+    """ Белая"""
+
+    NEGATIVE = 'negative'
+    """ Красная """
+
+    POSITIVE = 'positive'
+    """ Зелёная """
 
 
 class VkKeyboard(object):
@@ -54,14 +62,14 @@ def get_empty_keyboard(cls):
         keyboard.keyboard['buttons'] = []
         return keyboard.get_keyboard()
 
-    def add_button(self, label, color=KeyboardColor.DEFAULT, payload=None):
+    def add_button(self, label, color=VkKeyboardColor.DEFAULT, payload=None):
         """ Добавить кнопку. Максимальное количество кнопок на строке - 4
 
         :param label: Надпись на кнопке и текст, отправляющийся при её нажатии.
         :type label: str
 
         :param color: цвет кнопки.
-        :type color: KeyboardColor or str
+        :type color: VkKeyboardColor or str
 
         :param payload: Параметр для callback api
         :type payload: str or list or dict
@@ -74,7 +82,7 @@ def add_button(self, label, color=KeyboardColor.DEFAULT, payload=None):
 
         color_value = color
 
-        if isinstance(color, KeyboardColor):
+        if isinstance(color, VkKeyboardColor):
             color_value = color_value.value
 
         if payload is not None and not isinstance(payload, six.string_types):

vk_api/streaming.py

@@ -12,13 +12,13 @@
 import json
 
 
-URL_TEMPLATE = "{schema}://{server}/{method}?key={key}"
-
 
 class VkStreaming(object):
 
     __slots__ = ('vk', 'url', 'key', 'server')
 
+    URL_TEMPLATE = '{schema}://{server}/{method}?key={key}'
+
     def __init__(self, vk):
         """
         :param vk: объект VkApi
@@ -38,60 +38,60 @@ def update_streaming_server(self):
         self.server = response['endpoint']
 
     def get_rules(self):
-        response = self.vk.http.get(URL_TEMPLATE.format(
-            schema="https",
+        response = self.vk.http.get(self.URL_TEMPLATE.format(
+            schema='https',
             server=self.server,
-            method="rules",
+            method='rules',
             key=self.key)
         ).json()
 
-        if response["code"] == 200:
+        if response['code'] == 200:
             return response['rules'] or []
-        elif response["code"] == 400:
+        elif response['code'] == 400:
             raise VkStreamingError(response['error'])
 
     def add_rule(self, value, tag):
-        response = self.vk.http.post(URL_TEMPLATE.format(
-            schema="https",
+        response = self.vk.http.post(self.URL_TEMPLATE.format(
+            schema='https',
             server=self.server,
-            method="rules",
+            method='rules',
             key=self.key),
-            json={"rule": {"value": value, "tag": tag}}
+            json={'rule': {'value': value, 'tag': tag}}
         ).json()
 
-        if response["code"] == 200:
+        if response['code'] == 200:
             return True
-        elif response["code"] == 400:
+        elif response['code'] == 400:
             raise VkStreamingError(response['error'])
 
     def delete_rule(self, tag):
-        response = self.vk.http.delete(URL_TEMPLATE.format(
-            schema="https",
+        response = self.vk.http.delete(self.URL_TEMPLATE.format(
+            schema='https',
             server=self.server,
-            method="rules",
+            method='rules',
             key=self.key),
-            json={"tag": tag}
+            json={'tag': tag}
         ).json()
 
-        if response["code"] == 200:
+        if response['code'] == 200:
             return True
-        elif response["code"] == 400:
+        elif response['code'] == 400:
             raise VkStreamingError(response['error'])
 
     def listen(self):
-        ws = websocket.create_connection(URL_TEMPLATE.format(
-            schema="wss",
+        ws = websocket.create_connection(self.URL_TEMPLATE.format(
+            schema='wss',
             server=self.server,
-            method="stream",
-            key=self.key)
-        )
+            method='stream',
+            key=self.key
+        ))
 
         while True:
-            response = ws.recv()
-            response = json.loads(response)
-            if response["code"] == 100:
-                yield response["event"]
-            elif response["code"] == 300:
+            response = json.loads(ws.recv())
+
+            if response['code'] == 100:
+                yield response['event']
+            elif response['code'] == 300:
                 raise VkStreamingServiceMessage(response['service_message'])
 
 
@@ -113,5 +113,4 @@ def __init__(self, error):
         self.message = error['message']
 
     def __str__(self):
-        return '[{}] {}'.format(self.service_code,
-                                self.message)
+        return '[{}] {}'.format(self.service_code, self.message)

vk_api/tools.py

@@ -13,7 +13,7 @@
 
 class VkTools(object):
     """ Содержит некоторые вспомогательные функции, которые могут понадобиться
-        при использовании API
+    при использовании API
 
     :param vk: Объект :class:`VkApi`
     """
@@ -26,8 +26,9 @@ def __init__(self, vk):
     def get_all_iter(self, method, max_count, values=None, key='items',
                      limit=None, stop_fn=None, negative_offset=False):
         """ Получить все элементы.
-            Работает в методах, где в ответе есть count и items или users.
-            За один запрос получает max_count * 25 элементов
+
+        Работает в методах, где в ответе есть count и items или users.
+        За один запрос получает max_count * 25 элементов
 
         :param method: имя метода
         :type method: str
@@ -91,8 +92,7 @@ def get_all_iter(self, method, max_count, values=None, key='items',
 
     def get_all(self, method, max_count, values=None, key='items', limit=None,
                 stop_fn=None, negative_offset=False):
-        """
-        Использовать только если нужно загрузить все объекты в память.
+        """ Использовать только если нужно загрузить все объекты в память.
 
         Eсли вы можете обрабатывать объекты по частям, то лучше
         использовать get_all_iter
@@ -112,7 +112,8 @@ def get_all(self, method, max_count, values=None, key='items', limit=None,
     def get_all_slow_iter(self, method, max_count, values=None, key='items',
                           limit=None, stop_fn=None, negative_offset=False):
         """ Получить все элементы (без использования execute)
-            Работает в методах, где в ответе есть count и items или users
+
+        Работает в методах, где в ответе есть count и items или users
 
         :param method: имя метода
         :type method: str
@@ -182,8 +183,7 @@ def get_all_slow_iter(self, method, max_count, values=None, key='items',
 
     def get_all_slow(self, method, max_count, values=None, key='items',
                      limit=None, stop_fn=None, negative_offset=False):
-        """
-        Использовать только если нужно загрузить все объекты в память.
+        """ Использовать только если нужно загрузить все объекты в память.
 
         Eсли вы можете обрабатывать объекты по частям, то лучше
         использовать get_all_slow_iter