18
18
# TODO: probably should say which arguments are candidates for glob
19
19
# expansion on windows and do that at the command level.
21
# TODO: Help messages for options.
23
# TODO: Define arguments by objects, rather than just using names.
24
# Those objects can specify the expected type of the argument, which
25
# would help with validation and shell completion.
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.
21
# TODO: Define arguments by objects, rather than just using names.
22
# Those objects can specify the expected type of the argument, which
23
# would help with validation and shell completion. They could also provide
24
# help/explanation for that argument in a structured way.
26
# TODO: Specific "examples" property on commands for consistent formatting.
28
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
29
# the profile output behind so it can be interactively examined?
38
33
from warnings import warn
39
from inspect import getdoc
37
from bzrlib.errors import (BzrError,
42
from bzrlib.option import Option
43
from bzrlib.revisionspec import RevisionSpec
44
from bzrlib.symbol_versioning import *
42
45
import bzrlib.trace
43
from bzrlib.trace import mutter, note, log_error, warning
44
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
45
from bzrlib.branch import find_branch
46
from bzrlib import BZRDIR
46
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
51
def register_command(cmd):
52
"Utility function to help register a command"
51
def register_command(cmd, decorate=False):
52
"""Utility function to help register a command
54
:param cmd: Command subclass to register
55
:param decorate: If true, allow overriding an existing command
56
of the same name; the old command is returned by this function.
57
Otherwise it is an error to try to override an existing command.
55
61
if k.startswith("cmd_"):
73
85
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
81
It supports integers directly, but everything else it
82
defers for passing to Branch.get_revision_info()
84
>>> _parse_revision_str('234')
86
>>> _parse_revision_str('234..567')
88
>>> _parse_revision_str('..')
90
>>> _parse_revision_str('..234')
92
>>> _parse_revision_str('234..')
94
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
96
>>> _parse_revision_str('234....789') # Error?
98
>>> _parse_revision_str('revid:test@other.com-234234')
99
['revid:test@other.com-234234']
100
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
101
['revid:test@other.com-234234', 'revid:test@other.com-234235']
102
>>> _parse_revision_str('revid:test@other.com-234234..23')
103
['revid:test@other.com-234234', 23]
104
>>> _parse_revision_str('date:2005-04-12')
106
>>> _parse_revision_str('date:2005-04-12 12:24:33')
107
['date:2005-04-12 12:24:33']
108
>>> _parse_revision_str('date:2005-04-12T12:24:33')
109
['date:2005-04-12T12:24:33']
110
>>> _parse_revision_str('date:2005-04-12,12:24:33')
111
['date:2005-04-12,12:24:33']
112
>>> _parse_revision_str('-5..23')
114
>>> _parse_revision_str('-5')
116
>>> _parse_revision_str('123a')
118
>>> _parse_revision_str('abc')
122
old_format_re = re.compile('\d*:\d*')
123
m = old_format_re.match(revstr)
125
warning('Colon separator for revision numbers is deprecated.'
128
for rev in revstr.split(':'):
130
revs.append(int(rev))
135
for x in revstr.split('..'):
146
def get_merge_type(typestring):
147
"""Attempt to find the merge class/factory associated with a string."""
148
from merge import merge_types
150
return merge_types[typestring][0]
152
templ = '%s%%7s: %%s' % (' '*12)
153
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
154
type_list = '\n'.join(lines)
155
msg = "No known merge type %s. Supported types are:\n%s" %\
156
(typestring, type_list)
157
raise BzrCommandError(msg)
160
88
def _builtin_commands():
161
89
import bzrlib.builtins
163
91
builtins = bzrlib.builtins.__dict__
164
92
for name in builtins:
165
93
if name.startswith("cmd_"):
166
real_name = _unsquish_command_name(name)
94
real_name = _unsquish_command_name(name)
167
95
r[real_name] = builtins[name]
172
99
def builtin_command_names():
265
201
if self.__doc__ == Command.__doc__:
266
202
warn("No help message set for %r" % self)
205
"""Return dict of valid options for this command.
207
Maps from long option name to option object."""
209
r['help'] = Option.OPTIONS['help']
210
for o in self.takes_options:
211
if not isinstance(o, Option):
212
o = Option.OPTIONS[o]
216
@deprecated_method(zero_eight)
269
217
def run_argv(self, argv):
270
"""Parse command line and run."""
271
args, opts = parse_args(argv)
218
"""Parse command line and run.
220
See run_argv_aliases for the 0.8 and beyond api.
222
return self.run_argv_aliases(argv)
224
def run_argv_aliases(self, argv, alias_argv=None):
225
"""Parse the command line and run with extra aliases in alias_argv."""
226
args, opts = parse_args(self, argv, alias_argv)
273
227
if 'help' in opts: # e.g. bzr add --help
274
228
from bzrlib.help import help_on_command
275
229
help_on_command(self.name())
278
# check options are reasonable
279
allowed = self.takes_options
231
# XXX: This should be handled by the parser
232
allowed_names = self.options().keys()
280
233
for oname in opts:
281
if oname not in allowed:
282
raise BzrCommandError("option '--%s' is not allowed for command %r"
283
% (oname, self.name()))
234
if oname not in allowed_names:
235
raise BzrCommandError("option '--%s' is not allowed for"
236
" command %r" % (oname, self.name()))
285
237
# mix arguments and options into one dictionary
286
238
cmdargs = _match_argform(self.name(), self.takes_args, args)
348
300
parsed = [spec, None]
352
# list of all available options; the rhs can be either None for an
353
# option that takes no argument, or a constructor function that checks
366
'revision': _parse_revision_str,
378
'merge-type': get_merge_type,
392
def parse_args(argv):
303
def parse_args(command, argv, alias_argv=None):
393
304
"""Parse command line.
395
306
Arguments and options are parsed at this level before being passed
396
307
down to specific command handlers. This routine knows, from a
397
308
lookup table, something about the available options, what optargs
398
309
they take, and which commands will accept them.
400
>>> parse_args('--help'.split())
402
>>> parse_args('help -- --invalidcmd'.split())
403
(['help', '--invalidcmd'], {})
404
>>> parse_args('--version'.split())
405
([], {'version': True})
406
>>> parse_args('status --all'.split())
407
(['status'], {'all': True})
408
>>> parse_args('commit --message=biter'.split())
409
(['commit'], {'message': u'biter'})
410
>>> parse_args('log -r 500'.split())
411
(['log'], {'revision': [500]})
412
>>> parse_args('log -r500..600'.split())
413
(['log'], {'revision': [500, 600]})
414
>>> parse_args('log -vr500..600'.split())
415
(['log'], {'verbose': True, 'revision': [500, 600]})
416
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
417
(['log'], {'revision': ['v500', 600]})
311
# TODO: chop up this beast; make it a method of the Command
316
cmd_options = command.options()
425
if not argsover and a[0] == '-':
426
# option names must not be unicode
431
# We've received a standalone -- No more flags
434
mutter(" got option %r" % a)
436
optname, optarg = a[2:].split('=', 1)
439
if optname not in OPTIONS:
440
raise BzrError('unknown long option %r' % a)
443
if shortopt in SHORT_OPTIONS:
444
# Multi-character options must have a space to delimit
446
optname = SHORT_OPTIONS[shortopt]
448
# Single character short options, can be chained,
449
# and have their value appended to their name
451
if shortopt not in SHORT_OPTIONS:
452
# We didn't find the multi-character name, and we
453
# didn't find the single char name
454
raise BzrError('unknown short option %r' % a)
455
optname = SHORT_OPTIONS[shortopt]
318
proc_aliasarg = True # Are we processing alias_argv now?
319
for proc_argv in alias_argv, argv:
326
# We've received a standalone -- No more flags
330
# option names must not be unicode
334
mutter(" got option %r", a)
336
optname, optarg = a[2:].split('=', 1)
339
if optname not in cmd_options:
340
raise BzrOptionError('unknown long option %r for'
345
if shortopt in Option.SHORT_OPTIONS:
346
# Multi-character options must have a space to delimit
348
# ^^^ what does this mean? mbp 20051014
349
optname = Option.SHORT_OPTIONS[shortopt].name
351
# Single character short options, can be chained,
352
# and have their value appended to their name
354
if shortopt not in Option.SHORT_OPTIONS:
355
# We didn't find the multi-character name, and we
356
# didn't find the single char name
357
raise BzrError('unknown short option %r' % a)
358
optname = Option.SHORT_OPTIONS[shortopt].name
458
# There are extra things on this option
459
# see if it is the value, or if it is another
461
optargfn = OPTIONS[optname]
463
# This option does not take an argument, so the
464
# next entry is another short option, pack it back
466
argv.insert(0, '-' + a[2:])
361
# There are extra things on this option
362
# see if it is the value, or if it is another
364
optargfn = Option.OPTIONS[optname].type
366
# This option does not take an argument, so the
367
# next entry is another short option, pack it
369
proc_argv.insert(0, '-' + a[2:])
371
# This option takes an argument, so pack it
375
if optname not in cmd_options:
376
raise BzrOptionError('unknown short option %r for'
378
(shortopt, command.name()))
380
# XXX: Do we ever want to support this, e.g. for -r?
382
raise BzrError('repeated option %r' % a)
383
elif optname in alias_opts:
384
# Replace what's in the alias with what's in the real
386
del alias_opts[optname]
388
proc_argv.insert(0, a)
391
raise BzrError('repeated option %r' % a)
393
option_obj = cmd_options[optname]
394
optargfn = option_obj.type
398
raise BzrError('option %r needs an argument' % a)
468
# This option takes an argument, so pack it
473
# XXX: Do we ever want to support this, e.g. for -r?
474
raise BzrError('repeated option %r' % a)
476
optargfn = OPTIONS[optname]
480
raise BzrError('option %r needs an argument' % a)
483
opts[optname] = optargfn(optarg)
400
optarg = proc_argv.pop(0)
401
opts[optname] = optargfn(optarg)
403
alias_opts[optname] = optargfn(optarg)
406
raise BzrError('option %r takes no argument' % optname)
409
alias_opts[optname] = True
486
raise BzrError('option %r takes no argument' % optname)
412
proc_aliasarg = False # Done with alias argv
491
413
return args, opts
496
416
def _match_argform(cmd, takes_args, args):
581
522
Do not load plugin modules at all
584
528
Only use builtin commands. (Plugins are still allowed to change
585
529
other behaviour.)
588
Run under the Python profiler.
532
Run under the Python hotshot profiler.
535
Run under the Python lsprof profiler.
590
# Load all of the transport methods
591
import bzrlib.transport.local, bzrlib.transport.http
593
537
argv = [a.decode(bzrlib.user_encoding) for a in argv]
595
opt_profile = opt_no_plugins = opt_builtin = False
539
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
540
opt_no_aliases = False
541
opt_lsprof_file = None
597
543
# --no-plugins is handled specially at a very early stage. We need
598
544
# to load plugins before doing other command parsing so that they
599
545
# can override commands, but this needs to happen first.
602
551
if a == '--profile':
603
552
opt_profile = True
553
elif a == '--lsprof':
555
elif a == '--lsprof-file':
556
opt_lsprof_file = argv[i + 1]
604
558
elif a == '--no-plugins':
605
559
opt_no_plugins = True
560
elif a == '--no-aliases':
561
opt_no_aliases = True
606
562
elif a == '--builtin':
607
563
opt_builtin = True
564
elif a in ('--quiet', '-q'):
612
if (not argv) or (argv[0] == '--help'):
613
from bzrlib.help import help
572
from bzrlib.builtins import cmd_help
573
cmd_help().run_argv_aliases([])
620
576
if argv[0] == '--version':
625
581
if not opt_no_plugins:
626
582
from bzrlib.plugin import load_plugins
585
from bzrlib.plugin import disable_plugins
590
if not opt_no_aliases:
591
alias_argv = get_alias(argv[0])
593
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
594
argv[0] = alias_argv.pop(0)
629
596
cmd = str(argv.pop(0))
631
598
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
634
ret = apply_profiled(cmd_obj.run_argv, argv)
599
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
600
run = cmd_obj.run_argv
636
ret = cmd_obj.run_argv(argv)
603
run = cmd_obj.run_argv_aliases
604
run_argv = [argv, alias_argv]
608
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
610
ret = apply_profiled(run, *run_argv)
615
# reset, in case we may do other commands later within the same process
618
def display_command(func):
619
"""Decorator that suppresses pipe/interrupt errors."""
620
def ignore_pipe(*args, **kwargs):
622
result = func(*args, **kwargs)
626
if not hasattr(e, 'errno'):
628
if e.errno != errno.EPIPE:
631
except KeyboardInterrupt:
638
from bzrlib.ui.text import TextUIFactory
639
## bzrlib.trace.enable_default_logging()
642
640
bzrlib.trace.log_startup(argv)
643
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
641
bzrlib.ui.ui_factory = TextUIFactory()
642
ret = run_bzr_catch_errors(argv[1:])
643
mutter("return code %d", ret)
647
def run_bzr_catch_errors(argv):
648
return run_bzr(argv[1:])
650
# do this here inside the exception wrappers to catch EPIPE
652
#wrap common errors as CommandErrors.
653
except (NotBranchError,), e:
654
raise BzrCommandError(str(e))
655
except BzrCommandError, e:
656
# command line syntax error, etc
660
bzrlib.trace.log_exception()
662
except AssertionError, e:
663
bzrlib.trace.log_exception('assertion failed: ' + str(e))
665
except KeyboardInterrupt, e:
666
bzrlib.trace.note('interrupted')
652
# do this here inside the exception wrappers to catch EPIPE
668
654
except Exception, e:
655
# used to handle AssertionError and KeyboardInterrupt
656
# specially here, but hopefully they're handled ok by the logger now
670
658
if (isinstance(e, IOError)
671
659
and hasattr(e, 'errno')
672
660
and e.errno == errno.EPIPE):
673
661
bzrlib.trace.note('broken pipe')
676
664
bzrlib.trace.log_exception()
665
if os.environ.get('BZR_PDB'):
666
print '**** entering debugger'
668
pdb.post_mortem(sys.exc_traceback)
679
671
if __name__ == '__main__':
680
672
sys.exit(main(sys.argv))