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: 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?
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.
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
38
38
from warnings import warn
39
from inspect import getdoc
50
from bzrlib.symbol_versioning import (
57
from bzrlib.option import Option
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
63
def register_command(cmd, decorate=False):
64
"""Utility function to help register a command
66
:param cmd: Command subclass to register
67
:param decorate: If true, allow overriding an existing command
68
of the same name; the old command is returned by this function.
69
Otherwise it is an error to try to override an existing command.
51
def register_command(cmd):
52
"Utility function to help register a command"
73
55
if k.startswith("cmd_"):
74
56
k_unsquished = _unsquish_command_name(k)
77
if k_unsquished not in plugin_cmds:
78
plugin_cmds[k_unsquished] = cmd
79
## trace.mutter('registered plugin command %s', k_unsquished)
80
if decorate and k_unsquished in builtin_command_names():
81
return _builtin_commands()[k_unsquished]
83
result = plugin_cmds[k_unsquished]
84
plugin_cmds[k_unsquished] = cmd
59
if not plugin_cmds.has_key(k_unsquished):
60
plugin_cmds[k_unsquished] = cmd
61
mutter('registered plugin command %s', k_unsquished)
87
trace.log_error('Two plugins defined the same command: %r' % k)
88
trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
63
log_error('Two plugins defined the same command: %r' % k)
64
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
91
67
def _squish_command_name(cmd):
97
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
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)
100
160
def _builtin_commands():
101
161
import bzrlib.builtins
103
163
builtins = bzrlib.builtins.__dict__
104
164
for name in builtins:
105
165
if name.startswith("cmd_"):
106
real_name = _unsquish_command_name(name)
166
real_name = _unsquish_command_name(name)
107
167
r[real_name] = builtins[name]
111
172
def builtin_command_names():
195
246
List of argument forms, marked with whether they are optional,
200
['to_location', 'from_branch?', 'file*']
202
'to_location' is required
203
'from_branch' is optional
204
'file' can be specified 0 or more times
207
List of options that may be given for this command. These can
208
be either strings, referring to globally-defined options,
209
or option objects. Retrieve through options().
250
List of options that may be given for this command.
212
253
If true, this command isn't advertised. This is typically
213
254
for commands intended for expert users.
216
Command objects will get a 'outf' attribute, which has been
217
setup to properly handle encoding of unicode strings.
218
encoding_type determines what will happen when characters cannot
220
strict - abort if we cannot decode
221
replace - put in a bogus character (typically '?')
222
exact - do not encode sys.stdout
224
NOTE: by default on Windows, sys.stdout is opened as a text
225
stream, therefore LF line-endings are converted to CRLF.
226
When a command uses encoding_type = 'exact', then
227
sys.stdout is forced to be a binary stream, and line-endings
233
259
takes_options = []
234
encoding_type = 'strict'
240
265
if self.__doc__ == Command.__doc__:
241
266
warn("No help message set for %r" % self)
244
"""Return single-line grammar for this command.
246
Only describes arguments, not options.
248
s = 'bzr ' + self.name() + ' '
249
for aname in self.takes_args:
250
aname = aname.upper()
251
if aname[-1] in ['$', '+']:
252
aname = aname[:-1] + '...'
253
elif aname[-1] == '?':
254
aname = '[' + aname[:-1] + ']'
255
elif aname[-1] == '*':
256
aname = '[' + aname[:-1] + '...]'
263
def get_help_text(self, additional_see_also=None):
264
"""Return a text string with help for this command.
266
:param additional_see_also: Additional help topics to be
271
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
274
result += 'usage: %s\n' % self._usage()
277
result += 'aliases: '
278
result += ', '.join(self.aliases) + '\n'
282
plugin_name = self.plugin_name()
283
if plugin_name is not None:
284
result += '(From plugin "%s")' % plugin_name
288
if result[-1] != '\n':
291
result += option.get_optparser(self.options()).format_option_help()
292
see_also = self.get_see_also(additional_see_also)
294
result += '\nSee also: '
295
result += ', '.join(see_also)
299
def get_help_topic(self):
300
"""Return the commands help topic - its name."""
303
def get_see_also(self, additional_terms=None):
304
"""Return a list of help topics that are related to this ommand.
306
The list is derived from the content of the _see_also attribute. Any
307
duplicates are removed and the result is in lexical order.
308
:param additional_terms: Additional help topics to cross-reference.
309
:return: A list of help topics.
311
see_also = set(getattr(self, '_see_also', []))
313
see_also.update(additional_terms)
314
return sorted(see_also)
317
"""Return dict of valid options for this command.
319
Maps from long option name to option object."""
321
r['help'] = option.Option.OPTIONS['help']
322
for o in self.takes_options:
323
if isinstance(o, basestring):
324
o = option.Option.OPTIONS[o]
328
def _setup_outf(self):
329
"""Return a file linked to stdout, which has proper encoding."""
330
assert self.encoding_type in ['strict', 'exact', 'replace']
332
# Originally I was using self.stdout, but that looks
333
# *way* too much like sys.stdout
334
if self.encoding_type == 'exact':
335
# force sys.stdout to be binary stream on win32
336
if sys.platform == 'win32':
337
fileno = getattr(sys.stdout, 'fileno', None)
340
msvcrt.setmode(fileno(), os.O_BINARY)
341
self.outf = sys.stdout
344
output_encoding = osutils.get_terminal_encoding()
346
# use 'replace' so that we don't abort if trying to write out
347
# in e.g. the default C locale.
348
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
349
# For whatever reason codecs.getwriter() does not advertise its encoding
350
# it just returns the encoding of the wrapped file, which is completely
351
# bogus. So set the attribute, so we can find the correct encoding later.
352
self.outf.encoding = output_encoding
354
def run_argv_aliases(self, argv, alias_argv=None):
355
"""Parse the command line and run with extra aliases in alias_argv."""
357
warn("Passing None for [] is deprecated from bzrlib 0.10",
358
DeprecationWarning, stacklevel=2)
360
args, opts = parse_args(self, argv, alias_argv)
269
def run_argv(self, argv):
270
"""Parse command line and run."""
271
args, opts = parse_args(argv)
361
273
if 'help' in opts: # e.g. bzr add --help
362
sys.stdout.write(self.get_help_text())
274
from bzrlib.help import help_on_command
275
help_on_command(self.name())
278
# check options are reasonable
279
allowed = self.takes_options
281
if oname not in allowed:
282
raise BzrCommandError("option '--%s' is not allowed for command %r"
283
% (oname, self.name()))
364
285
# mix arguments and options into one dictionary
365
286
cmdargs = _match_argform(self.name(), self.takes_args, args)
443
348
parsed = [spec, None]
446
def parse_args(command, argv, alias_argv=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):
447
393
"""Parse command line.
449
395
Arguments and options are parsed at this level before being passed
450
396
down to specific command handlers. This routine knows, from a
451
397
lookup table, something about the available options, what optargs
452
398
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]})
454
# TODO: make it a method of the Command?
455
parser = option.get_optparser(command.options())
456
if alias_argv is not None:
457
args = alias_argv + argv
461
options, args = parser.parse_args(args)
462
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
463
v is not option.OptionParser.DEFAULT_VALUE])
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]
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:])
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)
486
raise BzrError('option %r takes no argument' % optname)
464
491
return args, opts
467
496
def _match_argform(cmd, takes_args, args):
481
510
argdict[argname + '_list'] = None
482
511
elif ap[-1] == '+':
484
raise errors.BzrCommandError("command %r needs one or more %s"
485
% (cmd, argname.upper()))
513
raise BzrCommandError("command %r needs one or more %s"
514
% (cmd, argname.upper()))
487
516
argdict[argname + '_list'] = args[:]
489
518
elif ap[-1] == '$': # all but one
490
519
if len(args) < 2:
491
raise errors.BzrCommandError("command %r needs one or more %s"
492
% (cmd, argname.upper()))
520
raise BzrCommandError("command %r needs one or more %s"
521
% (cmd, argname.upper()))
493
522
argdict[argname + '_list'] = args[:-1]
496
525
# just a plain arg
499
raise errors.BzrCommandError("command %r requires argument %s"
500
% (cmd, argname.upper()))
528
raise BzrCommandError("command %r requires argument %s"
529
% (cmd, argname.upper()))
502
531
argdict[argname] = args.pop(0)
505
raise errors.BzrCommandError("extra argument to command %s: %s"
534
raise BzrCommandError("extra argument to command %s: %s"
520
548
ret = prof.runcall(the_callable, *args, **kwargs) or 0
523
553
stats = hotshot.stats.load(pfname)
525
stats.sort_stats('cum') # 'time'
555
stats.sort_stats('time')
526
556
## XXX: Might like to write to stderr or the trace file instead but
527
557
## print_stats seems hardcoded to stdout
528
558
stats.print_stats(20)
531
562
os.close(pffileno)
532
563
os.remove(pfname)
535
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
536
from bzrlib.lsprof import profile
537
ret, stats = profile(the_callable, *args, **kwargs)
543
trace.note('Profile data written to "%s".', filename)
547
def get_alias(cmd, config=None):
548
"""Return an expanded alias, or None if no alias exists.
551
Command to be checked for an alias.
553
Used to specify an alternative config to use,
554
which is especially useful for testing.
555
If it is unspecified, the global config will be used.
559
config = bzrlib.config.GlobalConfig()
560
alias = config.get_alias(cmd)
563
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
567
566
def run_bzr(argv):
568
567
"""Execute a command.
584
581
Do not load plugin modules at all
590
584
Only use builtin commands. (Plugins are still allowed to change
591
585
other behaviour.)
594
Run under the Python hotshot profiler.
597
Run under the Python lsprof profiler.
588
Run under the Python profiler.
600
trace.mutter("bzr arguments: %r", argv)
590
# Load all of the transport methods
591
import bzrlib.transport.local, bzrlib.transport.http
593
argv = [a.decode(bzrlib.user_encoding) for a in argv]
602
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
603
opt_no_aliases = False
604
opt_lsprof_file = None
595
opt_profile = opt_no_plugins = opt_builtin = False
606
597
# --no-plugins is handled specially at a very early stage. We need
607
598
# to load plugins before doing other command parsing so that they
608
599
# can override commands, but this needs to happen first.
614
602
if a == '--profile':
615
603
opt_profile = True
616
elif a == '--lsprof':
618
elif a == '--lsprof-file':
620
opt_lsprof_file = argv[i + 1]
622
604
elif a == '--no-plugins':
623
605
opt_no_plugins = True
624
elif a == '--no-aliases':
625
opt_no_aliases = True
626
606
elif a == '--builtin':
627
607
opt_builtin = True
628
elif a in ('--quiet', '-q'):
630
elif a.startswith('-D'):
631
debug.debug_flags.add(a[2:])
638
from bzrlib.builtins import cmd_help
639
cmd_help().run_argv_aliases([])
612
if (not argv) or (argv[0] == '--help'):
613
from bzrlib.help import help
642
620
if argv[0] == '--version':
643
from bzrlib.version import show_version
621
from bzrlib.builtins import show_version
647
625
if not opt_no_plugins:
648
626
from bzrlib.plugin import load_plugins
651
from bzrlib.plugin import disable_plugins
656
if not opt_no_aliases:
657
alias_argv = get_alias(argv[0])
659
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
660
argv[0] = alias_argv.pop(0)
663
# We want only 'ascii' command names, but the user may have typed
664
# in a Unicode name. In that case, they should just get a
665
# 'command not found' error later.
629
cmd = str(argv.pop(0))
667
631
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
668
run = cmd_obj.run_argv_aliases
669
run_argv = [argv, alias_argv]
673
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
675
ret = apply_profiled(run, *run_argv)
680
# reset, in case we may do other commands later within the same process
681
trace.be_quiet(False)
683
def display_command(func):
684
"""Decorator that suppresses pipe/interrupt errors."""
685
def ignore_pipe(*args, **kwargs):
687
result = func(*args, **kwargs)
691
if getattr(e, 'errno', None) is None:
693
if e.errno != errno.EPIPE:
694
# Win32 raises IOError with errno=0 on a broken pipe
695
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
698
except KeyboardInterrupt:
634
ret = apply_profiled(cmd_obj.run_argv, argv)
636
ret = cmd_obj.run_argv(argv)
705
from bzrlib.ui.text import TextUIFactory
706
bzrlib.ui.ui_factory = TextUIFactory()
707
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
708
ret = run_bzr_catch_errors(argv)
709
trace.mutter("return code %d", ret)
713
def run_bzr_catch_errors(argv):
642
bzrlib.trace.log_startup(argv)
643
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
716
except (KeyboardInterrupt, Exception), e:
717
# used to handle AssertionError and KeyboardInterrupt
718
# specially here, but hopefully they're handled ok by the logger now
719
trace.report_exception(sys.exc_info(), sys.stderr)
720
if os.environ.get('BZR_PDB'):
721
print '**** entering debugger'
723
pdb.post_mortem(sys.exc_traceback)
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))
727
class HelpCommandIndex(object):
728
"""A index for bzr help that returns commands."""
731
self.prefix = 'commands/'
733
def get_topics(self, topic):
734
"""Search for topic amongst commands.
736
:param topic: A topic to search for.
737
:return: A list which is either empty or contains a single
740
if topic and topic.startswith(self.prefix):
741
topic = topic[len(self.prefix):]
743
cmd = _get_cmd_object(topic)
665
except KeyboardInterrupt, e:
666
bzrlib.trace.note('interrupted')
670
if (isinstance(e, IOError)
671
and hasattr(e, 'errno')
672
and e.errno == errno.EPIPE):
673
bzrlib.trace.note('broken pipe')
676
bzrlib.trace.log_exception()
750
679
if __name__ == '__main__':
751
680
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
