📓Структура модуля

Это все классно, но как создать модуль?

Модуль представляет собой Python-модуль (директория с файлом __init__.py) особой структуры.

core
├── extensions
│   ├── logs.py
│   ├── mod_manage.py
│   └── permissions.py
├── info.yaml
├── __init__.py
├── main.py
└── strings
    ├── en.yaml
    └── ru.yaml

Пример структуры

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

from base.module import BaseModule

class CoreModule(BaseModule):

В __init__.py обязан быть импорт нового класса модуля, иначе загрузчик просто не увидит его

from .main import CoreModule

Вся информация о модуле описывается в YAML файле info.yaml. В нее входит: название, автор, версия, описание, и разрешения (о них позже). Пример такого файла:

info:
  name: BestModule
  author: Developers
  version: 0.0.1
  description: Just best module, lol
  src_url: https://bestgit.org/BestModule

# Use raw loader object. Very dangerous permission!
permissions:
  - use_loader

Команды модуля создаются в виде методов класса, с теми же аргументами, что и обычный обработчик в pyrogram, за тем исключением, что необходимо использовать специальные декораторы (подробнее в следующем разделе).

Классы ModuleExtension позволяют разбить код модуля на файлы, не теряя при этом важные атрибуты класса. В примере выше, файлы с расширениями расположены в папке extensions, хотя они могут располагаться как угодно, все зависит от вас.

В модуль встроена система переводов. При загрузке модуль проверяет папку strings, и загружает файлы переводов в виде словарей в атрибут rawS, после чего выбирается текущий активный язык (указывается в конфиге бота) и загружает в атрибут S. Пример использования:

text = self.S["help"]["header"]