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.
27
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
28
# the profile output behind so it can be interactively examined?
32
from warnings import warn
33
from inspect import getdoc
37
from bzrlib.trace import mutter, note, log_error, warning
38
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
39
from bzrlib.revisionspec import RevisionSpec
40
from bzrlib import BZRDIR
45
def register_command(cmd):
46
"Utility function to help register a command"
49
if k.startswith("cmd_"):
50
k_unsquished = _unsquish_command_name(k)
53
if not plugin_cmds.has_key(k_unsquished):
54
plugin_cmds[k_unsquished] = cmd
55
mutter('registered plugin command %s', k_unsquished)
57
log_error('Two plugins defined the same command: %r' % k)
58
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
61
def _squish_command_name(cmd):
62
return 'cmd_' + cmd.replace('-', '_')
65
def _unsquish_command_name(cmd):
66
assert cmd.startswith("cmd_")
67
return cmd[4:].replace('_','-')
70
def _parse_revision_str(revstr):
71
"""This handles a revision string -> revno.
73
This always returns a list. The list will have one element for
74
each revision specifier supplied.
76
>>> _parse_revision_str('234')
77
[<RevisionSpec_int 234>]
78
>>> _parse_revision_str('234..567')
79
[<RevisionSpec_int 234>, <RevisionSpec_int 567>]
80
>>> _parse_revision_str('..')
81
[<RevisionSpec None>, <RevisionSpec None>]
82
>>> _parse_revision_str('..234')
83
[<RevisionSpec None>, <RevisionSpec_int 234>]
84
>>> _parse_revision_str('234..')
85
[<RevisionSpec_int 234>, <RevisionSpec None>]
86
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
87
[<RevisionSpec_int 234>, <RevisionSpec_int 456>, <RevisionSpec_int 789>]
88
>>> _parse_revision_str('234....789') #Error ?
89
[<RevisionSpec_int 234>, <RevisionSpec None>, <RevisionSpec_int 789>]
90
>>> _parse_revision_str('revid:test@other.com-234234')
91
[<RevisionSpec_revid revid:test@other.com-234234>]
92
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
93
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
94
>>> _parse_revision_str('revid:test@other.com-234234..23')
95
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_int 23>]
96
>>> _parse_revision_str('date:2005-04-12')
97
[<RevisionSpec_date date:2005-04-12>]
98
>>> _parse_revision_str('date:2005-04-12 12:24:33')
99
[<RevisionSpec_date date:2005-04-12 12:24:33>]
100
>>> _parse_revision_str('date:2005-04-12T12:24:33')
101
[<RevisionSpec_date date:2005-04-12T12:24:33>]
102
>>> _parse_revision_str('date:2005-04-12,12:24:33')
103
[<RevisionSpec_date date:2005-04-12,12:24:33>]
104
>>> _parse_revision_str('-5..23')
105
[<RevisionSpec_int -5>, <RevisionSpec_int 23>]
106
>>> _parse_revision_str('-5')
107
[<RevisionSpec_int -5>]
108
>>> _parse_revision_str('123a')
109
Traceback (most recent call last):
111
BzrError: No namespace registered for string: '123a'
112
>>> _parse_revision_str('abc')
113
Traceback (most recent call last):
115
BzrError: No namespace registered for string: 'abc'
116
>>> _parse_revision_str('branch:../branch2')
117
[<RevisionSpec_branch branch:../branch2>]
120
old_format_re = re.compile('\d*:\d*')
121
m = old_format_re.match(revstr)
124
warning('Colon separator for revision numbers is deprecated.'
126
for rev in revstr.split(':'):
128
revs.append(RevisionSpec(int(rev)))
130
revs.append(RevisionSpec(None))
133
for x in revstr.split('..'):
135
revs.append(RevisionSpec(None))
137
# looks like a namespace:.. has happened
138
next_prefix = x + '..'
140
if next_prefix is not None:
142
revs.append(RevisionSpec(x))
144
if next_prefix is not None:
145
revs.append(RevisionSpec(next_prefix))
149
def _builtin_commands():
150
import bzrlib.builtins
152
builtins = bzrlib.builtins.__dict__
153
for name in builtins:
154
if name.startswith("cmd_"):
155
real_name = _unsquish_command_name(name)
156
r[real_name] = builtins[name]
161
def builtin_command_names():
162
"""Return list of builtin command names."""
163
return _builtin_commands().keys()
166
def plugin_command_names():
167
return plugin_cmds.keys()
170
def _get_cmd_dict(plugins_override=True):
171
"""Return name->class mapping for all commands."""
172
d = _builtin_commands()
174
d.update(plugin_cmds)
178
def get_all_cmds(plugins_override=True):
179
"""Return canonical name and class for all registered commands."""
180
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
184
def get_cmd_object(cmd_name, plugins_override=True):
185
"""Return the canonical name and command class for a command.
188
If true, plugin commands can override builtins.
190
from bzrlib.externalcommand import ExternalCommand
192
cmd_name = str(cmd_name) # not unicode
194
# first look up this command under the specified name
195
cmds = _get_cmd_dict(plugins_override=plugins_override)
197
return cmds[cmd_name]()
201
# look for any command which claims this as an alias
202
for real_cmd_name, cmd_class in cmds.iteritems():
203
if cmd_name in cmd_class.aliases:
206
cmd_obj = ExternalCommand.find_command(cmd_name)
210
raise BzrCommandError("unknown command %r" % cmd_name)
213
class Command(object):
214
"""Base class for commands.
216
Commands are the heart of the command-line bzr interface.
218
The command object mostly handles the mapping of command-line
219
parameters into one or more bzrlib operations, and of the results
222
Commands normally don't have any state. All their arguments are
223
passed in to the run method. (Subclasses may take a different
224
policy if the behaviour of the instance needs to depend on e.g. a
225
shell plugin and not just its Python class.)
227
The docstring for an actual command should give a single-line
228
summary, then a complete description of the command. A grammar
229
description will be inserted.
232
Other accepted names for this command.
235
List of argument forms, marked with whether they are optional,
239
List of options that may be given for this command.
242
If true, this command isn't advertised. This is typically
243
for commands intended for expert users.
253
"""Construct an instance of this command."""
254
if self.__doc__ == Command.__doc__:
255
warn("No help message set for %r" % self)
258
def run_argv(self, argv):
259
"""Parse command line and run."""
260
args, opts = parse_args(argv)
262
if 'help' in opts: # e.g. bzr add --help
263
from bzrlib.help import help_on_command
264
help_on_command(self.name())
267
# check options are reasonable
268
allowed = self.takes_options
270
if oname not in allowed:
271
raise BzrCommandError("option '--%s' is not allowed for command %r"
272
% (oname, self.name()))
274
# mix arguments and options into one dictionary
275
cmdargs = _match_argform(self.name(), self.takes_args, args)
277
for k, v in opts.items():
278
cmdopts[k.replace('-', '_')] = v
280
all_cmd_args = cmdargs.copy()
281
all_cmd_args.update(cmdopts)
283
return self.run(**all_cmd_args)
287
"""Actually run the command.
289
This is invoked with the options and arguments bound to
292
Return 0 or None if the command was successful, or a non-zero
293
shell error code if not. It's OK for this method to allow
294
an exception to raise up.
296
raise NotImplementedError()
300
"""Return help message for this class."""
301
if self.__doc__ is Command.__doc__:
306
return _unsquish_command_name(self.__class__.__name__)
309
def parse_spec(spec):
315
>>> parse_spec("../@")
317
>>> parse_spec("../f/@35")
319
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
320
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
325
parsed = spec.split('/@')
326
assert len(parsed) == 2
331
parsed[1] = int(parsed[1])
333
pass # We can allow stuff like ./@revid:blahblahblah
337
parsed = [spec, None]
341
# list of all available options; the rhs can be either None for an
342
# option that takes no argument, or a constructor function that checks
356
'revision': _parse_revision_str,
382
def parse_args(argv):
383
"""Parse command line.
385
Arguments and options are parsed at this level before being passed
386
down to specific command handlers. This routine knows, from a
387
lookup table, something about the available options, what optargs
388
they take, and which commands will accept them.
390
>>> parse_args('--help'.split())
392
>>> parse_args('help -- --invalidcmd'.split())
393
(['help', '--invalidcmd'], {})
394
>>> parse_args('--version'.split())
395
([], {'version': True})
396
>>> parse_args('status --all'.split())
397
(['status'], {'all': True})
398
>>> parse_args('commit --message=biter'.split())
399
(['commit'], {'message': u'biter'})
400
>>> parse_args('log -r 500'.split())
401
(['log'], {'revision': [<RevisionSpec_int 500>]})
402
>>> parse_args('log -r500..600'.split())
403
(['log'], {'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
404
>>> parse_args('log -vr500..600'.split())
405
(['log'], {'verbose': True, 'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
406
>>> parse_args('log -rrevno:500..600'.split()) #the r takes an argument
407
(['log'], {'revision': [<RevisionSpec_revno revno:500>, <RevisionSpec_int 600>]})
415
if not argsover and a[0] == '-':
416
# option names must not be unicode
421
# We've received a standalone -- No more flags
424
mutter(" got option %r" % a)
426
optname, optarg = a[2:].split('=', 1)
429
if optname not in OPTIONS:
430
raise BzrError('unknown long option %r' % a)
433
if shortopt in SHORT_OPTIONS:
434
# Multi-character options must have a space to delimit
436
optname = SHORT_OPTIONS[shortopt]
438
# Single character short options, can be chained,
439
# and have their value appended to their name
441
if shortopt not in SHORT_OPTIONS:
442
# We didn't find the multi-character name, and we
443
# didn't find the single char name
444
raise BzrError('unknown short option %r' % a)
445
optname = SHORT_OPTIONS[shortopt]
448
# There are extra things on this option
449
# see if it is the value, or if it is another
451
optargfn = OPTIONS[optname]
453
# This option does not take an argument, so the
454
# next entry is another short option, pack it back
456
argv.insert(0, '-' + a[2:])
458
# This option takes an argument, so pack it
463
# XXX: Do we ever want to support this, e.g. for -r?
464
raise BzrError('repeated option %r' % a)
466
optargfn = OPTIONS[optname]
470
raise BzrError('option %r needs an argument' % a)
473
opts[optname] = optargfn(optarg)
476
raise BzrError('option %r takes no argument' % optname)
486
def _match_argform(cmd, takes_args, args):
489
# step through args and takes_args, allowing appropriate 0-many matches
490
for ap in takes_args:
494
argdict[argname] = args.pop(0)
495
elif ap[-1] == '*': # all remaining arguments
497
argdict[argname + '_list'] = args[:]
500
argdict[argname + '_list'] = None
503
raise BzrCommandError("command %r needs one or more %s"
504
% (cmd, argname.upper()))
506
argdict[argname + '_list'] = args[:]
508
elif ap[-1] == '$': # all but one
510
raise BzrCommandError("command %r needs one or more %s"
511
% (cmd, argname.upper()))
512
argdict[argname + '_list'] = args[:-1]
518
raise BzrCommandError("command %r requires argument %s"
519
% (cmd, argname.upper()))
521
argdict[argname] = args.pop(0)
524
raise BzrCommandError("extra argument to command %s: %s"
531
def apply_profiled(the_callable, *args, **kwargs):
535
pffileno, pfname = tempfile.mkstemp()
537
prof = hotshot.Profile(pfname)
539
ret = prof.runcall(the_callable, *args, **kwargs) or 0
542
stats = hotshot.stats.load(pfname)
544
stats.sort_stats('cum') # 'time'
545
## XXX: Might like to write to stderr or the trace file instead but
546
## print_stats seems hardcoded to stdout
547
stats.print_stats(20)
555
"""Execute a command.
557
This is similar to main(), but without all the trappings for
558
logging and error handling.
561
The command-line arguments, without the program name from argv[0]
563
Returns a command status or raises an exception.
565
Special master options: these must come before the command because
566
they control how the command is interpreted.
569
Do not load plugin modules at all
572
Only use builtin commands. (Plugins are still allowed to change
576
Run under the Python profiler.
578
# Load all of the transport methods
579
import bzrlib.transport.local, bzrlib.transport.http
581
argv = [a.decode(bzrlib.user_encoding) for a in argv]
583
opt_profile = opt_no_plugins = opt_builtin = False
585
# --no-plugins is handled specially at a very early stage. We need
586
# to load plugins before doing other command parsing so that they
587
# can override commands, but this needs to happen first.
592
elif a == '--no-plugins':
593
opt_no_plugins = True
594
elif a == '--builtin':
600
if (not argv) or (argv[0] == '--help'):
601
from bzrlib.help import help
608
if argv[0] == '--version':
609
from bzrlib.builtins import show_version
613
if not opt_no_plugins:
614
from bzrlib.plugin import load_plugins
617
cmd = str(argv.pop(0))
619
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
622
ret = apply_profiled(cmd_obj.run_argv, argv)
624
ret = cmd_obj.run_argv(argv)
630
bzrlib.trace.log_startup(argv)
631
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
633
return run_bzr_catch_errors(argv[1:])
636
def run_bzr_catch_errors(argv):
641
# do this here inside the exception wrappers to catch EPIPE
643
except BzrCommandError, e:
644
# command line syntax error, etc
648
bzrlib.trace.log_exception()
650
except AssertionError, e:
651
bzrlib.trace.log_exception('assertion failed: ' + str(e))
653
except KeyboardInterrupt, e:
654
bzrlib.trace.log_exception('interrupted')
658
if (isinstance(e, IOError)
659
and hasattr(e, 'errno')
660
and e.errno == errno.EPIPE):
661
bzrlib.trace.note('broken pipe')
666
bzrlib.trace.log_exception()
669
if __name__ == '__main__':
670
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
