24
24
# Those objects can specify the expected type of the argument, which
25
25
# would help with validation and shell completion.
27
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
28
# the profile output behind so it can be interactively examined?
32
31
from warnings import warn
33
32
from inspect import getdoc
37
35
import bzrlib.trace
38
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
39
from bzrlib.errors import (BzrError,
44
from bzrlib.revisionspec import RevisionSpec
36
from bzrlib.trace import mutter, note, log_error, warning
37
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
38
from bzrlib.branch import find_branch
45
39
from bzrlib import BZRDIR
46
from bzrlib.option import Option
51
def register_command(cmd, decorate=False):
44
def register_command(cmd):
52
45
"Utility function to help register a command"
79
66
return cmd[4:].replace('_','-')
69
def _parse_revision_str(revstr):
70
"""This handles a revision string -> revno.
72
This always returns a list. The list will have one element for
74
It supports integers directly, but everything else it
75
defers for passing to Branch.get_revision_info()
77
>>> _parse_revision_str('234')
79
>>> _parse_revision_str('234..567')
81
>>> _parse_revision_str('..')
83
>>> _parse_revision_str('..234')
85
>>> _parse_revision_str('234..')
87
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
89
>>> _parse_revision_str('234....789') # Error?
91
>>> _parse_revision_str('revid:test@other.com-234234')
92
['revid:test@other.com-234234']
93
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
94
['revid:test@other.com-234234', 'revid:test@other.com-234235']
95
>>> _parse_revision_str('revid:test@other.com-234234..23')
96
['revid:test@other.com-234234', 23]
97
>>> _parse_revision_str('date:2005-04-12')
99
>>> _parse_revision_str('date:2005-04-12 12:24:33')
100
['date:2005-04-12 12:24:33']
101
>>> _parse_revision_str('date:2005-04-12T12:24:33')
102
['date:2005-04-12T12:24:33']
103
>>> _parse_revision_str('date:2005-04-12,12:24:33')
104
['date:2005-04-12,12:24:33']
105
>>> _parse_revision_str('-5..23')
107
>>> _parse_revision_str('-5')
109
>>> _parse_revision_str('123a')
111
>>> _parse_revision_str('abc')
115
old_format_re = re.compile('\d*:\d*')
116
m = old_format_re.match(revstr)
118
warning('Colon separator for revision numbers is deprecated.'
121
for rev in revstr.split(':'):
123
revs.append(int(rev))
128
for x in revstr.split('..'):
139
def get_merge_type(typestring):
140
"""Attempt to find the merge class/factory associated with a string."""
141
from merge import merge_types
143
return merge_types[typestring][0]
145
templ = '%s%%7s: %%s' % (' '*12)
146
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
147
type_list = '\n'.join(lines)
148
msg = "No known merge type %s. Supported types are:\n%s" %\
149
(typestring, type_list)
150
raise BzrCommandError(msg)
153
def get_merge_type(typestring):
154
"""Attempt to find the merge class/factory associated with a string."""
155
from merge import merge_types
157
return merge_types[typestring][0]
159
templ = '%s%%7s: %%s' % (' '*12)
160
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
161
type_list = '\n'.join(lines)
162
msg = "No known merge type %s. Supported types are:\n%s" %\
163
(typestring, type_list)
164
raise BzrCommandError(msg)
82
167
def _builtin_commands():
83
168
import bzrlib.builtins
168
253
List of argument forms, marked with whether they are optional,
173
['to_location', 'from_branch?', 'file*']
175
'to_location' is required
176
'from_branch' is optional
177
'file' can be specified 0 or more times
180
List of options that may be given for this command. These can
181
be either strings, referring to globally-defined options,
182
or option objects. Retrieve through options().
257
List of options that may be given for this command.
185
260
If true, this command isn't advertised. This is typically
186
261
for commands intended for expert users.
190
266
takes_options = []
196
272
if self.__doc__ == Command.__doc__:
197
273
warn("No help message set for %r" % self)
200
"""Return dict of valid options for this command.
202
Maps from long option name to option object."""
204
r['help'] = Option.OPTIONS['help']
205
for o in self.takes_options:
206
if not isinstance(o, Option):
207
o = Option.OPTIONS[o]
211
276
def run_argv(self, argv):
212
277
"""Parse command line and run."""
213
args, opts = parse_args(self, argv)
278
args, opts = parse_args(argv)
214
280
if 'help' in opts: # e.g. bzr add --help
215
281
from bzrlib.help import help_on_command
216
282
help_on_command(self.name())
218
# XXX: This should be handled by the parser
219
allowed_names = self.options().keys()
285
# check options are reasonable
286
allowed = self.takes_options
220
287
for oname in opts:
221
if oname not in allowed_names:
288
if oname not in allowed:
222
289
raise BzrCommandError("option '--%s' is not allowed for command %r"
223
290
% (oname, self.name()))
224
292
# mix arguments and options into one dictionary
225
293
cmdargs = _match_argform(self.name(), self.takes_args, args)
286
355
parsed = [spec, None]
289
def parse_args(command, argv):
361
# list of all available options; the rhs can be either None for an
362
# option that takes no argument, or a constructor function that checks
375
'revision': _parse_revision_str,
387
'merge-type': get_merge_type,
401
def parse_args(argv):
290
402
"""Parse command line.
292
404
Arguments and options are parsed at this level before being passed
293
405
down to specific command handlers. This routine knows, from a
294
406
lookup table, something about the available options, what optargs
295
407
they take, and which commands will accept them.
409
>>> parse_args('--help'.split())
411
>>> parse_args('help -- --invalidcmd'.split())
412
(['help', '--invalidcmd'], {})
413
>>> parse_args('--version'.split())
414
([], {'version': True})
415
>>> parse_args('status --all'.split())
416
(['status'], {'all': True})
417
>>> parse_args('commit --message=biter'.split())
418
(['commit'], {'message': u'biter'})
419
>>> parse_args('log -r 500'.split())
420
(['log'], {'revision': [500]})
421
>>> parse_args('log -r500..600'.split())
422
(['log'], {'revision': [500, 600]})
423
>>> parse_args('log -vr500..600'.split())
424
(['log'], {'verbose': True, 'revision': [500, 600]})
425
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
426
(['log'], {'revision': ['v500', 600]})
297
# TODO: chop up this beast; make it a method of the Command
301
cmd_options = command.options()
309
# We've received a standalone -- No more flags
434
if not argsover and a[0] == '-':
313
435
# option names must not be unicode
317
mutter(" got option %r", a)
440
# We've received a standalone -- No more flags
443
mutter(" got option %r" % a)
319
445
optname, optarg = a[2:].split('=', 1)
322
if optname not in cmd_options:
323
raise BzrOptionError('unknown long option %r for command %s'
324
% (a, command.name()))
448
if optname not in OPTIONS:
449
raise BzrError('unknown long option %r' % a)
327
if shortopt in Option.SHORT_OPTIONS:
452
if shortopt in SHORT_OPTIONS:
328
453
# Multi-character options must have a space to delimit
330
# ^^^ what does this mean? mbp 20051014
331
optname = Option.SHORT_OPTIONS[shortopt].name
455
optname = SHORT_OPTIONS[shortopt]
333
457
# Single character short options, can be chained,
334
458
# and have their value appended to their name
335
459
shortopt = a[1:2]
336
if shortopt not in Option.SHORT_OPTIONS:
460
if shortopt not in SHORT_OPTIONS:
337
461
# We didn't find the multi-character name, and we
338
462
# didn't find the single char name
339
463
raise BzrError('unknown short option %r' % a)
340
optname = Option.SHORT_OPTIONS[shortopt].name
464
optname = SHORT_OPTIONS[shortopt]
343
467
# There are extra things on this option
344
468
# see if it is the value, or if it is another
346
optargfn = Option.OPTIONS[optname].type
470
optargfn = OPTIONS[optname]
347
471
if optargfn is None:
348
472
# This option does not take an argument, so the
349
473
# next entry is another short option, pack it back
435
557
ret = prof.runcall(the_callable, *args, **kwargs) or 0
438
562
stats = hotshot.stats.load(pfname)
440
stats.sort_stats('cum') # 'time'
564
stats.sort_stats('time')
441
565
## XXX: Might like to write to stderr or the trace file instead but
442
566
## print_stats seems hardcoded to stdout
443
567
stats.print_stats(20)
446
571
os.close(pffileno)
447
572
os.remove(pfname)
450
def apply_lsprofiled(the_callable, *args, **kwargs):
451
from bzrlib.lsprof import profile
452
ret,stats = profile(the_callable,*args,**kwargs)
457
575
def run_bzr(argv):
458
576
"""Execute a command.
526
638
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
530
ret = apply_lsprofiled(cmd_obj.run_argv, argv)
532
ret = apply_profiled(cmd_obj.run_argv, argv)
534
ret = cmd_obj.run_argv(argv)
537
# reset, in case we may do other commands later within the same process
540
def display_command(func):
541
"""Decorator that suppresses pipe/interrupt errors."""
542
def ignore_pipe(*args, **kwargs):
544
result = func(*args, **kwargs)
548
if not hasattr(e, 'errno'):
550
if e.errno != errno.EPIPE:
553
except KeyboardInterrupt:
641
ret = apply_profiled(cmd_obj.run_argv, argv)
643
ret = cmd_obj.run_argv(argv)
560
from bzrlib.ui.text import TextUIFactory
561
## bzrlib.trace.enable_default_logging()
562
649
bzrlib.trace.log_startup(argv)
563
bzrlib.ui.ui_factory = TextUIFactory()
564
ret = run_bzr_catch_errors(argv[1:])
565
mutter("return code %d", ret)
569
def run_bzr_catch_errors(argv):
650
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
654
return run_bzr(argv[1:])
574
656
# do this here inside the exception wrappers to catch EPIPE
575
657
sys.stdout.flush()
658
except BzrCommandError, e:
659
# command line syntax error, etc
663
bzrlib.trace.log_exception()
665
except AssertionError, e:
666
bzrlib.trace.log_exception('assertion failed: ' + str(e))
668
except KeyboardInterrupt, e:
669
bzrlib.trace.note('interrupted')
576
671
except Exception, e:
577
# used to handle AssertionError and KeyboardInterrupt
578
# specially here, but hopefully they're handled ok by the logger now
580
673
if (isinstance(e, IOError)
581
674
and hasattr(e, 'errno')
582
675
and e.errno == errno.EPIPE):
583
676
bzrlib.trace.note('broken pipe')
586
679
bzrlib.trace.log_exception()
587
if os.environ.get('BZR_PDB'):
588
print '**** entering debugger'
590
pdb.post_mortem(sys.exc_traceback)
593
683
if __name__ == '__main__':
594
684
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
