1
# Copyright (C) 2006 Canonical Ltd
1
# Copyright (C) 2004, 2005 by Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
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.
21
23
# TODO: Define arguments by objects, rather than just using names.
22
24
# 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?
25
# would help with validation and shell completion.
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
38
31
from warnings import warn
32
from inspect import getdoc
50
from bzrlib.symbol_versioning import (
57
from bzrlib.option import Option
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
39
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.
44
def register_command(cmd):
45
"Utility function to help register a command"
73
48
if k.startswith("cmd_"):
74
49
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
52
if not plugin_cmds.has_key(k_unsquished):
53
plugin_cmds[k_unsquished] = cmd
54
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__])
56
log_error('Two plugins defined the same command: %r' % k)
57
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
91
60
def _squish_command_name(cmd):
97
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)
100
153
def _builtin_commands():
101
154
import bzrlib.builtins
103
156
builtins = bzrlib.builtins.__dict__
104
157
for name in builtins:
105
158
if name.startswith("cmd_"):
106
real_name = _unsquish_command_name(name)
159
real_name = _unsquish_command_name(name)
107
160
r[real_name] = builtins[name]
111
165
def builtin_command_names():
195
239
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().
243
List of options that may be given for this command.
212
246
If true, this command isn't advertised. This is typically
213
247
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
252
takes_options = []
234
encoding_type = 'strict'
240
258
if self.__doc__ == Command.__doc__:
241
259
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)
262
def run_argv(self, argv):
263
"""Parse command line and run."""
264
args, opts = parse_args(argv)
361
266
if 'help' in opts: # e.g. bzr add --help
362
sys.stdout.write(self.get_help_text())
267
from bzrlib.help import help_on_command
268
help_on_command(self.name())
271
# check options are reasonable
272
allowed = self.takes_options
274
if oname not in allowed:
275
raise BzrCommandError("option '--%s' is not allowed for command %r"
276
% (oname, self.name()))
364
278
# mix arguments and options into one dictionary
365
279
cmdargs = _match_argform(self.name(), self.takes_args, args)
443
341
parsed = [spec, None]
446
def parse_args(command, argv, alias_argv=None):
347
# list of all available options; the rhs can be either None for an
348
# option that takes no argument, or a constructor function that checks
361
'revision': _parse_revision_str,
373
'merge-type': get_merge_type,
387
def parse_args(argv):
447
388
"""Parse command line.
449
390
Arguments and options are parsed at this level before being passed
450
391
down to specific command handlers. This routine knows, from a
451
392
lookup table, something about the available options, what optargs
452
393
they take, and which commands will accept them.
395
>>> parse_args('--help'.split())
397
>>> parse_args('help -- --invalidcmd'.split())
398
(['help', '--invalidcmd'], {})
399
>>> parse_args('--version'.split())
400
([], {'version': True})
401
>>> parse_args('status --all'.split())
402
(['status'], {'all': True})
403
>>> parse_args('commit --message=biter'.split())
404
(['commit'], {'message': u'biter'})
405
>>> parse_args('log -r 500'.split())
406
(['log'], {'revision': [500]})
407
>>> parse_args('log -r500..600'.split())
408
(['log'], {'revision': [500, 600]})
409
>>> parse_args('log -vr500..600'.split())
410
(['log'], {'verbose': True, 'revision': [500, 600]})
411
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
412
(['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])
420
if not argsover and a[0] == '-':
421
# option names must not be unicode
426
# We've received a standalone -- No more flags
429
mutter(" got option %r" % a)
431
optname, optarg = a[2:].split('=', 1)
434
if optname not in OPTIONS:
435
raise BzrError('unknown long option %r' % a)
438
if shortopt in SHORT_OPTIONS:
439
# Multi-character options must have a space to delimit
441
optname = SHORT_OPTIONS[shortopt]
443
# Single character short options, can be chained,
444
# and have their value appended to their name
446
if shortopt not in SHORT_OPTIONS:
447
# We didn't find the multi-character name, and we
448
# didn't find the single char name
449
raise BzrError('unknown short option %r' % a)
450
optname = SHORT_OPTIONS[shortopt]
453
# There are extra things on this option
454
# see if it is the value, or if it is another
456
optargfn = OPTIONS[optname]
458
# This option does not take an argument, so the
459
# next entry is another short option, pack it back
461
argv.insert(0, '-' + a[2:])
463
# This option takes an argument, so pack it
468
# XXX: Do we ever want to support this, e.g. for -r?
469
raise BzrError('repeated option %r' % a)
471
optargfn = OPTIONS[optname]
475
raise BzrError('option %r needs an argument' % a)
478
opts[optname] = optargfn(optarg)
481
raise BzrError('option %r takes no argument' % optname)
464
486
return args, opts
467
491
def _match_argform(cmd, takes_args, args):
481
505
argdict[argname + '_list'] = None
482
506
elif ap[-1] == '+':
484
raise errors.BzrCommandError("command %r needs one or more %s"
485
% (cmd, argname.upper()))
508
raise BzrCommandError("command %r needs one or more %s"
509
% (cmd, argname.upper()))
487
511
argdict[argname + '_list'] = args[:]
489
513
elif ap[-1] == '$': # all but one
490
514
if len(args) < 2:
491
raise errors.BzrCommandError("command %r needs one or more %s"
492
% (cmd, argname.upper()))
515
raise BzrCommandError("command %r needs one or more %s"
516
% (cmd, argname.upper()))
493
517
argdict[argname + '_list'] = args[:-1]
496
520
# just a plain arg
499
raise errors.BzrCommandError("command %r requires argument %s"
500
% (cmd, argname.upper()))
523
raise BzrCommandError("command %r requires argument %s"
524
% (cmd, argname.upper()))
502
526
argdict[argname] = args.pop(0)
505
raise errors.BzrCommandError("extra argument to command %s: %s"
529
raise BzrCommandError("extra argument to command %s: %s"
520
543
ret = prof.runcall(the_callable, *args, **kwargs) or 0
523
548
stats = hotshot.stats.load(pfname)
525
stats.sort_stats('cum') # 'time'
550
stats.sort_stats('time')
526
551
## XXX: Might like to write to stderr or the trace file instead but
527
552
## print_stats seems hardcoded to stdout
528
553
stats.print_stats(20)
531
557
os.close(pffileno)
532
558
os.remove(pfname)
535
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
536
from bzrlib.lsprof import profile
538
ret, stats = profile(the_callable, *args, **kwargs)
544
print 'Profile data written to %r.' % filename
548
def get_alias(cmd, config=None):
549
"""Return an expanded alias, or None if no alias exists.
552
Command to be checked for an alias.
554
Used to specify an alternative config to use,
555
which is especially useful for testing.
556
If it is unspecified, the global config will be used.
560
config = bzrlib.config.GlobalConfig()
561
alias = config.get_alias(cmd)
564
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
568
561
def run_bzr(argv):
569
562
"""Execute a command.
585
576
Do not load plugin modules at all
591
579
Only use builtin commands. (Plugins are still allowed to change
592
580
other behaviour.)
595
Run under the Python hotshot profiler.
598
Run under the Python lsprof profiler.
583
Run under the Python profiler.
601
trace.mutter("bzr arguments: %r", argv)
586
argv = [a.decode(bzrlib.user_encoding) for a in argv]
603
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
604
opt_no_aliases = False
605
opt_lsprof_file = None
588
opt_profile = opt_no_plugins = opt_builtin = False
607
590
# --no-plugins is handled specially at a very early stage. We need
608
591
# to load plugins before doing other command parsing so that they
609
592
# can override commands, but this needs to happen first.
615
595
if a == '--profile':
616
596
opt_profile = True
617
elif a == '--lsprof':
619
elif a == '--lsprof-file':
621
opt_lsprof_file = argv[i + 1]
623
597
elif a == '--no-plugins':
624
598
opt_no_plugins = True
625
elif a == '--no-aliases':
626
opt_no_aliases = True
627
599
elif a == '--builtin':
628
600
opt_builtin = True
629
elif a in ('--quiet', '-q'):
631
elif a.startswith('-D'):
632
debug.debug_flags.add(a[2:])
639
from bzrlib.builtins import cmd_help
640
cmd_help().run_argv_aliases([])
605
if (not argv) or (argv[0] == '--help'):
606
from bzrlib.help import help
643
613
if argv[0] == '--version':
644
from bzrlib.version import show_version
614
from bzrlib.builtins import show_version
648
618
if not opt_no_plugins:
649
619
from bzrlib.plugin import load_plugins
652
from bzrlib.plugin import disable_plugins
657
if not opt_no_aliases:
658
alias_argv = get_alias(argv[0])
660
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
661
argv[0] = alias_argv.pop(0)
664
# We want only 'ascii' command names, but the user may have typed
665
# in a Unicode name. In that case, they should just get a
666
# 'command not found' error later.
622
cmd = str(argv.pop(0))
668
624
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
669
run = cmd_obj.run_argv_aliases
670
run_argv = [argv, alias_argv]
674
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
676
ret = apply_profiled(run, *run_argv)
681
# reset, in case we may do other commands later within the same process
682
trace.be_quiet(False)
684
def display_command(func):
685
"""Decorator that suppresses pipe/interrupt errors."""
686
def ignore_pipe(*args, **kwargs):
688
result = func(*args, **kwargs)
692
if getattr(e, 'errno', None) is None:
694
if e.errno != errno.EPIPE:
695
# Win32 raises IOError with errno=0 on a broken pipe
696
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
699
except KeyboardInterrupt:
627
ret = apply_profiled(cmd_obj.run_argv, argv)
629
ret = cmd_obj.run_argv(argv)
706
from bzrlib.ui.text import TextUIFactory
707
bzrlib.ui.ui_factory = TextUIFactory()
708
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
709
ret = run_bzr_catch_errors(argv)
710
trace.mutter("return code %d", ret)
714
def run_bzr_catch_errors(argv):
635
bzrlib.trace.log_startup(argv)
636
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
640
return run_bzr(argv[1:])
719
642
# do this here inside the exception wrappers to catch EPIPE
720
643
sys.stdout.flush()
721
except (KeyboardInterrupt, Exception), e:
722
# used to handle AssertionError and KeyboardInterrupt
723
# specially here, but hopefully they're handled ok by the logger now
724
trace.report_exception(sys.exc_info(), sys.stderr)
725
if os.environ.get('BZR_PDB'):
726
print '**** entering debugger'
728
pdb.post_mortem(sys.exc_traceback)
644
except BzrCommandError, e:
645
# command line syntax error, etc
649
bzrlib.trace.log_exception()
651
except AssertionError, e:
652
bzrlib.trace.log_exception('assertion failed: ' + str(e))
732
class HelpCommandIndex(object):
733
"""A index for bzr help that returns commands."""
736
self.prefix = 'commands/'
738
def get_topics(self, topic):
739
"""Search for topic amongst commands.
741
:param topic: A topic to search for.
742
:return: A list which is either empty or contains a single
745
if topic and topic.startswith(self.prefix):
746
topic = topic[len(self.prefix):]
748
cmd = _get_cmd_object(topic)
654
except KeyboardInterrupt, e:
655
bzrlib.trace.note('interrupted')
659
if (isinstance(e, IOError)
660
and hasattr(e, 'errno')
661
and e.errno == errno.EPIPE):
662
bzrlib.trace.note('broken pipe')
665
bzrlib.trace.log_exception()
755
669
if __name__ == '__main__':
added
removed
bzrlib/commands.py
