Команди#
Використання#
Фільтр єдиного варіанту команд:
Command("start")
Handle command by regexp pattern:
Command(re.compile(r"item_(\d+)"))
Match command by multiple variants:
Command("item", re.compile(r"item_(\d+)"))
Обробка команди в публічних чатах, призначених для інших ботів:
Command("command", ignore_mention=True)
Використання об’єкту
aiogram.types.bot_command.BotCommand
як посилання на командуCommand(BotCommand(command="command", description="My awesome command")
Попередження
Команда не може містити пробілів чи переносів рядків
- class aiogram.filters.command.Command(*values: str | Pattern | BotCommand, commands: Sequence[str | Pattern | BotCommand] | str | Pattern | BotCommand | None = None, prefix: str = '/', ignore_case: bool = False, ignore_mention: bool = False, magic: MagicFilter | None = None)[source]#
Цей фільтр може бути корисним для обробки команд із текстових повідомлень.
Працює лише з подіями
aiogram.types.message.Message
, що маютьtext
.- __init__(*values: str | Pattern | BotCommand, commands: Sequence[str | Pattern | BotCommand] | str | Pattern | BotCommand | None = None, prefix: str = '/', ignore_case: bool = False, ignore_mention: bool = False, magic: MagicFilter | None = None)[source]#
Перелік команд (рядки або скомпільовані шаблони регулярних виразів)
- Параметри:
prefix – Префікс для команди. Префікс завжди складається з одного символу, але тут ви можете передати всі дозволені префікси, наприклад:
"/!"
працюватиме з командами з префіксом"/"
або :code:`»!» `.ignore_case – Ігнорувати регістр (не працює з регулярним виразом, замість цього використовуйте маркери)
ignore_mention – Ігнорувати згадку про бота. За замовчуванням бот не може обробляти команди, призначені для інших ботів
magic – Перевірка об’єкту команди за допомогою магічного фільтра після виконання всіх перевірок
Коли фільтр пройдено, aiogram.filters.command.CommandObject
буде передано аргументу обробника command
- class aiogram.filters.command.CommandObject(prefix: str = '/', command: str = '', mention: str | None = None, args: str | None = None, regexp_match: Match[str] | None = None, magic_result: Any | None = None)[source]#
Екземпляр цього об’єкта завжди має команду та її префікс. Можна передати обробнику (handler) як аргумент ключового слова command
- prefix: str = '/'#
Префікс команди
- command: str = ''#
Команда без префікса та згадки
- mention: str | None = None#
Згадка (за наявності)
- args: str | None = None#
Аргумент команди
- regexp_match: Match[str] | None = None#
Буде представлено результат відповідності, якщо команда представлена як регулярний вираз у фільтрі
- magic_result: Any | None = None#
- property mentioned: bool#
Ця команда згадується?
- property text: str#
Створення оригінального тексту з об’єкта
Дозволені обробники (handler)#
Дозволені типи оновлень для цього фільтра:
message
edited_message