Dispatcher Module¶
Dispatcher(router_id=None, use_create_task=False, storage=MemoryContext, **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
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 | |
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 |
|---|---|
Optional[Dict[str, Any]] | 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
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 | |
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
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 | |
stop_polling()
async
¶
Останавливает цикл получения обновлений (long polling).
Этот метод устанавливает флаг polling в False, что приводит к завершению цикла в методе start_polling.
Source code in maxapi/dispatcher.py
handle_webhook(bot, host=DEFAULT_HOST, port=DEFAULT_PORT, **kwargs)
async
¶
Запускает FastAPI-приложение для приёма обновлений через вебхук.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
bot
|
Bot
|
Экземпляр бота. |
required |
host
|
str
|
Хост сервера. |
DEFAULT_HOST
|
port
|
int
|
Порт сервера. |
DEFAULT_PORT
|
Source code in maxapi/dispatcher.py
init_serve(bot, host=DEFAULT_HOST, port=DEFAULT_PORT, **kwargs)
async
¶
Запускает сервер для обработки вебхуков.
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
|
Декоратор. |