telegram.ext.PrefixHandler#

class telegram.ext.PrefixHandler(prefix, command, callback, filters=None, block=True)[source]#

Handler class to handle custom prefix commands.

This is an intermediate handler between MessageHandler and CommandHandler. It supports configurable commands with the same options as CommandHandler. It will respond to every combination of prefix and command. It will add a list to the CallbackContext named CallbackContext.args. It will contain a list of strings, which is the text following the command split on single or consecutive whitespace characters.

Examples

Single prefix and command:

PrefixHandler("!", "test", callback)  # will respond to '!test'.

Multiple prefixes, single command:

PrefixHandler(["!", "#"], "test", callback)  # will respond to '!test' and '#test'.

Multiple prefixes and commands:

PrefixHandler(
    ["!", "#"], ["test", "help"], callback
)  # will respond to '!test', '#test', '!help' and '#help'.

By default, the handler listens to messages as well as edited messages. To change this behavior use ~filters.UpdateType.EDITED_MESSAGE

Note

Warning

When setting block to False, you cannot rely on adding custom attributes to telegram.ext.CallbackContext. See its docs for more info.

Parameters

prefix (str | Tuple[str] | List[str]) – The prefix(es) that will precede command.
command (str | Tuple[str] | List[str]) – The command or list of commands this handler should listen for.
callback (coroutine function) –
The callback function for this handler. Will be called when check_update() has determined that an update should be processed by this handler. Callback signature:
```
async def callback(update: Update, context: CallbackContext)
```
The return value of the callback is usually ignored except for the special case of telegram.ext.ConversationHandler.
filters (telegram.ext.filters.BaseFilter, optional) – A filter inheriting from telegram.ext.filters.BaseFilter. Standard filters can be found in telegram.ext.filters. Filters can be combined using bitwise operators (& for and, | for or, ~ for not)
block (bool, optional) – Determines whether the return value of the callback should be awaited before processing the next handler in telegram.ext.Application.process_update(). Defaults to True.

The callback function for this handler.

Optional. Only allow updates with these Filters.

Determines whether the return value of the callback should be awaited before processing the next handler in telegram.ext.Application.process_update().

check_update(update)[source]#

Determines whether an update should be passed to this handler’s callback.

property command[source]#

The list of commands this handler should listen for.

property prefix[source]#

The prefixes that will precede command.