canonical.launchpad.mail.commands : API documentation

Function	get_error_message	Returns the error message that's in the given filename.
Function	normalize_arguments	Normalizes the string arguments.
Class	EmailCommand	Represents a command.
Class	BugEmailCommand	Creates new bug, or returns an existing one.
Class	EditEmailCommand	Helper class for commands that edits the context.
Class	PrivateEmailCommand	Marks a bug public or private.
Class	SecurityEmailCommand	Marks a bug as security related.
Class	SubscribeEmailCommand	Subscribes someone to the bug.
Class	UnsubscribeEmailCommand	Unsubscribes someone from the bug.
Class	SummaryEmailCommand	Changes the title of the bug.
Class	DuplicateEmailCommand	Marks a bug as a duplicate of another bug.
Class	CVEEmailCommand	Links a CVE to a bug.
Class	AffectsEmailCommand	Either creates a new task, or edits an existing task.
Class	AssigneeEmailCommand	Assigns someone to the bug.
Class	MilestoneEmailCommand	Sets the milestone for the bugtask.
Class	DBSchemaEditEmailCommand	Helper class for edit DBSchema attributes.
Class	StatusEmailCommand	Changes a bug task's status.
Class	ImportanceEmailCommand	Changes a bug task's importance.
Class	ReplacedByImportanceCommand	This command has been replaced by the 'importance' command.
Class	TagEmailCommand	Assigns a tag to or removes a tag from bug.
Class	NoSuchCommand	A command with the given name couldn't be found.
Class	EmailCommandCollection	A collection of email commands.
Class	BugEmailCommands	A collection of email commands.

def get_error_message(filename, **interpolation_items):

Returns the error message that's in the given filename.

If the error message requires some parameters, those are given in interpolation_items.

The files are searched for in lib/canonical/launchpad/mail/errortemplates.

def normalize_arguments(string_args):

Normalizes the string arguments.

The string_args argument is simply the argument string whitespace splitted. Sometimes arguments may be quoted, though, so that they can contain space characters. For example "This is a long string".

This function loops through all the argument and joins the quoted strings into a single arguments.

>>> normalize_arguments(['"This', 'is', 'a', 'long', 'string."'])
['This is a long string.']

>>> normalize_arguments(
...     ['"First', 'string"', '"Second', 'string"', 'foo'])
['First string', 'Second string', 'foo']

c.l.m.commands : module documentation