1
# Copyright (C) 2006 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: Define arguments by objects, rather than just using names.
22
# Those objects can specify the expected type of the argument, which
23
# would help with validation and shell completion. They could also provide
24
# help/explanation for that argument in a structured way.
26
# TODO: Specific "examples" property on commands for consistent formatting.
28
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
29
# the profile output behind so it can be interactively examined?
33
from warnings import warn
37
import bzrlib.errors as errors
38
from bzrlib.errors import (BzrError,
42
from bzrlib.option import Option
43
from bzrlib.revisionspec import RevisionSpec
44
from bzrlib.symbol_versioning import *
46
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
51
def register_command(cmd, decorate=False):
52
"""Utility function to help register a command
54
:param cmd: Command subclass to register
55
:param decorate: If true, allow overriding an existing command
56
of the same name; the old command is returned by this function.
57
Otherwise it is an error to try to override an existing command.
61
if k.startswith("cmd_"):
62
k_unsquished = _unsquish_command_name(k)
65
if not plugin_cmds.has_key(k_unsquished):
66
plugin_cmds[k_unsquished] = cmd
67
mutter('registered plugin command %s', k_unsquished)
68
if decorate and k_unsquished in builtin_command_names():
69
return _builtin_commands()[k_unsquished]
71
result = plugin_cmds[k_unsquished]
72
plugin_cmds[k_unsquished] = cmd
75
log_error('Two plugins defined the same command: %r' % k)
76
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
79
def _squish_command_name(cmd):
80
return 'cmd_' + cmd.replace('-', '_')
83
def _unsquish_command_name(cmd):
84
assert cmd.startswith("cmd_")
85
return cmd[4:].replace('_','-')
88
def _builtin_commands():
89
import bzrlib.builtins
91
builtins = bzrlib.builtins.__dict__
93
if name.startswith("cmd_"):
94
real_name = _unsquish_command_name(name)
95
r[real_name] = builtins[name]
99
def builtin_command_names():
100
"""Return list of builtin command names."""
101
return _builtin_commands().keys()
104
def plugin_command_names():
105
return plugin_cmds.keys()
108
def _get_cmd_dict(plugins_override=True):
109
"""Return name->class mapping for all commands."""
110
d = _builtin_commands()
112
d.update(plugin_cmds)
116
def get_all_cmds(plugins_override=True):
117
"""Return canonical name and class for all registered commands."""
118
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
122
def get_cmd_object(cmd_name, plugins_override=True):
123
"""Return the canonical name and command class for a command.
126
If true, plugin commands can override builtins.
128
from bzrlib.externalcommand import ExternalCommand
130
cmd_name = str(cmd_name) # not unicode
132
# first look up this command under the specified name
133
cmds = _get_cmd_dict(plugins_override=plugins_override)
135
return cmds[cmd_name]()
139
# look for any command which claims this as an alias
140
for real_cmd_name, cmd_class in cmds.iteritems():
141
if cmd_name in cmd_class.aliases:
144
cmd_obj = ExternalCommand.find_command(cmd_name)
148
raise BzrCommandError('unknown command "%s"' % cmd_name)
151
class Command(object):
152
"""Base class for commands.
154
Commands are the heart of the command-line bzr interface.
156
The command object mostly handles the mapping of command-line
157
parameters into one or more bzrlib operations, and of the results
160
Commands normally don't have any state. All their arguments are
161
passed in to the run method. (Subclasses may take a different
162
policy if the behaviour of the instance needs to depend on e.g. a
163
shell plugin and not just its Python class.)
165
The docstring for an actual command should give a single-line
166
summary, then a complete description of the command. A grammar
167
description will be inserted.
170
Other accepted names for this command.
173
List of argument forms, marked with whether they are optional,
178
['to_location', 'from_branch?', 'file*']
180
'to_location' is required
181
'from_branch' is optional
182
'file' can be specified 0 or more times
185
List of options that may be given for this command. These can
186
be either strings, referring to globally-defined options,
187
or option objects. Retrieve through options().
190
If true, this command isn't advertised. This is typically
191
for commands intended for expert users.
200
"""Construct an instance of this command."""
201
if self.__doc__ == Command.__doc__:
202
warn("No help message set for %r" % self)
205
"""Return dict of valid options for this command.
207
Maps from long option name to option object."""
209
r['help'] = Option.OPTIONS['help']
210
for o in self.takes_options:
211
if not isinstance(o, Option):
212
o = Option.OPTIONS[o]
216
@deprecated_method(zero_eight)
217
def run_argv(self, argv):
218
"""Parse command line and run.
220
See run_argv_aliases for the 0.8 and beyond api.
222
return self.run_argv_aliases(argv)
224
def run_argv_aliases(self, argv, alias_argv=None):
225
"""Parse the command line and run with extra aliases in alias_argv."""
226
args, opts = parse_args(self, argv, alias_argv)
227
if 'help' in opts: # e.g. bzr add --help
228
from bzrlib.help import help_on_command
229
help_on_command(self.name())
231
# XXX: This should be handled by the parser
232
allowed_names = self.options().keys()
234
if oname not in allowed_names:
235
raise BzrCommandError("option '--%s' is not allowed for"
236
" command %r" % (oname, self.name()))
237
# mix arguments and options into one dictionary
238
cmdargs = _match_argform(self.name(), self.takes_args, args)
240
for k, v in opts.items():
241
cmdopts[k.replace('-', '_')] = v
243
all_cmd_args = cmdargs.copy()
244
all_cmd_args.update(cmdopts)
246
return self.run(**all_cmd_args)
249
"""Actually run the command.
251
This is invoked with the options and arguments bound to
254
Return 0 or None if the command was successful, or a non-zero
255
shell error code if not. It's OK for this method to allow
256
an exception to raise up.
258
raise NotImplementedError('no implementation of command %r'
262
"""Return help message for this class."""
263
from inspect import getdoc
264
if self.__doc__ is Command.__doc__:
269
return _unsquish_command_name(self.__class__.__name__)
272
def parse_spec(spec):
278
>>> parse_spec("../@")
280
>>> parse_spec("../f/@35")
282
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
283
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
288
parsed = spec.split('/@')
289
assert len(parsed) == 2
294
parsed[1] = int(parsed[1])
296
pass # We can allow stuff like ./@revid:blahblahblah
300
parsed = [spec, None]
303
def parse_args(command, argv, alias_argv=None):
304
"""Parse command line.
306
Arguments and options are parsed at this level before being passed
307
down to specific command handlers. This routine knows, from a
308
lookup table, something about the available options, what optargs
309
they take, and which commands will accept them.
311
# TODO: chop up this beast; make it a method of the Command
316
cmd_options = command.options()
318
proc_aliasarg = True # Are we processing alias_argv now?
319
for proc_argv in alias_argv, argv:
326
# We've received a standalone -- No more flags
330
# option names must not be unicode
334
mutter(" got option %r", a)
336
optname, optarg = a[2:].split('=', 1)
339
if optname not in cmd_options:
340
raise BzrCommandError('unknown option "%s"' % a)
343
if shortopt in Option.SHORT_OPTIONS:
344
# Multi-character options must have a space to delimit
346
# ^^^ what does this mean? mbp 20051014
347
optname = Option.SHORT_OPTIONS[shortopt].name
349
# Single character short options, can be chained,
350
# and have their value appended to their name
352
if shortopt not in Option.SHORT_OPTIONS:
353
# We didn't find the multi-character name, and we
354
# didn't find the single char name
355
raise BzrCommandError('unknown option "%s"' % a)
356
optname = Option.SHORT_OPTIONS[shortopt].name
359
# There are extra things on this option
360
# see if it is the value, or if it is another
362
optargfn = Option.OPTIONS[optname].type
364
# This option does not take an argument, so the
365
# next entry is another short option, pack it
367
proc_argv.insert(0, '-' + a[2:])
369
# This option takes an argument, so pack it
372
if optname not in cmd_options:
373
raise BzrCommandError('unknown option "%s"' % shortopt)
375
# XXX: Do we ever want to support this, e.g. for -r?
377
raise BzrCommandError('repeated option %r' % a)
378
elif optname in alias_opts:
379
# Replace what's in the alias with what's in the real
381
del alias_opts[optname]
383
proc_argv.insert(0, a)
386
raise BzrCommandError('repeated option %r' % a)
388
option_obj = cmd_options[optname]
389
optargfn = option_obj.type
393
raise BzrCommandError('option %r needs an argument' % a)
395
optarg = proc_argv.pop(0)
396
opts[optname] = optargfn(optarg)
398
alias_opts[optname] = optargfn(optarg)
401
raise BzrCommandError('option %r takes no argument' % optname)
404
alias_opts[optname] = True
407
proc_aliasarg = False # Done with alias argv
411
def _match_argform(cmd, takes_args, args):
414
# step through args and takes_args, allowing appropriate 0-many matches
415
for ap in takes_args:
419
argdict[argname] = args.pop(0)
420
elif ap[-1] == '*': # all remaining arguments
422
argdict[argname + '_list'] = args[:]
425
argdict[argname + '_list'] = None
428
raise BzrCommandError("command %r needs one or more %s"
429
% (cmd, argname.upper()))
431
argdict[argname + '_list'] = args[:]
433
elif ap[-1] == '$': # all but one
435
raise BzrCommandError("command %r needs one or more %s"
436
% (cmd, argname.upper()))
437
argdict[argname + '_list'] = args[:-1]
443
raise BzrCommandError("command %r requires argument %s"
444
% (cmd, argname.upper()))
446
argdict[argname] = args.pop(0)
449
raise BzrCommandError("extra argument to command %s: %s"
456
def apply_profiled(the_callable, *args, **kwargs):
460
pffileno, pfname = tempfile.mkstemp()
462
prof = hotshot.Profile(pfname)
464
ret = prof.runcall(the_callable, *args, **kwargs) or 0
467
stats = hotshot.stats.load(pfname)
469
stats.sort_stats('cum') # 'time'
470
## XXX: Might like to write to stderr or the trace file instead but
471
## print_stats seems hardcoded to stdout
472
stats.print_stats(20)
479
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
480
from bzrlib.lsprof import profile
482
ret, stats = profile(the_callable, *args, **kwargs)
488
cPickle.dump(stats, open(filename, 'w'), 2)
489
print 'Profile data written to %r.' % filename
494
"""Return an expanded alias, or None if no alias exists"""
496
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
498
return alias.split(' ')
503
"""Execute a command.
505
This is similar to main(), but without all the trappings for
506
logging and error handling.
509
The command-line arguments, without the program name from argv[0]
511
Returns a command status or raises an exception.
513
Special master options: these must come before the command because
514
they control how the command is interpreted.
517
Do not load plugin modules at all
523
Only use builtin commands. (Plugins are still allowed to change
527
Run under the Python hotshot profiler.
530
Run under the Python lsprof profiler.
532
argv = [a.decode(bzrlib.user_encoding) for a in argv]
534
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
535
opt_no_aliases = False
536
opt_lsprof_file = None
538
# --no-plugins is handled specially at a very early stage. We need
539
# to load plugins before doing other command parsing so that they
540
# can override commands, but this needs to happen first.
548
elif a == '--lsprof':
550
elif a == '--lsprof-file':
551
opt_lsprof_file = argv[i + 1]
553
elif a == '--no-plugins':
554
opt_no_plugins = True
555
elif a == '--no-aliases':
556
opt_no_aliases = True
557
elif a == '--builtin':
559
elif a in ('--quiet', '-q'):
567
from bzrlib.builtins import cmd_help
568
cmd_help().run_argv_aliases([])
571
if argv[0] == '--version':
572
from bzrlib.builtins import show_version
576
if not opt_no_plugins:
577
from bzrlib.plugin import load_plugins
580
from bzrlib.plugin import disable_plugins
585
if not opt_no_aliases:
586
alias_argv = get_alias(argv[0])
588
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
589
argv[0] = alias_argv.pop(0)
591
cmd = str(argv.pop(0))
593
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
594
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
595
run = cmd_obj.run_argv
598
run = cmd_obj.run_argv_aliases
599
run_argv = [argv, alias_argv]
603
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
605
ret = apply_profiled(run, *run_argv)
610
# reset, in case we may do other commands later within the same process
613
def display_command(func):
614
"""Decorator that suppresses pipe/interrupt errors."""
615
def ignore_pipe(*args, **kwargs):
617
result = func(*args, **kwargs)
621
if not hasattr(e, 'errno'):
623
if e.errno != errno.EPIPE:
626
except KeyboardInterrupt:
633
from bzrlib.ui.text import TextUIFactory
634
## bzrlib.trace.enable_default_logging()
635
bzrlib.ui.ui_factory = TextUIFactory()
636
ret = run_bzr_catch_errors(argv[1:])
637
mutter("return code %d", ret)
641
def run_bzr_catch_errors(argv):
646
# do this here inside the exception wrappers to catch EPIPE
649
# used to handle AssertionError and KeyboardInterrupt
650
# specially here, but hopefully they're handled ok by the logger now
651
bzrlib.trace.report_exception(sys.exc_info(), sys.stderr)
652
if os.environ.get('BZR_PDB'):
653
print '**** entering debugger'
655
pdb.post_mortem(sys.exc_traceback)
658
if __name__ == '__main__':
659
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
