Bot

Основной класс бота.

class bot.Bot

Класс, описывающий объект бота, включая авторизацию в API, и все методы бота.

token

Токен доступа к сообществу ВКонтакте

Type

str

user_token

Токен доступа пользователя-администратора ВКонтакте (используется для обновления статуса сообщества)

Type

str

gid

Идентификатор сообщества ВКонтакте

Type

str

cid

Идентификатор активной беседы (используется в рассылке расписания)

Type

str

kbs

Объект класса Keyboards, содержащий генераторы клавиатур

Type

Keyboards

db

Объект класса Database, инициирующий подключение к базе данных

Type

Database

admins

Список идентификаторов ВКонтакте пользователей, имеющих доступ администратора бота

Type

List[str]

Пример

from bot import Bot
bot = Bot()
bot.auth()

auth()

Авторизация ВКонтакте, подключение к API

generate_mentions(ids: str, names: bool) → str

Генерирует строку с упоминаниями из списка идентификаторов

Параметры

• ids – Перечень идентификаторов пользователей

• names – Флаг, указывающий на необходимость использования имён

Результат

Сообщение, упоминающее выбранных пользователей

Тип результата

str

is_admin(_id: int) → bool

Проверяет, является ли пользователь администратором бота

Параметры

_id – Идентификатор пользователя для проверки привелегий

Результат

Флаг, указывающий на принадлежность текущего пользователя к касте Администраторов

Тип результата

bool

send_gui(pid: int, text: str = 'Привет!') → NoReturn

Отправляет клавиатуру главного меню

Параметры

• pid – Получатель клавиатуры

• text – Сообщение, вместе с которым будет отправлена клавиатура

send_mailing(m_id: int, text: str, group: int, attach: str = '')

Генерирует строку с упоминаниями из списка идентификаторов

Параметры

• group – Номер группы для поиска подписчиков

• m_id – Идентификатор рассылки

• text – Сообщение рассылки

• attach – Список вложений, прикрепляемых к рассылке

send_message(msg: str = '', pid: int = None, keyboard: str = '', attachment: str = None, user_ids: str = None, forward: str = '') → NoReturn

Обёртка над API ВКонтакте, отправляющая сообщения

Параметры

• msg – Текст отправляемого сообщения

• pid – Идентификатор пользователя/беседы/сообщества получателя сообщения (не нужен, если указан user_ids)

• keyboard – JSON-подобная строка со встроенной клавиатурой

• attachment – Вложения к сообщению (не работает)

• user_ids – Перечень адресатов для отправки одного сообщения (не нужен, если указан pid)

• forward – Перечень идентификаторов сообщений для пересылки

update_version()

Обновляет версию в статусе группы с ботом