Commit e80ea90e authored by mathieui's avatar mathieui

Improve the alias plugin (save aliases, format strings, etc)

parent 0ee19d51
You only have to load the plugin:
``/load alias``
......@@ -15,32 +9,68 @@ This plugin defines two new global commands: :term:`/alias` and :term:`/unalias`
**Usage:** ``/alias <name> <command> [args]``
This command will create a new command, named ``name`` (and callable with
``/name``), that runs ``/command``, with ``[args]`` as fixed args for the command.
When you run the alias, you can also pass parameters to it, that will be fed
to the original command.
This command will create a new command, named ``<name>`` (and callable
with ``/name``), that runs ``/command``, with ``[args]`` as fixed
args for the command.
When you run the alias, you can also pass parameters to it, that will be
given to the original command.
Example: ::
/alias toto say "koin "
/alias toto say koin
Will bind ``/say koin `` to ``/toto``, so this alias will work in any
Will bind ``/say koin`` to ``/toto``, so this alias will work in any
Chat tab. If someone calls it with ::
/toto koin
Poezio will then execute ``/say koin koin``.
Also, you can rebind arguments arbitrarily, with the ``{}`` placeholder.
For example, ::
/alias toto say {} le {}
/toto loulou coucou
Will execute ``/say loulou le coucou``, because the ``{}`` are
replaced with the command args, in the order they are given.
Extra args are still added at the end of the command if provided
(args used for the formatting are only used for the formatting).
**Usage:** ``/unalias <name>``
This command removes a defined alias.
The aliases are stored inside the configuration file for the plugin.
You can either use the above commands or write it manually, and it
will be read when the plugin is loaded.
Example of the syntax:
.. code-block:: ini
toto = say {} le {}
j = join {}
jp = say je proteste
from plugin import BasePlugin
import common
from common import shell_split
from functools import partial, wraps
class Plugin(BasePlugin):
def init(self):
......@@ -54,26 +84,43 @@ class Plugin(BasePlugin):
short='Remove an alias',
self.commands = {}
def load_conf(self):
load stored aliases on startup
for alias in self.config.options():
full = self.config.get(alias, '')
self.command_alias(alias + ' ' + full)
def command_alias(self, line):
/alias <alias> <command> [args]
arg = common.shell_split(line)
if len(arg) < 2:
arg = split_args(line)
if not arg:
self.api.information('Alias: Not enough parameters', 'Error')
alias = arg[0]
command = arg[1]
tmp_args = arg[2] if len(arg) > 2 else ''
alias, command, args = arg
if alias in self.core.commands or alias in self.commands:
if alias in self.commands:
update = True
elif alias in self.core.commands:
self.api.information('Alias: command already exists', 'Error')
update = False
self.config.set(alias, command + ' ' + args)
self.commands[alias] = command_wrapper(generic_command, lambda: self.get_command(command), args)
self.api.add_command(alias, self.commands[alias], 'This command is an alias for /%s %s' %(alias, command))
self.commands[alias] = lambda arg: self.get_command(command)(tmp_args + arg)
self.api.add_command(alias, self.commands[alias], 'This command is an alias for /%s %s' %( command, tmp_args))
self.api.information('Alias /%s successfuly created' % alias, 'Info')
if update:
self.api.information('Alias /%s updated' % alias, 'Info')
self.api.information('Alias /%s successfuly created' % alias, 'Info')
def command_unalias(self, alias):
......@@ -85,6 +132,7 @@ class Plugin(BasePlugin):
self.api.information('Alias /%s successfuly deleted' % alias, 'Info')
def completion_unalias(self, the_input):
"Completion for /unalias"
aliases = [alias for alias in self.commands]
return the_input.auto_completion(aliases, '', quotify=False)
......@@ -99,3 +147,38 @@ class Plugin(BasePlugin):
elif name in self.api.current_tab().commands:
return self.api.current_tab().commands[name][0]
return dummy
def split_args(line):
Extract the relevant vars from the command line
arg = line.split()
if len(arg) < 2:
return None
alias_pos = line.find(' ')
alias = line[:alias_pos]
end = line[alias_pos+1:]
args_pos = end.find(' ')
command = end[:args_pos]
args = end[args_pos+1:]
return (alias, command, args)
def generic_command(command, extra_args, args):
Function that will execute the command and set the relevant
parameters (format string, etc).
args = shell_split(args)
new_extra_args = extra_args.format(*args)
count = extra_args.count('{}')
args = args[count:]
new_extra_args += ' '.join(args)
return command()(new_extra_args)
def command_wrapper(func, command, extra_args):
"set the predefined arguments"
def wrapper(*args, **kwargs):
return func(command, extra_args, *args, **kwargs)
return wrapper
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment