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
|
# Copyright (C) 2005-2009 Aaron Bentley and Panometrics, Inc.
# Chris Ball <cjb@laptop.org>
# Gianluca Montecchi <gian@grys.it>
# Oleg Romanyshyn <oromanyshyn@panoramicfeedback.com>
# W. Trevor King <wking@drexel.edu>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
"""
A command line interface to Bugs Everywhere.
"""
import optparse
import os
import sys
import libbe
import libbe.bugdir
import libbe.command
import libbe.command.util
import libbe.version
import libbe.ui.util.pager
if libbe.TESTING == True:
import doctest
class CallbackExit (Exception):
pass
class CmdOptionParser(optparse.OptionParser):
def __init__(self, command):
self.command = command
optparse.OptionParser.__init__(self)
self.remove_option('-h')
self.disable_interspersed_args()
self._option_by_name = {}
for option in self.command.options:
self._add_option(option)
def _add_option(self, option):
option.validate()
self._option_by_name[option.name] = option
long_opt = '--%s' % option.name
if option.short_name != None:
short_opt = '-%s' % option.short_name
assert '_' not in option.name, \
'Non-reconstructable option name %s' % option.name
kwargs = {'dest':option.name.replace('-', '_'),
'help':option.help}
if option.arg == None: # a callback option
kwargs['action'] = 'callback'
kwargs['callback'] = self.callback
elif option.arg.type == 'bool':
kwargs['action'] = 'store_true'
kwargs['metavar'] = None
kwargs['default'] = False
else:
kwargs['type'] = option.arg.type
kwargs['action'] = 'store'
kwargs['metavar'] = option.arg.metavar
kwargs['default'] = option.arg.default
if option.short_name != None:
opt = optparse.Option(short_opt, long_opt, **kwargs)
else:
opt = optparse.Option(long_opt, **kwargs)
opt._option = option
self.add_option(opt)
def parse_args(self, args=None, values=None):
args = self._get_args(args)
options,parsed_args = optparse.OptionParser.parse_args(
self, args=args, values=values)
options = options.__dict__
for name,value in options.items():
if '_' in name: # reconstruct original option name
options[name.replace('_', '-')] = options.pop(name)
for name,value in options.items():
if value == '--complete':
argument = None
option = self._option_by_name[name]
if option.arg != None:
argument = option.arg
fragment = None
indices = [i for i,arg in enumerate(args)
if arg == '--complete']
for i in indices:
assert i > 0 # this --complete is an option value
if args[i-1] in ['--%s' % o.name
for o in self.command.options]:
name = args[i-1][2:]
if name == option.name:
break
elif option.short_name != None \
and args[i-1].startswith('-') \
and args[i-1].endswith(option.short_name):
break
if i+1 < len(args):
fragment = args[i+1]
self.complete(argument, fragment)
for i,arg in enumerate(parsed_args):
if arg == '--complete':
if i < len(self.command.args):
argument = self.command.args[i]
else:
argument = self.command.args[-1]
if argument.repeatable == False:
raise libbe.command.UserError('Too many arguments')
fragment = None
if i < len(args) - 1:
fragment = args[i+1]
self.complete(argument, fragment)
if len(parsed_args) > len(self.command.args) \
and self.command.args[-1] == False:
raise libbe.command.UserError('Too many arguments')
for arg in self.command.args[len(parsed_args):]:
if arg.optional == False:
raise libbe.command.UserError(
'Missing required argument %s' % arg.metavar)
return (options, parsed_args)
def callback(self, option, opt, value, parser):
command_option = option._option
if command_option.name == 'complete':
argument = None
fragment = None
if len(parser.rargs) > 0:
fragment = parser.rargs[0]
self.complete(argument, fragment)
else:
print command_option.callback(
self.command, command_option, value)
raise CallbackExit
def complete(self, argument=None, fragment=None):
comps = self.command.complete(argument, fragment)
if fragment != None:
comps = [c for c in comps if c.startswith(fragment)]
print '\n'.join(comps)
raise CallbackExit
class BE (libbe.command.Command):
"""Class for parsing the command line arguments for `be`.
This class does not contain a useful _run() method. Call this
module's main() function instead.
>>> be = BE()
>>> p = CmdOptionParser(be)
>>> p.exit_after_callback = False
>>> try:
... options,args = p.parse_args(['--help']) # doctest: +ELLIPSIS
... except CallbackExit:
... pass
usage: be [options] [COMMAND [command-options] [COMMAND-ARGS ...]]
<BLANKLINE>
Options:
-h, --help Print a help message.
<BLANKLINE>
--complete Print a list of possible completions.
<BLANKLINE>
--version Print version string.
...
>>> try:
... options,args = p.parse_args(['--complete']) # doctest: +ELLIPSIS
... except CallbackExit:
... print ' got callback'
--help
--complete
--version
...
subscribe
tag
target
got callback
"""
name = 'be'
def __init__(self, *args, **kwargs):
libbe.command.Command.__init__(self, *args, **kwargs)
self.options.extend([
libbe.command.Option(name='version',
help='Print version string.',
callback=self.version),
libbe.command.Option(name='full-version',
help='Print full version information.',
callback=self.full_version),
libbe.command.Option(name='repo', short_name='r',
help='Select BE repository (see `be help repo`) rather '
'than the current directory.',
arg=libbe.command.Argument(
name='repo', metavar='REPO', default='.',
completion_callback=libbe.command.util.complete_path)),
libbe.command.Option(name='paginate',
help='Pipe all output into less (or if set, $PAGER).'),
libbe.command.Option(name='no-pager',
help='Do not pipe git output into a pager.'),
])
self.args.extend([
libbe.command.Argument(
name='command', optional=False,
completion_callback=libbe.command.util.complete_command),
libbe.command.Argument(
name='args', optional=True, repeatable=True)
])
def _usage(self):
return 'usage: be [options] [COMMAND [command-options] [COMMAND-ARGS ...]]'
def _long_help(self):
cmdlist = []
for name in libbe.command.commands():
module = libbe.command.get_command(name)
Class = getattr(module, name.capitalize())
cmdlist.append((name, Class.__doc__.splitlines()[0]))
cmdlist.sort()
longest_cmd_len = max([len(name) for name,desc in cmdlist])
ret = ['Bugs Everywhere - Distributed bug tracking',
'', 'Supported commands']
for name, desc in cmdlist:
numExtraSpaces = longest_cmd_len-len(name)
ret.append('be %s%*s %s' % (name, numExtraSpaces, '', desc))
ret.extend(['', 'Run', ' be help [command]', 'for more information.'])
return '\n'.join(ret)
def version(self, *args):
return libbe.version.version(verbose=False)
def full_version(self, *args):
return libbe.version.version(verbose=True)
def main():
parser = CmdOptionParser(BE())
try:
options,args = parser.parse_args()
except CallbackExit:
return 0
except libbe.command.UserError, e:
print 'ERROR:\n', e
return 1
paginate = 'auto'
if options['paginate'] == True:
paginate = 'always'
if options['no-pager'] == True:
paginate = 'never'
libbe.ui.util.pager.run_pager(paginate)
command_name = args[0]
try:
module = libbe.command.get_command(command_name)
except libbe.command.UnknownCommand, e:
print e
return 1
Class = getattr(module, command_name.capitalize())
command = Class()
parser = CmdOptionParser(command)
storage = None
bugdir = None
if command.requires_bugdir == True:
assert command.requires_unconnected_storage == False
storage = libbe.storage.get_storage(options['repo'])
storage.connect()
bugdir = libbe.bugdir.BugDir(storage, from_storage=True)
elif command.requires_storage == True \
or command.requires_unconnected_storage == True:
storage = libbe.storage.get_storage(options['repo'])
if command.requires_unconnected_storage == False:
storage.connect()
try:
options,args = parser.parse_args(args[1:])
command.run(storage, bugdir, options, args)
except CallbackExit:
if storage != None: storage.disconnect()
return 0
except libbe.command.UserError, e:
if storage != None: storage.disconnect()
print 'ERROR:\n', e
return 1
if storage != None: storage.disconnect()
return 0
if __name__ == '__main__':
sys.exit(main())
|
