Dispatcher Module¶
Dispatcher(router_id=None, storage=MemoryContext, *, use_create_task=False, **storage_kwargs)
¶
Bases: BotMixin
Основной класс для обработки событий бота.
Обеспечивает запуск поллинга и вебхука, маршрутизацию событий, применение middleware, фильтров и вызов соответствующих обработчиков.
Инициализация диспетчера.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
router_id
|
str | None
|
Идентификатор роутера для логов. |
None
|
use_create_task
|
bool
|
Флаг, отвечающий за параллелизацию обработок событий. |
False
|
storage
|
type[BaseContext]
|
Класс контекста для хранения данных (MemoryContext, RedisContext и т.д.). |
MemoryContext
|
**storage_kwargs
|
Any
|
Дополнительные аргументы для инициализации хранилища. |
{}
|
Source code in maxapi/dispatcher.py
check_me()
async
¶
Проверяет и логирует информацию о боте.
Source code in maxapi/dispatcher.py
build_middleware_chain(middlewares, handler)
¶
Формирует цепочку вызова middleware вокруг хендлера.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
middlewares
|
List[BaseMiddleware]
|
Список middleware. |
required |
handler
|
Callable
|
Финальный обработчик. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
Callable |
Callable[[Any, dict[str, Any]], Awaitable[Any]]
|
Обёрнутый обработчик. |
Source code in maxapi/dispatcher.py
include_routers(*routers)
¶
Добавляет указанные роутеры в диспетчер.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
*routers
|
Router
|
Роутеры для добавления. |
()
|
outer_middleware(middleware)
¶
Добавляет Middleware на первое место в списке.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
middleware
|
BaseMiddleware
|
Middleware. |
required |
middleware(middleware)
¶
Добавляет Middleware в конец списка.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
middleware
|
BaseMiddleware
|
Middleware. |
required |
filter(base_filter)
¶
Добавляет фильтр в список.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
base_filter
|
BaseFilter
|
Фильтр. |
required |
__ready(bot)
async
¶
Подготавливает диспетчер: сохраняет бота, подготавливает обработчики, вызывает on_started.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
bot
|
Bot
|
Экземпляр бота. |
required |
Source code in maxapi/dispatcher.py
__get_context(chat_id, user_id)
¶
Возвращает существующий или создаёт новый контекст по chat_id и user_id.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
chat_id
|
Optional[int]
|
Идентификатор чата. |
required |
user_id
|
Optional[int]
|
Идентификатор пользователя. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
BaseContext |
BaseContext
|
Контекст. |
Source code in maxapi/dispatcher.py
call_handler(handler, event_object, data)
async
¶
Вызывает хендлер с нужными аргументами.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
handler
|
Handler
|
Handler. |
required |
event_object
|
UpdateType | dict[str, Any]
|
Объект события. |
required |
data
|
dict[str, Any]
|
Данные для хендлера. |
required |
Returns:
| Type | Description |
|---|---|
None
|
None |
Source code in maxapi/dispatcher.py
process_base_filters(event, filters)
async
¶
Асинхронно применяет фильтры к событию.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event
|
UpdateUnion
|
Событие. |
required |
filters
|
List[BaseFilter]
|
Список фильтров. |
required |
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None | Literal[False]
|
Optional[Dict[str, Any]] | Literal[False]: Словарь с результатом или False. |
Source code in maxapi/dispatcher.py
handle_raw_response(event_type, raw_data)
async
¶
Специальный метод для обработки сырых ответов API.
Source code in maxapi/dispatcher.py
handle(event_object)
async
¶
Основной обработчик события. Применяет фильтры, middleware и вызывает нужный handler.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event_object
|
UpdateUnion
|
Событие. |
required |
Source code in maxapi/dispatcher.py
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 | |
start_polling(bot, *, skip_updates=False)
async
¶
Запускает цикл получения обновлений (long polling).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
bot
|
Bot
|
Экземпляр бота. |
required |
skip_updates
|
bool
|
Флаг, отвечающий за обработку старых событий. |
False
|
Source code in maxapi/dispatcher.py
794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 | |
stop_polling()
async
¶
Останавливает цикл получения обновлений (long polling).
Этот метод устанавливает флаг polling в False, что приводит к завершению цикла в методе start_polling.
Source code in maxapi/dispatcher.py
startup(bot)
async
¶
Инициализирует диспетчер: сохраняет бота, подготавливает обработчики и вызывает on_started.
Используется интеграционными модулями (например, maxapi.webhook.fastapi) для инициализации в lifespan веб-фреймворка.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
bot
|
Bot
|
Экземпляр бота. |
required |
Source code in maxapi/dispatcher.py
handle_webhook(bot, *, host=DEFAULT_HOST, port=DEFAULT_PORT, path=DEFAULT_PATH, secret=None, webhook_type=AiohttpMaxWebhook, **kwargs)
async
¶
Запускает вебхук-сервер (aiohttp) для приёма обновлений.
Удобный метод «всё в одном»: создаёт aiohttp-приложение через
:class:~maxapi.webhook.aiohttp.BaseMaxWebhook,
регистрирует маршрут и запускает сервер.
Для более гибкого управления жизненным циклом сервера используйте
одну из реализаций BaseMaxWebhook напрямую, например
:class:~maxapi.webhook.aiohttp.BaseMaxWebhook.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
bot
|
Bot
|
Экземпляр бота. |
required |
host
|
str
|
Хост сервера (по умолчанию |
DEFAULT_HOST
|
port
|
int
|
Порт сервера (по умолчанию |
DEFAULT_PORT
|
path
|
str
|
URL-путь для маршрута вебхука. |
DEFAULT_PATH
|
secret
|
str | None
|
Секрет для проверки заголовка
|
None
|
webhook_type
|
type[BaseMaxWebhook]
|
Класс вебхука. |
AiohttpMaxWebhook
|
**kwargs
|
Any
|
Дополнительные аргументы для |
{}
|
Source code in maxapi/dispatcher.py
init_serve(bot, host=DEFAULT_HOST, port=DEFAULT_PORT, **kwargs)
async
¶
.. deprecated::
Используйте :meth:handle_webhook вместо init_serve.
Метод будет удалён в одной из следующих версий.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
bot
|
Bot
|
Экземпляр бота. |
required |
host
|
str
|
Хост. |
DEFAULT_HOST
|
port
|
int
|
Порт. |
DEFAULT_PORT
|
Source code in maxapi/dispatcher.py
Router(router_id=None)
¶
Bases: Dispatcher
Роутер для группировки обработчиков событий.
Инициализация роутера.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
router_id
|
str | None
|
Идентификатор роутера для логов. |
None
|
Source code in maxapi/dispatcher.py
Event(update_type, router, *, deprecated=False)
¶
Декоратор для регистрации обработчиков событий.
Инициализирует событие-декоратор.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
update_type
|
UpdateType
|
Тип события. |
required |
router
|
Dispatcher | Router
|
Экземпляр роутера или диспетчера. |
required |
deprecated
|
bool
|
Флаг, указывающий на то, что событие устарело. |
False
|
Source code in maxapi/dispatcher.py
register(func_event, *args, **kwargs)
¶
Регистрирует функцию как обработчик события.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
func_event
|
Callable
|
Функция-обработчик |
required |
*args
|
Any
|
Фильтры |
()
|
**kwargs
|
Any
|
Дополнительные параметры (например, states) |
{}
|
Returns:
| Name | Type | Description |
|---|---|---|
Callable |
Callable
|
Исходная функция. |
Source code in maxapi/dispatcher.py
__call__(*args, **kwargs)
¶
Регистрирует функцию как обработчик события через декоратор.
Returns:
| Name | Type | Description |
|---|---|---|
Callable |
Callable
|
Декоратор. |