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
38
import bzrlib.errors as errors
39
from bzrlib.errors import (BzrError,
43
from bzrlib.option import Option
45
from bzrlib.revisionspec import RevisionSpec
46
from bzrlib.symbol_versioning import (deprecated_method, zero_eight)
47
from bzrlib import trace
48
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
53
def register_command(cmd, decorate=False):
54
"""Utility function to help register a command
56
:param cmd: Command subclass to register
57
:param decorate: If true, allow overriding an existing command
58
of the same name; the old command is returned by this function.
59
Otherwise it is an error to try to override an existing command.
63
if k.startswith("cmd_"):
64
k_unsquished = _unsquish_command_name(k)
67
if not plugin_cmds.has_key(k_unsquished):
68
plugin_cmds[k_unsquished] = cmd
69
mutter('registered plugin command %s', k_unsquished)
70
if decorate and k_unsquished in builtin_command_names():
71
return _builtin_commands()[k_unsquished]
73
result = plugin_cmds[k_unsquished]
74
plugin_cmds[k_unsquished] = cmd
77
log_error('Two plugins defined the same command: %r' % k)
78
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
81
def _squish_command_name(cmd):
82
return 'cmd_' + cmd.replace('-', '_')
85
def _unsquish_command_name(cmd):
86
assert cmd.startswith("cmd_")
87
return cmd[4:].replace('_','-')
90
def _builtin_commands():
91
import bzrlib.builtins
93
builtins = bzrlib.builtins.__dict__
95
if name.startswith("cmd_"):
96
real_name = _unsquish_command_name(name)
97
r[real_name] = builtins[name]
101
def builtin_command_names():
102
"""Return list of builtin command names."""
103
return _builtin_commands().keys()
106
def plugin_command_names():
107
return plugin_cmds.keys()
110
def _get_cmd_dict(plugins_override=True):
111
"""Return name->class mapping for all commands."""
112
d = _builtin_commands()
114
d.update(plugin_cmds)
118
def get_all_cmds(plugins_override=True):
119
"""Return canonical name and class for all registered commands."""
120
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
124
def get_cmd_object(cmd_name, plugins_override=True):
125
"""Return the canonical name and command class for a command.
128
If true, plugin commands can override builtins.
130
from bzrlib.externalcommand import ExternalCommand
132
cmd_name = str(cmd_name) # not unicode
134
# first look up this command under the specified name
135
cmds = _get_cmd_dict(plugins_override=plugins_override)
137
return cmds[cmd_name]()
141
# look for any command which claims this as an alias
142
for real_cmd_name, cmd_class in cmds.iteritems():
143
if cmd_name in cmd_class.aliases:
146
cmd_obj = ExternalCommand.find_command(cmd_name)
150
raise BzrCommandError('unknown command "%s"' % cmd_name)
153
class Command(object):
154
"""Base class for commands.
156
Commands are the heart of the command-line bzr interface.
158
The command object mostly handles the mapping of command-line
159
parameters into one or more bzrlib operations, and of the results
162
Commands normally don't have any state. All their arguments are
163
passed in to the run method. (Subclasses may take a different
164
policy if the behaviour of the instance needs to depend on e.g. a
165
shell plugin and not just its Python class.)
167
The docstring for an actual command should give a single-line
168
summary, then a complete description of the command. A grammar
169
description will be inserted.
172
Other accepted names for this command.
175
List of argument forms, marked with whether they are optional,
180
['to_location', 'from_branch?', 'file*']
182
'to_location' is required
183
'from_branch' is optional
184
'file' can be specified 0 or more times
187
List of options that may be given for this command. These can
188
be either strings, referring to globally-defined options,
189
or option objects. Retrieve through options().
192
If true, this command isn't advertised. This is typically
193
for commands intended for expert users.
196
Command objects will get a 'outf' attribute, which has been
197
setup to properly handle encoding of unicode strings.
198
encoding_type determines what will happen when characters cannot
200
strict - abort if we cannot decode
201
replace - put in a bogus character (typically '?')
202
exact - do not encode sys.stdout
208
encoding_type = 'strict'
213
"""Construct an instance of this command."""
214
if self.__doc__ == Command.__doc__:
215
warn("No help message set for %r" % self)
218
"""Return dict of valid options for this command.
220
Maps from long option name to option object."""
222
r['help'] = Option.OPTIONS['help']
223
for o in self.takes_options:
224
if not isinstance(o, Option):
225
o = Option.OPTIONS[o]
229
def _setup_outf(self):
230
"""Return a file linked to stdout, which has proper encoding."""
231
assert self.encoding_type in ['strict', 'exact', 'replace']
233
# Originally I was using self.stdout, but that looks
234
# *way* too much like sys.stdout
235
if self.encoding_type == 'exact':
236
self.outf = sys.stdout
239
output_encoding = bzrlib.osutils.get_terminal_encoding()
241
# use 'replace' so that we don't abort if trying to write out
242
# in e.g. the default C locale.
243
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
244
# For whatever reason codecs.getwriter() does not advertise its encoding
245
# it just returns the encoding of the wrapped file, which is completely
246
# bogus. So set the attribute, so we can find the correct encoding later.
247
self.outf.encoding = output_encoding
249
@deprecated_method(zero_eight)
250
def run_argv(self, argv):
251
"""Parse command line and run.
253
See run_argv_aliases for the 0.8 and beyond api.
255
return self.run_argv_aliases(argv)
257
def run_argv_aliases(self, argv, alias_argv=None):
258
"""Parse the command line and run with extra aliases in alias_argv."""
259
args, opts = parse_args(self, argv, alias_argv)
260
if 'help' in opts: # e.g. bzr add --help
261
from bzrlib.help import help_on_command
262
help_on_command(self.name())
264
# XXX: This should be handled by the parser
265
allowed_names = self.options().keys()
267
if oname not in allowed_names:
268
raise BzrOptionError("option '--%s' is not allowed for"
269
" command %r" % (oname, self.name()))
270
# mix arguments and options into one dictionary
271
cmdargs = _match_argform(self.name(), self.takes_args, args)
273
for k, v in opts.items():
274
cmdopts[k.replace('-', '_')] = v
276
all_cmd_args = cmdargs.copy()
277
all_cmd_args.update(cmdopts)
281
return self.run(**all_cmd_args)
284
"""Actually run the command.
286
This is invoked with the options and arguments bound to
289
Return 0 or None if the command was successful, or a non-zero
290
shell error code if not. It's OK for this method to allow
291
an exception to raise up.
293
raise NotImplementedError('no implementation of command %r'
297
"""Return help message for this class."""
298
from inspect import getdoc
299
if self.__doc__ is Command.__doc__:
304
return _unsquish_command_name(self.__class__.__name__)
306
def plugin_name(self):
307
"""Get the name of the plugin that provides this command.
309
:return: The name of the plugin or None if the command is builtin.
311
mod_parts = self.__module__.split('.')
312
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
318
def parse_spec(spec):
324
>>> parse_spec("../@")
326
>>> parse_spec("../f/@35")
328
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
329
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
334
parsed = spec.split('/@')
335
assert len(parsed) == 2
340
parsed[1] = int(parsed[1])
342
pass # We can allow stuff like ./@revid:blahblahblah
346
parsed = [spec, None]
349
def parse_args(command, argv, alias_argv=None):
350
"""Parse command line.
352
Arguments and options are parsed at this level before being passed
353
down to specific command handlers. This routine knows, from a
354
lookup table, something about the available options, what optargs
355
they take, and which commands will accept them.
357
# TODO: chop up this beast; make it a method of the Command
362
cmd_options = command.options()
364
proc_aliasarg = True # Are we processing alias_argv now?
365
for proc_argv in alias_argv, argv:
372
# We've received a standalone -- No more flags
376
# option names must not be unicode
380
mutter(" got option %r", a)
382
optname, optarg = a[2:].split('=', 1)
385
if optname not in cmd_options:
386
raise BzrCommandError('unknown option "%s"' % a)
389
if shortopt in Option.SHORT_OPTIONS:
390
# Multi-character options must have a space to delimit
392
# ^^^ what does this mean? mbp 20051014
393
optname = Option.SHORT_OPTIONS[shortopt].name
395
# Single character short options, can be chained,
396
# and have their value appended to their name
398
if shortopt not in Option.SHORT_OPTIONS:
399
# We didn't find the multi-character name, and we
400
# didn't find the single char name
401
raise BzrCommandError('unknown option "%s"' % a)
402
optname = Option.SHORT_OPTIONS[shortopt].name
405
# There are extra things on this option
406
# see if it is the value, or if it is another
408
optargfn = Option.OPTIONS[optname].type
410
# This option does not take an argument, so the
411
# next entry is another short option, pack it
413
proc_argv.insert(0, '-' + a[2:])
415
# This option takes an argument, so pack it
418
if optname not in cmd_options:
419
raise BzrCommandError('unknown option "%s"' % shortopt)
421
# XXX: Do we ever want to support this, e.g. for -r?
423
raise BzrCommandError('repeated option %r' % a)
424
elif optname in alias_opts:
425
# Replace what's in the alias with what's in the real
427
del alias_opts[optname]
429
proc_argv.insert(0, a)
432
raise BzrCommandError('repeated option %r' % a)
434
option_obj = cmd_options[optname]
435
optargfn = option_obj.type
439
raise BzrCommandError('option %r needs an argument' % a)
441
optarg = proc_argv.pop(0)
442
opts[optname] = optargfn(optarg)
444
alias_opts[optname] = optargfn(optarg)
447
raise BzrCommandError('option %r takes no argument' % optname)
450
alias_opts[optname] = True
453
proc_aliasarg = False # Done with alias argv
457
def _match_argform(cmd, takes_args, args):
460
# step through args and takes_args, allowing appropriate 0-many matches
461
for ap in takes_args:
465
argdict[argname] = args.pop(0)
466
elif ap[-1] == '*': # all remaining arguments
468
argdict[argname + '_list'] = args[:]
471
argdict[argname + '_list'] = None
474
raise BzrCommandError("command %r needs one or more %s"
475
% (cmd, argname.upper()))
477
argdict[argname + '_list'] = args[:]
479
elif ap[-1] == '$': # all but one
481
raise BzrCommandError("command %r needs one or more %s"
482
% (cmd, argname.upper()))
483
argdict[argname + '_list'] = args[:-1]
489
raise BzrCommandError("command %r requires argument %s"
490
% (cmd, argname.upper()))
492
argdict[argname] = args.pop(0)
495
raise BzrCommandError("extra argument to command %s: %s"
502
def apply_profiled(the_callable, *args, **kwargs):
506
pffileno, pfname = tempfile.mkstemp()
508
prof = hotshot.Profile(pfname)
510
ret = prof.runcall(the_callable, *args, **kwargs) or 0
513
stats = hotshot.stats.load(pfname)
515
stats.sort_stats('cum') # 'time'
516
## XXX: Might like to write to stderr or the trace file instead but
517
## print_stats seems hardcoded to stdout
518
stats.print_stats(20)
525
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
526
from bzrlib.lsprof import profile
528
ret, stats = profile(the_callable, *args, **kwargs)
534
cPickle.dump(stats, open(filename, 'w'), 2)
535
print 'Profile data written to %r.' % filename
540
"""Return an expanded alias, or None if no alias exists"""
542
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
544
return alias.split(' ')
549
"""Execute a command.
551
This is similar to main(), but without all the trappings for
552
logging and error handling.
555
The command-line arguments, without the program name from argv[0]
556
These should already be decoded. All library/test code calling
557
run_bzr should be passing valid strings (don't need decoding).
559
Returns a command status or raises an exception.
561
Special master options: these must come before the command because
562
they control how the command is interpreted.
565
Do not load plugin modules at all
571
Only use builtin commands. (Plugins are still allowed to change
575
Run under the Python hotshot profiler.
578
Run under the Python lsprof profiler.
582
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
583
opt_no_aliases = False
584
opt_lsprof_file = None
586
# --no-plugins is handled specially at a very early stage. We need
587
# to load plugins before doing other command parsing so that they
588
# can override commands, but this needs to happen first.
596
elif a == '--lsprof':
598
elif a == '--lsprof-file':
599
opt_lsprof_file = argv[i + 1]
601
elif a == '--no-plugins':
602
opt_no_plugins = True
603
elif a == '--no-aliases':
604
opt_no_aliases = True
605
elif a == '--builtin':
607
elif a in ('--quiet', '-q'):
615
from bzrlib.builtins import cmd_help
616
cmd_help().run_argv_aliases([])
619
if argv[0] == '--version':
620
from bzrlib.builtins import show_version
624
if not opt_no_plugins:
625
from bzrlib.plugin import load_plugins
628
from bzrlib.plugin import disable_plugins
633
if not opt_no_aliases:
634
alias_argv = get_alias(argv[0])
636
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
637
argv[0] = alias_argv.pop(0)
639
cmd = str(argv.pop(0))
641
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
642
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
643
run = cmd_obj.run_argv
646
run = cmd_obj.run_argv_aliases
647
run_argv = [argv, alias_argv]
651
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
653
ret = apply_profiled(run, *run_argv)
658
# reset, in case we may do other commands later within the same process
661
def display_command(func):
662
"""Decorator that suppresses pipe/interrupt errors."""
663
def ignore_pipe(*args, **kwargs):
665
result = func(*args, **kwargs)
669
if not hasattr(e, 'errno'):
671
if e.errno != errno.EPIPE:
672
# Win32 raises IOError with errno=0 on a broken pipe
673
if sys.platform != 'win32' or e.errno != 0:
676
except KeyboardInterrupt:
683
from bzrlib.ui.text import TextUIFactory
684
bzrlib.ui.ui_factory = TextUIFactory()
685
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
686
ret = run_bzr_catch_errors(argv)
687
mutter("return code %d", ret)
691
def run_bzr_catch_errors(argv):
694
# do this here inside the exception wrappers to catch EPIPE
697
# used to handle AssertionError and KeyboardInterrupt
698
# specially here, but hopefully they're handled ok by the logger now
699
bzrlib.trace.report_exception(sys.exc_info(), sys.stderr)
700
if os.environ.get('BZR_PDB'):
701
print '**** entering debugger'
703
pdb.post_mortem(sys.exc_traceback)
706
if __name__ == '__main__':
707
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
