Fix pytest, fix docs, streaming docs (#159)

Author: Igor

tests/__init__.py

@@ -0,0 +1,13 @@
+import os
+import pytest
+
+from vk_api import VkApi
+
+
+@pytest.fixture
+def vk():
+    login = os.environ['LOGIN']
+    password = os.environ['PASSWORD']
+    vk = VkApi(login, password)
+    vk.auth(token_only=True)
+    return vk

tests/conftest.py

@@ -1,13 +1,5 @@
-import os
-
-import vk_api
-
-vk = vk_api.VkApi(login=os.environ['LOGIN'], password=os.environ['PASSWORD'])
-vk.auth(token_only=True)
-api = vk.get_api()
-
-
-def test_api():
+def test_api(vk):
+    api = vk.get_api()
     user_info = api.users.get(user_ids=1)
     assert isinstance(user_info, list)
     assert user_info[0]['id'] == 1

tests/test_api.py

@@ -1,16 +1,12 @@
-import os
-
-from vk_api import VkApi
 from vk_api.execute import VkFunction
 
-vk = VkApi(login=os.environ['LOGIN'], password=os.environ['PASSWORD'])
-vk.auth(token_only=True)
-
 
-def test_execute():
+def test_execute(vk):
     func_add = VkFunction('return %(x)s + %(y)s;', args=('x', 'y'))
-    func_get = VkFunction('return API.users.get(%(values)s)[0]["id"];',
-                          args=('values',))
+    func_get = VkFunction(
+        'return API.users.get(%(values)s)[0]["id"];',
+        args=('values',)
+    )
 
     assert func_add(vk, 2, 6) == 8
     assert func_get(vk, {'user_ids': 'durov'}) == 1

tests/test_execute.py

@@ -1,5 +1,4 @@
-from vk_api import VkKeyboard
-from vk_api.keyboard import KeyboardColor
+from vk_api.keyboard import VkKeyboard, VkKeyboardColor
 from vk_api.utils import sjson_dumps
 
 KEYBOARD_TEST = {
@@ -26,9 +25,11 @@
 
 
 def test_keyboard():
-    keyboard.add_button('Test-1',
-                        color=KeyboardColor.DEFAULT,
-                        payload={'test': 'some_payload'})
+    keyboard.add_button(
+        'Test-1',
+        color=VkKeyboardColor.DEFAULT,
+        payload={'test': 'some_payload'}
+    )
     keyboard.add_line()
     assert keyboard.get_keyboard() == sjson_dumps(KEYBOARD_TEST)
 

tests/test_keyboard.py

@@ -1,12 +1,7 @@
-import os
+from vk_api import VkRequestsPool, vk_request_one_param_pool
 
-from vk_api import VkApi, VkRequestsPool, vk_request_one_param_pool
 
-vk = VkApi(login=os.environ['LOGIN'], password=os.environ['PASSWORD'])
-vk.auth(token_only=True)
-
-
-def test_requests_pool():
+def test_requests_pool(vk):
     with VkRequestsPool(vk) as pool:
         users = pool.method('users.get', {'user_ids': 'durov'})
         error_request = pool.method('invalid.method')
@@ -18,12 +13,14 @@ def test_requests_pool():
     assert not error_request.ok
 
 
-def test_requests_pool_one_param():
-    users, error = vk_request_one_param_pool(vk,
-                                             'users.get',
-                                             key='user_ids',
-                                             values=['durov', 'python273'],
-                                             default_values={'fields': 'city'})
+def test_requests_pool_one_param(vk):
+    users, error = vk_request_one_param_pool(
+        vk,
+        'users.get',
+        key='user_ids',
+        values=['durov', 'python273'],
+        default_values={'fields': 'city'}
+    )
 
     assert error == {}
     assert isinstance(users, dict)

tests/test_requests_pool.py

@@ -209,7 +209,7 @@ class VkMessageFlag(IntEnum):
 
 
 class VkPeerFlag(IntEnum):
-    """Флаги диалогов"""
+    """ Флаги диалогов """
 
     #: Важный диалог
     IMPORTANT = 1

vk_api/longpoll.py

@@ -12,17 +12,19 @@
 import json
 
 
-
 class VkStreaming(object):
+    """ Класс для работы с Streaming API
+
+    `Подробнее в документации VK API <https://vk.com/dev/streaming_api_docs>`__.
+
+    :param vk: объект :class:`VkApi`
+    """
 
     __slots__ = ('vk', 'url', 'key', 'server')
 
     URL_TEMPLATE = '{schema}://{server}/{method}?key={key}'
 
     def __init__(self, vk):
-        """
-        :param vk: объект VkApi
-        """
         self.vk = vk
 
         self.url = None
@@ -38,6 +40,7 @@ def update_streaming_server(self):
         self.server = response['endpoint']
 
     def get_rules(self):
+        """ Получить список добавленных правил """
         response = self.vk.http.get(self.URL_TEMPLATE.format(
             schema='https',
             server=self.server,
@@ -51,6 +54,14 @@ def get_rules(self):
             raise VkStreamingError(response['error'])
 
     def add_rule(self, value, tag):
+        """ Добавить правило
+
+        :param value: Строковое представление правила
+        :type value: str
+
+        :param tag: Тег правила
+        :type tag: str
+        """
         response = self.vk.http.post(self.URL_TEMPLATE.format(
             schema='https',
             server=self.server,
@@ -65,6 +76,11 @@ def add_rule(self, value, tag):
             raise VkStreamingError(response['error'])
 
     def delete_rule(self, tag):
+        """ Удалить правило
+
+        :param tag: Тег правила
+        :type tag: str
+        """
         response = self.vk.http.delete(self.URL_TEMPLATE.format(
             schema='https',
             server=self.server,
@@ -79,6 +95,7 @@ def delete_rule(self, tag):
             raise VkStreamingError(response['error'])
 
     def listen(self):
+        """ Слушать сервер """
         ws = websocket.create_connection(self.URL_TEMPLATE.format(
             schema='wss',
             server=self.server,