1
# Copyright (C) 2006 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
50
from bzrlib.symbol_versioning import (
57
from bzrlib.option import Option
63
def register_command(cmd, decorate=False):
64
"""Utility function to help register a command
66
:param cmd: Command subclass to register
67
:param decorate: If true, allow overriding an existing command
68
of the same name; the old command is returned by this function.
69
Otherwise it is an error to try to override an existing command.
73
if k.startswith("cmd_"):
74
k_unsquished = _unsquish_command_name(k)
77
if k_unsquished not in plugin_cmds:
78
plugin_cmds[k_unsquished] = cmd
79
## trace.mutter('registered plugin command %s', k_unsquished)
80
if decorate and k_unsquished in builtin_command_names():
81
return _builtin_commands()[k_unsquished]
83
result = plugin_cmds[k_unsquished]
84
plugin_cmds[k_unsquished] = cmd
87
trace.log_error('Two plugins defined the same command: %r' % k)
88
trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
91
def _squish_command_name(cmd):
92
return 'cmd_' + cmd.replace('-', '_')
95
def _unsquish_command_name(cmd):
96
assert cmd.startswith("cmd_")
97
return cmd[4:].replace('_','-')
100
def _builtin_commands():
101
import bzrlib.builtins
103
builtins = bzrlib.builtins.__dict__
104
for name in builtins:
105
if name.startswith("cmd_"):
106
real_name = _unsquish_command_name(name)
107
r[real_name] = builtins[name]
111
def builtin_command_names():
112
"""Return list of builtin command names."""
113
return _builtin_commands().keys()
116
def plugin_command_names():
117
return plugin_cmds.keys()
120
def _get_cmd_dict(plugins_override=True):
121
"""Return name->class mapping for all commands."""
122
d = _builtin_commands()
124
d.update(plugin_cmds)
128
def get_all_cmds(plugins_override=True):
129
"""Return canonical name and class for all registered commands."""
130
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
134
def get_cmd_object(cmd_name, plugins_override=True):
135
"""Return the canonical name and command class for a command.
138
If true, plugin commands can override builtins.
140
from bzrlib.externalcommand import ExternalCommand
142
# We want only 'ascii' command names, but the user may have typed
143
# in a Unicode name. In that case, they should just get a
144
# 'command not found' error later.
145
# In the future, we may actually support Unicode command names.
147
# first look up this command under the specified name
148
cmds = _get_cmd_dict(plugins_override=plugins_override)
150
return cmds[cmd_name]()
154
# look for any command which claims this as an alias
155
for real_cmd_name, cmd_class in cmds.iteritems():
156
if cmd_name in cmd_class.aliases:
159
cmd_obj = ExternalCommand.find_command(cmd_name)
163
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
166
class Command(object):
167
"""Base class for commands.
169
Commands are the heart of the command-line bzr interface.
171
The command object mostly handles the mapping of command-line
172
parameters into one or more bzrlib operations, and of the results
175
Commands normally don't have any state. All their arguments are
176
passed in to the run method. (Subclasses may take a different
177
policy if the behaviour of the instance needs to depend on e.g. a
178
shell plugin and not just its Python class.)
180
The docstring for an actual command should give a single-line
181
summary, then a complete description of the command. A grammar
182
description will be inserted.
185
Other accepted names for this command.
188
List of argument forms, marked with whether they are optional,
193
['to_location', 'from_branch?', 'file*']
195
'to_location' is required
196
'from_branch' is optional
197
'file' can be specified 0 or more times
200
List of options that may be given for this command. These can
201
be either strings, referring to globally-defined options,
202
or option objects. Retrieve through options().
205
If true, this command isn't advertised. This is typically
206
for commands intended for expert users.
209
Command objects will get a 'outf' attribute, which has been
210
setup to properly handle encoding of unicode strings.
211
encoding_type determines what will happen when characters cannot
213
strict - abort if we cannot decode
214
replace - put in a bogus character (typically '?')
215
exact - do not encode sys.stdout
217
NOTE: by default on Windows, sys.stdout is opened as a text
218
stream, therefore LF line-endings are converted to CRLF.
219
When a command uses encoding_type = 'exact', then
220
sys.stdout is forced to be a binary stream, and line-endings
227
encoding_type = 'strict'
232
"""Construct an instance of this command."""
233
if self.__doc__ == Command.__doc__:
234
warn("No help message set for %r" % self)
236
def get_see_also(self):
237
"""Return a list of help topics that are related to this ommand.
239
The list is derived from the content of the _see_also attribute. Any
240
duplicates are removed and the result is in lexical order.
241
:return: A list of help topics.
243
return sorted(set(getattr(self, '_see_also', [])))
246
"""Return dict of valid options for this command.
248
Maps from long option name to option object."""
250
r['help'] = option.Option.OPTIONS['help']
251
for o in self.takes_options:
252
if isinstance(o, basestring):
253
o = option.Option.OPTIONS[o]
257
def _setup_outf(self):
258
"""Return a file linked to stdout, which has proper encoding."""
259
assert self.encoding_type in ['strict', 'exact', 'replace']
261
# Originally I was using self.stdout, but that looks
262
# *way* too much like sys.stdout
263
if self.encoding_type == 'exact':
264
# force sys.stdout to be binary stream on win32
265
if sys.platform == 'win32':
266
fileno = getattr(sys.stdout, 'fileno', None)
269
msvcrt.setmode(fileno(), os.O_BINARY)
270
self.outf = sys.stdout
273
output_encoding = osutils.get_terminal_encoding()
275
# use 'replace' so that we don't abort if trying to write out
276
# in e.g. the default C locale.
277
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
278
# For whatever reason codecs.getwriter() does not advertise its encoding
279
# it just returns the encoding of the wrapped file, which is completely
280
# bogus. So set the attribute, so we can find the correct encoding later.
281
self.outf.encoding = output_encoding
283
def run_argv_aliases(self, argv, alias_argv=None):
284
"""Parse the command line and run with extra aliases in alias_argv."""
286
warn("Passing None for [] is deprecated from bzrlib 0.10",
287
DeprecationWarning, stacklevel=2)
289
args, opts = parse_args(self, argv, alias_argv)
290
if 'help' in opts: # e.g. bzr add --help
291
from bzrlib.help import help_on_command
292
help_on_command(self.name())
294
# mix arguments and options into one dictionary
295
cmdargs = _match_argform(self.name(), self.takes_args, args)
297
for k, v in opts.items():
298
cmdopts[k.replace('-', '_')] = v
300
all_cmd_args = cmdargs.copy()
301
all_cmd_args.update(cmdopts)
305
return self.run(**all_cmd_args)
308
"""Actually run the command.
310
This is invoked with the options and arguments bound to
313
Return 0 or None if the command was successful, or a non-zero
314
shell error code if not. It's OK for this method to allow
315
an exception to raise up.
317
raise NotImplementedError('no implementation of command %r'
321
"""Return help message for this class."""
322
from inspect import getdoc
323
if self.__doc__ is Command.__doc__:
328
return _unsquish_command_name(self.__class__.__name__)
330
def plugin_name(self):
331
"""Get the name of the plugin that provides this command.
333
:return: The name of the plugin or None if the command is builtin.
335
mod_parts = self.__module__.split('.')
336
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
342
# Technically, this function hasn't been use in a *really* long time
343
# but we are only deprecating it now.
344
@deprecated_function(zero_eleven)
345
def parse_spec(spec):
351
>>> parse_spec("../@")
353
>>> parse_spec("../f/@35")
355
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
356
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
361
parsed = spec.split('/@')
362
assert len(parsed) == 2
367
parsed[1] = int(parsed[1])
369
pass # We can allow stuff like ./@revid:blahblahblah
373
parsed = [spec, None]
376
def parse_args(command, argv, alias_argv=None):
377
"""Parse command line.
379
Arguments and options are parsed at this level before being passed
380
down to specific command handlers. This routine knows, from a
381
lookup table, something about the available options, what optargs
382
they take, and which commands will accept them.
384
# TODO: make it a method of the Command?
385
parser = option.get_optparser(command.options())
386
if alias_argv is not None:
387
args = alias_argv + argv
391
options, args = parser.parse_args(args)
392
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
393
v is not option.OptionParser.DEFAULT_VALUE])
397
def _match_argform(cmd, takes_args, args):
400
# step through args and takes_args, allowing appropriate 0-many matches
401
for ap in takes_args:
405
argdict[argname] = args.pop(0)
406
elif ap[-1] == '*': # all remaining arguments
408
argdict[argname + '_list'] = args[:]
411
argdict[argname + '_list'] = None
414
raise errors.BzrCommandError("command %r needs one or more %s"
415
% (cmd, argname.upper()))
417
argdict[argname + '_list'] = args[:]
419
elif ap[-1] == '$': # all but one
421
raise errors.BzrCommandError("command %r needs one or more %s"
422
% (cmd, argname.upper()))
423
argdict[argname + '_list'] = args[:-1]
429
raise errors.BzrCommandError("command %r requires argument %s"
430
% (cmd, argname.upper()))
432
argdict[argname] = args.pop(0)
435
raise errors.BzrCommandError("extra argument to command %s: %s"
442
def apply_profiled(the_callable, *args, **kwargs):
446
pffileno, pfname = tempfile.mkstemp()
448
prof = hotshot.Profile(pfname)
450
ret = prof.runcall(the_callable, *args, **kwargs) or 0
453
stats = hotshot.stats.load(pfname)
455
stats.sort_stats('cum') # 'time'
456
## XXX: Might like to write to stderr or the trace file instead but
457
## print_stats seems hardcoded to stdout
458
stats.print_stats(20)
465
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
466
from bzrlib.lsprof import profile
468
ret, stats = profile(the_callable, *args, **kwargs)
474
cPickle.dump(stats, open(filename, 'w'), 2)
475
print 'Profile data written to %r.' % filename
479
def get_alias(cmd, config=None):
480
"""Return an expanded alias, or None if no alias exists.
483
Command to be checked for an alias.
485
Used to specify an alternative config to use,
486
which is especially useful for testing.
487
If it is unspecified, the global config will be used.
491
config = bzrlib.config.GlobalConfig()
492
alias = config.get_alias(cmd)
495
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
500
"""Execute a command.
502
This is similar to main(), but without all the trappings for
503
logging and error handling.
506
The command-line arguments, without the program name from argv[0]
507
These should already be decoded. All library/test code calling
508
run_bzr should be passing valid strings (don't need decoding).
510
Returns a command status or raises an exception.
512
Special master options: these must come before the command because
513
they control how the command is interpreted.
516
Do not load plugin modules at all
522
Only use builtin commands. (Plugins are still allowed to change
526
Run under the Python hotshot profiler.
529
Run under the Python lsprof profiler.
532
trace.mutter("bzr arguments: %r", argv)
534
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
535
opt_no_aliases = False
536
opt_lsprof_file = None
538
# --no-plugins is handled specially at a very early stage. We need
539
# to load plugins before doing other command parsing so that they
540
# can override commands, but this needs to happen first.
548
elif a == '--lsprof':
550
elif a == '--lsprof-file':
552
opt_lsprof_file = argv[i + 1]
554
elif a == '--no-plugins':
555
opt_no_plugins = True
556
elif a == '--no-aliases':
557
opt_no_aliases = True
558
elif a == '--builtin':
560
elif a in ('--quiet', '-q'):
562
elif a.startswith('-D'):
563
debug.debug_flags.add(a[2:])
570
from bzrlib.builtins import cmd_help
571
cmd_help().run_argv_aliases([])
574
if argv[0] == '--version':
575
from bzrlib.version import show_version
579
if not opt_no_plugins:
580
from bzrlib.plugin import load_plugins
583
from bzrlib.plugin import disable_plugins
588
if not opt_no_aliases:
589
alias_argv = get_alias(argv[0])
591
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
592
argv[0] = alias_argv.pop(0)
595
# We want only 'ascii' command names, but the user may have typed
596
# in a Unicode name. In that case, they should just get a
597
# 'command not found' error later.
599
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
600
run = cmd_obj.run_argv_aliases
601
run_argv = [argv, alias_argv]
605
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
607
ret = apply_profiled(run, *run_argv)
612
# reset, in case we may do other commands later within the same process
613
trace.be_quiet(False)
615
def display_command(func):
616
"""Decorator that suppresses pipe/interrupt errors."""
617
def ignore_pipe(*args, **kwargs):
619
result = func(*args, **kwargs)
623
if getattr(e, 'errno', None) is None:
625
if e.errno != errno.EPIPE:
626
# Win32 raises IOError with errno=0 on a broken pipe
627
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
630
except KeyboardInterrupt:
637
from bzrlib.ui.text import TextUIFactory
638
bzrlib.ui.ui_factory = TextUIFactory()
639
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
640
ret = run_bzr_catch_errors(argv)
641
trace.mutter("return code %d", ret)
645
def run_bzr_catch_errors(argv):
648
# do this here inside the exception wrappers to catch EPIPE
650
except (KeyboardInterrupt, Exception), e:
651
# used to handle AssertionError and KeyboardInterrupt
652
# specially here, but hopefully they're handled ok by the logger now
653
trace.report_exception(sys.exc_info(), sys.stderr)
654
if os.environ.get('BZR_PDB'):
655
print '**** entering debugger'
657
pdb.post_mortem(sys.exc_traceback)
660
if __name__ == '__main__':
661
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
