summon.options
index
/home/raz/projects/summon.git/lib/summon/options.py

Argument parsing
 
file:   options.py
author: Matt Rasmussen
date:   11/30/05

 
Modules
       
__builtin__
getopt
os
shlex
sys

 
Classes
       
__builtin__.dict(__builtin__.object)
Configuration
exceptions.Exception
OptionError
Option

 
class Configuration(__builtin__.dict)
    Configuration dict
 
will throw informative exception if key is not present.
 
 
Method resolution order:
Configuration
__builtin__.dict
__builtin__.object

Methods defined here:
__getitem__(self, key)
__init__(self, options)

Data and other attributes defined here:
__dict__ = <dictproxy object>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'Configuration' objects>
list of weak references to the object (if defined)

Methods inherited from __builtin__.dict:
__cmp__(...)
x.__cmp__(y) <==> cmp(x,y)
__contains__(...)
D.__contains__(k) -> True if D has a key k, else False
__delitem__(...)
x.__delitem__(y) <==> del x[y]
__eq__(...)
x.__eq__(y) <==> x==y
__ge__(...)
x.__ge__(y) <==> x>=y
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__gt__(...)
x.__gt__(y) <==> x>y
__hash__(...)
x.__hash__() <==> hash(x)
__iter__(...)
x.__iter__() <==> iter(x)
__le__(...)
x.__le__(y) <==> x<=y
__len__(...)
x.__len__() <==> len(x)
__lt__(...)
x.__lt__(y) <==> x<y
__ne__(...)
x.__ne__(y) <==> x!=y
__repr__(...)
x.__repr__() <==> repr(x)
__setitem__(...)
x.__setitem__(i, y) <==> x[i]=y
clear(...)
D.clear() -> None.  Remove all items from D.
copy(...)
D.copy() -> a shallow copy of D
get(...)
D.get(k[,d]) -> D[k] if k in D, else d.  d defaults to None.
has_key(...)
D.has_key(k) -> True if D has a key k, else False
items(...)
D.items() -> list of D's (key, value) pairs, as 2-tuples
iteritems(...)
D.iteritems() -> an iterator over the (key, value) items of D
iterkeys(...)
D.iterkeys() -> an iterator over the keys of D
itervalues(...)
D.itervalues() -> an iterator over the values of D
keys(...)
D.keys() -> list of D's keys
pop(...)
D.pop(k[,d]) -> v, remove specified key and return the corresponding value
If key is not found, d is returned if given, otherwise KeyError is raised
popitem(...)
D.popitem() -> (k, v), remove and return some (key, value) pair as a
2-tuple; but raise KeyError if D is empty
setdefault(...)
D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D
update(...)
D.update(E, **F) -> None.  Update D from E and F: for k in E: D[k] = E[k]
(if E has keys else: for (k, v) in E: D[k] = v) then: for k in F: D[k] = F[k]
values(...)
D.values() -> list of D's values

Data and other attributes inherited from __builtin__.dict:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
fromkeys = <built-in method fromkeys of type object>
dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v.
v defaults to None.

 
class Option
    Class for commandline options
 
  Methods defined here:
__init__(self, option_list)

 
class OptionError(exceptions.Exception)
    Exception for errors while parsing and accessing optiosn
 
  Methods defined here:
__init__(self, msg)
__str__(self)

Methods inherited from exceptions.Exception:
__getitem__(...)

 
Functions
       
parseOptions(argv, options, quit=True, resthelp='', helpOption=True, configFileOption=False)
readConfigFile(*filenames)
shellparser(arg)
usage(progname, options, resthelp='')
options = [("a:", "a_long=", "a_name", "<arg>]"), ...]