32
33
from warnings import warn
33
from inspect import getdoc
37
from bzrlib.trace import mutter, note, log_error, warning
38
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
38
import bzrlib.errors as errors
39
from bzrlib.errors import (BzrError,
43
from bzrlib.option import Option
39
45
from bzrlib.revisionspec import RevisionSpec
40
from bzrlib import BZRDIR
46
from bzrlib.symbol_versioning import (deprecated_method, zero_eight)
47
from bzrlib import trace
48
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
45
def register_command(cmd):
46
"Utility function to help register a command"
53
def register_command(cmd, decorate=False):
54
"""Utility function to help register a command
56
:param cmd: Command subclass to register
57
:param decorate: If true, allow overriding an existing command
58
of the same name; the old command is returned by this function.
59
Otherwise it is an error to try to override an existing command.
49
63
if k.startswith("cmd_"):
67
87
return cmd[4:].replace('_','-')
70
def _parse_revision_str(revstr):
71
"""This handles a revision string -> revno.
73
This always returns a list. The list will have one element for
76
>>> _parse_revision_str('234')
77
[<RevisionSpec_int 234>]
78
>>> _parse_revision_str('234..567')
79
[<RevisionSpec_int 234>, <RevisionSpec_int 567>]
80
>>> _parse_revision_str('..')
81
[<RevisionSpec None>, <RevisionSpec None>]
82
>>> _parse_revision_str('..234')
83
[<RevisionSpec None>, <RevisionSpec_int 234>]
84
>>> _parse_revision_str('234..')
85
[<RevisionSpec_int 234>, <RevisionSpec None>]
86
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
87
[<RevisionSpec_int 234>, <RevisionSpec_int 456>, <RevisionSpec_int 789>]
88
>>> _parse_revision_str('234....789') # Error?
89
[<RevisionSpec_int 234>, <RevisionSpec None>, <RevisionSpec_int 789>]
90
>>> _parse_revision_str('revid:test@other.com-234234')
91
[<RevisionSpec_revid revid:test@other.com-234234>]
92
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
93
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
94
>>> _parse_revision_str('revid:test@other.com-234234..23')
95
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_int 23>]
96
>>> _parse_revision_str('date:2005-04-12')
97
[<RevisionSpec_date date:2005-04-12>]
98
>>> _parse_revision_str('date:2005-04-12 12:24:33')
99
[<RevisionSpec_date date:2005-04-12 12:24:33>]
100
>>> _parse_revision_str('date:2005-04-12T12:24:33')
101
[<RevisionSpec_date date:2005-04-12T12:24:33>]
102
>>> _parse_revision_str('date:2005-04-12,12:24:33')
103
[<RevisionSpec_date date:2005-04-12,12:24:33>]
104
>>> _parse_revision_str('-5..23')
105
[<RevisionSpec_int -5>, <RevisionSpec_int 23>]
106
>>> _parse_revision_str('-5')
107
[<RevisionSpec_int -5>]
108
>>> _parse_revision_str('123a')
109
Traceback (most recent call last):
111
BzrError: No namespace registered for string: '123a'
112
>>> _parse_revision_str('abc')
113
Traceback (most recent call last):
115
BzrError: No namespace registered for string: 'abc'
118
old_format_re = re.compile('\d*:\d*')
119
m = old_format_re.match(revstr)
122
warning('Colon separator for revision numbers is deprecated.'
124
for rev in revstr.split(':'):
126
revs.append(RevisionSpec(int(rev)))
128
revs.append(RevisionSpec(None))
130
for x in revstr.split('..'):
132
revs.append(RevisionSpec(None))
134
revs.append(RevisionSpec(x))
138
90
def _builtin_commands():
139
91
import bzrlib.builtins
141
93
builtins = bzrlib.builtins.__dict__
142
94
for name in builtins:
143
95
if name.startswith("cmd_"):
144
real_name = _unsquish_command_name(name)
96
real_name = _unsquish_command_name(name)
145
97
r[real_name] = builtins[name]
150
101
def builtin_command_names():
224
175
List of argument forms, marked with whether they are optional,
180
['to_location', 'from_branch?', 'file*']
182
'to_location' is required
183
'from_branch' is optional
184
'file' can be specified 0 or more times
228
List of options that may be given for this command.
187
List of options that may be given for this command. These can
188
be either strings, referring to globally-defined options,
189
or option objects. Retrieve through options().
231
192
If true, this command isn't advertised. This is typically
232
193
for commands intended for expert users.
196
Command objects will get a 'outf' attribute, which has been
197
setup to properly handle encoding of unicode strings.
198
encoding_type determines what will happen when characters cannot
200
strict - abort if we cannot decode
201
replace - put in a bogus character (typically '?')
202
exact - do not encode sys.stdout
237
207
takes_options = []
208
encoding_type = 'strict'
243
214
if self.__doc__ == Command.__doc__:
244
215
warn("No help message set for %r" % self)
218
"""Return dict of valid options for this command.
220
Maps from long option name to option object."""
222
r['help'] = Option.OPTIONS['help']
223
for o in self.takes_options:
224
if not isinstance(o, Option):
225
o = Option.OPTIONS[o]
229
def _setup_outf(self):
230
"""Return a file linked to stdout, which has proper encoding."""
231
assert self.encoding_type in ['strict', 'exact', 'replace']
233
# Originally I was using self.stdout, but that looks
234
# *way* too much like sys.stdout
235
if self.encoding_type == 'exact':
236
self.outf = sys.stdout
239
output_encoding = bzrlib.osutils.get_terminal_encoding()
241
# use 'replace' so that we don't abort if trying to write out
242
# in e.g. the default C locale.
243
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
244
# For whatever reason codecs.getwriter() does not advertise its encoding
245
# it just returns the encoding of the wrapped file, which is completely
246
# bogus. So set the attribute, so we can find the correct encoding later.
247
self.outf.encoding = output_encoding
249
@deprecated_method(zero_eight)
247
250
def run_argv(self, argv):
248
"""Parse command line and run."""
249
args, opts = parse_args(argv)
251
"""Parse command line and run.
253
See run_argv_aliases for the 0.8 and beyond api.
255
return self.run_argv_aliases(argv)
257
def run_argv_aliases(self, argv, alias_argv=None):
258
"""Parse the command line and run with extra aliases in alias_argv."""
259
args, opts = parse_args(self, argv, alias_argv)
251
260
if 'help' in opts: # e.g. bzr add --help
252
261
from bzrlib.help import help_on_command
253
262
help_on_command(self.name())
256
# check options are reasonable
257
allowed = self.takes_options
264
# XXX: This should be handled by the parser
265
allowed_names = self.options().keys()
258
266
for oname in opts:
259
if oname not in allowed:
260
raise BzrCommandError("option '--%s' is not allowed for command %r"
261
% (oname, self.name()))
267
if oname not in allowed_names:
268
raise BzrOptionError("option '--%s' is not allowed for"
269
" command %r" % (oname, self.name()))
263
270
# mix arguments and options into one dictionary
264
271
cmdargs = _match_argform(self.name(), self.takes_args, args)
326
346
parsed = [spec, None]
330
# list of all available options; the rhs can be either None for an
331
# option that takes no argument, or a constructor function that checks
345
'revision': _parse_revision_str,
371
def parse_args(argv):
349
def parse_args(command, argv, alias_argv=None):
372
350
"""Parse command line.
374
352
Arguments and options are parsed at this level before being passed
375
353
down to specific command handlers. This routine knows, from a
376
354
lookup table, something about the available options, what optargs
377
355
they take, and which commands will accept them.
379
>>> parse_args('--help'.split())
381
>>> parse_args('help -- --invalidcmd'.split())
382
(['help', '--invalidcmd'], {})
383
>>> parse_args('--version'.split())
384
([], {'version': True})
385
>>> parse_args('status --all'.split())
386
(['status'], {'all': True})
387
>>> parse_args('commit --message=biter'.split())
388
(['commit'], {'message': u'biter'})
389
>>> parse_args('log -r 500'.split())
390
(['log'], {'revision': [<RevisionSpec_int 500>]})
391
>>> parse_args('log -r500..600'.split())
392
(['log'], {'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
393
>>> parse_args('log -vr500..600'.split())
394
(['log'], {'verbose': True, 'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
395
>>> parse_args('log -rrevno:500..600'.split()) #the r takes an argument
396
(['log'], {'revision': [<RevisionSpec_revno revno:500>, <RevisionSpec_int 600>]})
357
# TODO: chop up this beast; make it a method of the Command
362
cmd_options = command.options()
404
if not argsover and a[0] == '-':
405
# option names must not be unicode
410
# We've received a standalone -- No more flags
413
mutter(" got option %r" % a)
415
optname, optarg = a[2:].split('=', 1)
418
if optname not in OPTIONS:
419
raise BzrError('unknown long option %r' % a)
422
if shortopt in SHORT_OPTIONS:
423
# Multi-character options must have a space to delimit
425
optname = SHORT_OPTIONS[shortopt]
427
# Single character short options, can be chained,
428
# and have their value appended to their name
430
if shortopt not in SHORT_OPTIONS:
431
# We didn't find the multi-character name, and we
432
# didn't find the single char name
433
raise BzrError('unknown short option %r' % a)
434
optname = SHORT_OPTIONS[shortopt]
364
proc_aliasarg = True # Are we processing alias_argv now?
365
for proc_argv in alias_argv, argv:
372
# We've received a standalone -- No more flags
376
# option names must not be unicode
380
mutter(" got option %r", a)
382
optname, optarg = a[2:].split('=', 1)
385
if optname not in cmd_options:
386
raise BzrCommandError('unknown option "%s"' % a)
389
if shortopt in Option.SHORT_OPTIONS:
390
# Multi-character options must have a space to delimit
392
# ^^^ what does this mean? mbp 20051014
393
optname = Option.SHORT_OPTIONS[shortopt].name
395
# Single character short options, can be chained,
396
# and have their value appended to their name
398
if shortopt not in Option.SHORT_OPTIONS:
399
# We didn't find the multi-character name, and we
400
# didn't find the single char name
401
raise BzrCommandError('unknown option "%s"' % a)
402
optname = Option.SHORT_OPTIONS[shortopt].name
437
# There are extra things on this option
438
# see if it is the value, or if it is another
440
optargfn = OPTIONS[optname]
442
# This option does not take an argument, so the
443
# next entry is another short option, pack it back
445
argv.insert(0, '-' + a[2:])
405
# There are extra things on this option
406
# see if it is the value, or if it is another
408
optargfn = Option.OPTIONS[optname].type
410
# This option does not take an argument, so the
411
# next entry is another short option, pack it
413
proc_argv.insert(0, '-' + a[2:])
415
# This option takes an argument, so pack it
418
if optname not in cmd_options:
419
raise BzrCommandError('unknown option "%s"' % shortopt)
421
# XXX: Do we ever want to support this, e.g. for -r?
423
raise BzrCommandError('repeated option %r' % a)
424
elif optname in alias_opts:
425
# Replace what's in the alias with what's in the real
427
del alias_opts[optname]
429
proc_argv.insert(0, a)
432
raise BzrCommandError('repeated option %r' % a)
434
option_obj = cmd_options[optname]
435
optargfn = option_obj.type
439
raise BzrCommandError('option %r needs an argument' % a)
447
# This option takes an argument, so pack it
452
# XXX: Do we ever want to support this, e.g. for -r?
453
raise BzrError('repeated option %r' % a)
455
optargfn = OPTIONS[optname]
459
raise BzrError('option %r needs an argument' % a)
462
opts[optname] = optargfn(optarg)
441
optarg = proc_argv.pop(0)
442
opts[optname] = optargfn(optarg)
444
alias_opts[optname] = optargfn(optarg)
447
raise BzrCommandError('option %r takes no argument' % optname)
450
alias_opts[optname] = True
465
raise BzrError('option %r takes no argument' % optname)
453
proc_aliasarg = False # Done with alias argv
470
454
return args, opts
475
457
def _match_argform(cmd, takes_args, args):
558
565
Do not load plugin modules at all
561
571
Only use builtin commands. (Plugins are still allowed to change
562
572
other behaviour.)
565
Run under the Python profiler.
575
Run under the Python hotshot profiler.
578
Run under the Python lsprof profiler.
567
# Load all of the transport methods
568
import bzrlib.transport.local, bzrlib.transport.http
570
argv = [a.decode(bzrlib.user_encoding) for a in argv]
572
opt_profile = opt_no_plugins = opt_builtin = False
582
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
583
opt_no_aliases = False
584
opt_lsprof_file = None
574
586
# --no-plugins is handled specially at a very early stage. We need
575
587
# to load plugins before doing other command parsing so that they
576
588
# can override commands, but this needs to happen first.
579
594
if a == '--profile':
580
595
opt_profile = True
596
elif a == '--lsprof':
598
elif a == '--lsprof-file':
599
opt_lsprof_file = argv[i + 1]
581
601
elif a == '--no-plugins':
582
602
opt_no_plugins = True
603
elif a == '--no-aliases':
604
opt_no_aliases = True
583
605
elif a == '--builtin':
584
606
opt_builtin = True
607
elif a in ('--quiet', '-q'):
589
if (not argv) or (argv[0] == '--help'):
590
from bzrlib.help import help
615
from bzrlib.builtins import cmd_help
616
cmd_help().run_argv_aliases([])
597
619
if argv[0] == '--version':
602
624
if not opt_no_plugins:
603
625
from bzrlib.plugin import load_plugins
628
from bzrlib.plugin import disable_plugins
633
if not opt_no_aliases:
634
alias_argv = get_alias(argv[0])
636
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
637
argv[0] = alias_argv.pop(0)
606
639
cmd = str(argv.pop(0))
608
641
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
611
ret = apply_profiled(cmd_obj.run_argv, argv)
642
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
643
run = cmd_obj.run_argv
613
ret = cmd_obj.run_argv(argv)
646
run = cmd_obj.run_argv_aliases
647
run_argv = [argv, alias_argv]
651
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
653
ret = apply_profiled(run, *run_argv)
658
# reset, in case we may do other commands later within the same process
661
def display_command(func):
662
"""Decorator that suppresses pipe/interrupt errors."""
663
def ignore_pipe(*args, **kwargs):
665
result = func(*args, **kwargs)
669
if not hasattr(e, 'errno'):
671
if e.errno != errno.EPIPE:
674
except KeyboardInterrupt:
619
bzrlib.trace.log_startup(argv)
620
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
622
return run_bzr_catch_errors(argv[1:])
681
from bzrlib.ui.text import TextUIFactory
682
bzrlib.ui.ui_factory = TextUIFactory()
683
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
684
ret = run_bzr_catch_errors(argv)
685
mutter("return code %d", ret)
625
689
def run_bzr_catch_errors(argv):
630
694
# do this here inside the exception wrappers to catch EPIPE
631
695
sys.stdout.flush()
632
except BzrCommandError, e:
633
# command line syntax error, etc
637
bzrlib.trace.log_exception()
639
except AssertionError, e:
640
bzrlib.trace.log_exception('assertion failed: ' + str(e))
697
# used to handle AssertionError and KeyboardInterrupt
698
# specially here, but hopefully they're handled ok by the logger now
699
bzrlib.trace.report_exception(sys.exc_info(), sys.stderr)
700
if os.environ.get('BZR_PDB'):
701
print '**** entering debugger'
703
pdb.post_mortem(sys.exc_traceback)
642
except KeyboardInterrupt, e:
643
bzrlib.trace.log_exception('interrupted')
647
if (isinstance(e, IOError)
648
and hasattr(e, 'errno')
649
and e.errno == errno.EPIPE):
650
bzrlib.trace.note('broken pipe')
655
bzrlib.trace.log_exception()
658
706
if __name__ == '__main__':
659
707
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
