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 k_unsquished not in plugin_cmds:
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
# We want only 'ascii' command names, but the user may have typed
134
# in a Unicode name. In that case, they should just get a
135
# 'command not found' error later.
136
# In the future, we may actually support Unicode command names.
138
# first look up this command under the specified name
139
cmds = _get_cmd_dict(plugins_override=plugins_override)
141
return cmds[cmd_name]()
145
# look for any command which claims this as an alias
146
for real_cmd_name, cmd_class in cmds.iteritems():
147
if cmd_name in cmd_class.aliases:
150
cmd_obj = ExternalCommand.find_command(cmd_name)
154
raise BzrCommandError('unknown command "%s"' % cmd_name)
157
class Command(object):
158
"""Base class for commands.
160
Commands are the heart of the command-line bzr interface.
162
The command object mostly handles the mapping of command-line
163
parameters into one or more bzrlib operations, and of the results
166
Commands normally don't have any state. All their arguments are
167
passed in to the run method. (Subclasses may take a different
168
policy if the behaviour of the instance needs to depend on e.g. a
169
shell plugin and not just its Python class.)
171
The docstring for an actual command should give a single-line
172
summary, then a complete description of the command. A grammar
173
description will be inserted.
176
Other accepted names for this command.
179
List of argument forms, marked with whether they are optional,
184
['to_location', 'from_branch?', 'file*']
186
'to_location' is required
187
'from_branch' is optional
188
'file' can be specified 0 or more times
191
List of options that may be given for this command. These can
192
be either strings, referring to globally-defined options,
193
or option objects. Retrieve through options().
196
If true, this command isn't advertised. This is typically
197
for commands intended for expert users.
200
Command objects will get a 'outf' attribute, which has been
201
setup to properly handle encoding of unicode strings.
202
encoding_type determines what will happen when characters cannot
204
strict - abort if we cannot decode
205
replace - put in a bogus character (typically '?')
206
exact - do not encode sys.stdout
212
encoding_type = 'strict'
217
"""Construct an instance of this command."""
218
if self.__doc__ == Command.__doc__:
219
warn("No help message set for %r" % self)
222
"""Return dict of valid options for this command.
224
Maps from long option name to option object."""
226
r['help'] = Option.OPTIONS['help']
227
for o in self.takes_options:
228
if isinstance(o, basestring):
229
o = Option.OPTIONS[o]
233
def _setup_outf(self):
234
"""Return a file linked to stdout, which has proper encoding."""
235
assert self.encoding_type in ['strict', 'exact', 'replace']
237
# Originally I was using self.stdout, but that looks
238
# *way* too much like sys.stdout
239
if self.encoding_type == 'exact':
240
self.outf = sys.stdout
243
output_encoding = bzrlib.osutils.get_terminal_encoding()
245
# use 'replace' so that we don't abort if trying to write out
246
# in e.g. the default C locale.
247
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
248
# For whatever reason codecs.getwriter() does not advertise its encoding
249
# it just returns the encoding of the wrapped file, which is completely
250
# bogus. So set the attribute, so we can find the correct encoding later.
251
self.outf.encoding = output_encoding
253
@deprecated_method(zero_eight)
254
def run_argv(self, argv):
255
"""Parse command line and run.
257
See run_argv_aliases for the 0.8 and beyond api.
259
return self.run_argv_aliases(argv)
261
def run_argv_aliases(self, argv, alias_argv=None):
262
"""Parse the command line and run with extra aliases in alias_argv."""
264
warn("Passing None for [] is deprecated from bzrlib 0.10",
265
DeprecationWarning, stacklevel=2)
267
args, opts = parse_args(self, argv, alias_argv)
268
if 'help' in opts: # e.g. bzr add --help
269
from bzrlib.help import help_on_command
270
help_on_command(self.name())
272
# mix arguments and options into one dictionary
273
cmdargs = _match_argform(self.name(), self.takes_args, args)
275
for k, v in opts.items():
276
cmdopts[k.replace('-', '_')] = v
278
all_cmd_args = cmdargs.copy()
279
all_cmd_args.update(cmdopts)
283
return self.run(**all_cmd_args)
286
"""Actually run the command.
288
This is invoked with the options and arguments bound to
291
Return 0 or None if the command was successful, or a non-zero
292
shell error code if not. It's OK for this method to allow
293
an exception to raise up.
295
raise NotImplementedError('no implementation of command %r'
299
"""Return help message for this class."""
300
from inspect import getdoc
301
if self.__doc__ is Command.__doc__:
306
return _unsquish_command_name(self.__class__.__name__)
308
def plugin_name(self):
309
"""Get the name of the plugin that provides this command.
311
:return: The name of the plugin or None if the command is builtin.
313
mod_parts = self.__module__.split('.')
314
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
320
def parse_spec(spec):
326
>>> parse_spec("../@")
328
>>> parse_spec("../f/@35")
330
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
331
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
336
parsed = spec.split('/@')
337
assert len(parsed) == 2
342
parsed[1] = int(parsed[1])
344
pass # We can allow stuff like ./@revid:blahblahblah
348
parsed = [spec, None]
351
def parse_args(command, argv, alias_argv=None):
352
"""Parse command line.
354
Arguments and options are parsed at this level before being passed
355
down to specific command handlers. This routine knows, from a
356
lookup table, something about the available options, what optargs
357
they take, and which commands will accept them.
359
# TODO: make it a method of the Command?
360
parser = option.get_optparser(command.options())
361
if alias_argv is not None:
362
args = alias_argv + argv
366
options, args = parser.parse_args(args)
367
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
368
v is not option.OptionParser.DEFAULT_VALUE])
372
def _match_argform(cmd, takes_args, args):
375
# step through args and takes_args, allowing appropriate 0-many matches
376
for ap in takes_args:
380
argdict[argname] = args.pop(0)
381
elif ap[-1] == '*': # all remaining arguments
383
argdict[argname + '_list'] = args[:]
386
argdict[argname + '_list'] = None
389
raise BzrCommandError("command %r needs one or more %s"
390
% (cmd, argname.upper()))
392
argdict[argname + '_list'] = args[:]
394
elif ap[-1] == '$': # all but one
396
raise BzrCommandError("command %r needs one or more %s"
397
% (cmd, argname.upper()))
398
argdict[argname + '_list'] = args[:-1]
404
raise BzrCommandError("command %r requires argument %s"
405
% (cmd, argname.upper()))
407
argdict[argname] = args.pop(0)
410
raise BzrCommandError("extra argument to command %s: %s"
417
def apply_profiled(the_callable, *args, **kwargs):
421
pffileno, pfname = tempfile.mkstemp()
423
prof = hotshot.Profile(pfname)
425
ret = prof.runcall(the_callable, *args, **kwargs) or 0
428
stats = hotshot.stats.load(pfname)
430
stats.sort_stats('cum') # 'time'
431
## XXX: Might like to write to stderr or the trace file instead but
432
## print_stats seems hardcoded to stdout
433
stats.print_stats(20)
440
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
441
from bzrlib.lsprof import profile
443
ret, stats = profile(the_callable, *args, **kwargs)
449
cPickle.dump(stats, open(filename, 'w'), 2)
450
print 'Profile data written to %r.' % filename
455
"""Return an expanded alias, or None if no alias exists"""
457
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
459
return alias.split(' ')
464
"""Execute a command.
466
This is similar to main(), but without all the trappings for
467
logging and error handling.
470
The command-line arguments, without the program name from argv[0]
471
These should already be decoded. All library/test code calling
472
run_bzr should be passing valid strings (don't need decoding).
474
Returns a command status or raises an exception.
476
Special master options: these must come before the command because
477
they control how the command is interpreted.
480
Do not load plugin modules at all
486
Only use builtin commands. (Plugins are still allowed to change
490
Run under the Python hotshot profiler.
493
Run under the Python lsprof profiler.
497
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
498
opt_no_aliases = False
499
opt_lsprof_file = None
501
# --no-plugins is handled specially at a very early stage. We need
502
# to load plugins before doing other command parsing so that they
503
# can override commands, but this needs to happen first.
511
elif a == '--lsprof':
513
elif a == '--lsprof-file':
515
opt_lsprof_file = argv[i + 1]
517
elif a == '--no-plugins':
518
opt_no_plugins = True
519
elif a == '--no-aliases':
520
opt_no_aliases = True
521
elif a == '--builtin':
523
elif a in ('--quiet', '-q'):
531
from bzrlib.builtins import cmd_help
532
cmd_help().run_argv_aliases([])
535
if argv[0] == '--version':
536
from bzrlib.version import show_version
540
if not opt_no_plugins:
541
from bzrlib.plugin import load_plugins
544
from bzrlib.plugin import disable_plugins
549
if not opt_no_aliases:
550
alias_argv = get_alias(argv[0])
552
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
553
argv[0] = alias_argv.pop(0)
556
# We want only 'ascii' command names, but the user may have typed
557
# in a Unicode name. In that case, they should just get a
558
# 'command not found' error later.
560
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
561
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
562
run = cmd_obj.run_argv
565
run = cmd_obj.run_argv_aliases
566
run_argv = [argv, alias_argv]
570
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
572
ret = apply_profiled(run, *run_argv)
577
# reset, in case we may do other commands later within the same process
580
def display_command(func):
581
"""Decorator that suppresses pipe/interrupt errors."""
582
def ignore_pipe(*args, **kwargs):
584
result = func(*args, **kwargs)
588
if not hasattr(e, 'errno'):
590
if e.errno != errno.EPIPE:
591
# Win32 raises IOError with errno=0 on a broken pipe
592
if sys.platform != 'win32' or e.errno != 0:
595
except KeyboardInterrupt:
602
from bzrlib.ui.text import TextUIFactory
603
bzrlib.ui.ui_factory = TextUIFactory()
604
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
605
ret = run_bzr_catch_errors(argv)
606
mutter("return code %d", ret)
610
def run_bzr_catch_errors(argv):
613
# do this here inside the exception wrappers to catch EPIPE
616
# used to handle AssertionError and KeyboardInterrupt
617
# specially here, but hopefully they're handled ok by the logger now
618
bzrlib.trace.report_exception(sys.exc_info(), sys.stderr)
619
if os.environ.get('BZR_PDB'):
620
print '**** entering debugger'
622
pdb.post_mortem(sys.exc_traceback)
625
if __name__ == '__main__':
626
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
