Package jazzparser :: Package shell :: Module tools :: Class Tool

Class Tool

object --+
         |
        Tool

Known Subclasses:

Base class for interactive shell tools. A basic set of subclasses is provided here, others may be provided by a formalism, tagger, parser, etc.

Instance Methods

[hide private]

run(self, args, state)
Main operation of tool, taking arguments in args and reading and potentially manipulating the shell state.

source code

process_option_list(self, options)

source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

[hide private]

name = None
hash(x)

commands = []

usage = ('command', 'help text')

help = '\nNo help text defined for this command.\n'

tool_options = []

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

run(self, args, state)

source code

Main operation of tool, taking arguments in args and reading and potentially manipulating the shell state.

By the time this is called, the options dict is available in self.options.