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 bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
38
from warnings import warn
49
from bzrlib.symbol_versioning import (deprecated_method, zero_eight)
51
from bzrlib.option import Option
57
def register_command(cmd, decorate=False):
58
"""Utility function to help register a command
60
:param cmd: Command subclass to register
61
:param decorate: If true, allow overriding an existing command
62
of the same name; the old command is returned by this function.
63
Otherwise it is an error to try to override an existing command.
67
if k.startswith("cmd_"):
68
k_unsquished = _unsquish_command_name(k)
71
if k_unsquished not in plugin_cmds:
72
plugin_cmds[k_unsquished] = cmd
73
trace.mutter('registered plugin command %s', k_unsquished)
74
if decorate and k_unsquished in builtin_command_names():
75
return _builtin_commands()[k_unsquished]
77
result = plugin_cmds[k_unsquished]
78
plugin_cmds[k_unsquished] = cmd
81
trace.log_error('Two plugins defined the same command: %r' % k)
82
trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
85
def _squish_command_name(cmd):
86
return 'cmd_' + cmd.replace('-', '_')
89
def _unsquish_command_name(cmd):
90
assert cmd.startswith("cmd_")
91
return cmd[4:].replace('_','-')
94
def _builtin_commands():
95
import bzrlib.builtins
97
builtins = bzrlib.builtins.__dict__
99
if name.startswith("cmd_"):
100
real_name = _unsquish_command_name(name)
101
r[real_name] = builtins[name]
105
def builtin_command_names():
106
"""Return list of builtin command names."""
107
return _builtin_commands().keys()
110
def plugin_command_names():
111
return plugin_cmds.keys()
114
def _get_cmd_dict(plugins_override=True):
115
"""Return name->class mapping for all commands."""
116
d = _builtin_commands()
118
d.update(plugin_cmds)
122
def get_all_cmds(plugins_override=True):
123
"""Return canonical name and class for all registered commands."""
124
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
128
def get_cmd_object(cmd_name, plugins_override=True):
129
"""Return the canonical name and command class for a command.
132
If true, plugin commands can override builtins.
134
from bzrlib.externalcommand import ExternalCommand
136
# We want only 'ascii' command names, but the user may have typed
137
# in a Unicode name. In that case, they should just get a
138
# 'command not found' error later.
139
# In the future, we may actually support Unicode command names.
141
# first look up this command under the specified name
142
cmds = _get_cmd_dict(plugins_override=plugins_override)
144
return cmds[cmd_name]()
148
# look for any command which claims this as an alias
149
for real_cmd_name, cmd_class in cmds.iteritems():
150
if cmd_name in cmd_class.aliases:
153
cmd_obj = ExternalCommand.find_command(cmd_name)
157
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
160
class Command(object):
161
"""Base class for commands.
163
Commands are the heart of the command-line bzr interface.
165
The command object mostly handles the mapping of command-line
166
parameters into one or more bzrlib operations, and of the results
169
Commands normally don't have any state. All their arguments are
170
passed in to the run method. (Subclasses may take a different
171
policy if the behaviour of the instance needs to depend on e.g. a
172
shell plugin and not just its Python class.)
174
The docstring for an actual command should give a single-line
175
summary, then a complete description of the command. A grammar
176
description will be inserted.
179
Other accepted names for this command.
182
List of argument forms, marked with whether they are optional,
187
['to_location', 'from_branch?', 'file*']
189
'to_location' is required
190
'from_branch' is optional
191
'file' can be specified 0 or more times
194
List of options that may be given for this command. These can
195
be either strings, referring to globally-defined options,
196
or option objects. Retrieve through options().
199
If true, this command isn't advertised. This is typically
200
for commands intended for expert users.
203
Command objects will get a 'outf' attribute, which has been
204
setup to properly handle encoding of unicode strings.
205
encoding_type determines what will happen when characters cannot
207
strict - abort if we cannot decode
208
replace - put in a bogus character (typically '?')
209
exact - do not encode sys.stdout
215
encoding_type = 'strict'
220
"""Construct an instance of this command."""
221
if self.__doc__ == Command.__doc__:
222
warn("No help message set for %r" % self)
225
"""Return dict of valid options for this command.
227
Maps from long option name to option object."""
229
r['help'] = option.Option.OPTIONS['help']
230
for o in self.takes_options:
231
if isinstance(o, basestring):
232
o = option.Option.OPTIONS[o]
236
def _setup_outf(self):
237
"""Return a file linked to stdout, which has proper encoding."""
238
assert self.encoding_type in ['strict', 'exact', 'replace']
240
# Originally I was using self.stdout, but that looks
241
# *way* too much like sys.stdout
242
if self.encoding_type == 'exact':
243
self.outf = sys.stdout
246
output_encoding = osutils.get_terminal_encoding()
248
# use 'replace' so that we don't abort if trying to write out
249
# in e.g. the default C locale.
250
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
251
# For whatever reason codecs.getwriter() does not advertise its encoding
252
# it just returns the encoding of the wrapped file, which is completely
253
# bogus. So set the attribute, so we can find the correct encoding later.
254
self.outf.encoding = output_encoding
256
@deprecated_method(zero_eight)
257
def run_argv(self, argv):
258
"""Parse command line and run.
260
See run_argv_aliases for the 0.8 and beyond api.
262
return self.run_argv_aliases(argv)
264
def run_argv_aliases(self, argv, alias_argv=None):
265
"""Parse the command line and run with extra aliases in alias_argv."""
267
warn("Passing None for [] is deprecated from bzrlib 0.10",
268
DeprecationWarning, stacklevel=2)
270
args, opts = parse_args(self, argv, alias_argv)
271
if 'help' in opts: # e.g. bzr add --help
272
from bzrlib.help import help_on_command
273
help_on_command(self.name())
275
# mix arguments and options into one dictionary
276
cmdargs = _match_argform(self.name(), self.takes_args, args)
278
for k, v in opts.items():
279
cmdopts[k.replace('-', '_')] = v
281
all_cmd_args = cmdargs.copy()
282
all_cmd_args.update(cmdopts)
286
return self.run(**all_cmd_args)
289
"""Actually run the command.
291
This is invoked with the options and arguments bound to
294
Return 0 or None if the command was successful, or a non-zero
295
shell error code if not. It's OK for this method to allow
296
an exception to raise up.
298
raise NotImplementedError('no implementation of command %r'
302
"""Return help message for this class."""
303
from inspect import getdoc
304
if self.__doc__ is Command.__doc__:
309
return _unsquish_command_name(self.__class__.__name__)
311
def plugin_name(self):
312
"""Get the name of the plugin that provides this command.
314
:return: The name of the plugin or None if the command is builtin.
316
mod_parts = self.__module__.split('.')
317
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
323
def parse_spec(spec):
329
>>> parse_spec("../@")
331
>>> parse_spec("../f/@35")
333
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
334
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
339
parsed = spec.split('/@')
340
assert len(parsed) == 2
345
parsed[1] = int(parsed[1])
347
pass # We can allow stuff like ./@revid:blahblahblah
351
parsed = [spec, None]
354
def parse_args(command, argv, alias_argv=None):
355
"""Parse command line.
357
Arguments and options are parsed at this level before being passed
358
down to specific command handlers. This routine knows, from a
359
lookup table, something about the available options, what optargs
360
they take, and which commands will accept them.
362
# TODO: make it a method of the Command?
363
parser = option.get_optparser(command.options())
364
if alias_argv is not None:
365
args = alias_argv + argv
369
options, args = parser.parse_args(args)
370
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
371
v is not option.OptionParser.DEFAULT_VALUE])
375
def _match_argform(cmd, takes_args, args):
378
# step through args and takes_args, allowing appropriate 0-many matches
379
for ap in takes_args:
383
argdict[argname] = args.pop(0)
384
elif ap[-1] == '*': # all remaining arguments
386
argdict[argname + '_list'] = args[:]
389
argdict[argname + '_list'] = None
392
raise errors.BzrCommandError("command %r needs one or more %s"
393
% (cmd, argname.upper()))
395
argdict[argname + '_list'] = args[:]
397
elif ap[-1] == '$': # all but one
399
raise errors.BzrCommandError("command %r needs one or more %s"
400
% (cmd, argname.upper()))
401
argdict[argname + '_list'] = args[:-1]
407
raise errors.BzrCommandError("command %r requires argument %s"
408
% (cmd, argname.upper()))
410
argdict[argname] = args.pop(0)
413
raise errors.BzrCommandError("extra argument to command %s: %s"
420
def apply_profiled(the_callable, *args, **kwargs):
424
pffileno, pfname = tempfile.mkstemp()
426
prof = hotshot.Profile(pfname)
428
ret = prof.runcall(the_callable, *args, **kwargs) or 0
431
stats = hotshot.stats.load(pfname)
433
stats.sort_stats('cum') # 'time'
434
## XXX: Might like to write to stderr or the trace file instead but
435
## print_stats seems hardcoded to stdout
436
stats.print_stats(20)
443
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
444
from bzrlib.lsprof import profile
446
ret, stats = profile(the_callable, *args, **kwargs)
452
cPickle.dump(stats, open(filename, 'w'), 2)
453
print 'Profile data written to %r.' % filename
458
"""Return an expanded alias, or None if no alias exists"""
460
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
462
return alias.split(' ')
467
"""Execute a command.
469
This is similar to main(), but without all the trappings for
470
logging and error handling.
473
The command-line arguments, without the program name from argv[0]
474
These should already be decoded. All library/test code calling
475
run_bzr should be passing valid strings (don't need decoding).
477
Returns a command status or raises an exception.
479
Special master options: these must come before the command because
480
they control how the command is interpreted.
483
Do not load plugin modules at all
489
Only use builtin commands. (Plugins are still allowed to change
493
Run under the Python hotshot profiler.
496
Run under the Python lsprof profiler.
500
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
501
opt_no_aliases = False
502
opt_lsprof_file = None
504
# --no-plugins is handled specially at a very early stage. We need
505
# to load plugins before doing other command parsing so that they
506
# can override commands, but this needs to happen first.
514
elif a == '--lsprof':
516
elif a == '--lsprof-file':
518
opt_lsprof_file = argv[i + 1]
520
elif a == '--no-plugins':
521
opt_no_plugins = True
522
elif a == '--no-aliases':
523
opt_no_aliases = True
524
elif a == '--builtin':
526
elif a in ('--quiet', '-q'):
534
from bzrlib.builtins import cmd_help
535
cmd_help().run_argv_aliases([])
538
if argv[0] == '--version':
539
from bzrlib.version import show_version
543
if not opt_no_plugins:
544
from bzrlib.plugin import load_plugins
547
from bzrlib.plugin import disable_plugins
552
if not opt_no_aliases:
553
alias_argv = get_alias(argv[0])
555
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
556
argv[0] = alias_argv.pop(0)
559
# We want only 'ascii' command names, but the user may have typed
560
# in a Unicode name. In that case, they should just get a
561
# 'command not found' error later.
563
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
564
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
565
run = cmd_obj.run_argv
568
run = cmd_obj.run_argv_aliases
569
run_argv = [argv, alias_argv]
573
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
575
ret = apply_profiled(run, *run_argv)
580
# reset, in case we may do other commands later within the same process
581
trace.be_quiet(False)
583
def display_command(func):
584
"""Decorator that suppresses pipe/interrupt errors."""
585
def ignore_pipe(*args, **kwargs):
587
result = func(*args, **kwargs)
591
if getattr(e, 'errno', None) is None:
593
if e.errno != errno.EPIPE:
594
# Win32 raises IOError with errno=0 on a broken pipe
595
if sys.platform != 'win32' or e.errno != 0:
598
except KeyboardInterrupt:
605
from bzrlib.ui.text import TextUIFactory
606
bzrlib.ui.ui_factory = TextUIFactory()
607
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
608
ret = run_bzr_catch_errors(argv)
609
trace.mutter("return code %d", ret)
613
def run_bzr_catch_errors(argv):
616
# do this here inside the exception wrappers to catch EPIPE
619
# used to handle AssertionError and KeyboardInterrupt
620
# specially here, but hopefully they're handled ok by the logger now
621
trace.report_exception(sys.exc_info(), sys.stderr)
622
if os.environ.get('BZR_PDB'):
623
print '**** entering debugger'
625
pdb.post_mortem(sys.exc_traceback)
628
if __name__ == '__main__':
629
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
