🌙

Вебхуки на Python

В pykodaribot 0.5.0 вебхуки поддерживаются клиентом Bot и приёмником WebhookRequestHandler. Для aiohttp отдельные зависимости ставить не нужно.

Настройка через SDK

await bot.set_webhook(
    "https://bot.example.com/shlyaps/webhook",
    secret_token=os.environ["KODARI_WEBHOOK_SECRET"],
    allowed_updates=["message", "callback_query"],
    drop_pending_updates=False,
)

info = await bot.get_webhook_info()
print(info.pending_update_count, info.last_error_message)

await bot.delete_webhook(drop_pending_updates=False)

Для подключения через BotFather откройте /mybots, выберите бота и пункт «Вебхук». Секрет из ответа BotFather сохраните как KODARI_WEBHOOK_SECRET у получателя.

get_webhook_info возвращает WebhookInfo. allowed_updates=None сохраняет прежний фильтр, пустой список включает все типы. При повторной настройке передавайте secret_token снова. drop_pending_updates=True удаляет ожидающую очередь. Остановите getUpdates перед включением вебхука.

Полный пример на aiohttp

Задайте KODARI_BOT_TOKEN, KODARI_WEBHOOK_SECRET и KODARI_WEBHOOK_URL. Последняя переменная содержит публичный HTTPS-адрес на порту 443. Настройте веб-сервер, чтобы он направлял /shlyaps/webhook на локальный порт 8080.

import os

from aiohttp import web

from pykodaribot import Bot, Dispatcher, WebhookRequestHandler, filters

bot = Bot(os.environ["KODARI_BOT_TOKEN"])
dp = Dispatcher()
secret = os.environ["KODARI_WEBHOOK_SECRET"]


@dp.message(filters.command("start"))
async def start(message):
    await message.answer("Привет! Напиши мне.")


@dp.message()
async def echo(message):
    if message.text:
        await message.reply(message.text)


async def setup(app):
    await bot.set_webhook(
        os.environ["KODARI_WEBHOOK_URL"],
        secret_token=secret,
        allowed_updates=["message", "callback_query"],
    )


app = web.Application(client_max_size=2 * 1024 * 1024)
WebhookRequestHandler(dp, bot, secret).register(app, "/shlyaps/webhook")
app.on_startup.append(setup)

if __name__ == "__main__":
    web.run_app(app, host="127.0.0.1", port=8080)

Запустите файл обычным Python. При запуске приложение сохраняет адрес вебхука и использует прежние обработчики Dispatcher. Не запускайте start_polling одновременно с этим приложением.

Что делает приёмник

WebhookRequestHandler проверяет X-Shlyaps-Bot-Api-Secret-Token, разбирает JSON и связывает Update с Bot. Поэтому message.answer(), message.reply() и callback.answer() работают без дополнительной настройки.

После завершения обработчика возвращается HTTP 204. Если обработчик выбросил исключение, ответ будет HTTP 503 и событие придёт повторно. Неверный секрет получает 403, неверный JSON или Update получает 400. Ограничение размера запроса задаётся client_max_size приложения.

При завершении aiohttp-приложения Bot закрывается автоматически. Если его жизненным циклом управляет другой код, вызовите register(app, path, close_bot=False).

Повторы и длительная обработка

Приёмник по умолчанию помнит последние 1024 успешно обработанных update_id в памяти одного процесса. Повторы в этот процесс подтверждаются без повторного вызова обработчика. deduplication_limit меняет размер кеша, 0 отключает его. После перезапуска или между процессами повторы возможны, поэтому для действий с постоянным результатом сохраняйте ID в своей базе.

Шляпс ждёт HTTP-ответ до 10 секунд. Долгую работу сначала сохраняйте в постоянную очередь и подтверждайте только успешную запись. Ошибка после частично выполненного действия тоже может привести к повтору, учитывайте это в своём обработчике.

Другой веб-фреймворк

await dp.feed_update(bot, data)

data может быть JSON-словарём или Update. Метод передаёт ошибки вызывающему коду. Для повторной доставки верните 5xx при ошибке и 2xx только после успешной обработки либо записи в очередь.

Доставка, допустимые адреса и IP фронтов описаны в общем разделе.

14 просмотров