1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
|
# Copyright (C) 2004 Mike Wray <mike.wray@hp.com>
"""Object-oriented command-line option support.
"""
from getopt import getopt
import os
import os.path
import sys
import types
class Opt:
"""An individual option.
"""
def __init__(self, opts, name, short=None, long=None,
val=None, fn=None, use=None, default=None):
"""Create an option.
opts parent options object
name name of the field it controls
short short (1-char) command line switch (optional)
long long command-line switch. Defaults to option name.
val string used to print option args in help.
If val is not specified the option has no arg.
fn function to call when the option is specified.
use usage (help) string
default default value if not specified on command-line
"""
self.opts = opts
self.name = name
self.short = short
if long is None:
long = name
self.long = long
self.val = val
self.use = use
self.default = default
self.optkeys = []
if self.short:
self.optkeys.append('-' + self.short)
if self.long:
self.optkeys.append('--' + self.long)
self.fn = fn
self.specified_opt = None
self.specified_val = None
self.value = None
self.set(default)
def __repr__(self):
return self.name + '=' + str(self.specified_val)
__str__ = __repr__
def set(self, value):
"""Set the option value.
"""
self.opts.setopt(self.name, value)
def get(self):
"""Get the option value.
"""
return self.opts.getopt(self.name)
def append(self, value):
"""Append a value to the option value.
"""
v = self.get() or []
v.append(value)
self.set(v)
def short_opt(self):
"""Short option spec.
"""
if self.short:
if self.val:
return self.short + ':'
else:
return self.short
else:
return None
def long_opt(self):
"""Long option spec.
"""
if self.long:
if self.val:
return self.long + '='
else:
return self.long
else:
return None
def show(self):
sep = ''
for x in self.optkeys:
print sep, x,
sep = ','
if self.val:
print self.val,
print
if self.use:
print '\t',
print self.use
if self.val:
print '\tDefault', self.default or 'None'
def specify(self, k, v):
"""Specify the option. Called when the option is set
from the command line.
k option switch used
v optional value given (if any)
"""
if k in self.optkeys:
if self.val is None and v:
self.opts.err("Option '%s' does not take a value" % k)
self.specified_opt = k
self.specified_val = v
if self.fn:
self.fn(self, k, v)
return 1
else:
return 0
def specified(self):
"""Test whether the option has been specified: set
from the command line.
"""
return self.specified_opt
class OptVals:
"""Class to hold option values.
"""
pass
class Opts:
"""Container for options.
"""
def __init__(self, use=None):
"""Options constructor.
use usage string
"""
self.use = use
# List of options.
self.options = []
# Options indexed by name.
self.options_map = {}
# Command-line arguments.
self.argv = []
# Option values.
self.vals = OptVals()
self.vals.quiet = 0
# Variables for default scripts.
self.vars = {}
def __repr__(self):
return '\n'.join(map(str, self.options))
__str__ = __repr__
def opt(self, name, **args):
"""Add an option.
name option name
**args keyword params for option constructor
"""
x = Opt(self, name, **args)
self.options.append(x)
self.options_map[name] = x
return x
def setvar(self, var, val):
"""Set a default script variable.
"""
self.vars[var] = val
def getvar(self, var):
"""Get a default script variable.
"""
return self.vars.get(var)
def option(self, name):
"""Get an option (object).
"""
return self.options_map.get(name)
def setopt(self, name, val):
"""Set an option value.
An option can also be set using 'opts.vals.name = val'.
"""
setattr(self.vals, name, val)
def getopt(self, name):
"""Get an option value.
An option value can also be got using 'opts.vals.name'.
"""
getattr(self.vals, name)
def specified(self, name):
"""Test if an option has been specified.
"""
opt = self.option(name)
return opt and opt.specified()
def err(self, msg):
"""Print an error to stderr and exit.
"""
print >>sys.stderr, "Error:", msg
sys.exit(1)
def info(self, msg):
"""Print a message to stdout (unless quiet is set).
"""
if self.vals.quiet: return
print msg
def warn(self, msg):
"""Print a warning to stdout.
"""
print >>sys.stderr, "Warning:", msg
def parse(self, argv):
"""Parse arguments argv using the options.
return remaining arguments
"""
self.argv = argv
(vals, args) = getopt(argv[1:], self.short_opts(), self.long_opts())
self.args = args
for (k, v) in vals:
for opt in self.options:
if opt.specify(k, v): break
else:
print >>sys.stderr, "Error: Unknown option:", k
self.usage()
return args
def short_opts(self):
"""Get short options specifier for getopt.
"""
l = []
for x in self.options:
y = x.short_opt()
if not y: continue
l.append(y)
return ''.join(l)
def long_opts(self):
"""Get long options specifier for getopt.
"""
l = []
for x in self.options:
y = x.long_opt()
if not y: continue
l.append(y)
return l
def usage(self):
print 'Usage: ', self.argv[0], self.use or 'OPTIONS'
for opt in self.options:
opt.show()
def load_defaults(self):
"""Load a defaults script. Assumes these options set:
'path' search path
'default' script name
"""
for x in [ '' ] + self.vals.path.split(':'):
if x:
p = os.path.join(x, self.vals.defaults)
else:
p = self.vals.defaults
if os.path.exists(p):
self.load(p)
break
else:
self.err("Cannot open defaults file %s" % self.vals.defaults)
def load(self, defaults, help=0):
"""Load a defaults file. Local variables in the file
are used to set options with the same names.
Variables are not used to set options that are already specified.
"""
# Create global and lobal dicts for the file.
# Initialize locals to the vars.
# Use exec to do the standard imports and
# define variables we are passing to the script.
globals = {}
locals = {}
locals.update(self.vars)
cmd = '\n'.join(["import sys",
"import os",
"import os.path",
"import xen.util.ip",
"xm_file = '%s'" % defaults,
"xm_help = %d" % help ])
exec cmd in globals, locals
execfile(defaults, globals, locals)
if help: return
# Extract the values set by the script and set the corresponding
# options, if not set on the command line.
vtypes = [ types.StringType,
types.ListType,
types.IntType,
types.FloatType
]
for (k, v) in locals.items():
if self.specified(k): continue
if not(type(v) in vtypes): continue
self.setopt(k, v)
def set_true(opt, k, v):
"""Set an option true."""
opt.set(1)
def set_false(opt, k, v):
"""Set an option false."""
opt.set(0)
def set_value(opt, k, v):
"""Set an option to a valoue."""
opt.set(v)
def set_int(opt, k, v):
"""Set an option to an integer value."""
try:
v = int(v)
except:
opt.opts.err('Invalid value: ' + str(v))
opt.set(v)
def append_value(opt, k, v):
"""Append a value to a list option."""
opt.append(v)
def set_var(opt, k, v):
"""Set a default script variable.
"""
(var, val) = v.strip().split('=')
opt.opts.setvar(var.strip(), val.strip())
|