deadrat 0.0.3

A Python wrapper for the DeadRat Bot API

DeadRat Bot Framework 🐀

Легковесный, синхронный объектно-ориентированный фреймворк для создания ботов на Python.
Создан для быстрого написания логики без boilerplate-кода.

✨ Особенности

• Умная обработка аргументов: Не нужно парсить строки вручную. Фреймворк сам поймет, нужны ли функции аргументы (/command arg1 arg2).
• ООП-стиль: Методы msg.reply(), msg.reply_with_file() вместо передачи ID чатов.
• Декораторы: Простой и понятный синтаксис регистрации команд (@bot.command).
• События: Хуки на старт, выключение и ошибки.
• Типизация: Полная поддержка Type Hints для автокомплита в IDE.

📦 Установка

1. Скопируйте файл framework.py в папку вашего проекта.
2. Установите зависимости:

   pip install deadrat
   

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

from deadrat import Bot, Message

bot = Bot("YOUR_API_KEY")

@bot.command("/start")
def start(msg: Message):
    msg.reply(f"Привет, {msg.author.username}!")

@bot.command("/ban")
def ban(msg: Message, args: list):
    # Фреймворк сам разбил текст на аргументы
    if args:
        msg.reply(f"Пользователь {args[0]} забанен (понарошку).")

bot.run()

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

Инициализация

bot = Bot(api_key="...", base_url="...") # base_url опционален

Декораторы

@bot.command(trigger)

Регистрирует команду. Функция может принимать 1 или 2 аргумента:

1. msg (Message) — объект сообщения.
2. args (List[str]) — опционально. Список слов после команды.

@bot.on_message()

Регистрирует функцию, которая вызывается для всех сообщений, не являющихся командами.

@bot.event(name)

Обработка системных событий.

• "startup": Перед началом прослушивания.
• "shutdown": При остановке (Ctrl+C).
• "error": При возникновении исключения в хендлерах.

Объект Message

• msg.text (str): Текст сообщения.
• msg.author (Author): Объект автора (id, username).
• msg.reply_to_message (Message | None): Сообщение, на которое ответили.
• msg.reply(text, image_url): Ответить на сообщение.
• msg.reply_with_file(path, text): Загрузить файл и ответить им.

Объект SentMessage

Возвращается методами отправки (msg.reply).

• sent.edit(new_text): Изменить текст.
• sent.delete(): Удалить сообщение.