mable

mable

Документация в разработке оповещение будет в дс

Самоуверенный, статически типизированный микро-фреймворк Discord для Python3 и asyncio, который поддерживает REST версии Discord v10 и API-интерфейсы шлюза.

Построенный на благих намерениях и надежде, что он будет расширяемым и многоразовым, а не препятствием для будущего развития.

В настоящее время поддерживаются Python 3.8, 3.9, 3.10 и 3.11.

Installation

Установите marble из PyPI с помощью следующей команды:

python -m pip install -U mable
# Windows users may need to run this instead...
py -3 -m pip install -U mable

---

Bots

marble предоставляет две различные реализации бота по умолчанию в соответствии с вашими потребностями:

• GatewayBot
• RESTBot

GatewayBot

Шлюзовой бот - это тот, который будет подключаться к Discord через шлюз и получать события через него. Простым примером запуска может быть следующий:

import mable

bot = mable.GatewayBot(token="...")

@bot.listen()
async def ping(event: mable.GuildMessageCreateEvent) -> None:
    #If a non-bot user mentions your bot, respond with 'Pong!'.

    # Do not respond to bots nor webhooks pinging us, only user accounts
    if not event.is_human:
        return

    me = bot.get_me()

    if me.id in event.message.user_mentions_ids:
        await event.message.respond("Pong!")

bot.run()

Это будет отвечать только на сообщения, созданные в гильдиях. Вместо этого вы можете использовать DM Message Create Event, чтобы прослушивать только Dm или Message Create Event для прослушивания как DMS, так и сообщений от гильдии.

Если вы хотите настроить используемые намерения, чтобы изменить, о каких событиях уведомляется ваш бот, то вы можете передать kwarg intents конструктору Gateway Bot:

import mable

# the default is to enable all unprivileged intents (all events that do not target the
# presence, activity of a specific member nor message content).
bot = mable.GatewayBot(intents=mable.Intents.ALL, token="...")

Приведенный выше пример включил бы все намерения, тем самым позволяя получать события, связанные с присутствием участников (сначала вам нужно будет внести свое приложение в белый список, чтобы иметь возможность запустить бота, если вы это сделаете).

События определяются аннотацией типа в параметре event или, альтернативно, как тип, передаваемый декоратору @bot.listen(), если вы не хотите использовать подсказки типа.

import mable

bot = mable.GatewayBot("...")

@bot.listen()
async def ping(event: mable.MessageCreateEvent):
    ...

# or

@bot.listen(mable.MessageCreateEvent)
async def ping(event):
    ...

RESTBot

Тестовый бот создает сервер взаимодействия, на который Discord будет ** отправлять только ** события взаимодействия, которые можно обрабатывать и на которые можно реагировать.

Примером простого "REST Both" может быть следующее:

import asyncio

import mable


# This function will handle the interactions received
async def handle_command(interaction: mable.CommandInteraction):
    # Create an initial response to be able to take longer to respond
    yield interaction.build_deferred_response()

    await asyncio.sleep(5)

    # Edit the initial response
    await interaction.edit_initial_response("Edit after 5 seconds!")


# Register the commands on startup.
#
# Note that this is not a nice way to manage this, as it is quite spammy
# to do it every time the bot is started. You can either use a command handler
# or only run this code in a script using `RESTApp` or add checks to not update
# the commands if there were no changes
async def create_commands(bot: mable.RESTBot):
    application = await bot.rest.fetch_application()

    await bot.rest.set_application_commands(
        application=application.id,
        commands=[
            bot.rest.slash_command_builder("test", "My first test command!"),
        ],
    )


bot = mable.RESTBot(
    token="...",
    token_type="...",
    public_key="...",
)

bot.add_startup_callback(create_commands)
bot.set_listener(mable.CommandInteraction, handle_command)

bot.run()

В отличие от GatewayBot, регистрация слушателей выполняется через .set_listener, и она принимает тип взаимодействия , который будет принимать обработчик.

Обратите внимание, что для того, чтобы приведенный выше код заработал, требуется небольшая настройка. Вам нужно будет разместить проект во Всемирной паутине (страшно!), а затем зарегистрировать URL-адрес на портале приложений Discord для вашего приложения в разделе "URL конечной точки взаимодействия".

Быстрый способ загрузить своего бота в Интернет и сделать его доступным через Discord (** только для среды разработки **) - это с помощью такого инструмента, как ngrok или localhost.run. Более подробную информацию о том, как их использовать, можно найти на их соответствующих веб-сайтах.

Common helpful features

Обе реализации используют полезные аргументы, такие как настройка тайм-аутов для запросов и включение прокси-сервера, которые передаются непосредственно боту во время инициализации.

Также обратите внимание, что вы могли бы передать дополнительные параметры bot.run во время разработки, например:

import mable

bot = mable.GatewayBot("...")
# or
bot = mable.RESTBot("...", "...")

bot.run(
    asyncio_debug=True,             # enable asyncio debug to detect blocking and slow code.

    coroutine_tracking_depth=20,    # enable tracking of coroutines, makes some asyncio
                                    # errors clearer.

    propagate_interrupts=True,      # Any OS interrupts get rethrown as errors.
)

Существует множество других полезных опций, которыми вы можете воспользоваться, если пожелаете. Ссылки на соответствующие документы можно увидеть ниже:

• GatewayBot.run - ранее было сказано документация в разработке как только будет готово будет оповещение
• RESTBot.run - ранее было сказано документация в разработке как только будет готово будет оповещение

---

REST-only applications

Возможно, вы захотите интегрироваться только с REST API, например, при написании веб-панели мониторинга.

Это относительно просто сделать:

import mable
import asyncio

rest = mable.RESTApp()

async def print_my_user(token):
    await rest.start()
  
    # We acquire a client with a given token. This allows one REST app instance
    # with one internal connection pool to be reused.
    async with rest.acquire(token) as client:
        my_user = await client.fetch_my_user()
        print(my_user)

    await rest.close()
        
asyncio.run(print_my_user("user token acquired through OAuth here"))

---

Optional Features

Дополнительные функции могут быть указаны при установке mable:

• server - Установите зависимости, необходимые для включения стандартной функциональности сервера взаимодействия mable (REST Both).
• speedups - подробно описано в mable[speedups].

Пример:

# To install mable with the speedups feature:
python -m pip install -U mable[speedups]

# To install mable with both the speedups and server features:
python -m pip install -U mable[speedups, server]

Additional resources

Возможно, вы захотите использовать командный фреймворк поверх marble, чтобы вы могли быстро начать писать бота, не внедряя свой собственный обработчик команд.

mable по умолчанию не включает в себя командную платформу, поэтому для этого вам потребуется выбрать стороннюю библиотеку:

Повышение эффективности вашего приложения

По мере масштабирования вашего приложения вам, возможно, потребуется скорректировать некоторые параметры, чтобы оно работало нормально.

Флаги оптимизации на Python

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

• питон bot.py - без оптимизации - это значение по умолчанию.
• python -O bot.py - оптимизация первого уровня - такие функции, как внутренние утверждения, будут отключены.
• питон -ОО bot.py - оптимизация второго уровня - дополнительные функции (** включая все строки документации **) будут удалены из загруженный код во время выполнения. При запуске ботов в производственной среде рекомендуется минимум первый уровень оптимизации.

Не стесняйтесь также присоединяться к нашему Discord, чтобы напрямую задавать вопросы сопровождающим! Они будут будем рады помочь вам и направить в правильном направлении.