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
74
It supports integers directly, but everything else it
75
defers for passing to Branch.get_revision_info()
77
>>> _parse_revision_str('234')
79
>>> _parse_revision_str('234..567')
81
>>> _parse_revision_str('..')
83
>>> _parse_revision_str('..234')
85
>>> _parse_revision_str('234..')
87
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
89
>>> _parse_revision_str('234....789') # Error?
91
>>> _parse_revision_str('revid:test@other.com-234234')
92
['revid:test@other.com-234234']
93
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
94
['revid:test@other.com-234234', 'revid:test@other.com-234235']
95
>>> _parse_revision_str('revid:test@other.com-234234..23')
96
['revid:test@other.com-234234', 23]
97
>>> _parse_revision_str('date:2005-04-12')
99
>>> _parse_revision_str('date:2005-04-12 12:24:33')
100
['date:2005-04-12 12:24:33']
101
>>> _parse_revision_str('date:2005-04-12T12:24:33')
102
['date:2005-04-12T12:24:33']
103
>>> _parse_revision_str('date:2005-04-12,12:24:33')
104
['date:2005-04-12,12:24:33']
105
>>> _parse_revision_str('-5..23')
107
>>> _parse_revision_str('-5')
109
>>> _parse_revision_str('123a')
111
>>> _parse_revision_str('abc')
115
old_format_re = re.compile('\d*:\d*')
116
m = old_format_re.match(revstr)
118
warning('Colon separator for revision numbers is deprecated.'
121
for rev in revstr.split(':'):
123
revs.append(int(rev))
128
for x in revstr.split('..'):
139
def get_merge_type(typestring):
140
"""Attempt to find the merge class/factory associated with a string."""
141
from merge import merge_types
143
return merge_types[typestring][0]
145
templ = '%s%%7s: %%s' % (' '*12)
146
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
147
type_list = '\n'.join(lines)
148
msg = "No known merge type %s. Supported types are:\n%s" %\
149
(typestring, type_list)
150
raise BzrCommandError(msg)
153
def get_merge_type(typestring):
154
"""Attempt to find the merge class/factory associated with a string."""
155
from merge import merge_types
157
return merge_types[typestring][0]
159
templ = '%s%%7s: %%s' % (' '*12)
160
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
161
type_list = '\n'.join(lines)
162
msg = "No known merge type %s. Supported types are:\n%s" %\
163
(typestring, type_list)
164
raise BzrCommandError(msg)
167
def _builtin_commands():
168
import bzrlib.builtins
170
builtins = bzrlib.builtins.__dict__
171
for name in builtins:
172
if name.startswith("cmd_"):
173
real_name = _unsquish_command_name(name)
174
r[real_name] = builtins[name]
179
def builtin_command_names():
180
"""Return list of builtin command names."""
181
return _builtin_commands().keys()
184
def plugin_command_names():
185
return plugin_cmds.keys()
188
def _get_cmd_dict(plugins_override=True):
189
"""Return name->class mapping for all commands."""
190
d = _builtin_commands()
192
d.update(plugin_cmds)
196
def get_all_cmds(plugins_override=True):
197
"""Return canonical name and class for all registered commands."""
198
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
202
def get_cmd_object(cmd_name, plugins_override=True):
203
"""Return the canonical name and command class for a command.
206
If true, plugin commands can override builtins.
208
from bzrlib.externalcommand import ExternalCommand
210
cmd_name = str(cmd_name) # not unicode
212
# first look up this command under the specified name
213
cmds = _get_cmd_dict(plugins_override=plugins_override)
215
return cmds[cmd_name]()
219
# look for any command which claims this as an alias
220
for real_cmd_name, cmd_class in cmds.iteritems():
221
if cmd_name in cmd_class.aliases:
224
cmd_obj = ExternalCommand.find_command(cmd_name)
228
raise BzrCommandError("unknown command %r" % cmd_name)
231
class Command(object):
232
"""Base class for commands.
234
Commands are the heart of the command-line bzr interface.
236
The command object mostly handles the mapping of command-line
237
parameters into one or more bzrlib operations, and of the results
240
Commands normally don't have any state. All their arguments are
241
passed in to the run method. (Subclasses may take a different
242
policy if the behaviour of the instance needs to depend on e.g. a
243
shell plugin and not just its Python class.)
245
The docstring for an actual command should give a single-line
246
summary, then a complete description of the command. A grammar
247
description will be inserted.
250
Other accepted names for this command.
253
List of argument forms, marked with whether they are optional,
257
List of options that may be given for this command.
260
If true, this command isn't advertised. This is typically
261
for commands intended for expert users.
271
"""Construct an instance of this command."""
272
if self.__doc__ == Command.__doc__:
273
warn("No help message set for %r" % self)
276
def run_argv(self, argv):
277
"""Parse command line and run."""
278
args, opts = parse_args(argv)
280
if 'help' in opts: # e.g. bzr add --help
281
from bzrlib.help import help_on_command
282
help_on_command(self.name())
285
# check options are reasonable
286
allowed = self.takes_options
288
if oname not in allowed:
289
raise BzrCommandError("option '--%s' is not allowed for command %r"
290
% (oname, self.name()))
292
# mix arguments and options into one dictionary
293
cmdargs = _match_argform(self.name(), self.takes_args, args)
295
for k, v in opts.items():
296
cmdopts[k.replace('-', '_')] = v
298
all_cmd_args = cmdargs.copy()
299
all_cmd_args.update(cmdopts)
301
return self.run(**all_cmd_args)
305
"""Actually run the command.
307
This is invoked with the options and arguments bound to
310
Return 0 or None if the command was successful, or a non-zero
311
shell error code if not. It's OK for this method to allow
312
an exception to raise up.
314
raise NotImplementedError()
318
"""Return help message for this class."""
319
if self.__doc__ is Command.__doc__:
324
return _unsquish_command_name(self.__class__.__name__)
327
def parse_spec(spec):
333
>>> parse_spec("../@")
335
>>> parse_spec("../f/@35")
337
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
338
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
343
parsed = spec.split('/@')
344
assert len(parsed) == 2
349
parsed[1] = int(parsed[1])
351
pass # We can allow stuff like ./@revid:blahblahblah
355
parsed = [spec, None]
361
# list of all available options; the rhs can be either None for an
362
# option that takes no argument, or a constructor function that checks
375
'revision': _parse_revision_str,
387
'merge-type': get_merge_type,
401
def parse_args(argv):
402
"""Parse command line.
404
Arguments and options are parsed at this level before being passed
405
down to specific command handlers. This routine knows, from a
406
lookup table, something about the available options, what optargs
407
they take, and which commands will accept them.
409
>>> parse_args('--help'.split())
411
>>> parse_args('help -- --invalidcmd'.split())
412
(['help', '--invalidcmd'], {})
413
>>> parse_args('--version'.split())
414
([], {'version': True})
415
>>> parse_args('status --all'.split())
416
(['status'], {'all': True})
417
>>> parse_args('commit --message=biter'.split())
418
(['commit'], {'message': u'biter'})
419
>>> parse_args('log -r 500'.split())
420
(['log'], {'revision': [500]})
421
>>> parse_args('log -r500..600'.split())
422
(['log'], {'revision': [500, 600]})
423
>>> parse_args('log -vr500..600'.split())
424
(['log'], {'verbose': True, 'revision': [500, 600]})
425
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
426
(['log'], {'revision': ['v500', 600]})
434
if not argsover and a[0] == '-':
435
# option names must not be unicode
440
# We've received a standalone -- No more flags
443
mutter(" got option %r" % a)
445
optname, optarg = a[2:].split('=', 1)
448
if optname not in OPTIONS:
449
raise BzrError('unknown long option %r' % a)
452
if shortopt in SHORT_OPTIONS:
453
# Multi-character options must have a space to delimit
455
optname = SHORT_OPTIONS[shortopt]
457
# Single character short options, can be chained,
458
# and have their value appended to their name
460
if shortopt not in SHORT_OPTIONS:
461
# We didn't find the multi-character name, and we
462
# didn't find the single char name
463
raise BzrError('unknown short option %r' % a)
464
optname = SHORT_OPTIONS[shortopt]
467
# There are extra things on this option
468
# see if it is the value, or if it is another
470
optargfn = OPTIONS[optname]
472
# This option does not take an argument, so the
473
# next entry is another short option, pack it back
475
argv.insert(0, '-' + a[2:])
477
# This option takes an argument, so pack it
482
# XXX: Do we ever want to support this, e.g. for -r?
483
raise BzrError('repeated option %r' % a)
485
optargfn = OPTIONS[optname]
489
raise BzrError('option %r needs an argument' % a)
492
opts[optname] = optargfn(optarg)
495
raise BzrError('option %r takes no argument' % optname)
505
def _match_argform(cmd, takes_args, args):
508
# step through args and takes_args, allowing appropriate 0-many matches
509
for ap in takes_args:
513
argdict[argname] = args.pop(0)
514
elif ap[-1] == '*': # all remaining arguments
516
argdict[argname + '_list'] = args[:]
519
argdict[argname + '_list'] = None
522
raise BzrCommandError("command %r needs one or more %s"
523
% (cmd, argname.upper()))
525
argdict[argname + '_list'] = args[:]
527
elif ap[-1] == '$': # all but one
529
raise BzrCommandError("command %r needs one or more %s"
530
% (cmd, argname.upper()))
531
argdict[argname + '_list'] = args[:-1]
537
raise BzrCommandError("command %r requires argument %s"
538
% (cmd, argname.upper()))
540
argdict[argname] = args.pop(0)
543
raise BzrCommandError("extra argument to command %s: %s"
550
def apply_profiled(the_callable, *args, **kwargs):
553
pffileno, pfname = tempfile.mkstemp()
555
prof = hotshot.Profile(pfname)
557
ret = prof.runcall(the_callable, *args, **kwargs) or 0
562
stats = hotshot.stats.load(pfname)
564
stats.sort_stats('time')
565
## XXX: Might like to write to stderr or the trace file instead but
566
## print_stats seems hardcoded to stdout
567
stats.print_stats(20)
576
"""Execute a command.
578
This is similar to main(), but without all the trappings for
579
logging and error handling.
582
The command-line arguments, without the program name from argv[0]
584
Returns a command status or raises an exception.
586
Special master options: these must come before the command because
587
they control how the command is interpreted.
590
Do not load plugin modules at all
593
Only use builtin commands. (Plugins are still allowed to change
597
Run under the Python profiler.
600
argv = [a.decode(bzrlib.user_encoding) for a in argv]
602
opt_profile = opt_no_plugins = opt_builtin = False
604
# --no-plugins is handled specially at a very early stage. We need
605
# to load plugins before doing other command parsing so that they
606
# can override commands, but this needs to happen first.
611
elif a == '--no-plugins':
612
opt_no_plugins = True
613
elif a == '--builtin':
619
if (not argv) or (argv[0] == '--help'):
620
from bzrlib.help import help
627
if argv[0] == '--version':
628
from bzrlib.builtins import show_version
632
if not opt_no_plugins:
633
from bzrlib.plugin import load_plugins
636
cmd = str(argv.pop(0))
638
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
641
ret = apply_profiled(cmd_obj.run_argv, argv)
643
ret = cmd_obj.run_argv(argv)
649
bzrlib.trace.log_startup(argv)
650
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
654
return run_bzr(argv[1:])
656
# do this here inside the exception wrappers to catch EPIPE
658
except BzrCommandError, e:
659
# command line syntax error, etc
663
bzrlib.trace.log_exception()
665
except AssertionError, e:
666
bzrlib.trace.log_exception('assertion failed: ' + str(e))
668
except KeyboardInterrupt, e:
669
bzrlib.trace.note('interrupted')
673
if (isinstance(e, IOError)
674
and hasattr(e, 'errno')
675
and e.errno == errno.EPIPE):
676
bzrlib.trace.note('broken pipe')
679
bzrlib.trace.log_exception()
683
if __name__ == '__main__':
684
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
