1 # Copyright (c) 2005 The Regents of The University of Michigan
4 # Redistribution and use in source and binary forms, with or without
5 # modification, are permitted provided that the following conditions are
6 # met: redistributions of source code must retain the above copyright
7 # notice, this list of conditions and the following disclaimer;
8 # redistributions in binary form must reproduce the above copyright
9 # notice, this list of conditions and the following disclaimer in the
10 # documentation and/or other materials provided with the distribution;
11 # neither the name of the copyright holders nor the names of its
12 # contributors may be used to endorse or promote products derived from
13 # this software without specific prior written permission.
15 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 # Authors: Nathan Binkert
33 from optparse
import *
35 class nodefault(object): pass
37 class splitter(object):
38 def __init__(self
, split
):
40 def __call__(self
, option
, opt_str
, value
, parser
):
41 values
= value
.split(self
.split
)
42 dest
= getattr(parser
.values
, option
.dest
)
44 setattr(parser
.values
, option
.dest
, values
)
48 class OptionParser(object):
49 def __init__(self
, *args
, **kwargs
):
50 kwargs
.setdefault('formatter', optparse
.TitledHelpFormatter())
51 self
._optparse
= optparse
.OptionParser(*args
, **kwargs
)
52 self
._optparse
.disable_interspersed_args()
56 self
._options
= util
.attrdict()
58 # current option group
59 self
._group
= self
._optparse
61 def set_group(self
, *args
, **kwargs
):
62 '''set the current option group'''
63 if not args
and not kwargs
:
64 self
._group
= self
._optparse
66 self
._group
= self
._optparse
.add_option_group(*args
, **kwargs
)
68 def add_option(self
, *args
, **kwargs
):
69 '''add an option to the current option group, or global none set'''
71 # if action=split, but allows the option arguments
72 # themselves to be lists separated by the split variable'''
74 if kwargs
.get('action', None) == 'append' and 'split' in kwargs
:
75 split
= kwargs
.pop('split')
76 kwargs
['default'] = []
77 kwargs
['type'] = 'string'
78 kwargs
['action'] = 'callback'
79 kwargs
['callback'] = splitter(split
)
81 default
= kwargs
.pop('default', nodefault
)
82 option
= self
._group
.add_option(*args
, **kwargs
)
84 if dest
not in self
._allopts
:
85 self
._allopts
[dest
] = option
87 if default
!= nodefault
:
88 if dest
not in self
._options
:
89 self
._options
[dest
] = default
93 def bool_option(self
, name
, default
, help):
94 '''add a boolean option called --name and --no-name.
95 Display help depending on which is the default'''
98 fname
= '--no-%s' % name
99 dest
= name
.replace('-', '_')
101 thelp
= optparse
.SUPPRESS_HELP
105 fhelp
= optparse
.SUPPRESS_HELP
107 topt
= self
.add_option(tname
, action
="store_true", default
=default
,
109 fopt
= self
.add_option(fname
, action
="store_false", dest
=dest
,
114 def __getattr__(self
, attr
):
115 if attr
.startswith('_'):
116 return super(OptionParser
, self
).__getattr
__(attr
)
118 if attr
in self
._options
:
119 return self
._options
[attr
]
121 raise AttributeError, "Option %s not found" % attr
123 def __setattr__(self
, attr
, value
):
124 if attr
.startswith('_'):
125 return super(OptionParser
, self
).__setattr
__(attr
, value
)
127 if attr
in self
._options
:
128 self
._options
[attr
] = value
130 return super(OptionParser
, self
).__setattr
__(attr
, value
)
132 def parse_args(self
):
133 opts
,args
= self
._optparse
.parse_args()
135 for key
,val
in opts
.__dict
__.iteritems():
136 if val
is not None or key
not in self
._options
:
137 self
._options
[key
] = val
141 def usage(self
, exitcode
=None):
142 self
._optparse
.print_help()
143 if exitcode
is not None: