Перейти к содержанию

Фильтры

Чтобы не городить сотни if'ов в одном хэндлере, были придуманы фильтры (правила).

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

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

Кастомный фильтр

Если мы хотим реализовать какую-то сложную проверку (например, с запросом в бд или к какому-то апи), то надо создать свой фильтр.

Фильтры могут быть:

  • Асинхронными функциями (async def my_filter(*args, **kwargs): pass)
  • Синхронными функциями (def my_filter(*args, **kwargs): pass)
  • Анонимными функциями (lambda event: True)
  • Любым awaitable объектом
  • Подклассом aliceio.filters.base.Filter
  • Экземпляром Магического фильтра

И они должны возвращать bool или dict. Если возвращается словарь, полученные данные будут переданы следующим фильтрам и обработчику в качестве ключевых аргументов.

Сделаем простой class-based фильтр:

1
2
3
4
5
6
7
8
9
from aliceio.filters import BaseFilter
from aliceio.types import Message

class InWordsFilter(BaseFilter):  # Кастомный фильтр
    def __init__(self, words: list[str]) -> None:
        self.words = words

    async def __call__(self, message: Message) -> bool:
        return message.command in self.words

Теперь напишем хэндлеры, которые ловят согласие и отказ - слова "да", "нет" и похожие:

1
2
3
4
5
6
7
@router.message(InWordsFilter(["да", "ок", "хорошо"]))
async def yes_message_handler(message: Message) -> str:
    return "Ну да так да, чё бубнеть-то"

@router.message(InWordsFilter(["не", "нет", "неа"]))
async def no_message_handler(message: Message) -> str:
    return "Ну на нет и суда нет"

Магический фильтр

Для начала этот фильтр нужно импортировать из aliceio.
Если импортировать его из magic-filter, то метод .as_() не будет доступен (о нём в главе про DI и про магический фильтр).

1
from aliceio import F

К уже написанным обработчикам создадим ещё два, которые будут реагировать на нажатия кнопок с payload'ом:

1
2
3
4
5
6
7
8
9
# Один и тот же фильтр, но разная запись
@router.button_pressed(F.payload["yes"], F.payload["yes"].is_(True))
async def yes_button_handler(button: ButtonPressed) -> str:
    return "Кнопку нажал? Говорить лень?\nНу да так да, чё бубнеть-то"

# Один и тот же фильтр, но разная запись
@router.button_pressed(~F.payload["yes"], F.payload["yes"].is_(False))
async def no_button_handler(button: ButtonPressed) -> str:
    return"Кнопку нажал? Говорить лень?\nНу на нет и суда нет"

И чтобы эти кнопки появились, добавим хэндлер без фильтров, который будет срабатывать всегда, когда событие дойдёт до него:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Лучше не обрабатывать разные типы событий одним хэндлером
@router.message()
@router.button_pressed()
async def any_message_handler(message: ...) -> Response:
    return Response(
        text="Да-да... Да-да...",
        buttons=[
            TextButton(title="Да", payload={"yes": True}),
            TextButton(title="Нет", payload={"yes": False}),
        ],
    )

Допишем обычную точку входа и вуаля, вы прекрасны!

Комбинация фильтров

Есть два основных способа комбинации фильтров: "и" и "или". Все фильтры можно комбинировать друг с другом и создавать любые конфигурации под любую задачу.

Логическое "и"

Предпочтительный: 

1
@<router>.message(F.text.startswith("yoy"), F.text.endswith("wasap?"))

Дополнительный (с помощью and_f() фильтра): 

1
@<router>.message(and_f(F.text.startswith("yoy"), F.text.endswith("wasap?")))

Логическое "или"

Предпочтительный: 

1
2
@<router>.message(F.text.startswith("yoy"))
@<router>.message(F.text.endswith("wasap?"))

Дополнительный (с помощью or_f() фильтра): 

1
@<router>.message(or_f(F.text.startswith("yoy"), F.text.endswith("wasap?")))

Логическое "не" (инверсия)

Предпочтительный: 

1
@<router>.message(~F.text.startswith("yoy"))

Дополнительный (с помощью invert_f() фильтра): 

1
@<router>.message(invert_f(F.text.startswith("yoy")))

Примеры