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.option import Option
50
def register_command(cmd, decorate=False):
51
"Utility function to help register a command"
54
if k.startswith("cmd_"):
55
k_unsquished = _unsquish_command_name(k)
58
if not plugin_cmds.has_key(k_unsquished):
59
plugin_cmds[k_unsquished] = cmd
60
mutter('registered plugin command %s', k_unsquished)
61
if decorate and k_unsquished in builtin_command_names():
62
return _builtin_commands()[k_unsquished]
64
result = plugin_cmds[k_unsquished]
65
plugin_cmds[k_unsquished] = cmd
68
log_error('Two plugins defined the same command: %r' % k)
69
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
72
def _squish_command_name(cmd):
73
return 'cmd_' + cmd.replace('-', '_')
76
def _unsquish_command_name(cmd):
77
assert cmd.startswith("cmd_")
78
return cmd[4:].replace('_','-')
81
def _builtin_commands():
82
import bzrlib.builtins
84
builtins = bzrlib.builtins.__dict__
86
if name.startswith("cmd_"):
87
real_name = _unsquish_command_name(name)
88
r[real_name] = builtins[name]
93
def builtin_command_names():
94
"""Return list of builtin command names."""
95
return _builtin_commands().keys()
98
def plugin_command_names():
99
return plugin_cmds.keys()
102
def _get_cmd_dict(plugins_override=True):
103
"""Return name->class mapping for all commands."""
104
d = _builtin_commands()
106
d.update(plugin_cmds)
110
def get_all_cmds(plugins_override=True):
111
"""Return canonical name and class for all registered commands."""
112
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
116
def get_cmd_object(cmd_name, plugins_override=True):
117
"""Return the canonical name and command class for a command.
120
If true, plugin commands can override builtins.
122
from bzrlib.externalcommand import ExternalCommand
124
cmd_name = str(cmd_name) # not unicode
126
# first look up this command under the specified name
127
cmds = _get_cmd_dict(plugins_override=plugins_override)
129
return cmds[cmd_name]()
133
# look for any command which claims this as an alias
134
for real_cmd_name, cmd_class in cmds.iteritems():
135
if cmd_name in cmd_class.aliases:
138
cmd_obj = ExternalCommand.find_command(cmd_name)
142
raise BzrCommandError("unknown command %r" % cmd_name)
145
class Command(object):
146
"""Base class for commands.
148
Commands are the heart of the command-line bzr interface.
150
The command object mostly handles the mapping of command-line
151
parameters into one or more bzrlib operations, and of the results
154
Commands normally don't have any state. All their arguments are
155
passed in to the run method. (Subclasses may take a different
156
policy if the behaviour of the instance needs to depend on e.g. a
157
shell plugin and not just its Python class.)
159
The docstring for an actual command should give a single-line
160
summary, then a complete description of the command. A grammar
161
description will be inserted.
164
Other accepted names for this command.
167
List of argument forms, marked with whether they are optional,
172
['to_location', 'from_branch?', 'file*']
174
'to_location' is required
175
'from_branch' is optional
176
'file' can be specified 0 or more times
179
List of options that may be given for this command. These can
180
be either strings, referring to globally-defined options,
181
or option objects. Retrieve through options().
184
If true, this command isn't advertised. This is typically
185
for commands intended for expert users.
194
"""Construct an instance of this command."""
195
if self.__doc__ == Command.__doc__:
196
warn("No help message set for %r" % self)
199
"""Return dict of valid options for this command.
201
Maps from long option name to option object."""
203
r['help'] = Option.OPTIONS['help']
204
for o in self.takes_options:
205
if not isinstance(o, Option):
206
o = Option.OPTIONS[o]
210
def run_argv(self, argv):
211
"""Parse command line and run."""
212
args, opts = parse_args(self, argv)
213
if 'help' in opts: # e.g. bzr add --help
214
from bzrlib.help import help_on_command
215
help_on_command(self.name())
217
# XXX: This should be handled by the parser
218
allowed_names = self.options().keys()
220
if oname not in allowed_names:
221
raise BzrCommandError("option '--%s' is not allowed for command %r"
222
% (oname, self.name()))
223
# mix arguments and options into one dictionary
224
cmdargs = _match_argform(self.name(), self.takes_args, args)
226
for k, v in opts.items():
227
cmdopts[k.replace('-', '_')] = v
229
all_cmd_args = cmdargs.copy()
230
all_cmd_args.update(cmdopts)
232
return self.run(**all_cmd_args)
235
"""Actually run the command.
237
This is invoked with the options and arguments bound to
240
Return 0 or None if the command was successful, or a non-zero
241
shell error code if not. It's OK for this method to allow
242
an exception to raise up.
244
raise NotImplementedError()
248
"""Return help message for this class."""
249
if self.__doc__ is Command.__doc__:
254
return _unsquish_command_name(self.__class__.__name__)
257
def parse_spec(spec):
263
>>> parse_spec("../@")
265
>>> parse_spec("../f/@35")
267
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
268
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
273
parsed = spec.split('/@')
274
assert len(parsed) == 2
279
parsed[1] = int(parsed[1])
281
pass # We can allow stuff like ./@revid:blahblahblah
285
parsed = [spec, None]
288
def parse_args(command, argv):
289
"""Parse command line.
291
Arguments and options are parsed at this level before being passed
292
down to specific command handlers. This routine knows, from a
293
lookup table, something about the available options, what optargs
294
they take, and which commands will accept them.
296
# TODO: chop up this beast; make it a method of the Command
300
cmd_options = command.options()
308
# We've received a standalone -- No more flags
312
# option names must not be unicode
316
mutter(" got option %r", a)
318
optname, optarg = a[2:].split('=', 1)
321
if optname not in cmd_options:
322
raise BzrOptionError('unknown long option %r for command %s'
323
% (a, command.name()))
326
if shortopt in Option.SHORT_OPTIONS:
327
# Multi-character options must have a space to delimit
329
# ^^^ what does this mean? mbp 20051014
330
optname = Option.SHORT_OPTIONS[shortopt].name
332
# Single character short options, can be chained,
333
# and have their value appended to their name
335
if shortopt not in Option.SHORT_OPTIONS:
336
# We didn't find the multi-character name, and we
337
# didn't find the single char name
338
raise BzrError('unknown short option %r' % a)
339
optname = Option.SHORT_OPTIONS[shortopt].name
342
# There are extra things on this option
343
# see if it is the value, or if it is another
345
optargfn = Option.OPTIONS[optname].type
347
# This option does not take an argument, so the
348
# next entry is another short option, pack it back
350
argv.insert(0, '-' + a[2:])
352
# This option takes an argument, so pack it
356
if optname not in cmd_options:
357
raise BzrOptionError('unknown short option %r for command'
358
' %s' % (shortopt, command.name()))
360
# XXX: Do we ever want to support this, e.g. for -r?
361
raise BzrError('repeated option %r' % a)
363
option_obj = cmd_options[optname]
364
optargfn = option_obj.type
368
raise BzrError('option %r needs an argument' % a)
371
opts[optname] = optargfn(optarg)
374
raise BzrError('option %r takes no argument' % optname)
381
def _match_argform(cmd, takes_args, args):
384
# step through args and takes_args, allowing appropriate 0-many matches
385
for ap in takes_args:
389
argdict[argname] = args.pop(0)
390
elif ap[-1] == '*': # all remaining arguments
392
argdict[argname + '_list'] = args[:]
395
argdict[argname + '_list'] = None
398
raise BzrCommandError("command %r needs one or more %s"
399
% (cmd, argname.upper()))
401
argdict[argname + '_list'] = args[:]
403
elif ap[-1] == '$': # all but one
405
raise BzrCommandError("command %r needs one or more %s"
406
% (cmd, argname.upper()))
407
argdict[argname + '_list'] = args[:-1]
413
raise BzrCommandError("command %r requires argument %s"
414
% (cmd, argname.upper()))
416
argdict[argname] = args.pop(0)
419
raise BzrCommandError("extra argument to command %s: %s"
426
def apply_profiled(the_callable, *args, **kwargs):
430
pffileno, pfname = tempfile.mkstemp()
432
prof = hotshot.Profile(pfname)
434
ret = prof.runcall(the_callable, *args, **kwargs) or 0
437
stats = hotshot.stats.load(pfname)
439
stats.sort_stats('cum') # 'time'
440
## XXX: Might like to write to stderr or the trace file instead but
441
## print_stats seems hardcoded to stdout
442
stats.print_stats(20)
449
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
450
from bzrlib.lsprof import profile
452
ret, stats = profile(the_callable, *args, **kwargs)
458
cPickle.dump(stats, open(filename, 'w'), 2)
459
print 'Profile data written to %r.' % filename
463
"""Execute a command.
465
This is similar to main(), but without all the trappings for
466
logging and error handling.
469
The command-line arguments, without the program name from argv[0]
471
Returns a command status or raises an exception.
473
Special master options: these must come before the command because
474
they control how the command is interpreted.
477
Do not load plugin modules at all
480
Only use builtin commands. (Plugins are still allowed to change
484
Run under the Python hotshot profiler.
487
Run under the Python lsprof profiler.
489
argv = [a.decode(bzrlib.user_encoding) for a in argv]
491
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = False
492
opt_lsprof_file = None
494
# --no-plugins is handled specially at a very early stage. We need
495
# to load plugins before doing other command parsing so that they
496
# can override commands, but this needs to happen first.
504
elif a == '--lsprof':
506
elif a == '--lsprof-file':
507
opt_lsprof_file = argv[i + 1]
509
elif a == '--no-plugins':
510
opt_no_plugins = True
511
elif a == '--builtin':
513
elif a in ('--quiet', '-q'):
520
if (not argv) or (argv[0] == '--help'):
521
from bzrlib.help import help
528
if argv[0] == '--version':
529
from bzrlib.builtins import show_version
533
if not opt_no_plugins:
534
from bzrlib.plugin import load_plugins
537
from bzrlib.plugin import disable_plugins
540
cmd = str(argv.pop(0))
542
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
546
ret = apply_lsprofiled(opt_lsprof_file, cmd_obj.run_argv, argv)
548
ret = apply_profiled(cmd_obj.run_argv, argv)
550
ret = cmd_obj.run_argv(argv)
553
# reset, in case we may do other commands later within the same process
556
def display_command(func):
557
"""Decorator that suppresses pipe/interrupt errors."""
558
def ignore_pipe(*args, **kwargs):
560
result = func(*args, **kwargs)
564
if not hasattr(e, 'errno'):
566
if e.errno != errno.EPIPE:
569
except KeyboardInterrupt:
576
from bzrlib.ui.text import TextUIFactory
577
## bzrlib.trace.enable_default_logging()
578
bzrlib.trace.log_startup(argv)
579
bzrlib.ui.ui_factory = TextUIFactory()
580
ret = run_bzr_catch_errors(argv[1:])
581
mutter("return code %d", ret)
585
def run_bzr_catch_errors(argv):
590
# do this here inside the exception wrappers to catch EPIPE
593
# used to handle AssertionError and KeyboardInterrupt
594
# specially here, but hopefully they're handled ok by the logger now
596
if (isinstance(e, IOError)
597
and hasattr(e, 'errno')
598
and e.errno == errno.EPIPE):
599
bzrlib.trace.note('broken pipe')
602
bzrlib.trace.log_exception()
603
if os.environ.get('BZR_PDB'):
604
print '**** entering debugger'
606
pdb.post_mortem(sys.exc_traceback)
609
if __name__ == '__main__':
610
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
