Merge pull request #77 from python273/v9

vk_api v9.0

Author: python273

.gitignore

@@ -8,6 +8,6 @@ MANIFEST
 .pydevproject
 .settings/
 testing/
-tests/config.py
-tests/vk_config.json
+tests/
 vk_config.json
+vk_config.v2.json

doc/VkApi.md

@@ -0,0 +1,80 @@
+# class VkApi(object):
+
+## Methods defined here:
+### \_\_init\_\_
+
+- login (default: `None`) — Логин ВКонтакте (лучше использовать номер телефона для автоматического обхода проверки безопасности)
+- password (default: `None`) — Пароль ВКонтакте (если пароль не передан, то будет попытка использовать сохраненные данные)
+- token (default: `None`; type: `str`) — access_token
+- auth_handler (default: `None`) — Функция для обработки двухфакторной аутентификации, должна возвращать строку с кодом и булевое значение, означающее, стоит ли запомнить это устройство, для прохождения аутентификации.
+- captcha_handler (default: `None`) — Функция для обработки капчи
+- config (default: `<class 'jconfig.jconfig.Config'>`) — Класс для сохранения настроек
+- config_filename (default: `'vk_config.v2.json'`) — Расположение config файла
+- api_version (default: `'5.63'`; type: `str`) — Версия API
+- app_id (default: `2895443`; type: `int`) — Standalone-приложение
+- scope (default: `33554431`; types: `int`, `str`) — Запрашиваемые права (можно передать строкой или числом)
+- client_secret (default: `None`) — Защищенный ключ приложения для серверной авторизации ([https://vk.com/dev/auth_server](https://vk.com/dev/auth_server))
+
+### api_login
+ Получение токена через Desktop приложение
+
+### auth
+ Аутентификация
+- reauth (default: `False`) — Позволяет переавторизиваться, игнорируя сохраненные куки и токен
+- token_only (default: `False`) — Включает оптимальную стратегию аутентификации, если необходим только access_token Например если сохраненные куки не валидны, но токен валиден, то аутентификация пройдет успешно При token_only=False, сначала проверяется валидность куки. Если кука не будет валидна, то будет произведена попытка аутетификации с паролем. Тогда если пароль не верен или пароль не передан, то аутентификация закончится с ошибкой. Если вы не делаете запросы к веб версии сайта используя куки, то лучше использовать token_only=True
+
+### auth_handler
+ Обработчик двухфакторной аутентификации
+
+### captcha_handler
+ Обработчик капчи ([http://vk.com/dev/captcha_error](http://vk.com/dev/captcha_error))
+- captcha — объект исключения `Captcha`
+
+### check_sid
+ Проверка Cookies remixsid на валидность
+
+### check_token
+ Проверка access_token на валидность
+
+### get_api
+ Возвращает VkApiMethod(self) Позволяет обращаться к методам API как к обычным классам. Например vk.wall.get(...)
+
+### http_handler
+ Обработчик ошибок соединения
+- error — исключение
+
+### method
+ Вызов метода API
+- method (type: `str`) — имя метода
+- values (default: `None`; type: `dict`) — параметры
+- captcha_sid (default: `None`) — id капчи
+- captcha_key (default: `None`; type: `str`) — ответ капчи
+- raw (default: `False`; type: `bool`) — при False возвращает `response['response']` при True возвращает `response` (может понадобиться для метода execute для получения execute_errors)
+
+### need_validation_handler
+ Обработчик проверки безопасности при запросе API ([http://vk.com/dev/need_validation](http://vk.com/dev/need_validation))
+- error — исключение
+
+### security_check
+ Функция для обхода проверки безопасности (запрос номера телефона)
+- response (default: `None`) — ответ предыдущего запроса, если есть
+
+### server_auth
+ Серверная авторизация
+
+### too_many_rps_handler
+ Обработчик ошибки "Слишком много запросов в секунду". Ждет пол секунды и пробудет отправить запрос заново
+- error — исключение
+
+### twofactor
+ Двухфакторная аутентификация
+- auth_response — страница с приглашением к аутентификации
+
+### vk_login
+ Авторизация ВКонтакте с получением cookies remixsid
+- captcha_sid (default: `None`) — id капчи
+- captcha_key (default: `None`; type: `str`) — ответ капчи
+
+## Data and other attributes defined here:
+**RPS_DELAY** = 0.34
+

doc/VkTools.md

@@ -0,0 +1,30 @@
+# class VkTools(object):
+Содержит некоторые воспомогательные функции, которые могут понадобиться  при использовании API
+
+## Methods defined here:
+### \_\_init\_\_
+
+- vk — объект VkApi
+
+### get_all
+ Использовать только если нужно загрузить все объекты в память. Eсли вы можете обрабатывать объекты по частям, то лучше использовать get_all_iter Например если вы записываете объекты в БД, то нет смысла загружать все данные в память
+
+### get_all_iter
+ Получить все элементы. Работает в методах, где в ответе есть count и items или users. За один запрос получает max_count * 25 элементов
+- method (type: `str`) — имя метода
+- max_count (type: `int`) — максимальное количество элементов, которое можно получить за один запрос
+- values (default: `None`; type: `dict`) — параметры
+- key (default: `'items'`; type: `str`) — ключ элементов, которые нужно получить
+- limit (default: `None`; type: `int`) — ограничение на кол-во получаемых элементов, но может прийти больше
+
+### get_all_slow
+ Использовать только если нужно загрузить все объекты в память. Eсли вы можете обрабатывать объекты по частям, то лучше использовать get_all_slow_iter Например если вы записываете объекты в БД, то нет смысла загружать все данные в память
+
+### get_all_slow_iter
+ Получить все элементы (без использования execute) Работает в методах, где в ответе есть count и items или users
+- method (type: `str`) — имя метода
+- max_count (type: `int`) — максимальное количество элементов, которое можно получить за один запрос
+- values (default: `None`; type: `dict`) — параметры
+- key (default: `'items'`; type: `str`) — ключ элементов, которые нужно получить
+- limit (default: `None`; type: `int`) — ограничение на кол-во получаемых элементов, но может прийти больше
+

doc/VkUpload.md

@@ -0,0 +1,76 @@
+# class VkUpload(object):
+
+## Methods defined here:
+### \_\_init\_\_
+
+- vk — объект VkApi
+
+### audio
+ Загрузка аудио
+- audio — путь к аудиофайлу или file-like объект
+- artist — исполнитель
+- title — название
+
+### document
+ Загрузка документа
+- doc — путь к документу или file-like объект
+- title (default: `None`) — название документа
+- tags (default: `None`) — метки для поиска
+- group_id (default: `None`) — идентификатор сообщества (если загрузка идет в группу)
+- to_wall (default: `False`) — загрузить на стену
+
+### document_wall
+ Загрузка документа в папку Отправленные, для последующей отправки документа на стену или личным сообщением.
+- doc — путь к документу или file-like объект
+- title (default: `None`) — название документа
+- tags (default: `None`) — метки для поиска
+- group_id (default: `None`) — идентификатор сообщества (если загрузка идет в группу)
+
+### photo
+ Загрузка изображений в альбом пользователя
+- photos (types: `str`, `list`) — путь к изображению(ям) или file-like объект(ы)
+- album_id — идентификатор альбома
+- latitude (default: `None`) — географическая широта, заданная в градусах (от -90 до 90)
+- longitude (default: `None`) — географическая долгота, заданная в градусах (от -180 до 180)
+- caption (default: `None`) — текст описания изображения
+- description (default: `None`) — текст описания альбома
+- group_id (default: `None`) — идентификатор сообщества (если загрузка идет в группу)
+
+### photo_chat
+ Загрузка и смена обложки в беседе
+- photo — путь к изображению или file-like объект
+- chat_id — ID беседы
+
+### photo_messages
+ Загрузка изображений в сообщения
+- photos (types: `str`, `list`) — путь к изображению(ям) или file-like объект(ы)
+
+### photo_profile
+ Загрузка изображения профиля
+- photo — путь к изображению или file-like объект
+- owner_id (default: `None`) — идентификатор сообщества или текущего пользователя. По умолчанию загрузка идет в профиль текущего пользователя. При отрицательном значении загрузка идет в группу.
+- crop_x (default: `None`) — координата X верхнего правого угла миниатюры.
+- crop_y (default: `None`) — координата Y верхнего правого угла миниатюры.
+- crop_width (default: `None`) — сторона квадрата миниатюры. При передаче всех crop_* для фотографии также будет подготовлена квадратная миниатюра.
+
+### photo_wall
+ Загрузка изображений на стену пользователя или в группу
+- photos (types: `str`, `list`) — путь к изображению(ям) или file-like объект(ы)
+- user_id (default: `None`) — идентификатор пользователя
+- group_id (default: `None`) — идентификатор сообщества (если загрузка идет в группу)
+
+### video
+ Загрузка видео
+- video_file (default: `None`; types: `object`, `str`) — путь до файла или file-like объект.
+- link (default: `None`; type: `str`) — url для встраивания видео с внешнего сайта, например, с Youtube.
+- name (default: `None`; type: `str`) — название видеофайла
+- description (default: `None`; type: `str`) — описание видеофайла
+- is_private (default: `False`; type: `bool`) — указывается 1, если видео загружается для отправки личным сообщением. После загрузки с этим параметром видеозапись не будет отображаться в списке видеозаписей пользователя и не будет доступна другим пользователям по ее идентификатору.
+- wallpost (default: `False`; type: `bool`) — требуется ли после сохранения опубликовать запись с видео на стене.
+- group_id (default: `None`; type: `int`) — идентификатор сообщества, в которое будет сохранен видеофайл. По умолчанию файл сохраняется на страницу текущего пользователя.
+- album_id (default: `None`; type: `int`) — идентификатор альбома, в который будет загружен видео файл.
+- privacy_view (default: `None`) — настройки приватности просмотра видеозаписи в специальном формате. ([https://vk.com/dev/objects/privacy](https://vk.com/dev/objects/privacy)) Приватность доступна для видеозаписей, которые пользователь загрузил в профиль. (список слов, разделенных через запятую)
+- privacy_comment (default: `None`) — настройки приватности комментирования видеозаписи в специальном формате. ([https://vk.com/dev/objects/privacy](https://vk.com/dev/objects/privacy))
+- no_comments (default: `False`; type: `bool`) — 1 — закрыть комментарии (для видео из сообществ).
+- repeat (default: `False`; type: `bool`) — зацикливание воспроизведения видеозаписи. флаг.
+

jconfig/__init__.py

@@ -8,7 +8,7 @@
 """
 
 __author__ = 'Kirill Python'
-__version__ = '2.1'
+__version__ = '3.0'
 __email__ = 'whoami@python273.pw'
 __contact__ = 'https://vk.com/python273'
 

jconfig/base.py

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+"""
+@author: python273
+@contact: https://vk.com/python273
+@license Apache License, Version 2.0, see LICENSE file
+
+Copyright (C) 2017
+"""
+
+
+class BaseConfig(object):
+
+    __slots__ = ('section_name', '_settings', '_section')
+
+    def __init__(self, section, **kwargs):
+        self.section_name = section
+
+        self._settings = self.load(**kwargs)
+        self._section = self._settings.setdefault(section, {})
+
+    def __getattr__(self, name):
+        return self._section.get(name)
+
+    __getitem__ = __getattr__
+
+    def __setattr__(self, name, value):
+        if name in self.__slots__:
+            return super(BaseConfig, self).__setattr__(name, value)
+
+        self._section[name] = value
+
+    __setitem__ = __setattr__
+
+    def setdefault(self, k, d=None):
+        return self._section.setdefault(k, d)
+
+    def clear_section(self):
+        self._section.clear()
+
+    def load(self, **kwargs):
+        raise NotImplementedError
+
+    def save(self):
+        raise NotImplementedError

jconfig/jconfig.py

@@ -9,42 +9,26 @@
 
 import json
 
+from .base import BaseConfig
 
-class Config(object):
-    __slots__ = ('_section', '_filename', '_settings')
 
-    def __init__(self, section, filename='.jconfig'):
-        self._section = section
-        self._filename = filename
-        self._settings = self.load()
-
-    def __getattr__(self, name):
-        return self._settings[self._section].get(name)
-
-    def __getitem__(self, key):
-        return self.__getattr__(key)
+class Config(BaseConfig):
 
-    def __setattr__(self, name, value):
-        if name.startswith('_'):
-            super(Config, self).__setattr__(name, value)
-            return
+    __slots__ = BaseConfig.__slots__ + ('_filename',)
 
-        self._settings[self._section][name] = value
-
-    def __setitem__(self, key, value):
-        return self.__setattr__(key, value)
+    def __init__(self, section, filename='.jconfig'):
+        self._filename = filename
 
-    def clear_section(self):
-        self._settings[self._section] = {}
+        super(Config, self).__init__(section, filename=filename)
 
-    def load(self):
+    def load(self, filename, **kwargs):
         try:
-            with open(self._filename, 'r') as f:
+            with open(filename, 'r') as f:
                 settings = json.load(f)
         except (IOError, ValueError):
             settings = {}
 
-        settings.setdefault(self._section, {})
+        settings.setdefault(self.section_name, {})
 
         return settings
 

jconfig/memory.py

@@ -7,38 +7,12 @@
 Copyright (C) 2017
 """
 
+from .base import BaseConfig
 
-class MemoryConfig(object):
 
-    __slots__ = ('_section', '_settings')
-
-    def __init__(self, section, filename=None, settings=None):
-        self._section = section
-
-        if settings is not None:
-            self._settings = settings
-        else:
-            self._settings = {}
-
-        self._settings.setdefault(section, {})
-
-    def __getattr__(self, name):
-        return self._settings[self._section].get(name)
-
-    def __getitem__(self, key):
-        return self.__getattr__(key)
-
-    def __setattr__(self, name, value):
-        if name.startswith('_'):
-            return super(MemoryConfig, self).__setattr__(name, value)
-
-        self._settings[self._section][name] = value
-
-    def __setitem__(self, key, value):
-        return self.__setattr__(key, value)
-
-    def clear_section(self):
-        self._settings[self._section] = {}
+class MemoryConfig(BaseConfig):
+    def load(self, settings=None, **kwargs):
+        return {} if settings is None else settings
 
     def save(self):
         pass

setup.py

@@ -3,7 +3,7 @@
 from distutils.core import setup
 
 """
-@author: Kirill Python
+@author: python273
 @contact: https://vk.com/python273
 @license Apache License, Version 2.0, see LICENSE file
 
@@ -13,7 +13,7 @@
 
 setup(
     name='vk_api',
-    version='8.9',
+    version='9.0',
     author='python273',
     author_email='whoami@python273.pw',
     url='https://github.com/python273/vk_api',

vk_api/__init__.py

@@ -6,14 +6,14 @@
 from .vk_api import VkApi
 
 """
-@author: Kirill Python
+@author: python273
 @contact: https://vk.com/python273
 @license Apache License, Version 2.0, see LICENSE file
 
 Copyright (C) 2017
 """
 
 __author__ = 'Kirill Python'
-__version__ = '8.9'
+__version__ = '9.0'
 __email__ = 'whoami@python273.pw'
 __contact__ = 'https://vk.com/python273'