raito.plugins.commands.flags module¶

raito.plugins.commands.flags.description(description)[source]¶

Attach a description to the command handler for use in command registration (e.g., raito.register_commands)

The description will be shown in the Telegram command list (via set_my_commands) Supports internationalization via LazyProxy.

Parameters:: description (str | LazyProxy) – A string or LazyProxy representing the description.
Returns:: A FlagDecorator to be applied to the handler.
Return type:: FlagDecorator

raito.plugins.commands.flags.hidden(func)[source]¶

Mark a command handler as hidden from the command list.

Hidden handlers will not be included in Telegram’s slash commands when calling raito.register_commands.

Parameters:: func (Callable) – The command handler to mark as hidden.
Returns:: The wrapped handler.
Return type:: Callable[[…], Any]

raito.plugins.commands.flags.params(**kwargs)[source]¶

Define expected parameters and their types for command parsing.

This acts as a lightweight argument extractor and validator for commands. For example, @rt.params(user_id=int) will extract user_id=1234 from a command like /ban 1234.

Example

@router.message(filters.Command("ban"))
@rt.params(user_id=int)
def ban(message: Message, user_id: int):
    ...

Parameters:: kwargs (type[str | int | bool | float]) – A mapping of parameter names to their expected types.
Returns:: A FlagDecorator to be applied to the handler with param data.
Return type:: FlagDecorator