1
# Copyright (C) 2004, 2005 by Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: probably should say which arguments are candidates for glob
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.
38
from warnings import warn
39
from inspect import getdoc
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
51
def register_command(cmd):
52
"Utility function to help register a command"
55
if k.startswith("cmd_"):
56
k_unsquished = _unsquish_command_name(k)
59
if not plugin_cmds.has_key(k_unsquished):
60
plugin_cmds[k_unsquished] = cmd
61
mutter('registered plugin command %s', k_unsquished)
63
log_error('Two plugins defined the same command: %r' % k)
64
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
67
def _squish_command_name(cmd):
68
return 'cmd_' + cmd.replace('-', '_')
71
def _unsquish_command_name(cmd):
72
assert cmd.startswith("cmd_")
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)
160
def _builtin_commands():
161
import bzrlib.builtins
163
builtins = bzrlib.builtins.__dict__
164
for name in builtins:
165
if name.startswith("cmd_"):
166
real_name = _unsquish_command_name(name)
167
r[real_name] = builtins[name]
172
def builtin_command_names():
173
"""Return list of builtin command names."""
174
return _builtin_commands().keys()
177
def plugin_command_names():
178
return plugin_cmds.keys()
181
def _get_cmd_dict(plugins_override=True):
182
"""Return name->class mapping for all commands."""
183
d = _builtin_commands()
185
d.update(plugin_cmds)
189
def get_all_cmds(plugins_override=True):
190
"""Return canonical name and class for all registered commands."""
191
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
195
def get_cmd_object(cmd_name, plugins_override=True):
196
"""Return the canonical name and command class for a command.
199
If true, plugin commands can override builtins.
201
from bzrlib.externalcommand import ExternalCommand
203
cmd_name = str(cmd_name) # not unicode
205
# first look up this command under the specified name
206
cmds = _get_cmd_dict(plugins_override=plugins_override)
208
return cmds[cmd_name]()
212
# look for any command which claims this as an alias
213
for real_cmd_name, cmd_class in cmds.iteritems():
214
if cmd_name in cmd_class.aliases:
217
cmd_obj = ExternalCommand.find_command(cmd_name)
221
raise BzrCommandError("unknown command %r" % cmd_name)
224
class Command(object):
225
"""Base class for commands.
227
Commands are the heart of the command-line bzr interface.
229
The command object mostly handles the mapping of command-line
230
parameters into one or more bzrlib operations, and of the results
233
Commands normally don't have any state. All their arguments are
234
passed in to the run method. (Subclasses may take a different
235
policy if the behaviour of the instance needs to depend on e.g. a
236
shell plugin and not just its Python class.)
238
The docstring for an actual command should give a single-line
239
summary, then a complete description of the command. A grammar
240
description will be inserted.
243
Other accepted names for this command.
246
List of argument forms, marked with whether they are optional,
250
List of options that may be given for this command.
253
If true, this command isn't advertised. This is typically
254
for commands intended for expert users.
264
"""Construct an instance of this command."""
265
if self.__doc__ == Command.__doc__:
266
warn("No help message set for %r" % self)
269
def run_argv(self, argv):
270
"""Parse command line and run."""
271
args, opts = parse_args(argv)
273
if 'help' in opts: # e.g. bzr add --help
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()))
285
# mix arguments and options into one dictionary
286
cmdargs = _match_argform(self.name(), self.takes_args, args)
288
for k, v in opts.items():
289
cmdopts[k.replace('-', '_')] = v
291
all_cmd_args = cmdargs.copy()
292
all_cmd_args.update(cmdopts)
294
return self.run(**all_cmd_args)
298
"""Actually run the command.
300
This is invoked with the options and arguments bound to
303
Return 0 or None if the command was successful, or a non-zero
304
shell error code if not. It's OK for this method to allow
305
an exception to raise up.
307
raise NotImplementedError()
311
"""Return help message for this class."""
312
if self.__doc__ is Command.__doc__:
317
return _unsquish_command_name(self.__class__.__name__)
320
def parse_spec(spec):
326
>>> parse_spec("../@")
328
>>> parse_spec("../f/@35")
330
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
331
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
336
parsed = spec.split('/@')
337
assert len(parsed) == 2
342
parsed[1] = int(parsed[1])
344
pass # We can allow stuff like ./@revid:blahblahblah
348
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):
393
"""Parse command line.
395
Arguments and options are parsed at this level before being passed
396
down to specific command handlers. This routine knows, from a
397
lookup table, something about the available options, what optargs
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]})
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)
496
def _match_argform(cmd, takes_args, args):
499
# step through args and takes_args, allowing appropriate 0-many matches
500
for ap in takes_args:
504
argdict[argname] = args.pop(0)
505
elif ap[-1] == '*': # all remaining arguments
507
argdict[argname + '_list'] = args[:]
510
argdict[argname + '_list'] = None
513
raise BzrCommandError("command %r needs one or more %s"
514
% (cmd, argname.upper()))
516
argdict[argname + '_list'] = args[:]
518
elif ap[-1] == '$': # all but one
520
raise BzrCommandError("command %r needs one or more %s"
521
% (cmd, argname.upper()))
522
argdict[argname + '_list'] = args[:-1]
528
raise BzrCommandError("command %r requires argument %s"
529
% (cmd, argname.upper()))
531
argdict[argname] = args.pop(0)
534
raise BzrCommandError("extra argument to command %s: %s"
541
def apply_profiled(the_callable, *args, **kwargs):
544
pffileno, pfname = tempfile.mkstemp()
546
prof = hotshot.Profile(pfname)
548
ret = prof.runcall(the_callable, *args, **kwargs) or 0
553
stats = hotshot.stats.load(pfname)
555
stats.sort_stats('time')
556
## XXX: Might like to write to stderr or the trace file instead but
557
## print_stats seems hardcoded to stdout
558
stats.print_stats(20)
567
"""Execute a command.
569
This is similar to main(), but without all the trappings for
570
logging and error handling.
573
The command-line arguments, without the program name from argv[0]
575
Returns a command status or raises an exception.
577
Special master options: these must come before the command because
578
they control how the command is interpreted.
581
Do not load plugin modules at all
584
Only use builtin commands. (Plugins are still allowed to change
588
Run under the Python profiler.
591
argv = [a.decode(bzrlib.user_encoding) for a in argv]
593
opt_profile = opt_no_plugins = opt_builtin = False
595
# --no-plugins is handled specially at a very early stage. We need
596
# to load plugins before doing other command parsing so that they
597
# can override commands, but this needs to happen first.
602
elif a == '--no-plugins':
603
opt_no_plugins = True
604
elif a == '--builtin':
610
if (not argv) or (argv[0] == '--help'):
611
from bzrlib.help import help
618
if argv[0] == '--version':
619
from bzrlib.builtins import show_version
623
if not opt_no_plugins:
624
from bzrlib.plugin import load_plugins
627
cmd = str(argv.pop(0))
629
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
632
ret = apply_profiled(cmd_obj.run_argv, argv)
634
ret = cmd_obj.run_argv(argv)
640
bzrlib.trace.log_startup(argv)
641
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
646
return run_bzr(argv[1:])
648
# do this here inside the exception wrappers to catch EPIPE
650
#wrap common errors as CommandErrors.
651
except (NotBranchError,), e:
652
raise BzrCommandError(str(e))
653
except BzrCommandError, e:
654
# command line syntax error, etc
658
bzrlib.trace.log_exception()
660
except AssertionError, e:
661
bzrlib.trace.log_exception('assertion failed: ' + str(e))
663
except KeyboardInterrupt, e:
664
bzrlib.trace.note('interrupted')
668
if (isinstance(e, IOError)
669
and hasattr(e, 'errno')
670
and e.errno == errno.EPIPE):
671
bzrlib.trace.note('broken pipe')
674
bzrlib.trace.log_exception()
678
if __name__ == '__main__':
679
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
