Package buildslave :: Package scripts :: Module runner :: Class SlaveOptions
[frames] | no frames]

Class SlaveOptions

source code

              object --+            
                       |            
                    dict --+        
                           |        
twisted.python.usage.Options --+    
                               |    
                       MakerBase --+
                                   |
                                  SlaveOptions

Instance Methods
 
getSynopsis(self)
Returns a string containing a description of these options and how to pass them to the executed file.
source code
 
parseArgs(self, *args)
I am called with any leftover arguments which were not options.
source code
 
postOptions(self)
I am called after the options are parsed.
source code

Inherited from MakerBase: opt_h

Inherited from twisted.python.usage.Options: __hash__, __init__, __str__, getUsage, opt_help, opt_version, parseOptions

Inherited from dict: __cmp__, __contains__, __delitem__, __eq__, __ge__, __getattribute__, __getitem__, __gt__, __iter__, __le__, __len__, __lt__, __ne__, __new__, __repr__, __setitem__, __sizeof__, clear, copy, fromkeys, get, has_key, items, iteritems, iterkeys, itervalues, keys, pop, popitem, setdefault, update, values, viewitems, viewkeys, viewvalues

Inherited from object: __delattr__, __format__, __reduce__, __reduce_ex__, __setattr__, __subclasshook__

Class Variables
  optFlags = [['force', 'f', 'Re-use an existing directory'], ['...
  optParameters = [['keepalive', 'k', 600, 'Interval at which ke...
  longdesc = '\n This command creates a buildslave working di...

Inherited from twisted.python.usage.Options: completionData, defaultSubCommand, parent, subCommand

Properties

Inherited from object: __class__

Method Details

getSynopsis(self)

source code 

Returns a string containing a description of these options and how to pass them to the executed file.

Overrides: twisted.python.usage.Options.getSynopsis
(inherited documentation)

parseArgs(self, *args)

source code 

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)

postOptions(self)

source code 

I am called after the options are parsed.

Override this method in your subclass to do something after the options have been parsed and assigned, like validate that all options are sane.

Overrides: twisted.python.usage.Options.postOptions
(inherited documentation)

Class Variable Details

optFlags

Value:
[['force', 'f', 'Re-use an existing directory'],
 ['relocatable', 'r', 'Create a relocatable buildbot.tac'],
 ['no-logrotate',
  'n',
  'Do not permit buildmaster rotate logs by itself']]

optParameters

Value:
[['keepalive',
  'k',
  600,
  'Interval at which keepalives should be sent (in seconds)'],
 ['usepty',
  None,
  0,
  '(1 or 0) child processes should be run in a pty (default 0)'],
...

longdesc

Value:
'''
    This command creates a buildslave working directory and buildbot.t\
ac
    file. The bot will use the <name> and <passwd> arguments to authen\
ticate
    itself when connecting to the master. All commands are run in a
    build-specific subdirectory of <basedir>. <master> is a string of \
the
...