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.
31
from warnings import warn
32
from inspect import getdoc
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
44
def register_command(cmd):
45
"Utility function to help register a command"
48
if k.startswith("cmd_"):
49
k_unsquished = _unsquish_command_name(k)
52
if not plugin_cmds.has_key(k_unsquished):
53
plugin_cmds[k_unsquished] = cmd
54
mutter('registered plugin command %s', k_unsquished)
56
log_error('Two plugins defined the same command: %r' % k)
57
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
60
def _squish_command_name(cmd):
61
return 'cmd_' + cmd.replace('-', '_')
64
def _unsquish_command_name(cmd):
65
assert cmd.startswith("cmd_")
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
75
It supports integers directly, but everything else it
76
defers for passing to RevisionSpec.
78
>>> _parse_revision_str('234')
80
>>> _parse_revision_str('234..567')
82
>>> _parse_revision_str('..')
84
>>> _parse_revision_str('..234')
86
>>> _parse_revision_str('234..')
88
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
90
>>> _parse_revision_str('234....789') # Error?
92
>>> _parse_revision_str('revid:test@other.com-234234')
93
['revid:test@other.com-234234']
94
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
95
['revid:test@other.com-234234', 'revid:test@other.com-234235']
96
>>> _parse_revision_str('revid:test@other.com-234234..23')
97
['revid:test@other.com-234234', 23]
98
>>> _parse_revision_str('date:2005-04-12')
100
>>> _parse_revision_str('date:2005-04-12 12:24:33')
101
['date:2005-04-12 12:24:33']
102
>>> _parse_revision_str('date:2005-04-12T12:24:33')
103
['date:2005-04-12T12:24:33']
104
>>> _parse_revision_str('date:2005-04-12,12:24:33')
105
['date:2005-04-12,12:24:33']
106
>>> _parse_revision_str('-5..23')
108
>>> _parse_revision_str('-5')
110
>>> _parse_revision_str('123a')
112
>>> _parse_revision_str('abc')
116
old_format_re = re.compile('\d*:\d*')
117
m = old_format_re.match(revstr)
119
warning('Colon separator for revision numbers is deprecated.'
122
for rev in revstr.split(':'):
124
revs.append(int(rev))
129
for x in revstr.split('..'):
140
def get_merge_type(typestring):
141
"""Attempt to find the merge class/factory associated with a string."""
142
from merge import merge_types
144
return merge_types[typestring][0]
146
templ = '%s%%7s: %%s' % (' '*12)
147
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
148
type_list = '\n'.join(lines)
149
msg = "No known merge type %s. Supported types are:\n%s" %\
150
(typestring, type_list)
151
raise BzrCommandError(msg)
154
def get_merge_type(typestring):
155
"""Attempt to find the merge class/factory associated with a string."""
156
from merge import merge_types
158
return merge_types[typestring][0]
160
templ = '%s%%7s: %%s' % (' '*12)
161
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
162
type_list = '\n'.join(lines)
163
msg = "No known merge type %s. Supported types are:\n%s" %\
164
(typestring, type_list)
165
raise BzrCommandError(msg)
168
def _builtin_commands():
169
import bzrlib.builtins
171
builtins = bzrlib.builtins.__dict__
172
for name in builtins:
173
if name.startswith("cmd_"):
174
real_name = _unsquish_command_name(name)
175
r[real_name] = builtins[name]
180
def builtin_command_names():
181
"""Return list of builtin command names."""
182
return _builtin_commands().keys()
185
def plugin_command_names():
186
return plugin_cmds.keys()
189
def _get_cmd_dict(plugins_override=True):
190
"""Return name->class mapping for all commands."""
191
d = _builtin_commands()
193
d.update(plugin_cmds)
197
def get_all_cmds(plugins_override=True):
198
"""Return canonical name and class for all registered commands."""
199
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
203
def get_cmd_object(cmd_name, plugins_override=True):
204
"""Return the canonical name and command class for a command.
207
If true, plugin commands can override builtins.
209
from bzrlib.externalcommand import ExternalCommand
211
cmd_name = str(cmd_name) # not unicode
213
# first look up this command under the specified name
214
cmds = _get_cmd_dict(plugins_override=plugins_override)
216
return cmds[cmd_name]()
220
# look for any command which claims this as an alias
221
for real_cmd_name, cmd_class in cmds.iteritems():
222
if cmd_name in cmd_class.aliases:
225
cmd_obj = ExternalCommand.find_command(cmd_name)
229
raise BzrCommandError("unknown command %r" % cmd_name)
232
class Command(object):
233
"""Base class for commands.
235
Commands are the heart of the command-line bzr interface.
237
The command object mostly handles the mapping of command-line
238
parameters into one or more bzrlib operations, and of the results
241
Commands normally don't have any state. All their arguments are
242
passed in to the run method. (Subclasses may take a different
243
policy if the behaviour of the instance needs to depend on e.g. a
244
shell plugin and not just its Python class.)
246
The docstring for an actual command should give a single-line
247
summary, then a complete description of the command. A grammar
248
description will be inserted.
251
Other accepted names for this command.
254
List of argument forms, marked with whether they are optional,
258
List of options that may be given for this command.
261
If true, this command isn't advertised. This is typically
262
for commands intended for expert users.
272
"""Construct an instance of this command."""
273
if self.__doc__ == Command.__doc__:
274
warn("No help message set for %r" % self)
277
def run_argv(self, argv):
278
"""Parse command line and run."""
279
args, opts = parse_args(argv)
281
if 'help' in opts: # e.g. bzr add --help
282
from bzrlib.help import help_on_command
283
help_on_command(self.name())
286
# check options are reasonable
287
allowed = self.takes_options
289
if oname not in allowed:
290
raise BzrCommandError("option '--%s' is not allowed for command %r"
291
% (oname, self.name()))
293
# mix arguments and options into one dictionary
294
cmdargs = _match_argform(self.name(), self.takes_args, args)
296
for k, v in opts.items():
297
cmdopts[k.replace('-', '_')] = v
299
all_cmd_args = cmdargs.copy()
300
all_cmd_args.update(cmdopts)
302
return self.run(**all_cmd_args)
306
"""Actually run the command.
308
This is invoked with the options and arguments bound to
311
Return 0 or None if the command was successful, or a non-zero
312
shell error code if not. It's OK for this method to allow
313
an exception to raise up.
315
raise NotImplementedError()
319
"""Return help message for this class."""
320
if self.__doc__ is Command.__doc__:
325
return _unsquish_command_name(self.__class__.__name__)
328
def parse_spec(spec):
334
>>> parse_spec("../@")
336
>>> parse_spec("../f/@35")
338
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
339
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
344
parsed = spec.split('/@')
345
assert len(parsed) == 2
350
parsed[1] = int(parsed[1])
352
pass # We can allow stuff like ./@revid:blahblahblah
356
parsed = [spec, None]
362
# list of all available options; the rhs can be either None for an
363
# option that takes no argument, or a constructor function that checks
376
'revision': _parse_revision_str,
388
'merge-type': get_merge_type,
402
def parse_args(argv):
403
"""Parse command line.
405
Arguments and options are parsed at this level before being passed
406
down to specific command handlers. This routine knows, from a
407
lookup table, something about the available options, what optargs
408
they take, and which commands will accept them.
410
>>> parse_args('--help'.split())
412
>>> parse_args('help -- --invalidcmd'.split())
413
(['help', '--invalidcmd'], {})
414
>>> parse_args('--version'.split())
415
([], {'version': True})
416
>>> parse_args('status --all'.split())
417
(['status'], {'all': True})
418
>>> parse_args('commit --message=biter'.split())
419
(['commit'], {'message': u'biter'})
420
>>> parse_args('log -r 500'.split())
421
(['log'], {'revision': [500]})
422
>>> parse_args('log -r500..600'.split())
423
(['log'], {'revision': [500, 600]})
424
>>> parse_args('log -vr500..600'.split())
425
(['log'], {'verbose': True, 'revision': [500, 600]})
426
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
427
(['log'], {'revision': ['v500', 600]})
435
if not argsover and a[0] == '-':
436
# option names must not be unicode
441
# We've received a standalone -- No more flags
444
mutter(" got option %r" % a)
446
optname, optarg = a[2:].split('=', 1)
449
if optname not in OPTIONS:
450
raise BzrError('unknown long option %r' % a)
453
if shortopt in SHORT_OPTIONS:
454
# Multi-character options must have a space to delimit
456
optname = SHORT_OPTIONS[shortopt]
458
# Single character short options, can be chained,
459
# and have their value appended to their name
461
if shortopt not in SHORT_OPTIONS:
462
# We didn't find the multi-character name, and we
463
# didn't find the single char name
464
raise BzrError('unknown short option %r' % a)
465
optname = SHORT_OPTIONS[shortopt]
468
# There are extra things on this option
469
# see if it is the value, or if it is another
471
optargfn = OPTIONS[optname]
473
# This option does not take an argument, so the
474
# next entry is another short option, pack it back
476
argv.insert(0, '-' + a[2:])
478
# This option takes an argument, so pack it
483
# XXX: Do we ever want to support this, e.g. for -r?
484
raise BzrError('repeated option %r' % a)
486
optargfn = OPTIONS[optname]
490
raise BzrError('option %r needs an argument' % a)
493
opts[optname] = optargfn(optarg)
496
raise BzrError('option %r takes no argument' % optname)
506
def _match_argform(cmd, takes_args, args):
509
# step through args and takes_args, allowing appropriate 0-many matches
510
for ap in takes_args:
514
argdict[argname] = args.pop(0)
515
elif ap[-1] == '*': # all remaining arguments
517
argdict[argname + '_list'] = args[:]
520
argdict[argname + '_list'] = None
523
raise BzrCommandError("command %r needs one or more %s"
524
% (cmd, argname.upper()))
526
argdict[argname + '_list'] = args[:]
528
elif ap[-1] == '$': # all but one
530
raise BzrCommandError("command %r needs one or more %s"
531
% (cmd, argname.upper()))
532
argdict[argname + '_list'] = args[:-1]
538
raise BzrCommandError("command %r requires argument %s"
539
% (cmd, argname.upper()))
541
argdict[argname] = args.pop(0)
544
raise BzrCommandError("extra argument to command %s: %s"
551
def apply_profiled(the_callable, *args, **kwargs):
554
pffileno, pfname = tempfile.mkstemp()
556
prof = hotshot.Profile(pfname)
558
ret = prof.runcall(the_callable, *args, **kwargs) or 0
563
stats = hotshot.stats.load(pfname)
565
stats.sort_stats('time')
566
## XXX: Might like to write to stderr or the trace file instead but
567
## print_stats seems hardcoded to stdout
568
stats.print_stats(20)
577
"""Execute a command.
579
This is similar to main(), but without all the trappings for
580
logging and error handling.
583
The command-line arguments, without the program name from argv[0]
585
Returns a command status or raises an exception.
587
Special master options: these must come before the command because
588
they control how the command is interpreted.
591
Do not load plugin modules at all
594
Only use builtin commands. (Plugins are still allowed to change
598
Run under the Python profiler.
601
argv = [a.decode(bzrlib.user_encoding) for a in argv]
603
opt_profile = opt_no_plugins = opt_builtin = False
605
# --no-plugins is handled specially at a very early stage. We need
606
# to load plugins before doing other command parsing so that they
607
# can override commands, but this needs to happen first.
612
elif a == '--no-plugins':
613
opt_no_plugins = True
614
elif a == '--builtin':
620
if (not argv) or (argv[0] == '--help'):
621
from bzrlib.help import help
628
if argv[0] == '--version':
629
from bzrlib.builtins import show_version
633
if not opt_no_plugins:
634
from bzrlib.plugin import load_plugins
637
cmd = str(argv.pop(0))
639
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
642
ret = apply_profiled(cmd_obj.run_argv, argv)
644
ret = cmd_obj.run_argv(argv)
650
bzrlib.trace.log_startup(argv)
651
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
655
return run_bzr(argv[1:])
657
# do this here inside the exception wrappers to catch EPIPE
659
except BzrCommandError, e:
660
# command line syntax error, etc
664
bzrlib.trace.log_exception()
666
except AssertionError, e:
667
bzrlib.trace.log_exception('assertion failed: ' + str(e))
669
except KeyboardInterrupt, e:
670
bzrlib.trace.note('interrupted')
674
if (isinstance(e, IOError)
675
and hasattr(e, 'errno')
676
and e.errno == errno.EPIPE):
677
bzrlib.trace.note('broken pipe')
680
bzrlib.trace.log_exception()
684
if __name__ == '__main__':
685
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
