rbtools.utils.aliases¶

Utilities for working with command aliases.

Functions

rbtools.utils.aliases.replace_arguments(cmd, args, posix)[source]¶

Do parameter substitution for the given command.

Occurrences of variables $1, $2, etc. are replaced with the nth element of args (1-indexed). The special variable $* is expanded to contain all arguments.

If neither of these are present in the command, all arguments will be appended to the end.

Parameters:

• cmd (unicode) – The alias to replace positional variables in.

• args (list of unicode) – The arguments being provided to the alias.

• posix (boolean) –

  Whether or not to use the POSIX processing of commands.

  This should be False when parsing a command that will be given directly to the shell.

Returns:

The command and its arguments.

Return type:

list of unicode

Raises:

ValueError – An invalid escape or missing quote was encountered.

rbtools.utils.aliases.expand_alias(alias, args)[source]¶

Expand the given alias.

This function returns a tuple of the list of command line arguments and whether or not shell execution is required for the alias.

Parameters:

• alias (unicode) – The alias to expand.

• args (list of unicode) – The arguments to provide to the command.

Returns:

A 2-tuple of:

• The expanded alias (unicode or list of unicode).

• Whether or not the command should be passed to the shell or not (boolean).

Return type:

tuple

rbtools.utils.aliases.run_alias(alias_name, alias, args)[source]¶

Run the alias with the given arguments after expanding parameters.

Parameters:

• alias_name (unicode) – The name of the alias being run.

• alias (unicode) – The alias to run.

• args (list of unicode) – The arguments to the command being run.

Returns:

The exit code of the executed command (if it executed) or 1 if the alias could not be expanded.

Return type:

int