Filters API

Aiogram-style platform-neutral filters.

class peyk.filters.BaseFilter

Bases: ABC

Base class for filters that may also contribute handler data.

peyk.filters.and_f(*filters: object) → BaseFilter

Provides the and f operation for the peyk integration.

Returns:

Result produced by the operation.

peyk.filters.or_f(*filters: object) → BaseFilter

Provides the or f operation for the peyk integration.

Returns:

Result produced by the operation.

peyk.filters.invert_f(filter_: object) → BaseFilter

Provides the invert f operation for the peyk integration.

Parameters:

filter – Value used by this operation.

Returns:

Result produced by the operation.

peyk.filters.normalize_filter(value: object) → BaseFilter

Provides the normalize filter operation for the peyk integration.

Parameters:

value – Value used by this operation.

Returns:

Result produced by the operation.

class peyk.filters.Command(*values: str, prefix: str = '/', ignore_case: bool = False, ignore_mention: bool = False, magic: object | None = None)

Bases: BaseFilter

Match a command and expose its parsed CommandObject as command.

class peyk.filters.CommandStart(deep_link: bool = False, **kwargs: object)

Bases: Command

Match the /start command, optionally requiring deep-link arguments.

class peyk.filters.CommandObject(prefix: str, command: str, mention: str | None = None, args: str | None = None, regexp_match: Match[str] | None = None, magic_result: object | None = None)

Bases: object

Parsed command information supplied to a matching handler.

args: str | None = None

magic_result: object | None = None

mention: str | None = None

regexp_match: Match[str] | None = None

prefix: str

command: str

class peyk.filters.CallbackData

Bases: BaseFilter

Dataclass-based callback-data factory compatible with aiogram’s model.

classmethod filter(magic: object | None = None) → BaseFilter

Provides the filter operation for the peyk integration.

Parameters:

magic – Value used by this operation.

Returns:

Result produced by the operation.

pack() → str

Provides the pack operation for the peyk integration.

Returns:

Result produced by the operation.

classmethod unpack(value: str) → CallbackDataT

Provides the unpack operation for the peyk integration.

Parameters:

value – Value used by this operation.

Returns:

Result produced by the operation.

class peyk.filters.CallbackDataEquals(value: str)

Bases: BaseFilter

Match an exact callback-data string.

class peyk.filters.CallbackDataStartsWith(prefix: str)

Bases: BaseFilter

Match callback data beginning with a prefix.

class peyk.filters.ChatTypeFilter(*chat_types: ChatType | str)

Bases: BaseFilter

Match a neutral chat type, treating Telegram supergroup as group.

peyk.filters.ChatType

alias of ChatTypeFilter

class peyk.filters.StateFilter(*states: State | type[StatesGroup] | str | None | Pattern[str], storage: BaseStorage | None = None, platform: str | None = None)

Bases: BaseFilter

Match raw_state injected by FSMContextMiddleware.

StateGroup values match any state in the group, re.Pattern values use match(), None matches the default empty state, and peyk.fsm.state.any_state matches every state.

class peyk.filters.MagicData(magic: object)

Bases: BaseFilter

Evaluate a magic filter against dispatcher dependency data.

class peyk.filters.ExceptionTypeFilter(*types: type[BaseException])

Bases: BaseFilter

Match an ErrorEvent by exception type.

class peyk.filters.ExceptionMessageFilter(message: str, *, contains: bool = False)

Bases: BaseFilter

Match an ErrorEvent by exception message.

class peyk.filters.PlatformFilter(*platforms: str)

Bases: BaseFilter

Match events handled by one of the named platforms.

class peyk.filters.SupportsFilter(feature: Feature)

Bases: BaseFilter

Match when the injected bot advertises audited support for a feature.

class peyk.filters.TextEquals(value: str, case_sensitive: bool = True)

Bases: BaseFilter

Match a message whose text equals value.

class peyk.filters.TextContains(value: str, case_sensitive: bool = True)

Bases: BaseFilter

Match a message containing value.