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
38
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
39
from bzrlib.errors import (BzrError,
44
from bzrlib.revisionspec import RevisionSpec
45
from bzrlib import BZRDIR
46
from bzrlib.option import Option
51
def register_command(cmd, decorate=False):
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)
62
if decorate and k_unsquished in builtin_command_names():
63
return _builtin_commands()[k_unsquished]
65
result = plugin_cmds[k_unsquished]
66
plugin_cmds[k_unsquished] = cmd
69
log_error('Two plugins defined the same command: %r' % k)
70
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
73
def _squish_command_name(cmd):
74
return 'cmd_' + cmd.replace('-', '_')
77
def _unsquish_command_name(cmd):
78
assert cmd.startswith("cmd_")
79
return cmd[4:].replace('_','-')
82
def _builtin_commands():
83
import bzrlib.builtins
85
builtins = bzrlib.builtins.__dict__
87
if name.startswith("cmd_"):
88
real_name = _unsquish_command_name(name)
89
r[real_name] = builtins[name]
94
def builtin_command_names():
95
"""Return list of builtin command names."""
96
return _builtin_commands().keys()
99
def plugin_command_names():
100
return plugin_cmds.keys()
103
def _get_cmd_dict(plugins_override=True):
104
"""Return name->class mapping for all commands."""
105
d = _builtin_commands()
107
d.update(plugin_cmds)
111
def get_all_cmds(plugins_override=True):
112
"""Return canonical name and class for all registered commands."""
113
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
117
def get_cmd_object(cmd_name, plugins_override=True):
118
"""Return the canonical name and command class for a command.
121
If true, plugin commands can override builtins.
123
from bzrlib.externalcommand import ExternalCommand
125
cmd_name = str(cmd_name) # not unicode
127
# first look up this command under the specified name
128
cmds = _get_cmd_dict(plugins_override=plugins_override)
130
return cmds[cmd_name]()
134
# look for any command which claims this as an alias
135
for real_cmd_name, cmd_class in cmds.iteritems():
136
if cmd_name in cmd_class.aliases:
139
cmd_obj = ExternalCommand.find_command(cmd_name)
143
raise BzrCommandError("unknown command %r" % cmd_name)
146
class Command(object):
147
"""Base class for commands.
149
Commands are the heart of the command-line bzr interface.
151
The command object mostly handles the mapping of command-line
152
parameters into one or more bzrlib operations, and of the results
155
Commands normally don't have any state. All their arguments are
156
passed in to the run method. (Subclasses may take a different
157
policy if the behaviour of the instance needs to depend on e.g. a
158
shell plugin and not just its Python class.)
160
The docstring for an actual command should give a single-line
161
summary, then a complete description of the command. A grammar
162
description will be inserted.
165
Other accepted names for this command.
168
List of argument forms, marked with whether they are optional,
173
['to_location', 'from_branch?', 'file*']
175
'to_location' is required
176
'from_branch' is optional
177
'file' can be specified 0 or more times
180
List of options that may be given for this command. These can
181
be either strings, referring to globally-defined options,
182
or option objects. Retrieve through options().
185
If true, this command isn't advertised. This is typically
186
for commands intended for expert users.
195
"""Construct an instance of this command."""
196
if self.__doc__ == Command.__doc__:
197
warn("No help message set for %r" % self)
200
"""Return dict of valid options for this command.
202
Maps from long option name to option object."""
204
r['help'] = Option.OPTIONS['help']
205
for o in self.takes_options:
206
if not isinstance(o, Option):
207
o = Option.OPTIONS[o]
211
def run_argv(self, argv):
212
"""Parse command line and run."""
213
args, opts = parse_args(self, argv)
214
if 'help' in opts: # e.g. bzr add --help
215
from bzrlib.help import help_on_command
216
help_on_command(self.name())
218
# XXX: This should be handled by the parser
219
allowed_names = self.options().keys()
221
if oname not in allowed_names:
222
raise BzrCommandError("option '--%s' is not allowed for command %r"
223
% (oname, self.name()))
224
# mix arguments and options into one dictionary
225
cmdargs = _match_argform(self.name(), self.takes_args, args)
227
for k, v in opts.items():
228
cmdopts[k.replace('-', '_')] = v
230
all_cmd_args = cmdargs.copy()
231
all_cmd_args.update(cmdopts)
233
return self.run(**all_cmd_args)
236
"""Actually run the command.
238
This is invoked with the options and arguments bound to
241
Return 0 or None if the command was successful, or a non-zero
242
shell error code if not. It's OK for this method to allow
243
an exception to raise up.
245
raise NotImplementedError()
249
"""Return help message for this class."""
250
if self.__doc__ is Command.__doc__:
255
return _unsquish_command_name(self.__class__.__name__)
258
def parse_spec(spec):
264
>>> parse_spec("../@")
266
>>> parse_spec("../f/@35")
268
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
269
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
274
parsed = spec.split('/@')
275
assert len(parsed) == 2
280
parsed[1] = int(parsed[1])
282
pass # We can allow stuff like ./@revid:blahblahblah
286
parsed = [spec, None]
289
def parse_args(command, argv):
290
"""Parse command line.
292
Arguments and options are parsed at this level before being passed
293
down to specific command handlers. This routine knows, from a
294
lookup table, something about the available options, what optargs
295
they take, and which commands will accept them.
297
# TODO: chop up this beast; make it a method of the Command
301
cmd_options = command.options()
309
# We've received a standalone -- No more flags
313
# option names must not be unicode
317
mutter(" got option %r", a)
319
optname, optarg = a[2:].split('=', 1)
322
if optname not in cmd_options:
323
raise BzrOptionError('unknown long option %r for command %s'
324
% (a, command.name()))
327
if shortopt in Option.SHORT_OPTIONS:
328
# Multi-character options must have a space to delimit
330
# ^^^ what does this mean? mbp 20051014
331
optname = Option.SHORT_OPTIONS[shortopt].name
333
# Single character short options, can be chained,
334
# and have their value appended to their name
336
if shortopt not in Option.SHORT_OPTIONS:
337
# We didn't find the multi-character name, and we
338
# didn't find the single char name
339
raise BzrError('unknown short option %r' % a)
340
optname = Option.SHORT_OPTIONS[shortopt].name
343
# There are extra things on this option
344
# see if it is the value, or if it is another
346
optargfn = Option.OPTIONS[optname].type
348
# This option does not take an argument, so the
349
# next entry is another short option, pack it back
351
argv.insert(0, '-' + a[2:])
353
# This option takes an argument, so pack it
357
if optname not in cmd_options:
358
raise BzrOptionError('unknown short option %r for command'
359
' %s' % (shortopt, command.name()))
361
# XXX: Do we ever want to support this, e.g. for -r?
362
raise BzrError('repeated option %r' % a)
364
option_obj = cmd_options[optname]
365
optargfn = option_obj.type
369
raise BzrError('option %r needs an argument' % a)
372
opts[optname] = optargfn(optarg)
375
raise BzrError('option %r takes no argument' % optname)
382
def _match_argform(cmd, takes_args, args):
385
# step through args and takes_args, allowing appropriate 0-many matches
386
for ap in takes_args:
390
argdict[argname] = args.pop(0)
391
elif ap[-1] == '*': # all remaining arguments
393
argdict[argname + '_list'] = args[:]
396
argdict[argname + '_list'] = None
399
raise BzrCommandError("command %r needs one or more %s"
400
% (cmd, argname.upper()))
402
argdict[argname + '_list'] = args[:]
404
elif ap[-1] == '$': # all but one
406
raise BzrCommandError("command %r needs one or more %s"
407
% (cmd, argname.upper()))
408
argdict[argname + '_list'] = args[:-1]
414
raise BzrCommandError("command %r requires argument %s"
415
% (cmd, argname.upper()))
417
argdict[argname] = args.pop(0)
420
raise BzrCommandError("extra argument to command %s: %s"
427
def apply_profiled(the_callable, *args, **kwargs):
431
pffileno, pfname = tempfile.mkstemp()
433
prof = hotshot.Profile(pfname)
435
ret = prof.runcall(the_callable, *args, **kwargs) or 0
438
stats = hotshot.stats.load(pfname)
440
stats.sort_stats('cum') # 'time'
441
## XXX: Might like to write to stderr or the trace file instead but
442
## print_stats seems hardcoded to stdout
443
stats.print_stats(20)
451
"""Execute a command.
453
This is similar to main(), but without all the trappings for
454
logging and error handling.
457
The command-line arguments, without the program name from argv[0]
459
Returns a command status or raises an exception.
461
Special master options: these must come before the command because
462
they control how the command is interpreted.
465
Do not load plugin modules at all
468
Only use builtin commands. (Plugins are still allowed to change
472
Run under the Python profiler.
474
argv = [a.decode(bzrlib.user_encoding) for a in argv]
476
opt_profile = opt_no_plugins = opt_builtin = False
478
# --no-plugins is handled specially at a very early stage. We need
479
# to load plugins before doing other command parsing so that they
480
# can override commands, but this needs to happen first.
485
elif a == '--no-plugins':
486
opt_no_plugins = True
487
elif a == '--builtin':
489
elif a in ('--quiet', '-q'):
495
if (not argv) or (argv[0] == '--help'):
496
from bzrlib.help import help
503
if argv[0] == '--version':
504
from bzrlib.builtins import show_version
508
if not opt_no_plugins:
509
from bzrlib.plugin import load_plugins
512
cmd = str(argv.pop(0))
514
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
518
ret = apply_profiled(cmd_obj.run_argv, argv)
520
ret = cmd_obj.run_argv(argv)
523
# reset, in case we may do other commands later within the same process
526
def display_command(func):
527
"""Decorator that suppresses pipe/interrupt errors."""
528
def ignore_pipe(*args, **kwargs):
530
result = func(*args, **kwargs)
534
if not hasattr(e, 'errno'):
536
if e.errno != errno.EPIPE:
539
except KeyboardInterrupt:
546
from bzrlib.ui.text import TextUIFactory
547
## bzrlib.trace.enable_default_logging()
548
bzrlib.trace.log_startup(argv)
549
bzrlib.ui.ui_factory = TextUIFactory()
550
ret = run_bzr_catch_errors(argv[1:])
551
mutter("return code %d", ret)
555
def run_bzr_catch_errors(argv):
560
# do this here inside the exception wrappers to catch EPIPE
563
# used to handle AssertionError and KeyboardInterrupt
564
# specially here, but hopefully they're handled ok by the logger now
566
if (isinstance(e, IOError)
567
and hasattr(e, 'errno')
568
and e.errno == errno.EPIPE):
569
bzrlib.trace.note('broken pipe')
572
bzrlib.trace.log_exception()
573
if os.environ.get('BZR_PDB'):
574
print '**** entering debugger'
576
pdb.post_mortem(sys.exc_traceback)
579
if __name__ == '__main__':
580
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
