Package jazzparser :: Package formalisms :: Package music_halfspan :: Module songtools :: Class ListSongsTool
[hide private]
[frames] | no frames]

Class ListSongsTool

source code

      object --+    
               |    
shell.tools.Tool --+
                   |
                  ListSongsTool

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 shell.tools.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 = 'List songs'
hash(x)
  commands = ['songs']
  usage = ('songs', 'list songs in loaded songset')
  help = 'List all the song names in the loaded tonal space anal...

Inherited from shell.tools.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: shell.tools.Tool.run
(inherited documentation)

Class Variable Details [hide private]

help

Value:
'''List all the song names in the loaded tonal space analysis songset.
'''