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.symbol_versioning import (deprecated_method, zero_eight)
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 k_unsquished not in plugin_cmds:
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
# We want only 'ascii' command names, but the user may have typed
133
# in a Unicode name. In that case, they should just get a
134
# 'command not found' error later.
135
# In the future, we may actually support Unicode command names.
137
# first look up this command under the specified name
138
cmds = _get_cmd_dict(plugins_override=plugins_override)
140
return cmds[cmd_name]()
144
# look for any command which claims this as an alias
145
for real_cmd_name, cmd_class in cmds.iteritems():
146
if cmd_name in cmd_class.aliases:
149
cmd_obj = ExternalCommand.find_command(cmd_name)
153
raise BzrCommandError('unknown command "%s"' % cmd_name)
156
class Command(object):
157
"""Base class for commands.
159
Commands are the heart of the command-line bzr interface.
161
The command object mostly handles the mapping of command-line
162
parameters into one or more bzrlib operations, and of the results
165
Commands normally don't have any state. All their arguments are
166
passed in to the run method. (Subclasses may take a different
167
policy if the behaviour of the instance needs to depend on e.g. a
168
shell plugin and not just its Python class.)
170
The docstring for an actual command should give a single-line
171
summary, then a complete description of the command. A grammar
172
description will be inserted.
175
Other accepted names for this command.
178
List of argument forms, marked with whether they are optional,
183
['to_location', 'from_branch?', 'file*']
185
'to_location' is required
186
'from_branch' is optional
187
'file' can be specified 0 or more times
190
List of options that may be given for this command. These can
191
be either strings, referring to globally-defined options,
192
or option objects. Retrieve through options().
195
If true, this command isn't advertised. This is typically
196
for commands intended for expert users.
199
Command objects will get a 'outf' attribute, which has been
200
setup to properly handle encoding of unicode strings.
201
encoding_type determines what will happen when characters cannot
203
strict - abort if we cannot decode
204
replace - put in a bogus character (typically '?')
205
exact - do not encode sys.stdout
211
encoding_type = 'strict'
216
"""Construct an instance of this command."""
217
if self.__doc__ == Command.__doc__:
218
warn("No help message set for %r" % self)
221
"""Return dict of valid options for this command.
223
Maps from long option name to option object."""
225
r['help'] = Option.OPTIONS['help']
226
for o in self.takes_options:
227
if isinstance(o, basestring):
228
o = Option.OPTIONS[o]
232
def _setup_outf(self):
233
"""Return a file linked to stdout, which has proper encoding."""
234
assert self.encoding_type in ['strict', 'exact', 'replace']
236
# Originally I was using self.stdout, but that looks
237
# *way* too much like sys.stdout
238
if self.encoding_type == 'exact':
239
self.outf = sys.stdout
242
output_encoding = bzrlib.osutils.get_terminal_encoding()
244
# use 'replace' so that we don't abort if trying to write out
245
# in e.g. the default C locale.
246
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
247
# For whatever reason codecs.getwriter() does not advertise its encoding
248
# it just returns the encoding of the wrapped file, which is completely
249
# bogus. So set the attribute, so we can find the correct encoding later.
250
self.outf.encoding = output_encoding
252
@deprecated_method(zero_eight)
253
def run_argv(self, argv):
254
"""Parse command line and run.
256
See run_argv_aliases for the 0.8 and beyond api.
258
return self.run_argv_aliases(argv)
260
def run_argv_aliases(self, argv, alias_argv=None):
261
"""Parse the command line and run with extra aliases in alias_argv."""
263
warn("Passing None for [] is deprecated from bzrlib 0.10",
264
DeprecationWarning, stacklevel=2)
266
args, opts = parse_args(self, argv, alias_argv)
267
if 'help' in opts: # e.g. bzr add --help
268
from bzrlib.help import help_on_command
269
help_on_command(self.name())
271
# mix arguments and options into one dictionary
272
cmdargs = _match_argform(self.name(), self.takes_args, args)
274
for k, v in opts.items():
275
cmdopts[k.replace('-', '_')] = v
277
all_cmd_args = cmdargs.copy()
278
all_cmd_args.update(cmdopts)
282
return self.run(**all_cmd_args)
285
"""Actually run the command.
287
This is invoked with the options and arguments bound to
290
Return 0 or None if the command was successful, or a non-zero
291
shell error code if not. It's OK for this method to allow
292
an exception to raise up.
294
raise NotImplementedError('no implementation of command %r'
298
"""Return help message for this class."""
299
from inspect import getdoc
300
if self.__doc__ is Command.__doc__:
305
return _unsquish_command_name(self.__class__.__name__)
307
def plugin_name(self):
308
"""Get the name of the plugin that provides this command.
310
:return: The name of the plugin or None if the command is builtin.
312
mod_parts = self.__module__.split('.')
313
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
319
def parse_spec(spec):
325
>>> parse_spec("../@")
327
>>> parse_spec("../f/@35")
329
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
330
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
335
parsed = spec.split('/@')
336
assert len(parsed) == 2
341
parsed[1] = int(parsed[1])
343
pass # We can allow stuff like ./@revid:blahblahblah
347
parsed = [spec, None]
350
def parse_args(command, argv, alias_argv=None):
351
"""Parse command line.
353
Arguments and options are parsed at this level before being passed
354
down to specific command handlers. This routine knows, from a
355
lookup table, something about the available options, what optargs
356
they take, and which commands will accept them.
358
# TODO: make it a method of the Command?
359
parser = option.get_optparser(command.options())
360
if alias_argv is not None:
361
args = alias_argv + argv
365
options, args = parser.parse_args(args)
366
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
367
v is not option.OptionParser.DEFAULT_VALUE])
371
def _match_argform(cmd, takes_args, args):
374
# step through args and takes_args, allowing appropriate 0-many matches
375
for ap in takes_args:
379
argdict[argname] = args.pop(0)
380
elif ap[-1] == '*': # all remaining arguments
382
argdict[argname + '_list'] = args[:]
385
argdict[argname + '_list'] = None
388
raise BzrCommandError("command %r needs one or more %s"
389
% (cmd, argname.upper()))
391
argdict[argname + '_list'] = args[:]
393
elif ap[-1] == '$': # all but one
395
raise BzrCommandError("command %r needs one or more %s"
396
% (cmd, argname.upper()))
397
argdict[argname + '_list'] = args[:-1]
403
raise BzrCommandError("command %r requires argument %s"
404
% (cmd, argname.upper()))
406
argdict[argname] = args.pop(0)
409
raise BzrCommandError("extra argument to command %s: %s"
416
def apply_profiled(the_callable, *args, **kwargs):
420
pffileno, pfname = tempfile.mkstemp()
422
prof = hotshot.Profile(pfname)
424
ret = prof.runcall(the_callable, *args, **kwargs) or 0
427
stats = hotshot.stats.load(pfname)
429
stats.sort_stats('cum') # 'time'
430
## XXX: Might like to write to stderr or the trace file instead but
431
## print_stats seems hardcoded to stdout
432
stats.print_stats(20)
439
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
440
from bzrlib.lsprof import profile
442
ret, stats = profile(the_callable, *args, **kwargs)
448
cPickle.dump(stats, open(filename, 'w'), 2)
449
print 'Profile data written to %r.' % filename
454
"""Return an expanded alias, or None if no alias exists"""
456
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
458
return alias.split(' ')
463
"""Execute a command.
465
This is similar to main(), but without all the trappings for
466
logging and error handling.
469
The command-line arguments, without the program name from argv[0]
470
These should already be decoded. All library/test code calling
471
run_bzr should be passing valid strings (don't need decoding).
473
Returns a command status or raises an exception.
475
Special master options: these must come before the command because
476
they control how the command is interpreted.
479
Do not load plugin modules at all
485
Only use builtin commands. (Plugins are still allowed to change
489
Run under the Python hotshot profiler.
492
Run under the Python lsprof profiler.
496
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
497
opt_no_aliases = False
498
opt_lsprof_file = None
500
# --no-plugins is handled specially at a very early stage. We need
501
# to load plugins before doing other command parsing so that they
502
# can override commands, but this needs to happen first.
510
elif a == '--lsprof':
512
elif a == '--lsprof-file':
514
opt_lsprof_file = argv[i + 1]
516
elif a == '--no-plugins':
517
opt_no_plugins = True
518
elif a == '--no-aliases':
519
opt_no_aliases = True
520
elif a == '--builtin':
522
elif a in ('--quiet', '-q'):
530
from bzrlib.builtins import cmd_help
531
cmd_help().run_argv_aliases([])
534
if argv[0] == '--version':
535
from bzrlib.version import show_version
539
if not opt_no_plugins:
540
from bzrlib.plugin import load_plugins
543
from bzrlib.plugin import disable_plugins
548
if not opt_no_aliases:
549
alias_argv = get_alias(argv[0])
551
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
552
argv[0] = alias_argv.pop(0)
555
# We want only 'ascii' command names, but the user may have typed
556
# in a Unicode name. In that case, they should just get a
557
# 'command not found' error later.
559
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
560
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
561
run = cmd_obj.run_argv
564
run = cmd_obj.run_argv_aliases
565
run_argv = [argv, alias_argv]
569
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
571
ret = apply_profiled(run, *run_argv)
576
# reset, in case we may do other commands later within the same process
579
def display_command(func):
580
"""Decorator that suppresses pipe/interrupt errors."""
581
def ignore_pipe(*args, **kwargs):
583
result = func(*args, **kwargs)
587
if getattr(e, 'errno', None) is None:
589
if e.errno != errno.EPIPE:
590
# Win32 raises IOError with errno=0 on a broken pipe
591
if sys.platform != 'win32' or e.errno != 0:
594
except KeyboardInterrupt:
601
from bzrlib.ui.text import TextUIFactory
602
bzrlib.ui.ui_factory = TextUIFactory()
603
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
604
ret = run_bzr_catch_errors(argv)
605
mutter("return code %d", ret)
609
def run_bzr_catch_errors(argv):
612
# do this here inside the exception wrappers to catch EPIPE
615
# used to handle AssertionError and KeyboardInterrupt
616
# specially here, but hopefully they're handled ok by the logger now
617
bzrlib.trace.report_exception(sys.exc_info(), sys.stderr)
618
if os.environ.get('BZR_PDB'):
619
print '**** entering debugger'
621
pdb.post_mortem(sys.exc_traceback)
624
if __name__ == '__main__':
625
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
