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
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'
118
old_format_re = re.compile('\d*:\d*')
119
m = old_format_re.match(revstr)
122
warning('Colon separator for revision numbers is deprecated.'
124
for rev in revstr.split(':'):
126
revs.append(RevisionSpec(int(rev)))
128
revs.append(RevisionSpec(None))
130
for x in revstr.split('..'):
132
revs.append(RevisionSpec(None))
134
revs.append(RevisionSpec(x))
138
def _builtin_commands():
139
import bzrlib.builtins
141
builtins = bzrlib.builtins.__dict__
142
for name in builtins:
143
if name.startswith("cmd_"):
144
real_name = _unsquish_command_name(name)
145
r[real_name] = builtins[name]
150
def builtin_command_names():
151
"""Return list of builtin command names."""
152
return _builtin_commands().keys()
155
def plugin_command_names():
156
return plugin_cmds.keys()
159
def _get_cmd_dict(plugins_override=True):
160
"""Return name->class mapping for all commands."""
161
d = _builtin_commands()
163
d.update(plugin_cmds)
167
def get_all_cmds(plugins_override=True):
168
"""Return canonical name and class for all registered commands."""
169
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
173
def get_cmd_object(cmd_name, plugins_override=True):
174
"""Return the canonical name and command class for a command.
177
If true, plugin commands can override builtins.
179
from bzrlib.externalcommand import ExternalCommand
181
cmd_name = str(cmd_name) # not unicode
183
# first look up this command under the specified name
184
cmds = _get_cmd_dict(plugins_override=plugins_override)
186
return cmds[cmd_name]()
190
# look for any command which claims this as an alias
191
for real_cmd_name, cmd_class in cmds.iteritems():
192
if cmd_name in cmd_class.aliases:
195
cmd_obj = ExternalCommand.find_command(cmd_name)
199
raise BzrCommandError("unknown command %r" % cmd_name)
202
class Command(object):
203
"""Base class for commands.
205
Commands are the heart of the command-line bzr interface.
207
The command object mostly handles the mapping of command-line
208
parameters into one or more bzrlib operations, and of the results
211
Commands normally don't have any state. All their arguments are
212
passed in to the run method. (Subclasses may take a different
213
policy if the behaviour of the instance needs to depend on e.g. a
214
shell plugin and not just its Python class.)
216
The docstring for an actual command should give a single-line
217
summary, then a complete description of the command. A grammar
218
description will be inserted.
221
Other accepted names for this command.
224
List of argument forms, marked with whether they are optional,
228
List of options that may be given for this command.
231
If true, this command isn't advertised. This is typically
232
for commands intended for expert users.
242
"""Construct an instance of this command."""
243
if self.__doc__ == Command.__doc__:
244
warn("No help message set for %r" % self)
247
def run_argv(self, argv):
248
"""Parse command line and run."""
249
args, opts = parse_args(argv)
251
if 'help' in opts: # e.g. bzr add --help
252
from bzrlib.help import help_on_command
253
help_on_command(self.name())
256
# check options are reasonable
257
allowed = self.takes_options
259
if oname not in allowed:
260
raise BzrCommandError("option '--%s' is not allowed for command %r"
261
% (oname, self.name()))
263
# mix arguments and options into one dictionary
264
cmdargs = _match_argform(self.name(), self.takes_args, args)
266
for k, v in opts.items():
267
cmdopts[k.replace('-', '_')] = v
269
all_cmd_args = cmdargs.copy()
270
all_cmd_args.update(cmdopts)
272
return self.run(**all_cmd_args)
276
"""Actually run the command.
278
This is invoked with the options and arguments bound to
281
Return 0 or None if the command was successful, or a non-zero
282
shell error code if not. It's OK for this method to allow
283
an exception to raise up.
285
raise NotImplementedError()
289
"""Return help message for this class."""
290
if self.__doc__ is Command.__doc__:
295
return _unsquish_command_name(self.__class__.__name__)
298
def parse_spec(spec):
304
>>> parse_spec("../@")
306
>>> parse_spec("../f/@35")
308
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
309
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
314
parsed = spec.split('/@')
315
assert len(parsed) == 2
320
parsed[1] = int(parsed[1])
322
pass # We can allow stuff like ./@revid:blahblahblah
326
parsed = [spec, None]
330
# list of all available options; the rhs can be either None for an
331
# option that takes no argument, or a constructor function that checks
345
'revision': _parse_revision_str,
370
def parse_args(argv):
371
"""Parse command line.
373
Arguments and options are parsed at this level before being passed
374
down to specific command handlers. This routine knows, from a
375
lookup table, something about the available options, what optargs
376
they take, and which commands will accept them.
378
>>> parse_args('--help'.split())
380
>>> parse_args('help -- --invalidcmd'.split())
381
(['help', '--invalidcmd'], {})
382
>>> parse_args('--version'.split())
383
([], {'version': True})
384
>>> parse_args('status --all'.split())
385
(['status'], {'all': True})
386
>>> parse_args('commit --message=biter'.split())
387
(['commit'], {'message': u'biter'})
388
>>> parse_args('log -r 500'.split())
389
(['log'], {'revision': [<RevisionSpec_int 500>]})
390
>>> parse_args('log -r500..600'.split())
391
(['log'], {'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
392
>>> parse_args('log -vr500..600'.split())
393
(['log'], {'verbose': True, 'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
394
>>> parse_args('log -rrevno:500..600'.split()) #the r takes an argument
395
(['log'], {'revision': [<RevisionSpec_revno revno:500>, <RevisionSpec_int 600>]})
403
if not argsover and a[0] == '-':
404
# option names must not be unicode
409
# We've received a standalone -- No more flags
412
mutter(" got option %r" % a)
414
optname, optarg = a[2:].split('=', 1)
417
if optname not in OPTIONS:
418
raise BzrError('unknown long option %r' % a)
421
if shortopt in SHORT_OPTIONS:
422
# Multi-character options must have a space to delimit
424
optname = SHORT_OPTIONS[shortopt]
426
# Single character short options, can be chained,
427
# and have their value appended to their name
429
if shortopt not in SHORT_OPTIONS:
430
# We didn't find the multi-character name, and we
431
# didn't find the single char name
432
raise BzrError('unknown short option %r' % a)
433
optname = SHORT_OPTIONS[shortopt]
436
# There are extra things on this option
437
# see if it is the value, or if it is another
439
optargfn = OPTIONS[optname]
441
# This option does not take an argument, so the
442
# next entry is another short option, pack it back
444
argv.insert(0, '-' + a[2:])
446
# This option takes an argument, so pack it
451
# XXX: Do we ever want to support this, e.g. for -r?
452
raise BzrError('repeated option %r' % a)
454
optargfn = OPTIONS[optname]
458
raise BzrError('option %r needs an argument' % a)
461
opts[optname] = optargfn(optarg)
464
raise BzrError('option %r takes no argument' % optname)
474
def _match_argform(cmd, takes_args, args):
477
# step through args and takes_args, allowing appropriate 0-many matches
478
for ap in takes_args:
482
argdict[argname] = args.pop(0)
483
elif ap[-1] == '*': # all remaining arguments
485
argdict[argname + '_list'] = args[:]
488
argdict[argname + '_list'] = None
491
raise BzrCommandError("command %r needs one or more %s"
492
% (cmd, argname.upper()))
494
argdict[argname + '_list'] = args[:]
496
elif ap[-1] == '$': # all but one
498
raise BzrCommandError("command %r needs one or more %s"
499
% (cmd, argname.upper()))
500
argdict[argname + '_list'] = args[:-1]
506
raise BzrCommandError("command %r requires argument %s"
507
% (cmd, argname.upper()))
509
argdict[argname] = args.pop(0)
512
raise BzrCommandError("extra argument to command %s: %s"
519
def apply_profiled(the_callable, *args, **kwargs):
523
pffileno, pfname = tempfile.mkstemp()
525
prof = hotshot.Profile(pfname)
527
ret = prof.runcall(the_callable, *args, **kwargs) or 0
530
stats = hotshot.stats.load(pfname)
532
stats.sort_stats('cum') # 'time'
533
## XXX: Might like to write to stderr or the trace file instead but
534
## print_stats seems hardcoded to stdout
535
stats.print_stats(20)
543
"""Execute a command.
545
This is similar to main(), but without all the trappings for
546
logging and error handling.
549
The command-line arguments, without the program name from argv[0]
551
Returns a command status or raises an exception.
553
Special master options: these must come before the command because
554
they control how the command is interpreted.
557
Do not load plugin modules at all
560
Only use builtin commands. (Plugins are still allowed to change
564
Run under the Python profiler.
566
# Load all of the transport methods
567
import bzrlib.transport.local, bzrlib.transport.http
569
argv = [a.decode(bzrlib.user_encoding) for a in argv]
571
opt_profile = opt_no_plugins = opt_builtin = False
573
# --no-plugins is handled specially at a very early stage. We need
574
# to load plugins before doing other command parsing so that they
575
# can override commands, but this needs to happen first.
580
elif a == '--no-plugins':
581
opt_no_plugins = True
582
elif a == '--builtin':
588
if (not argv) or (argv[0] == '--help'):
589
from bzrlib.help import help
596
if argv[0] == '--version':
597
from bzrlib.builtins import show_version
601
if not opt_no_plugins:
602
from bzrlib.plugin import load_plugins
605
cmd = str(argv.pop(0))
607
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
610
ret = apply_profiled(cmd_obj.run_argv, argv)
612
ret = cmd_obj.run_argv(argv)
618
bzrlib.trace.log_startup(argv)
619
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
621
return run_bzr_catch_errors(argv[1:])
624
def run_bzr_catch_errors(argv):
630
# do this here inside the exception wrappers to catch EPIPE
632
#wrap common errors as CommandErrors.
633
except (NotBranchError,), e:
634
raise BzrCommandError(str(e))
635
except BzrCommandError, e:
636
# command line syntax error, etc
640
bzrlib.trace.log_exception()
642
except AssertionError, e:
643
bzrlib.trace.log_exception('assertion failed: ' + str(e))
645
except KeyboardInterrupt, e:
646
bzrlib.trace.log_exception('interrupted')
650
if (isinstance(e, IOError)
651
and hasattr(e, 'errno')
652
and e.errno == errno.EPIPE):
653
bzrlib.trace.note('broken pipe')
656
bzrlib.trace.log_exception()
659
if __name__ == '__main__':
660
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
