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?
34
from warnings import warn
38
import bzrlib.errors as errors
39
from bzrlib.errors import (BzrError,
43
from bzrlib import option
44
from bzrlib.option import Option
46
from bzrlib.revisionspec import RevisionSpec
47
from bzrlib.symbol_versioning import (deprecated_method, zero_eight)
49
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
54
def register_command(cmd, decorate=False):
55
"""Utility function to help register a command
57
:param cmd: Command subclass to register
58
:param decorate: If true, allow overriding an existing command
59
of the same name; the old command is returned by this function.
60
Otherwise it is an error to try to override an existing command.
64
if k.startswith("cmd_"):
65
k_unsquished = _unsquish_command_name(k)
68
if not plugin_cmds.has_key(k_unsquished):
69
plugin_cmds[k_unsquished] = cmd
70
mutter('registered plugin command %s', k_unsquished)
71
if decorate and k_unsquished in builtin_command_names():
72
return _builtin_commands()[k_unsquished]
74
result = plugin_cmds[k_unsquished]
75
plugin_cmds[k_unsquished] = cmd
78
log_error('Two plugins defined the same command: %r' % k)
79
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
82
def _squish_command_name(cmd):
83
return 'cmd_' + cmd.replace('-', '_')
86
def _unsquish_command_name(cmd):
87
assert cmd.startswith("cmd_")
88
return cmd[4:].replace('_','-')
91
def _builtin_commands():
92
import bzrlib.builtins
94
builtins = bzrlib.builtins.__dict__
96
if name.startswith("cmd_"):
97
real_name = _unsquish_command_name(name)
98
r[real_name] = builtins[name]
102
def builtin_command_names():
103
"""Return list of builtin command names."""
104
return _builtin_commands().keys()
107
def plugin_command_names():
108
return plugin_cmds.keys()
111
def _get_cmd_dict(plugins_override=True):
112
"""Return name->class mapping for all commands."""
113
d = _builtin_commands()
115
d.update(plugin_cmds)
119
def get_all_cmds(plugins_override=True):
120
"""Return canonical name and class for all registered commands."""
121
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
125
def get_cmd_object(cmd_name, plugins_override=True):
126
"""Return the canonical name and command class for a command.
129
If true, plugin commands can override builtins.
131
from bzrlib.externalcommand import ExternalCommand
133
cmd_name = str(cmd_name) # not unicode
135
# first look up this command under the specified name
136
cmds = _get_cmd_dict(plugins_override=plugins_override)
138
return cmds[cmd_name]()
142
# look for any command which claims this as an alias
143
for real_cmd_name, cmd_class in cmds.iteritems():
144
if cmd_name in cmd_class.aliases:
147
cmd_obj = ExternalCommand.find_command(cmd_name)
151
raise BzrCommandError('unknown command "%s"' % cmd_name)
154
class Command(object):
155
"""Base class for commands.
157
Commands are the heart of the command-line bzr interface.
159
The command object mostly handles the mapping of command-line
160
parameters into one or more bzrlib operations, and of the results
163
Commands normally don't have any state. All their arguments are
164
passed in to the run method. (Subclasses may take a different
165
policy if the behaviour of the instance needs to depend on e.g. a
166
shell plugin and not just its Python class.)
168
The docstring for an actual command should give a single-line
169
summary, then a complete description of the command. A grammar
170
description will be inserted.
173
Other accepted names for this command.
176
List of argument forms, marked with whether they are optional,
181
['to_location', 'from_branch?', 'file*']
183
'to_location' is required
184
'from_branch' is optional
185
'file' can be specified 0 or more times
188
List of options that may be given for this command. These can
189
be either strings, referring to globally-defined options,
190
or option objects. Retrieve through options().
193
If true, this command isn't advertised. This is typically
194
for commands intended for expert users.
197
Command objects will get a 'outf' attribute, which has been
198
setup to properly handle encoding of unicode strings.
199
encoding_type determines what will happen when characters cannot
201
strict - abort if we cannot decode
202
replace - put in a bogus character (typically '?')
203
exact - do not encode sys.stdout
209
encoding_type = 'strict'
214
"""Construct an instance of this command."""
215
if self.__doc__ == Command.__doc__:
216
warn("No help message set for %r" % self)
219
"""Return dict of valid options for this command.
221
Maps from long option name to option object."""
223
r['help'] = Option.OPTIONS['help']
224
for o in self.takes_options:
225
if isinstance(o, basestring):
226
o = Option.OPTIONS[o]
230
def _setup_outf(self):
231
"""Return a file linked to stdout, which has proper encoding."""
232
assert self.encoding_type in ['strict', 'exact', 'replace']
234
# Originally I was using self.stdout, but that looks
235
# *way* too much like sys.stdout
236
if self.encoding_type == 'exact':
237
self.outf = sys.stdout
240
output_encoding = bzrlib.osutils.get_terminal_encoding()
242
# use 'replace' so that we don't abort if trying to write out
243
# in e.g. the default C locale.
244
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
245
# For whatever reason codecs.getwriter() does not advertise its encoding
246
# it just returns the encoding of the wrapped file, which is completely
247
# bogus. So set the attribute, so we can find the correct encoding later.
248
self.outf.encoding = output_encoding
250
@deprecated_method(zero_eight)
251
def run_argv(self, argv):
252
"""Parse command line and run.
254
See run_argv_aliases for the 0.8 and beyond api.
256
return self.run_argv_aliases(argv)
258
def run_argv_aliases(self, argv, alias_argv=None):
259
"""Parse the command line and run with extra aliases in alias_argv."""
260
args, opts = parse_args(self, argv, alias_argv)
261
if 'help' in opts: # e.g. bzr add --help
262
from bzrlib.help import help_on_command
263
help_on_command(self.name())
265
# mix arguments and options into one dictionary
266
cmdargs = _match_argform(self.name(), self.takes_args, args)
268
for k, v in opts.items():
269
cmdopts[k.replace('-', '_')] = v
271
all_cmd_args = cmdargs.copy()
272
all_cmd_args.update(cmdopts)
276
return self.run(**all_cmd_args)
279
"""Actually run the command.
281
This is invoked with the options and arguments bound to
284
Return 0 or None if the command was successful, or a non-zero
285
shell error code if not. It's OK for this method to allow
286
an exception to raise up.
288
raise NotImplementedError('no implementation of command %r'
292
"""Return help message for this class."""
293
from inspect import getdoc
294
if self.__doc__ is Command.__doc__:
299
return _unsquish_command_name(self.__class__.__name__)
301
def plugin_name(self):
302
"""Get the name of the plugin that provides this command.
304
:return: The name of the plugin or None if the command is builtin.
306
mod_parts = self.__module__.split('.')
307
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
313
def parse_spec(spec):
319
>>> parse_spec("../@")
321
>>> parse_spec("../f/@35")
323
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
324
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
329
parsed = spec.split('/@')
330
assert len(parsed) == 2
335
parsed[1] = int(parsed[1])
337
pass # We can allow stuff like ./@revid:blahblahblah
341
parsed = [spec, None]
344
def parse_args(command, argv, alias_argv=None):
345
"""Parse command line.
347
Arguments and options are parsed at this level before being passed
348
down to specific command handlers. This routine knows, from a
349
lookup table, something about the available options, what optargs
350
they take, and which commands will accept them.
352
# TODO: make it a method of the Command?
353
parser = option.get_optparser(command.options())
354
if alias_argv is not None:
355
args = alias_argv + argv
359
options, args = parser.parse_args(args)
360
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
361
v is not option.OptionParser.DEFAULT_VALUE])
365
def _match_argform(cmd, takes_args, args):
368
# step through args and takes_args, allowing appropriate 0-many matches
369
for ap in takes_args:
373
argdict[argname] = args.pop(0)
374
elif ap[-1] == '*': # all remaining arguments
376
argdict[argname + '_list'] = args[:]
379
argdict[argname + '_list'] = None
382
raise BzrCommandError("command %r needs one or more %s"
383
% (cmd, argname.upper()))
385
argdict[argname + '_list'] = args[:]
387
elif ap[-1] == '$': # all but one
389
raise BzrCommandError("command %r needs one or more %s"
390
% (cmd, argname.upper()))
391
argdict[argname + '_list'] = args[:-1]
397
raise BzrCommandError("command %r requires argument %s"
398
% (cmd, argname.upper()))
400
argdict[argname] = args.pop(0)
403
raise BzrCommandError("extra argument to command %s: %s"
410
def apply_profiled(the_callable, *args, **kwargs):
414
pffileno, pfname = tempfile.mkstemp()
416
prof = hotshot.Profile(pfname)
418
ret = prof.runcall(the_callable, *args, **kwargs) or 0
421
stats = hotshot.stats.load(pfname)
423
stats.sort_stats('cum') # 'time'
424
## XXX: Might like to write to stderr or the trace file instead but
425
## print_stats seems hardcoded to stdout
426
stats.print_stats(20)
433
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
434
from bzrlib.lsprof import profile
436
ret, stats = profile(the_callable, *args, **kwargs)
442
cPickle.dump(stats, open(filename, 'w'), 2)
443
print 'Profile data written to %r.' % filename
448
"""Return an expanded alias, or None if no alias exists"""
450
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
452
return alias.split(' ')
457
"""Execute a command.
459
This is similar to main(), but without all the trappings for
460
logging and error handling.
463
The command-line arguments, without the program name from argv[0]
464
These should already be decoded. All library/test code calling
465
run_bzr should be passing valid strings (don't need decoding).
467
Returns a command status or raises an exception.
469
Special master options: these must come before the command because
470
they control how the command is interpreted.
473
Do not load plugin modules at all
479
Only use builtin commands. (Plugins are still allowed to change
483
Run under the Python hotshot profiler.
486
Run under the Python lsprof profiler.
490
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
491
opt_no_aliases = 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':
508
opt_lsprof_file = argv[i + 1]
510
elif a == '--no-plugins':
511
opt_no_plugins = True
512
elif a == '--no-aliases':
513
opt_no_aliases = True
514
elif a == '--builtin':
516
elif a in ('--quiet', '-q'):
524
from bzrlib.builtins import cmd_help
525
cmd_help().run_argv_aliases([])
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
542
if not opt_no_aliases:
543
alias_argv = get_alias(argv[0])
545
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
546
argv[0] = alias_argv.pop(0)
548
cmd = str(argv.pop(0))
550
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
551
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
552
run = cmd_obj.run_argv
555
run = cmd_obj.run_argv_aliases
556
run_argv = [argv, alias_argv]
560
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
562
ret = apply_profiled(run, *run_argv)
567
# reset, in case we may do other commands later within the same process
570
def display_command(func):
571
"""Decorator that suppresses pipe/interrupt errors."""
572
def ignore_pipe(*args, **kwargs):
574
result = func(*args, **kwargs)
578
if not hasattr(e, 'errno'):
580
if e.errno != errno.EPIPE:
581
# Win32 raises IOError with errno=0 on a broken pipe
582
if sys.platform != 'win32' or e.errno != 0:
585
except KeyboardInterrupt:
592
from bzrlib.ui.text import TextUIFactory
593
bzrlib.ui.ui_factory = TextUIFactory()
594
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
595
ret = run_bzr_catch_errors(argv)
596
mutter("return code %d", ret)
600
def run_bzr_catch_errors(argv):
603
# do this here inside the exception wrappers to catch EPIPE
606
# used to handle AssertionError and KeyboardInterrupt
607
# specially here, but hopefully they're handled ok by the logger now
608
bzrlib.trace.report_exception(sys.exc_info(), sys.stderr)
609
if os.environ.get('BZR_PDB'):
610
print '**** entering debugger'
612
pdb.post_mortem(sys.exc_traceback)
615
if __name__ == '__main__':
616
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
