bzrlib.commands.Command : API documentation

def __init__(self):

overridden in bzrlib.builtins.cmd_selftest, bzrlib.externalcommand.ExternalCommand

Construct an instance of this command.

def add_cleanup(self, cleanup_func, *args, **kwargs):

Register a function to call after self.run returns or raises.

Functions will be called in LIFO order.

def cleanup_now(self):

Execute and empty pending cleanup functions immediately.

After cleanup_now all registered cleanups are forgotten. add_cleanup may be called again after cleanup_now; these cleanups will be called after self.run returns or raises (or when cleanup_now is next called).

This is useful for releasing expensive or contentious resources (such as write locks) before doing further work that does not require those resources (such as writing results to self.outf). Note though, that as it releases all resources, this may release locks that the command wants to hold, so use should be done with care.

def _usage(self):

Return single-line grammar for this command.

Only describes arguments, not options.

def get_help_text(self, additional_see_also=None, plain=True, see_also_as_links=False, verbose=True):

Return a text string with help for this command.

Parameters	additional_see_also	Additional help topics to be cross-referenced.
	plain	if False, raw help (reStructuredText) is returned instead of plain text.
	see_also_as_links	if True, convert items in 'See also' list to internal links (used by bzr_man rstx generator)
	verbose	if True, display the full help, otherwise leave out the descriptive sections and just display usage help (e.g. Purpose, Usage, Options) with a message explaining how to obtain full help.

@staticmethod
def _get_help_parts(text):

Split help text into a summary and named sections.

Returns (summary,sections,order) where summary is the top line and sections is a dictionary of the rest indexed by section name. order is the order the section appear in the text. A section starts with a heading line of the form ":xxx:". Indented text on following lines is the section value. All text found outside a named section is assigned to the default section which is given the key of None.

def get_help_topic(self):

Return the commands help topic - its name.

def get_see_also(self, additional_terms=None):

Return a list of help topics that are related to this command.

The list is derived from the content of the _see_also attribute. Any duplicates are removed and the result is in lexical order. :param additional_terms: Additional help topics to cross-reference. :return: A list of help topics.

def options(self):

Return dict of valid options for this command.

Maps from long option name to option object.

def _setup_outf(self):

Return a file linked to stdout, which has proper encoding.

def run_argv_aliases(self, argv, alias_argv=None):

overridden in bzrlib.externalcommand.ExternalCommand

Parse the command line and run with extra aliases in alias_argv.

def _setup_run(self):

Wrap the defined run method on self with a cleanup.

This is called by __init__ to make the Command be able to be run by just calling run(), as it could be before cleanups were added.

If a different form of cleanups are in use by your Command subclass, you can override this method.

def run(self):

Actually run the command.

This is invoked with the options and arguments bound to keyword parameters.

Return 0 or None if the command was successful, or a non-zero shell error code if not. It's OK for this method to allow an exception to raise up.

This method is automatically wrapped by Command.__init__ with a cleanup operation, stored as self._operation. This can be used via self.add_cleanup to perform automatic cleanups at the end of run().

The argument for run are assembled by introspection. So for instance, if your command takes an argument files, you would declare:

def run(self, files=None):
    pass

def help(self):

overridden in bzrlib.externalcommand.ExternalCommand

Return help message for this class.

def gettext(self, message):

Returns the gettext function used to translate this command's help.

Commands provided by plugins should override this to use their own i18n system.

def name(self):

overridden in bzrlib.externalcommand.ExternalCommand

Return the canonical name for this command.

The name under which it was actually invoked is available in invoked_as.

def plugin_name(self):

Get the name of the plugin that provides this command.

Returns The name of the plugin or None if the command is builtin.

Class Variables	aliases	Other accepted names for this command.
	takes_args	List of argument forms, marked with whether they are optional, repeated, etc. Examples: ['to_location', 'from_branch?', 'file*'] 'to_location' is required 'from_branch' is optional 'file' can be specified 0 or more times
	takes_options	List of options that may be given for this command. These can be either strings, referring to globally-defined options, or option objects. Retrieve through options().
	hidden	If true, this command isn't advertised. This is typically for commands intended for expert users.
	encoding_type	Command objects will get a 'outf' attribute, which has been setup to properly handle encoding of unicode strings. encoding_type determines what will happen when characters cannot be encoded: strict - abort if we cannot decode replace - put in a bogus character (typically '?') exact - do not encode sys.stdout NOTE: by default on Windows, sys.stdout is opened as a text stream, therefore LF line-endings are converted to CRLF. When a command uses encoding_type = 'exact', then sys.stdout is forced to be a binary stream, and line-endings will not mangled.
	invoked_as	A string indicating the real name under which this command was invoked, before expansion of aliases. (This may be None if the command was constructed and run in-process.)
	hooks	An instance of CommandHooks.
	__doc__	The help shown by 'bzr help command' for this command. This is set by assigning explicitly to __doc__ so that -OO can be used: class Foo(Command): __doc__ = "My help goes here"

Method	__init__	Construct an instance of this command.
Method	add_cleanup	Register a function to call after self.run returns or raises.
Method	cleanup_now	Execute and empty pending cleanup functions immediately.
Method	get_help_text	Return a text string with help for this command.
Method	get_help_topic	Return the commands help topic - its name.
Method	get_see_also	Return a list of help topics that are related to this command.
Method	options	Return dict of valid options for this command.
Method	run_argv_aliases	Parse the command line and run with extra aliases in alias_argv.
Method	run	Actually run the command.
Method	help	Return help message for this class.
Method	gettext	Returns the gettext function used to translate this command's help.
Method	name	Return the canonical name for this command.
Method	plugin_name	Get the name of the plugin that provides this command.
Method	_usage	Return single-line grammar for this command.
Static Method	_get_help_parts	Split help text into a summary and named sections.
Method	_setup_outf	Return a file linked to stdout, which has proper encoding.
Method	_setup_run	Wrap the defined run method on self with a cleanup.

b.c.Command(object) : class documentation