Package buildbot :: Package scripts :: Module runner :: Class UserOptions
[frames] | no frames]

Class UserOptions

source code

              object --+            
                       |            
                    dict --+        
                           |        
twisted.python.usage.Options --+    
                               |    
          base.SubcommandOptions --+
                                   |
                                  UserOptions

Instance Methods
new empty dictionary

__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
opt_ids(self, option) source code
 
opt_info(self, option) source code
 
getSynopsis(self)
Returns a string containing a description of these options and how to pass them to the executed file.
source code
 
postOptions(self)
I am called after the options are parsed.
source code

Inherited from base.SubcommandOptions: loadOptionsFile

Inherited from twisted.python.usage.Options: __hash__, __str__, getUsage, opt_help, opt_version, parseArgs, 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
  subcommandFunction = 'buildbot.scripts.user.user'
  optParameters = [['master', 'm', None, 'Location of the buildm...
  buildbotOptions = [['master', 'master'], ['user_master', 'mast...
  requiredOptions = ['master']
  longdesc = '\n Currently implemented types for --info= are:...

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

Properties

Inherited from object: __class__

Method Details

__init__(self)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Returns:
new empty dictionary

Overrides: object.__init__
(inherited documentation)

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)

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

optParameters

Value:
[['master',
  'm',
  None,
  'Location of the buildmaster\'s PBListener (host:port)'],
 ['username', 'u', None, 'Username for PB authentication'],
 ['passwd', 'p', None, 'Password for PB authentication'],
 ['op',
  None,
...

buildbotOptions

Value:
[['master', 'master'],
 ['user_master', 'master'],
 ['user_username', 'username'],
 ['user_passwd', 'passwd']]

longdesc

Value:
'''
    Currently implemented types for --info= are:

    git, svn, hg, cvs, darcs, bzr, email
    '''