telegram.ext.PrefixHandler

class telegram.ext.PrefixHandler(prefix: Union[str, List[str], Tuple[str, ...]], command: Union[str, List[str], Tuple[str, ...]], callback: Callable[[Union[str, Update], CallbackContext], RT], filters: telegram.ext.filters.BaseFilter = None, pass_args: bool = False, pass_update_queue: bool = False, pass_job_queue: bool = False, pass_user_data: bool = False, pass_chat_data: bool = False, run_async: Union[bool, telegram.utils.helpers.DefaultValue] = <telegram.utils.helpers.DefaultValue object>)

Bases: telegram.ext.commandhandler.CommandHandler

Handler class to handle custom prefix commands

This is a 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.update.edited_message``.

callback

The callback function for this handler.

Type:callable
filters

Optional. Only allow updates with these Filters.

Type:telegram.ext.BaseFilter
pass_args

Determines whether the handler should be passed args.

Type:bool
pass_update_queue

Determines whether update_queue will be passed to the callback function.

Type:bool
pass_job_queue

Determines whether job_queue will be passed to the callback function.

Type:bool
pass_user_data

Determines whether user_data will be passed to the callback function.

Type:bool
pass_chat_data

Determines whether chat_data will be passed to the callback function.

Type:bool
run_async

Determines whether the callback will run asynchronously.

Type:bool

Note

pass_user_data and pass_chat_data determine whether a dict you can use to keep any data in will be sent to the callback function. Related to either the user or the chat that the update was sent in. For each update from the same user or in the same chat, it will be the same dict.

Note that this is DEPRECATED, and you should use context based callbacks. See https://git.io/fxJuV for more info.

Warning

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

Parameters:
  • prefix (telegram.utils.types.SLT[str]) – The prefix(es) that will precede command.
  • command (telegram.utils.types.SLT[str]) – The command or list of commands this handler should listen for.
  • callback (callable) –

    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 for context based API:

    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.BaseFilter, optional) – A filter inheriting from telegram.ext.filters.BaseFilter. Standard filters can be found in telegram.ext.filters.Filters. Filters can be combined using bitwise operators (& for and, | for or, ~ for not).
  • pass_args (bool, optional) – Determines whether the handler should be passed the arguments passed to the command as a keyword argument called args. It will contain a list of strings, which is the text following the command split on single or consecutive whitespace characters. Default is False DEPRECATED: Please switch to context based callbacks.
  • pass_update_queue (bool, optional) – If set to True, a keyword argument called update_queue will be passed to the callback function. It will be the Queue instance used by the telegram.ext.Updater and telegram.ext.Dispatcher that contains new updates which can be used to insert updates. Default is False. DEPRECATED: Please switch to context based callbacks.
  • pass_job_queue (bool, optional) – If set to True, a keyword argument called job_queue will be passed to the callback function. It will be a telegram.ext.JobQueue instance created by the telegram.ext.Updater which can be used to schedule new jobs. Default is False. DEPRECATED: Please switch to context based callbacks.
  • pass_user_data (bool, optional) – If set to True, a keyword argument called user_data will be passed to the callback function. Default is False. DEPRECATED: Please switch to context based callbacks.
  • pass_chat_data (bool, optional) – If set to True, a keyword argument called chat_data will be passed to the callback function. Default is False. DEPRECATED: Please switch to context based callbacks.
  • run_async (bool) – Determines whether the callback will run asynchronously. Defaults to False.
check_update(update: Union[str, Update]) → Union[bool, Tuple[List[str], Union[bool, Dict[KT, VT], None]], None]

Determines whether an update should be passed to this handlers callback.

Parameters:update (telegram.Update) – Incoming telegram update.
Returns:The list of args for the handler.
Return type:list
collect_additional_context(context: CallbackContext, update: Union[str, Update], dispatcher: Dispatcher, check_result: Union[bool, Tuple[List[str], Optional[bool]], None]) → None

Prepares additional arguments for the context. Override if needed.

Parameters:
command

The list of commands this handler should listen for.

Returns:List[str]
prefix

The prefixes that will precede command.

Returns:List[str]