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)
153
def get_merge_type(typestring):
154
"""Attempt to find the merge class/factory associated with a string."""
155
from merge import merge_types
157
return merge_types[typestring][0]
159
templ = '%s%%7s: %%s' % (' '*12)
160
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
161
type_list = '\n'.join(lines)
162
msg = "No known merge type %s. Supported types are:\n%s" %\
163
(typestring, type_list)
164
raise BzrCommandError(msg)
100
167
def _builtin_commands():
101
168
import bzrlib.builtins
103
170
builtins = bzrlib.builtins.__dict__
104
171
for name in builtins:
105
172
if name.startswith("cmd_"):
106
real_name = _unsquish_command_name(name)
173
real_name = _unsquish_command_name(name)
107
174
r[real_name] = builtins[name]
111
179
def builtin_command_names():
195
253
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().
257
List of options that may be given for this command.
212
260
If true, this command isn't advertised. This is typically
213
261
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
266
takes_options = []
234
encoding_type = 'strict'
240
272
if self.__doc__ == Command.__doc__:
241
273
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)
276
def run_argv(self, argv):
277
"""Parse command line and run."""
278
args, opts = parse_args(argv)
361
280
if 'help' in opts: # e.g. bzr add --help
362
sys.stdout.write(self.get_help_text())
281
from bzrlib.help import help_on_command
282
help_on_command(self.name())
285
# check options are reasonable
286
allowed = self.takes_options
288
if oname not in allowed:
289
raise BzrCommandError("option '--%s' is not allowed for command %r"
290
% (oname, self.name()))
364
292
# mix arguments and options into one dictionary
365
293
cmdargs = _match_argform(self.name(), self.takes_args, args)
443
355
parsed = [spec, None]
446
def parse_args(command, argv, alias_argv=None):
361
# list of all available options; the rhs can be either None for an
362
# option that takes no argument, or a constructor function that checks
375
'revision': _parse_revision_str,
387
'merge-type': get_merge_type,
401
def parse_args(argv):
447
402
"""Parse command line.
449
404
Arguments and options are parsed at this level before being passed
450
405
down to specific command handlers. This routine knows, from a
451
406
lookup table, something about the available options, what optargs
452
407
they take, and which commands will accept them.
409
>>> parse_args('--help'.split())
411
>>> parse_args('help -- --invalidcmd'.split())
412
(['help', '--invalidcmd'], {})
413
>>> parse_args('--version'.split())
414
([], {'version': True})
415
>>> parse_args('status --all'.split())
416
(['status'], {'all': True})
417
>>> parse_args('commit --message=biter'.split())
418
(['commit'], {'message': u'biter'})
419
>>> parse_args('log -r 500'.split())
420
(['log'], {'revision': [500]})
421
>>> parse_args('log -r500..600'.split())
422
(['log'], {'revision': [500, 600]})
423
>>> parse_args('log -vr500..600'.split())
424
(['log'], {'verbose': True, 'revision': [500, 600]})
425
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
426
(['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])
434
if not argsover and a[0] == '-':
435
# option names must not be unicode
440
# We've received a standalone -- No more flags
443
mutter(" got option %r" % a)
445
optname, optarg = a[2:].split('=', 1)
448
if optname not in OPTIONS:
449
raise BzrError('unknown long option %r' % a)
452
if shortopt in SHORT_OPTIONS:
453
# Multi-character options must have a space to delimit
455
optname = SHORT_OPTIONS[shortopt]
457
# Single character short options, can be chained,
458
# and have their value appended to their name
460
if shortopt not in SHORT_OPTIONS:
461
# We didn't find the multi-character name, and we
462
# didn't find the single char name
463
raise BzrError('unknown short option %r' % a)
464
optname = SHORT_OPTIONS[shortopt]
467
# There are extra things on this option
468
# see if it is the value, or if it is another
470
optargfn = OPTIONS[optname]
472
# This option does not take an argument, so the
473
# next entry is another short option, pack it back
475
argv.insert(0, '-' + a[2:])
477
# This option takes an argument, so pack it
482
# XXX: Do we ever want to support this, e.g. for -r?
483
raise BzrError('repeated option %r' % a)
485
optargfn = OPTIONS[optname]
489
raise BzrError('option %r needs an argument' % a)
492
opts[optname] = optargfn(optarg)
495
raise BzrError('option %r takes no argument' % optname)
464
500
return args, opts
467
505
def _match_argform(cmd, takes_args, args):
481
519
argdict[argname + '_list'] = None
482
520
elif ap[-1] == '+':
484
raise errors.BzrCommandError("command %r needs one or more %s"
485
% (cmd, argname.upper()))
522
raise BzrCommandError("command %r needs one or more %s"
523
% (cmd, argname.upper()))
487
525
argdict[argname + '_list'] = args[:]
489
527
elif ap[-1] == '$': # all but one
490
528
if len(args) < 2:
491
raise errors.BzrCommandError("command %r needs one or more %s"
492
% (cmd, argname.upper()))
529
raise BzrCommandError("command %r needs one or more %s"
530
% (cmd, argname.upper()))
493
531
argdict[argname + '_list'] = args[:-1]
496
534
# just a plain arg
499
raise errors.BzrCommandError("command %r requires argument %s"
500
% (cmd, argname.upper()))
537
raise BzrCommandError("command %r requires argument %s"
538
% (cmd, argname.upper()))
502
540
argdict[argname] = args.pop(0)
505
raise errors.BzrCommandError("extra argument to command %s: %s"
543
raise BzrCommandError("extra argument to command %s: %s"
520
557
ret = prof.runcall(the_callable, *args, **kwargs) or 0
523
562
stats = hotshot.stats.load(pfname)
525
stats.sort_stats('cum') # 'time'
564
stats.sort_stats('time')
526
565
## XXX: Might like to write to stderr or the trace file instead but
527
566
## print_stats seems hardcoded to stdout
528
567
stats.print_stats(20)
531
571
os.close(pffileno)
532
572
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
cPickle.dump(stats, open(filename, 'w'), 2)
545
print 'Profile data written to %r.' % filename
549
def get_alias(cmd, config=None):
550
"""Return an expanded alias, or None if no alias exists.
553
Command to be checked for an alias.
555
Used to specify an alternative config to use,
556
which is especially useful for testing.
557
If it is unspecified, the global config will be used.
561
config = bzrlib.config.GlobalConfig()
562
alias = config.get_alias(cmd)
565
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
569
575
def run_bzr(argv):
570
576
"""Execute a command.
586
590
Do not load plugin modules at all
592
593
Only use builtin commands. (Plugins are still allowed to change
593
594
other behaviour.)
596
Run under the Python hotshot profiler.
599
Run under the Python lsprof profiler.
597
Run under the Python profiler.
602
trace.mutter("bzr arguments: %r", argv)
600
argv = [a.decode(bzrlib.user_encoding) for a in argv]
604
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
605
opt_no_aliases = False
606
opt_lsprof_file = None
602
opt_profile = opt_no_plugins = opt_builtin = False
608
604
# --no-plugins is handled specially at a very early stage. We need
609
605
# to load plugins before doing other command parsing so that they
610
606
# can override commands, but this needs to happen first.
616
609
if a == '--profile':
617
610
opt_profile = True
618
elif a == '--lsprof':
620
elif a == '--lsprof-file':
622
opt_lsprof_file = argv[i + 1]
624
611
elif a == '--no-plugins':
625
612
opt_no_plugins = True
626
elif a == '--no-aliases':
627
opt_no_aliases = True
628
613
elif a == '--builtin':
629
614
opt_builtin = True
630
elif a in ('--quiet', '-q'):
632
elif a.startswith('-D'):
633
debug.debug_flags.add(a[2:])
640
from bzrlib.builtins import cmd_help
641
cmd_help().run_argv_aliases([])
619
if (not argv) or (argv[0] == '--help'):
620
from bzrlib.help import help
644
627
if argv[0] == '--version':
645
from bzrlib.version import show_version
628
from bzrlib.builtins import show_version
649
632
if not opt_no_plugins:
650
633
from bzrlib.plugin import load_plugins
653
from bzrlib.plugin import disable_plugins
658
if not opt_no_aliases:
659
alias_argv = get_alias(argv[0])
661
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
662
argv[0] = alias_argv.pop(0)
665
# We want only 'ascii' command names, but the user may have typed
666
# in a Unicode name. In that case, they should just get a
667
# 'command not found' error later.
636
cmd = str(argv.pop(0))
669
638
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
670
run = cmd_obj.run_argv_aliases
671
run_argv = [argv, alias_argv]
675
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
677
ret = apply_profiled(run, *run_argv)
682
# reset, in case we may do other commands later within the same process
683
trace.be_quiet(False)
685
def display_command(func):
686
"""Decorator that suppresses pipe/interrupt errors."""
687
def ignore_pipe(*args, **kwargs):
689
result = func(*args, **kwargs)
693
if getattr(e, 'errno', None) is None:
695
if e.errno != errno.EPIPE:
696
# Win32 raises IOError with errno=0 on a broken pipe
697
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
700
except KeyboardInterrupt:
641
ret = apply_profiled(cmd_obj.run_argv, argv)
643
ret = cmd_obj.run_argv(argv)
707
from bzrlib.ui.text import TextUIFactory
708
bzrlib.ui.ui_factory = TextUIFactory()
709
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
710
ret = run_bzr_catch_errors(argv)
711
trace.mutter("return code %d", ret)
715
def run_bzr_catch_errors(argv):
649
bzrlib.trace.log_startup(argv)
650
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
654
return run_bzr(argv[1:])
720
656
# do this here inside the exception wrappers to catch EPIPE
721
657
sys.stdout.flush()
722
except (KeyboardInterrupt, Exception), e:
723
# used to handle AssertionError and KeyboardInterrupt
724
# specially here, but hopefully they're handled ok by the logger now
725
trace.report_exception(sys.exc_info(), sys.stderr)
726
if os.environ.get('BZR_PDB'):
727
print '**** entering debugger'
729
pdb.post_mortem(sys.exc_traceback)
658
except BzrCommandError, e:
659
# command line syntax error, etc
663
bzrlib.trace.log_exception()
665
except AssertionError, e:
666
bzrlib.trace.log_exception('assertion failed: ' + str(e))
733
class HelpCommandIndex(object):
734
"""A index for bzr help that returns commands."""
737
self.prefix = 'commands/'
739
def get_topics(self, topic):
740
"""Search for topic amongst commands.
742
:param topic: A topic to search for.
743
:return: A list which is either empty or contains a single
746
if topic and topic.startswith(self.prefix):
747
topic = topic[len(self.prefix):]
749
cmd = _get_cmd_object(topic)
668
except KeyboardInterrupt, e:
669
bzrlib.trace.note('interrupted')
673
if (isinstance(e, IOError)
674
and hasattr(e, 'errno')
675
and e.errno == errno.EPIPE):
676
bzrlib.trace.note('broken pipe')
679
bzrlib.trace.log_exception()
756
683
if __name__ == '__main__':
added
removed
bzrlib/commands.py
