Skip to content

Commit 74df7ab

Browse files
committed
Docstrings fix
1 parent 90e6dc5 commit 74df7ab

7 files changed

Lines changed: 35 additions & 37 deletions

File tree

example.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
11
# -*- coding: utf-8 -*-
22

3-
'''
3+
"""
44
@author: Kirill Python
55
@contact: http://vk.com/python273
66
@license Apache License, Version 2.0, see LICENSE file
77
88
Copyright (C) 2014
9-
'''
9+
"""
1010

1111
import vk_api
1212

1313

1414
def main():
15-
u''' Пример получения последнего сообщения со стены '''
15+
""" Пример получения последнего сообщения со стены """
1616

17-
login = u'python@vk.com'
18-
password = u'mypassword'
17+
login, password = 'python@vk.com', 'mypassword'
1918

2019
try:
2120
vk = vk_api.VkApi(login, password) # Авторизируемся

jconfig/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# -*- coding: utf-8 -*-
22

3-
'''
3+
"""
44
@author: Kirill Python
55
@contact: http://vk.com/python273
66
@license Apache License, Version 2.0, see LICENSE file
77
88
Copyright (C) 2014
9-
'''
9+
"""
1010

1111
__author__ = 'Kirill Python'
1212
__version__ = '1.2'

jconfig/jconfig.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# -*- coding: utf-8 -*-
22

3-
'''
3+
"""
44
@author: Kirill Python
55
@contact: http://vk.com/python273
66
@license Apache License, Version 2.0, see LICENSE file
77
88
Copyright (C) 2014
9-
'''
9+
"""
1010

1111
import os
1212
import json

vk_api/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# -*- coding: utf-8 -*-
22

3-
'''
3+
"""
44
@author: Kirill Python
55
@contact: http://vk.com/python273
66
@license Apache License, Version 2.0, see LICENSE file
77
88
Copyright (C) 2014
9-
'''
9+
"""
1010

1111
__author__ = 'Kirill Python'
1212
__version__ = '4.7.1'

vk_api/vk_api.py

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# -*- coding: utf-8 -*-
22

3-
'''
3+
"""
44
@author: Kirill Python
55
@contact: http://vk.com/python273
66
@license Apache License, Version 2.0, see LICENSE file
77
88
Copyright (C) 2014
9-
'''
9+
"""
1010

1111
import jconfig
1212
import re
@@ -22,7 +22,7 @@ class VkApi(object):
2222
def __init__(self, login=None, password=None, number=None, token=None,
2323
proxies=None, captcha_handler=None, config_filename=None,
2424
api_version='5.21', app_id=2895443, scope=2097151):
25-
u'''
25+
"""
2626
:param login: Логин ВКонтакте
2727
:param password: Пароль ВКонтакте
2828
:param number: Номер для проверке безопасности (указывать, если
@@ -38,7 +38,7 @@ def __init__(self, login=None, password=None, number=None, token=None,
3838
:param api_version: Версия API (default: '5.21')
3939
:param app_id: Standalone-приложение (default: 2895443)
4040
:param scope: Запрашиваемые права (default: 2097151)
41-
'''
41+
"""
4242

4343
self.login = login
4444
self.password = password
@@ -81,7 +81,7 @@ def __init__(self, login=None, password=None, number=None, token=None,
8181
self.api_login()
8282

8383
def vk_login(self, captcha_sid=None, captcha_key=None):
84-
u''' Авторизцаия ВКонтакте с получением cookies remixsid '''
84+
""" Авторизцаия ВКонтакте с получением cookies remixsid """
8585

8686
url = 'https://login.vk.com/'
8787
values = {
@@ -166,7 +166,7 @@ def security_check(self, url=None, response=None):
166166
raise SecurityCheck('Enter number')
167167

168168
def check_sid(self):
169-
u''' Прверка Cookies remixsid на валидность '''
169+
""" Прверка Cookies remixsid на валидность """
170170

171171
if self.sid:
172172
url = 'https://vk.com/feed2.php'
@@ -182,7 +182,7 @@ def check_sid(self):
182182
return response
183183

184184
def api_login(self):
185-
u''' Получение токена через Desktop приложение '''
185+
""" Получение токена через Desktop приложение """
186186

187187
url = 'https://oauth.vk.com/authorize'
188188
values = {
@@ -214,7 +214,7 @@ def api_login(self):
214214
raise AuthorizationError('Authorization error (api)')
215215

216216
def check_token(self):
217-
u''' Прверка access_token на валидность '''
217+
""" Прверка access_token на валидность """
218218

219219
if self.token:
220220
try:
@@ -225,23 +225,22 @@ def check_token(self):
225225
return True
226226

227227
def captcha_handler(self, captcha):
228-
u''' http://vk.com/dev/captcha_error '''
228+
""" http://vk.com/dev/captcha_error """
229229
pass
230230

231231
def need_validation_handler(self, error):
232-
u''' http://vk.com/dev/need_validation '''
232+
""" http://vk.com/dev/need_validation """
233233
# TODO: write me
234234
pass
235235

236236
def method(self, method, values=None, captcha_sid=None, captcha_key=None):
237-
u'''
238-
Использование методов API
237+
""" Использование методов API
239238
240239
:param method: метод
241240
:param values: параметры
242241
:param captcha_sid:
243242
:param captcha_key:
244-
'''
243+
"""
245244

246245
url = 'https://api.vk.com/method/%s' % method
247246

@@ -298,7 +297,7 @@ def method(self, method, values=None, captcha_sid=None, captcha_key=None):
298297

299298

300299
def regexp(reg, string):
301-
u''' Поиск по регулярке '''
300+
""" Поиск по регулярке """
302301

303302
reg = re.compile(reg, re.IGNORECASE | re.DOTALL)
304303
reg = reg.findall(string)

vk_api/vk_tools.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# encoding: utf-8
22

3-
'''
3+
"""
44
@author: Kirill Python
55
@contact: http://vk.com/python273
66
@license Apache License, Version 2.0, see LICENSE file
77
88
Copyright (C) 2014
9-
'''
9+
"""
1010

1111
import json
1212
import sys
@@ -20,7 +20,7 @@ def __init__(self, vk):
2020
self.vk = vk
2121

2222
def get_all(self, method, values=None, max_count=200, key='items'):
23-
u''' Получить все элементы
23+
""" Получить все элементы
2424
Работает в методах, где в ответе есть items или users
2525
За один запрос получает max_count * 25 элементов
2626
@@ -29,7 +29,7 @@ def get_all(self, method, values=None, max_count=200, key='items'):
2929
:param max_count: максимальное количество элементов,
3030
которое можно получить за один раз
3131
:param key: ключ элементов, которые нужно получить
32-
'''
32+
"""
3333

3434
if values:
3535
values = values.copy()
@@ -57,15 +57,15 @@ def get_all(self, method, values=None, max_count=200, key='items'):
5757
return {'count': len(items), key: items}
5858

5959
def get_all_slow(self, method, values=None, max_count=200, key='items'):
60-
u''' Получить все элементы
60+
""" Получить все элементы
6161
Работает в методах, где в ответе есть count и items или users
6262
6363
:param method: метод
6464
:param values: параметры
6565
:param max_count: максимальное количество элементов,
6666
которое можно получить за один раз
6767
:param key: ключ элементов, которые нужно получить
68-
'''
68+
"""
6969

7070
if not values:
7171
values = {}

vk_api/vk_upload.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# -*- coding: utf-8 -*-
22

3-
'''
3+
"""
44
@author: Kirill Python
55
@contact: http://vk.com/python273
66
@license Apache License, Version 2.0, see LICENSE file
77
88
Copyright (C) 2014
9-
'''
9+
"""
1010

1111

1212
class VkUpload(object):
@@ -15,14 +15,14 @@ def __init__(self, vk):
1515
# https://vk.com/dev/upload_files
1616

1717
def photo(self, photos, album_id=None, group_id=None):
18-
u''' Загрузка изображений в альбом пользователя
18+
""" Загрузка изображений в альбом пользователя
1919
2020
photos = ['photo1.jpg', 'img.png']
2121
= 'screen.png'
2222
Максимум 5 фотографий
2323
2424
album_id
25-
'''
25+
"""
2626

2727
if not (album_id and photos):
2828
return False
@@ -55,12 +55,12 @@ def photo(self, photos, album_id=None, group_id=None):
5555
return response
5656

5757
def photoMessages(self, photos, group_id=None):
58-
u''' Загрузка изображений в сообщения
58+
""" Загрузка изображений в сообщения
5959
6060
photos = ['photo1.jpg', 'img.png']
6161
= 'screen.png'
6262
Максимум 7(?) фотографий
63-
'''
63+
"""
6464

6565
if not photos:
6666
return False

0 commit comments

Comments
 (0)