Package twisted :: Package scripts :: Module generatelore :: Class Options
[show private | hide private]
[frames | no frames]

Class Options

UserDict --+    
           |    
     Options --+
               |
              Options


Method Summary
  __init__(self)
(inherited from Options)
  __cmp__(self, dict)
(inherited from UserDict)
  __contains__(self, key)
(inherited from UserDict)
  __delitem__(self, key)
(inherited from UserDict)
  __getattr__(self, attr)
I make sure that old style 'optObj.option' access still works. (inherited from Options)
  __getitem__(self, key)
(inherited from UserDict)
  __hash__(self)
(inherited from Options)
  __len__(self)
(inherited from UserDict)
  __repr__(self)
(inherited from UserDict)
  __setitem__(self, key, item)
(inherited from UserDict)
  __str__(self, width)
(inherited from Options)
  clear(self)
(inherited from UserDict)
  copy(self)
(inherited from UserDict)
  get(self, key, failobj)
(inherited from UserDict)
  has_key(self, key)
(inherited from UserDict)
  items(self)
(inherited from UserDict)
  iteritems(self)
(inherited from UserDict)
  iterkeys(self)
(inherited from UserDict)
  itervalues(self)
(inherited from UserDict)
  keys(self)
(inherited from UserDict)
  opt_help(self)
Display this help and exit. (inherited from Options)
  opt_version(self)
(inherited from Options)
  parseArgs(self)
I am called with any leftover arguments which were not options.
  parseOptions(self, options)
The guts of the command-line parser. (inherited from Options)
  popitem(self)
(inherited from UserDict)
  postOptions(self)
I am called after the options are parsed. (inherited from Options)
  setdefault(self, key, failobj)
(inherited from UserDict)
  update(self, dict)
(inherited from UserDict)
  values(self)
(inherited from UserDict)
  _gather_flags(self)
Gather up boolean (flag) options. (inherited from Options)
  _gather_handlers(self)
Gather up options with their own handler methods. (inherited from Options)
  _gather_parameters(self)
Gather options which take a value. (inherited from Options)
  _generic_flag(self, flagName, value)
(inherited from Options)
  _generic_parameter(self, parameterName, value)
(inherited from Options)

Class Variable Summary
list optParameters

Method Details

parseArgs(self, *files)

I am called with any leftover arguments which were not options.

Override me to do something with the remaining arguments on the command line, those which were not flags or options. e.g. interpret them as a list of files to operate on.

Note that if there more arguments on the command line than this method accepts, parseArgs will blow up with a getopt.error. This means if you don't override me, parseArgs will blow up if I am passed any arguments at all!
Overrides:
twisted.python.usage.Options.parseArgs (inherited documentation)

Class Variable Details

optParameters

Type:
list
Value:
[['template',
  't',
  'template.tpl',
  'The template to follow for generating content.'],
 ['docsdir', 'd', None],
 ['linkrel', 'l', ''],
 ['ext',
  'e',
...                                                                    

Generated by Epydoc 1.2 prerelease on Wed Jan 29 06:28:40 2003 http://epydoc.sf.net