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.revisionspec import RevisionSpec
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
82
>>> _parse_revision_str('234')
83
[<RevisionSpec_int 234>]
84
>>> _parse_revision_str('234..567')
85
[<RevisionSpec_int 234>, <RevisionSpec_int 567>]
86
>>> _parse_revision_str('..')
87
[<RevisionSpec None>, <RevisionSpec None>]
88
>>> _parse_revision_str('..234')
89
[<RevisionSpec None>, <RevisionSpec_int 234>]
90
>>> _parse_revision_str('234..')
91
[<RevisionSpec_int 234>, <RevisionSpec None>]
92
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
93
[<RevisionSpec_int 234>, <RevisionSpec_int 456>, <RevisionSpec_int 789>]
94
>>> _parse_revision_str('234....789') # Error?
95
[<RevisionSpec_int 234>, <RevisionSpec None>, <RevisionSpec_int 789>]
96
>>> _parse_revision_str('revid:test@other.com-234234')
97
[<RevisionSpec_revid revid:test@other.com-234234>]
98
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
99
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
100
>>> _parse_revision_str('revid:test@other.com-234234..23')
101
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_int 23>]
102
>>> _parse_revision_str('date:2005-04-12')
103
[<RevisionSpec_date date:2005-04-12>]
104
>>> _parse_revision_str('date:2005-04-12 12:24:33')
105
[<RevisionSpec_date date:2005-04-12 12:24:33>]
106
>>> _parse_revision_str('date:2005-04-12T12:24:33')
107
[<RevisionSpec_date date:2005-04-12T12:24:33>]
108
>>> _parse_revision_str('date:2005-04-12,12:24:33')
109
[<RevisionSpec_date date:2005-04-12,12:24:33>]
110
>>> _parse_revision_str('-5..23')
111
[<RevisionSpec_int -5>, <RevisionSpec_int 23>]
112
>>> _parse_revision_str('-5')
113
[<RevisionSpec_int -5>]
114
>>> _parse_revision_str('123a')
115
Traceback (most recent call last):
117
BzrError: No namespace registered for string: '123a'
118
>>> _parse_revision_str('abc')
119
Traceback (most recent call last):
121
BzrError: No namespace registered for string: 'abc'
124
old_format_re = re.compile('\d*:\d*')
125
m = old_format_re.match(revstr)
128
warning('Colon separator for revision numbers is deprecated.'
130
for rev in revstr.split(':'):
132
revs.append(RevisionSpec(int(rev)))
134
revs.append(RevisionSpec(None))
136
for x in revstr.split('..'):
138
revs.append(RevisionSpec(None))
140
revs.append(RevisionSpec(x))
144
def _builtin_commands():
145
import bzrlib.builtins
147
builtins = bzrlib.builtins.__dict__
148
for name in builtins:
149
if name.startswith("cmd_"):
150
real_name = _unsquish_command_name(name)
151
r[real_name] = builtins[name]
156
def builtin_command_names():
157
"""Return list of builtin command names."""
158
return _builtin_commands().keys()
161
def plugin_command_names():
162
return plugin_cmds.keys()
165
def _get_cmd_dict(plugins_override=True):
166
"""Return name->class mapping for all commands."""
167
d = _builtin_commands()
169
d.update(plugin_cmds)
173
def get_all_cmds(plugins_override=True):
174
"""Return canonical name and class for all registered commands."""
175
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
179
def get_cmd_object(cmd_name, plugins_override=True):
180
"""Return the canonical name and command class for a command.
183
If true, plugin commands can override builtins.
185
from bzrlib.externalcommand import ExternalCommand
187
cmd_name = str(cmd_name) # not unicode
189
# first look up this command under the specified name
190
cmds = _get_cmd_dict(plugins_override=plugins_override)
192
return cmds[cmd_name]()
196
# look for any command which claims this as an alias
197
for real_cmd_name, cmd_class in cmds.iteritems():
198
if cmd_name in cmd_class.aliases:
201
cmd_obj = ExternalCommand.find_command(cmd_name)
205
raise BzrCommandError("unknown command %r" % cmd_name)
208
class Command(object):
209
"""Base class for commands.
211
Commands are the heart of the command-line bzr interface.
213
The command object mostly handles the mapping of command-line
214
parameters into one or more bzrlib operations, and of the results
217
Commands normally don't have any state. All their arguments are
218
passed in to the run method. (Subclasses may take a different
219
policy if the behaviour of the instance needs to depend on e.g. a
220
shell plugin and not just its Python class.)
222
The docstring for an actual command should give a single-line
223
summary, then a complete description of the command. A grammar
224
description will be inserted.
227
Other accepted names for this command.
230
List of argument forms, marked with whether they are optional,
234
List of options that may be given for this command.
237
If true, this command isn't advertised. This is typically
238
for commands intended for expert users.
248
"""Construct an instance of this command."""
249
if self.__doc__ == Command.__doc__:
250
warn("No help message set for %r" % self)
253
def run_argv(self, argv):
254
"""Parse command line and run."""
255
args, opts = parse_args(argv)
257
if 'help' in opts: # e.g. bzr add --help
258
from bzrlib.help import help_on_command
259
help_on_command(self.name())
262
# check options are reasonable
263
allowed = self.takes_options
265
if oname not in allowed:
266
raise BzrCommandError("option '--%s' is not allowed for command %r"
267
% (oname, self.name()))
269
# mix arguments and options into one dictionary
270
cmdargs = _match_argform(self.name(), self.takes_args, args)
272
for k, v in opts.items():
273
cmdopts[k.replace('-', '_')] = v
275
all_cmd_args = cmdargs.copy()
276
all_cmd_args.update(cmdopts)
278
return self.run(**all_cmd_args)
282
"""Actually run the command.
284
This is invoked with the options and arguments bound to
287
Return 0 or None if the command was successful, or a non-zero
288
shell error code if not. It's OK for this method to allow
289
an exception to raise up.
291
raise NotImplementedError()
295
"""Return help message for this class."""
296
if self.__doc__ is Command.__doc__:
301
return _unsquish_command_name(self.__class__.__name__)
304
def parse_spec(spec):
310
>>> parse_spec("../@")
312
>>> parse_spec("../f/@35")
314
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
315
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
320
parsed = spec.split('/@')
321
assert len(parsed) == 2
326
parsed[1] = int(parsed[1])
328
pass # We can allow stuff like ./@revid:blahblahblah
332
parsed = [spec, None]
336
# list of all available options; the rhs can be either None for an
337
# option that takes no argument, or a constructor function that checks
350
'revision': _parse_revision_str,
375
def parse_args(argv):
376
"""Parse command line.
378
Arguments and options are parsed at this level before being passed
379
down to specific command handlers. This routine knows, from a
380
lookup table, something about the available options, what optargs
381
they take, and which commands will accept them.
383
>>> parse_args('--help'.split())
385
>>> parse_args('help -- --invalidcmd'.split())
386
(['help', '--invalidcmd'], {})
387
>>> parse_args('--version'.split())
388
([], {'version': True})
389
>>> parse_args('status --all'.split())
390
(['status'], {'all': True})
391
>>> parse_args('commit --message=biter'.split())
392
(['commit'], {'message': u'biter'})
393
>>> parse_args('log -r 500'.split())
394
(['log'], {'revision': [<RevisionSpec_int 500>]})
395
>>> parse_args('log -r500..600'.split())
396
(['log'], {'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
397
>>> parse_args('log -vr500..600'.split())
398
(['log'], {'verbose': True, 'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
399
>>> parse_args('log -rrevno:500..600'.split()) #the r takes an argument
400
(['log'], {'revision': [<RevisionSpec_revno revno:500>, <RevisionSpec_int 600>]})
408
if not argsover and a[0] == '-':
409
# option names must not be unicode
414
# We've received a standalone -- No more flags
417
mutter(" got option %r" % a)
419
optname, optarg = a[2:].split('=', 1)
422
if optname not in OPTIONS:
423
raise BzrError('unknown long option %r' % a)
426
if shortopt in SHORT_OPTIONS:
427
# Multi-character options must have a space to delimit
429
optname = SHORT_OPTIONS[shortopt]
431
# Single character short options, can be chained,
432
# and have their value appended to their name
434
if shortopt not in SHORT_OPTIONS:
435
# We didn't find the multi-character name, and we
436
# didn't find the single char name
437
raise BzrError('unknown short option %r' % a)
438
optname = SHORT_OPTIONS[shortopt]
441
# There are extra things on this option
442
# see if it is the value, or if it is another
444
optargfn = OPTIONS[optname]
446
# This option does not take an argument, so the
447
# next entry is another short option, pack it back
449
argv.insert(0, '-' + a[2:])
451
# This option takes an argument, so pack it
456
# XXX: Do we ever want to support this, e.g. for -r?
457
raise BzrError('repeated option %r' % a)
459
optargfn = OPTIONS[optname]
463
raise BzrError('option %r needs an argument' % a)
466
opts[optname] = optargfn(optarg)
469
raise BzrError('option %r takes no argument' % optname)
479
def _match_argform(cmd, takes_args, args):
482
# step through args and takes_args, allowing appropriate 0-many matches
483
for ap in takes_args:
487
argdict[argname] = args.pop(0)
488
elif ap[-1] == '*': # all remaining arguments
490
argdict[argname + '_list'] = args[:]
493
argdict[argname + '_list'] = None
496
raise BzrCommandError("command %r needs one or more %s"
497
% (cmd, argname.upper()))
499
argdict[argname + '_list'] = args[:]
501
elif ap[-1] == '$': # all but one
503
raise BzrCommandError("command %r needs one or more %s"
504
% (cmd, argname.upper()))
505
argdict[argname + '_list'] = args[:-1]
511
raise BzrCommandError("command %r requires argument %s"
512
% (cmd, argname.upper()))
514
argdict[argname] = args.pop(0)
517
raise BzrCommandError("extra argument to command %s: %s"
524
def apply_profiled(the_callable, *args, **kwargs):
527
pffileno, pfname = tempfile.mkstemp()
529
prof = hotshot.Profile(pfname)
531
ret = prof.runcall(the_callable, *args, **kwargs) or 0
536
stats = hotshot.stats.load(pfname)
538
stats.sort_stats('time')
539
## XXX: Might like to write to stderr or the trace file instead but
540
## print_stats seems hardcoded to stdout
541
stats.print_stats(20)
550
"""Execute a command.
552
This is similar to main(), but without all the trappings for
553
logging and error handling.
556
The command-line arguments, without the program name from argv[0]
558
Returns a command status or raises an exception.
560
Special master options: these must come before the command because
561
they control how the command is interpreted.
564
Do not load plugin modules at all
567
Only use builtin commands. (Plugins are still allowed to change
571
Run under the Python profiler.
574
argv = [a.decode(bzrlib.user_encoding) for a in argv]
576
opt_profile = opt_no_plugins = opt_builtin = False
578
# --no-plugins is handled specially at a very early stage. We need
579
# to load plugins before doing other command parsing so that they
580
# can override commands, but this needs to happen first.
585
elif a == '--no-plugins':
586
opt_no_plugins = True
587
elif a == '--builtin':
593
if (not argv) or (argv[0] == '--help'):
594
from bzrlib.help import help
601
if argv[0] == '--version':
602
from bzrlib.builtins import show_version
606
if not opt_no_plugins:
607
from bzrlib.plugin import load_plugins
610
cmd = str(argv.pop(0))
612
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
615
ret = apply_profiled(cmd_obj.run_argv, argv)
617
ret = cmd_obj.run_argv(argv)
623
bzrlib.trace.log_startup(argv)
624
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
626
return run_bzr_catch_errors(argv[1:])
629
def run_bzr_catch_errors(argv):
635
# do this here inside the exception wrappers to catch EPIPE
637
#wrap common errors as CommandErrors.
638
except (NotBranchError,), e:
639
raise BzrCommandError(str(e))
640
except BzrCommandError, e:
641
# command line syntax error, etc
645
bzrlib.trace.log_exception()
647
except AssertionError, e:
648
bzrlib.trace.log_exception('assertion failed: ' + str(e))
650
except KeyboardInterrupt, e:
651
bzrlib.trace.log_exception('interrupted')
655
if (isinstance(e, IOError)
656
and hasattr(e, 'errno')
657
and e.errno == errno.EPIPE):
658
bzrlib.trace.note('broken pipe')
661
bzrlib.trace.log_exception()
665
if __name__ == '__main__':
666
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
