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
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 get_merge_type(typestring):
145
"""Attempt to find the merge class/factory associated with a string."""
146
from merge import merge_types
148
return merge_types[typestring][0]
150
templ = '%s%%7s: %%s' % (' '*12)
151
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
152
type_list = '\n'.join(lines)
153
msg = "No known merge type %s. Supported types are:\n%s" %\
154
(typestring, type_list)
155
raise BzrCommandError(msg)
158
def get_merge_type(typestring):
159
"""Attempt to find the merge class/factory associated with a string."""
160
from merge import merge_types
162
return merge_types[typestring][0]
164
templ = '%s%%7s: %%s' % (' '*12)
165
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
166
type_list = '\n'.join(lines)
167
msg = "No known merge type %s. Supported types are:\n%s" %\
168
(typestring, type_list)
169
raise BzrCommandError(msg)
172
def _builtin_commands():
173
import bzrlib.builtins
175
builtins = bzrlib.builtins.__dict__
176
for name in builtins:
177
if name.startswith("cmd_"):
178
real_name = _unsquish_command_name(name)
179
r[real_name] = builtins[name]
184
def builtin_command_names():
185
"""Return list of builtin command names."""
186
return _builtin_commands().keys()
189
def plugin_command_names():
190
return plugin_cmds.keys()
193
def _get_cmd_dict(plugins_override=True):
194
"""Return name->class mapping for all commands."""
195
d = _builtin_commands()
197
d.update(plugin_cmds)
201
def get_all_cmds(plugins_override=True):
202
"""Return canonical name and class for all registered commands."""
203
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
207
def get_cmd_object(cmd_name, plugins_override=True):
208
"""Return the canonical name and command class for a command.
211
If true, plugin commands can override builtins.
213
from bzrlib.externalcommand import ExternalCommand
215
cmd_name = str(cmd_name) # not unicode
217
# first look up this command under the specified name
218
cmds = _get_cmd_dict(plugins_override=plugins_override)
220
return cmds[cmd_name]()
224
# look for any command which claims this as an alias
225
for real_cmd_name, cmd_class in cmds.iteritems():
226
if cmd_name in cmd_class.aliases:
229
cmd_obj = ExternalCommand.find_command(cmd_name)
233
raise BzrCommandError("unknown command %r" % cmd_name)
236
class Command(object):
237
"""Base class for commands.
239
Commands are the heart of the command-line bzr interface.
241
The command object mostly handles the mapping of command-line
242
parameters into one or more bzrlib operations, and of the results
245
Commands normally don't have any state. All their arguments are
246
passed in to the run method. (Subclasses may take a different
247
policy if the behaviour of the instance needs to depend on e.g. a
248
shell plugin and not just its Python class.)
250
The docstring for an actual command should give a single-line
251
summary, then a complete description of the command. A grammar
252
description will be inserted.
255
Other accepted names for this command.
258
List of argument forms, marked with whether they are optional,
262
List of options that may be given for this command.
265
If true, this command isn't advertised. This is typically
266
for commands intended for expert users.
276
"""Construct an instance of this command."""
277
if self.__doc__ == Command.__doc__:
278
warn("No help message set for %r" % self)
281
def run_argv(self, argv):
282
"""Parse command line and run."""
283
args, opts = parse_args(argv)
285
if 'help' in opts: # e.g. bzr add --help
286
from bzrlib.help import help_on_command
287
help_on_command(self.name())
290
# check options are reasonable
291
allowed = self.takes_options
293
if oname not in allowed:
294
raise BzrCommandError("option '--%s' is not allowed for command %r"
295
% (oname, self.name()))
297
# mix arguments and options into one dictionary
298
cmdargs = _match_argform(self.name(), self.takes_args, args)
300
for k, v in opts.items():
301
cmdopts[k.replace('-', '_')] = v
303
all_cmd_args = cmdargs.copy()
304
all_cmd_args.update(cmdopts)
306
return self.run(**all_cmd_args)
310
"""Actually run the command.
312
This is invoked with the options and arguments bound to
315
Return 0 or None if the command was successful, or a non-zero
316
shell error code if not. It's OK for this method to allow
317
an exception to raise up.
319
raise NotImplementedError()
323
"""Return help message for this class."""
324
if self.__doc__ is Command.__doc__:
329
return _unsquish_command_name(self.__class__.__name__)
332
def parse_spec(spec):
338
>>> parse_spec("../@")
340
>>> parse_spec("../f/@35")
342
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
343
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
348
parsed = spec.split('/@')
349
assert len(parsed) == 2
354
parsed[1] = int(parsed[1])
356
pass # We can allow stuff like ./@revid:blahblahblah
360
parsed = [spec, None]
364
# list of all available options; the rhs can be either None for an
365
# option that takes no argument, or a constructor function that checks
378
'revision': _parse_revision_str,
390
'merge-type': get_merge_type,
404
def parse_args(argv):
405
"""Parse command line.
407
Arguments and options are parsed at this level before being passed
408
down to specific command handlers. This routine knows, from a
409
lookup table, something about the available options, what optargs
410
they take, and which commands will accept them.
412
>>> parse_args('--help'.split())
414
>>> parse_args('help -- --invalidcmd'.split())
415
(['help', '--invalidcmd'], {})
416
>>> parse_args('--version'.split())
417
([], {'version': True})
418
>>> parse_args('status --all'.split())
419
(['status'], {'all': True})
420
>>> parse_args('commit --message=biter'.split())
421
(['commit'], {'message': u'biter'})
422
>>> parse_args('log -r 500'.split())
423
(['log'], {'revision': [<RevisionSpec_int 500>]})
424
>>> parse_args('log -r500..600'.split())
425
(['log'], {'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
426
>>> parse_args('log -vr500..600'.split())
427
(['log'], {'verbose': True, 'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
428
>>> parse_args('log -rrevno:500..600'.split()) #the r takes an argument
429
(['log'], {'revision': [<RevisionSpec_revno revno:500>, <RevisionSpec_int 600>]})
437
if not argsover and a[0] == '-':
438
# option names must not be unicode
443
# We've received a standalone -- No more flags
446
mutter(" got option %r" % a)
448
optname, optarg = a[2:].split('=', 1)
451
if optname not in OPTIONS:
452
raise BzrError('unknown long option %r' % a)
455
if shortopt in SHORT_OPTIONS:
456
# Multi-character options must have a space to delimit
458
optname = SHORT_OPTIONS[shortopt]
460
# Single character short options, can be chained,
461
# and have their value appended to their name
463
if shortopt not in SHORT_OPTIONS:
464
# We didn't find the multi-character name, and we
465
# didn't find the single char name
466
raise BzrError('unknown short option %r' % a)
467
optname = SHORT_OPTIONS[shortopt]
470
# There are extra things on this option
471
# see if it is the value, or if it is another
473
optargfn = OPTIONS[optname]
475
# This option does not take an argument, so the
476
# next entry is another short option, pack it back
478
argv.insert(0, '-' + a[2:])
480
# This option takes an argument, so pack it
485
# XXX: Do we ever want to support this, e.g. for -r?
486
raise BzrError('repeated option %r' % a)
488
optargfn = OPTIONS[optname]
492
raise BzrError('option %r needs an argument' % a)
495
opts[optname] = optargfn(optarg)
498
raise BzrError('option %r takes no argument' % optname)
508
def _match_argform(cmd, takes_args, args):
511
# step through args and takes_args, allowing appropriate 0-many matches
512
for ap in takes_args:
516
argdict[argname] = args.pop(0)
517
elif ap[-1] == '*': # all remaining arguments
519
argdict[argname + '_list'] = args[:]
522
argdict[argname + '_list'] = None
525
raise BzrCommandError("command %r needs one or more %s"
526
% (cmd, argname.upper()))
528
argdict[argname + '_list'] = args[:]
530
elif ap[-1] == '$': # all but one
532
raise BzrCommandError("command %r needs one or more %s"
533
% (cmd, argname.upper()))
534
argdict[argname + '_list'] = args[:-1]
540
raise BzrCommandError("command %r requires argument %s"
541
% (cmd, argname.upper()))
543
argdict[argname] = args.pop(0)
546
raise BzrCommandError("extra argument to command %s: %s"
553
def apply_profiled(the_callable, *args, **kwargs):
556
pffileno, pfname = tempfile.mkstemp()
558
prof = hotshot.Profile(pfname)
560
ret = prof.runcall(the_callable, *args, **kwargs) or 0
565
stats = hotshot.stats.load(pfname)
567
stats.sort_stats('time')
568
## XXX: Might like to write to stderr or the trace file instead but
569
## print_stats seems hardcoded to stdout
570
stats.print_stats(20)
579
"""Execute a command.
581
This is similar to main(), but without all the trappings for
582
logging and error handling.
585
The command-line arguments, without the program name from argv[0]
587
Returns a command status or raises an exception.
589
Special master options: these must come before the command because
590
they control how the command is interpreted.
593
Do not load plugin modules at all
596
Only use builtin commands. (Plugins are still allowed to change
600
Run under the Python profiler.
603
argv = [a.decode(bzrlib.user_encoding) for a in argv]
605
opt_profile = opt_no_plugins = opt_builtin = False
607
# --no-plugins is handled specially at a very early stage. We need
608
# to load plugins before doing other command parsing so that they
609
# can override commands, but this needs to happen first.
614
elif a == '--no-plugins':
615
opt_no_plugins = True
616
elif a == '--builtin':
622
if (not argv) or (argv[0] == '--help'):
623
from bzrlib.help import help
630
if argv[0] == '--version':
631
from bzrlib.builtins import show_version
635
if not opt_no_plugins:
636
from bzrlib.plugin import load_plugins
639
cmd = str(argv.pop(0))
641
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
644
ret = apply_profiled(cmd_obj.run_argv, argv)
646
ret = cmd_obj.run_argv(argv)
652
bzrlib.trace.log_startup(argv)
653
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
657
return run_bzr(argv[1:])
659
# do this here inside the exception wrappers to catch EPIPE
661
except BzrCommandError, e:
662
# command line syntax error, etc
666
bzrlib.trace.log_exception()
668
except AssertionError, e:
669
bzrlib.trace.log_exception('assertion failed: ' + str(e))
671
except KeyboardInterrupt, e:
672
bzrlib.trace.note('interrupted')
676
if (isinstance(e, IOError)
677
and hasattr(e, 'errno')
678
and e.errno == errno.EPIPE):
679
bzrlib.trace.note('broken pipe')
682
bzrlib.trace.log_exception()
686
if __name__ == '__main__':
687
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
