maxo 0.5.0

Asynchronous framework for MAX.ru bots

maxo

Асинхронный фреймворк для разработки ботов в max.ru

Документация

Оригинальный репозиторий
maxo/dialogs сделано из aiogram_dialog
maxo/transport/webhook сделано из aiogram-webhook

Установка

Через pip:

pip install maxo==0.5.0

В pyproject.toml:

[project]
dependencies = [
    "maxo==0.5.0",
]

Особенности

• Асинхронность на базе aiohttp и unihttp (asyncio, PEP 492)
• 100% покрытие типами, adaptix для валидации данных
• Роутеры, фильтры, милдвари
• Встроенная машина состояний (FSM) и диалоги поверх них
• Поддержка лонг-поллинга и вебхуков через aiohttp и fastapi
• Интеграции с dishka и magic_filter
• Автогенерация методов, типов и апдейтов по официальной документации

Быстрый старт

Больше примеров в примерах

Эхо-бот

from maxo import Bot, Dispatcher
from maxo.routing.updates import MessageCreated
from maxo.transport.long_polling import LongPolling
from maxo.utils.facades import MessageCreatedFacade

bot = Bot("TOKEN")
dispatcher = Dispatcher()

@dispatcher.message_created()
async def echo_handler(update: MessageCreated, facade: MessageCreatedFacade) -> None:
    text = update.message.body.text or "Текста нет"
    await facade.answer_text(text)

LongPolling(dispatcher).run(bot)

Команды

from maxo import Bot, Dispatcher
from maxo.routing.filters import Command, CommandObject, CommandStart
from maxo.routing.updates import MessageCreated
from maxo.transport.long_polling import LongPolling
from maxo.utils.facades import MessageCreatedFacade

bot = Bot("TOKEN")
dispatcher = Dispatcher()

@dispatcher.message_created(CommandStart())
# или @dispatcher.message_created(Command("start"))
async def start_handler(
    message: MessageCreated,
    command: CommandObject,
    facade: MessageCreatedFacade,
) -> None:
    await facade.answer_text(f"Привет! Я бот. Диплинк: {command.args}")

LongPolling(dispatcher).run(bot)

Клавиатуры

from magic_filter import F

from maxo import Bot, Dispatcher
from maxo.integrations.magic_filter import MagicFilter
from maxo.routing.filters import CommandStart
from maxo.routing.updates import MessageCallback, MessageCreated
from maxo.transport.long_polling import LongPolling
from maxo.utils.builders import KeyboardBuilder
from maxo.utils.facades import MessageCallbackFacade, MessageCreatedFacade

bot = Bot("TOKEN")
dispatcher = Dispatcher()

@dispatcher.message_created(CommandStart())
async def start_handler(message: MessageCreated, facade: MessageCreatedFacade) -> None:
    keyboard = (
        KeyboardBuilder()
        .add_callback(
            text="Колбэк кнопка",
            payload="callback_payload",
        )
        .add_message(text="Текстовая кнопка")
        .add_link(
            text="Maxo",
            url="https://github.com/K1rL3s/maxo",
        )
        .adjust(1, repeat=True)
        .build()
    )
    await facade.answer_text("Кнопочки:", keyboard=keyboard)

@dispatcher.message_callback(MagicFilter(F.payload == "callback_payload"))
async def button_handler(
    callback: MessageCallback,
    facade: MessageCallbackFacade,
) -> None:
    await facade.callback_answer("Вы нажали на кнопку!")

LongPolling(dispatcher).run(bot)

Вебхук

import logging
import os

from aiohttp import web

from maxo import Bot, Dispatcher, Router
from maxo.enums import TextFormat
from maxo.routing.updates import BotStarted, MessageCreated
from maxo.routing.utils import collect_used_updates
from maxo.transport.webhook.adapters.aiohttp import AiohttpWebAdapter
from maxo.transport.webhook.engines import SimpleEngine, WebhookEngine
from maxo.transport.webhook.routing import StaticRouting
from maxo.transport.webhook.security import Security, StaticSecretToken
from maxo.utils.facades import BotStartedFacade, MessageCreatedFacade

bot = Bot(os.environ["TOKEN"])
router = Router()

@router.bot_started()
async def start_handler(bot_started: BotStarted, facade: BotStartedFacade) -> None:
    await facade.send_message(text=f"Привет из вебхука, {bot_started.user.first_name}!")

@router.message_created()
async def echo_handler(message: MessageCreated, facade: MessageCreatedFacade) -> None:
    await facade.answer_text(
        text=message.message.body.html_text,
        format=TextFormat.HTML,
    )

@router.after_startup()
async def on_startup(dispatcher: Dispatcher, webhook_engine: WebhookEngine) -> None:
    await webhook_engine.set_webhook(update_types=collect_used_updates(dispatcher))

def main() -> None:
    dispatcher = Dispatcher()
    dispatcher.include(router)

    engine = SimpleEngine(
        dispatcher,
        bot,
        web_adapter=AiohttpWebAdapter(),
        routing=StaticRouting(url="https://example.com/webhook"),
        security=Security(secret_token=StaticSecretToken("pepa_pig")),
    )
    app = web.Application()
    engine.register(app)

    web.run_app(app, host="127.0.0.1", port=8080)

if __name__ == "__main__":
    logging.basicConfig(level=logging.DEBUG)
    main()

Связь

Если у вас есть вопросы, вы можете задать их в Телеграме @maxo_py или Максе