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?
28
# TODO: Help messages for options.
30
# TODO: Define arguments by objects, rather than just using names.
31
# Those objects can specify the expected type of the argument, which
32
# would help with validation and shell completion.
32
38
from warnings import warn
33
39
from inspect import getdoc
37
42
import bzrlib.trace
38
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
39
from bzrlib.errors import (BzrError,
43
from bzrlib.trace import mutter, note, log_error, warning
44
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
44
45
from bzrlib.revisionspec import RevisionSpec
45
46
from bzrlib import BZRDIR
46
from bzrlib.option import Option
51
def register_command(cmd, decorate=False):
51
def register_command(cmd):
52
52
"Utility function to help register a command"
79
73
return cmd[4:].replace('_','-')
76
def _parse_revision_str(revstr):
77
"""This handles a revision string -> revno.
79
This always returns a list. The list will have one element for
82
>>> _parse_revision_str('234')
83
[<RevisionSpec_int 234>]
84
>>> _parse_revision_str('234..567')
85
[<RevisionSpec_int 234>, <RevisionSpec_int 567>]
86
>>> _parse_revision_str('..')
87
[<RevisionSpec None>, <RevisionSpec None>]
88
>>> _parse_revision_str('..234')
89
[<RevisionSpec None>, <RevisionSpec_int 234>]
90
>>> _parse_revision_str('234..')
91
[<RevisionSpec_int 234>, <RevisionSpec None>]
92
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
93
[<RevisionSpec_int 234>, <RevisionSpec_int 456>, <RevisionSpec_int 789>]
94
>>> _parse_revision_str('234....789') # Error?
95
[<RevisionSpec_int 234>, <RevisionSpec None>, <RevisionSpec_int 789>]
96
>>> _parse_revision_str('revid:test@other.com-234234')
97
[<RevisionSpec_revid revid:test@other.com-234234>]
98
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
99
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
100
>>> _parse_revision_str('revid:test@other.com-234234..23')
101
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_int 23>]
102
>>> _parse_revision_str('date:2005-04-12')
103
[<RevisionSpec_date date:2005-04-12>]
104
>>> _parse_revision_str('date:2005-04-12 12:24:33')
105
[<RevisionSpec_date date:2005-04-12 12:24:33>]
106
>>> _parse_revision_str('date:2005-04-12T12:24:33')
107
[<RevisionSpec_date date:2005-04-12T12:24:33>]
108
>>> _parse_revision_str('date:2005-04-12,12:24:33')
109
[<RevisionSpec_date date:2005-04-12,12:24:33>]
110
>>> _parse_revision_str('-5..23')
111
[<RevisionSpec_int -5>, <RevisionSpec_int 23>]
112
>>> _parse_revision_str('-5')
113
[<RevisionSpec_int -5>]
114
>>> _parse_revision_str('123a')
115
Traceback (most recent call last):
117
BzrError: No namespace registered for string: '123a'
118
>>> _parse_revision_str('abc')
119
Traceback (most recent call last):
121
BzrError: No namespace registered for string: 'abc'
124
old_format_re = re.compile('\d*:\d*')
125
m = old_format_re.match(revstr)
128
warning('Colon separator for revision numbers is deprecated.'
130
for rev in revstr.split(':'):
132
revs.append(RevisionSpec(int(rev)))
134
revs.append(RevisionSpec(None))
136
for x in revstr.split('..'):
138
revs.append(RevisionSpec(None))
140
revs.append(RevisionSpec(x))
82
144
def _builtin_commands():
83
145
import bzrlib.builtins
168
230
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().
234
List of options that may be given for this command.
185
237
If true, this command isn't advertised. This is typically
186
238
for commands intended for expert users.
190
243
takes_options = []
196
249
if self.__doc__ == Command.__doc__:
197
250
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
253
def run_argv(self, argv):
212
254
"""Parse command line and run."""
213
args, opts = parse_args(self, argv)
255
args, opts = parse_args(argv)
214
257
if 'help' in opts: # e.g. bzr add --help
215
258
from bzrlib.help import help_on_command
216
259
help_on_command(self.name())
218
# XXX: This should be handled by the parser
219
allowed_names = self.options().keys()
262
# check options are reasonable
263
allowed = self.takes_options
220
264
for oname in opts:
221
if oname not in allowed_names:
265
if oname not in allowed:
222
266
raise BzrCommandError("option '--%s' is not allowed for command %r"
223
267
% (oname, self.name()))
224
269
# mix arguments and options into one dictionary
225
270
cmdargs = _match_argform(self.name(), self.takes_args, args)
286
332
parsed = [spec, None]
289
def parse_args(command, argv):
336
# list of all available options; the rhs can be either None for an
337
# option that takes no argument, or a constructor function that checks
351
'revision': _parse_revision_str,
376
def parse_args(argv):
290
377
"""Parse command line.
292
379
Arguments and options are parsed at this level before being passed
293
380
down to specific command handlers. This routine knows, from a
294
381
lookup table, something about the available options, what optargs
295
382
they take, and which commands will accept them.
384
>>> parse_args('--help'.split())
386
>>> parse_args('help -- --invalidcmd'.split())
387
(['help', '--invalidcmd'], {})
388
>>> parse_args('--version'.split())
389
([], {'version': True})
390
>>> parse_args('status --all'.split())
391
(['status'], {'all': True})
392
>>> parse_args('commit --message=biter'.split())
393
(['commit'], {'message': u'biter'})
394
>>> parse_args('log -r 500'.split())
395
(['log'], {'revision': [<RevisionSpec_int 500>]})
396
>>> parse_args('log -r500..600'.split())
397
(['log'], {'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
398
>>> parse_args('log -vr500..600'.split())
399
(['log'], {'verbose': True, 'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
400
>>> parse_args('log -rrevno:500..600'.split()) #the r takes an argument
401
(['log'], {'revision': [<RevisionSpec_revno revno:500>, <RevisionSpec_int 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
409
if not argsover and a[0] == '-':
313
410
# option names must not be unicode
317
mutter(" got option %r", a)
415
# We've received a standalone -- No more flags
418
mutter(" got option %r" % a)
319
420
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()))
423
if optname not in OPTIONS:
424
raise BzrError('unknown long option %r' % a)
327
if shortopt in Option.SHORT_OPTIONS:
427
if shortopt in SHORT_OPTIONS:
328
428
# Multi-character options must have a space to delimit
330
# ^^^ what does this mean? mbp 20051014
331
optname = Option.SHORT_OPTIONS[shortopt].name
430
optname = SHORT_OPTIONS[shortopt]
333
432
# Single character short options, can be chained,
334
433
# and have their value appended to their name
335
434
shortopt = a[1:2]
336
if shortopt not in Option.SHORT_OPTIONS:
435
if shortopt not in SHORT_OPTIONS:
337
436
# We didn't find the multi-character name, and we
338
437
# didn't find the single char name
339
438
raise BzrError('unknown short option %r' % a)
340
optname = Option.SHORT_OPTIONS[shortopt].name
439
optname = SHORT_OPTIONS[shortopt]
343
442
# There are extra things on this option
344
443
# see if it is the value, or if it is another
346
optargfn = Option.OPTIONS[optname].type
445
optargfn = OPTIONS[optname]
347
446
if optargfn is None:
348
447
# This option does not take an argument, so the
349
448
# next entry is another short option, pack it back
435
532
ret = prof.runcall(the_callable, *args, **kwargs) or 0
438
537
stats = hotshot.stats.load(pfname)
440
stats.sort_stats('cum') # 'time'
539
stats.sort_stats('time')
441
540
## XXX: Might like to write to stderr or the trace file instead but
442
541
## print_stats seems hardcoded to stdout
443
542
stats.print_stats(20)
446
546
os.close(pffileno)
447
547
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
550
def run_bzr(argv):
458
551
"""Execute a command.
526
613
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:
616
ret = apply_profiled(cmd_obj.run_argv, argv)
618
ret = cmd_obj.run_argv(argv)
560
from bzrlib.ui.text import TextUIFactory
561
## bzrlib.trace.enable_default_logging()
562
624
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)
625
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
627
return run_bzr_catch_errors(argv[1:])
569
630
def run_bzr_catch_errors(argv):
574
# do this here inside the exception wrappers to catch EPIPE
636
# do this here inside the exception wrappers to catch EPIPE
638
#wrap common errors as CommandErrors.
639
except (NotBranchError,), e:
640
raise BzrCommandError(str(e))
641
except BzrCommandError, e:
642
# command line syntax error, etc
646
bzrlib.trace.log_exception()
648
except AssertionError, e:
649
bzrlib.trace.log_exception('assertion failed: ' + str(e))
651
except KeyboardInterrupt, e:
652
bzrlib.trace.log_exception('interrupted')
576
654
except Exception, e:
577
# used to handle AssertionError and KeyboardInterrupt
578
# specially here, but hopefully they're handled ok by the logger now
580
656
if (isinstance(e, IOError)
581
657
and hasattr(e, 'errno')
582
658
and e.errno == errno.EPIPE):
583
659
bzrlib.trace.note('broken pipe')
586
662
bzrlib.trace.log_exception()
587
if os.environ.get('BZR_PDB'):
588
print '**** entering debugger'
590
pdb.post_mortem(sys.exc_traceback)
593
666
if __name__ == '__main__':
594
667
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
