Package jazzparser :: Package shell :: Module tools :: Class PythonTool
[hide private]
[frames] | no frames]

Class PythonTool

source code

object --+    
         |    
      Tool --+
             |
            PythonTool

Excecutes arbitrary python commands. The commands have access to the parser, formalism, options and results in the environment.

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

Inherited from Tool: process_option_list

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

Class Variables [hide private]
  name = 'Python'
hash(x)
  commands = ['python', 'py']
  usage = ('python <command>', 'run an arbitrary Python command.')
  help = '\nRuns an arbitrary Python command.\nThe given command...

Inherited from Tool: 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.

Overrides: Tool.run
(inherited documentation)

Class Variable Details [hide private]

help

Value:
'''
Runs an arbitrary Python command.
The given command will just be executed. Various references are 
available in the environment:
  results: the results list
  parser: the parser object
  formalism: the loaded formalism
  options: the command-line options
...