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.
141
return _get_cmd_object(cmd_name, plugins_override)
143
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
146
def _get_cmd_object(cmd_name, plugins_override=True):
147
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
148
from bzrlib.externalcommand import ExternalCommand
150
# We want only 'ascii' command names, but the user may have typed
151
# in a Unicode name. In that case, they should just get a
152
# 'command not found' error later.
153
# In the future, we may actually support Unicode command names.
155
# first look up this command under the specified name
156
cmds = _get_cmd_dict(plugins_override=plugins_override)
158
return cmds[cmd_name]()
162
# look for any command which claims this as an alias
163
for real_cmd_name, cmd_class in cmds.iteritems():
164
if cmd_name in cmd_class.aliases:
167
cmd_obj = ExternalCommand.find_command(cmd_name)
173
class Command(object):
174
"""Base class for commands.
176
Commands are the heart of the command-line bzr interface.
178
The command object mostly handles the mapping of command-line
179
parameters into one or more bzrlib operations, and of the results
182
Commands normally don't have any state. All their arguments are
183
passed in to the run method. (Subclasses may take a different
184
policy if the behaviour of the instance needs to depend on e.g. a
185
shell plugin and not just its Python class.)
187
The docstring for an actual command should give a single-line
188
summary, then a complete description of the command. A grammar
189
description will be inserted.
192
Other accepted names for this command.
195
List of argument forms, marked with whether they are optional,
200
['to_location', 'from_branch?', 'file*']
202
'to_location' is required
203
'from_branch' is optional
204
'file' can be specified 0 or more times
207
List of options that may be given for this command. These can
208
be either strings, referring to globally-defined options,
209
or option objects. Retrieve through options().
212
If true, this command isn't advertised. This is typically
213
for commands intended for expert users.
216
Command objects will get a 'outf' attribute, which has been
217
setup to properly handle encoding of unicode strings.
218
encoding_type determines what will happen when characters cannot
220
strict - abort if we cannot decode
221
replace - put in a bogus character (typically '?')
222
exact - do not encode sys.stdout
224
NOTE: by default on Windows, sys.stdout is opened as a text
225
stream, therefore LF line-endings are converted to CRLF.
226
When a command uses encoding_type = 'exact', then
227
sys.stdout is forced to be a binary stream, and line-endings
234
encoding_type = 'strict'
239
"""Construct an instance of this command."""
240
if self.__doc__ == Command.__doc__:
241
warn("No help message set for %r" % self)
244
"""Return single-line grammar for this command.
246
Only describes arguments, not options.
248
s = 'bzr ' + self.name() + ' '
249
for aname in self.takes_args:
250
aname = aname.upper()
251
if aname[-1] in ['$', '+']:
252
aname = aname[:-1] + '...'
253
elif aname[-1] == '?':
254
aname = '[' + aname[:-1] + ']'
255
elif aname[-1] == '*':
256
aname = '[' + aname[:-1] + '...]'
263
def get_help_text(self, additional_see_also=None):
264
"""Return a text string with help for this command.
266
:param additional_see_also: Additional help topics to be
271
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
274
result += 'usage: %s\n' % self._usage()
277
result += 'aliases: '
278
result += ', '.join(self.aliases) + '\n'
282
plugin_name = self.plugin_name()
283
if plugin_name is not None:
284
result += '(From plugin "%s")' % plugin_name
288
if result[-1] != '\n':
291
result += option.get_optparser(self.options()).format_option_help()
292
see_also = self.get_see_also(additional_see_also)
294
result += '\nSee also: '
295
result += ', '.join(see_also)
299
def get_help_topic(self):
300
"""Return the commands help topic - its name."""
303
def get_see_also(self, additional_terms=None):
304
"""Return a list of help topics that are related to this ommand.
306
The list is derived from the content of the _see_also attribute. Any
307
duplicates are removed and the result is in lexical order.
308
:param additional_terms: Additional help topics to cross-reference.
309
:return: A list of help topics.
311
see_also = set(getattr(self, '_see_also', []))
313
see_also.update(additional_terms)
314
return sorted(see_also)
317
"""Return dict of valid options for this command.
319
Maps from long option name to option object."""
321
r['help'] = option.Option.OPTIONS['help']
322
for o in self.takes_options:
323
if isinstance(o, basestring):
324
o = option.Option.OPTIONS[o]
328
def _setup_outf(self):
329
"""Return a file linked to stdout, which has proper encoding."""
330
assert self.encoding_type in ['strict', 'exact', 'replace']
332
# Originally I was using self.stdout, but that looks
333
# *way* too much like sys.stdout
334
if self.encoding_type == 'exact':
335
# force sys.stdout to be binary stream on win32
336
if sys.platform == 'win32':
337
fileno = getattr(sys.stdout, 'fileno', None)
340
msvcrt.setmode(fileno(), os.O_BINARY)
341
self.outf = sys.stdout
344
output_encoding = osutils.get_terminal_encoding()
346
# use 'replace' so that we don't abort if trying to write out
347
# in e.g. the default C locale.
348
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
349
# For whatever reason codecs.getwriter() does not advertise its encoding
350
# it just returns the encoding of the wrapped file, which is completely
351
# bogus. So set the attribute, so we can find the correct encoding later.
352
self.outf.encoding = output_encoding
354
def run_argv_aliases(self, argv, alias_argv=None):
355
"""Parse the command line and run with extra aliases in alias_argv."""
357
warn("Passing None for [] is deprecated from bzrlib 0.10",
358
DeprecationWarning, stacklevel=2)
360
args, opts = parse_args(self, argv, alias_argv)
361
if 'help' in opts: # e.g. bzr add --help
362
sys.stdout.write(self.get_help_text())
364
# mix arguments and options into one dictionary
365
cmdargs = _match_argform(self.name(), self.takes_args, args)
367
for k, v in opts.items():
368
cmdopts[k.replace('-', '_')] = v
370
all_cmd_args = cmdargs.copy()
371
all_cmd_args.update(cmdopts)
375
return self.run(**all_cmd_args)
378
"""Actually run the command.
380
This is invoked with the options and arguments bound to
383
Return 0 or None if the command was successful, or a non-zero
384
shell error code if not. It's OK for this method to allow
385
an exception to raise up.
387
raise NotImplementedError('no implementation of command %r'
391
"""Return help message for this class."""
392
from inspect import getdoc
393
if self.__doc__ is Command.__doc__:
398
return _unsquish_command_name(self.__class__.__name__)
400
def plugin_name(self):
401
"""Get the name of the plugin that provides this command.
403
:return: The name of the plugin or None if the command is builtin.
405
mod_parts = self.__module__.split('.')
406
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
412
# Technically, this function hasn't been use in a *really* long time
413
# but we are only deprecating it now.
414
@deprecated_function(zero_eleven)
415
def parse_spec(spec):
421
>>> parse_spec("../@")
423
>>> parse_spec("../f/@35")
425
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
426
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
431
parsed = spec.split('/@')
432
assert len(parsed) == 2
437
parsed[1] = int(parsed[1])
439
pass # We can allow stuff like ./@revid:blahblahblah
443
parsed = [spec, None]
446
def parse_args(command, argv, alias_argv=None):
447
"""Parse command line.
449
Arguments and options are parsed at this level before being passed
450
down to specific command handlers. This routine knows, from a
451
lookup table, something about the available options, what optargs
452
they take, and which commands will accept them.
454
# TODO: make it a method of the Command?
455
parser = option.get_optparser(command.options())
456
if alias_argv is not None:
457
args = alias_argv + argv
461
options, args = parser.parse_args(args)
462
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
463
v is not option.OptionParser.DEFAULT_VALUE])
467
def _match_argform(cmd, takes_args, args):
470
# step through args and takes_args, allowing appropriate 0-many matches
471
for ap in takes_args:
475
argdict[argname] = args.pop(0)
476
elif ap[-1] == '*': # all remaining arguments
478
argdict[argname + '_list'] = args[:]
481
argdict[argname + '_list'] = None
484
raise errors.BzrCommandError("command %r needs one or more %s"
485
% (cmd, argname.upper()))
487
argdict[argname + '_list'] = args[:]
489
elif ap[-1] == '$': # all but one
491
raise errors.BzrCommandError("command %r needs one or more %s"
492
% (cmd, argname.upper()))
493
argdict[argname + '_list'] = args[:-1]
499
raise errors.BzrCommandError("command %r requires argument %s"
500
% (cmd, argname.upper()))
502
argdict[argname] = args.pop(0)
505
raise errors.BzrCommandError("extra argument to command %s: %s"
512
def apply_profiled(the_callable, *args, **kwargs):
516
pffileno, pfname = tempfile.mkstemp()
518
prof = hotshot.Profile(pfname)
520
ret = prof.runcall(the_callable, *args, **kwargs) or 0
523
stats = hotshot.stats.load(pfname)
525
stats.sort_stats('cum') # 'time'
526
## XXX: Might like to write to stderr or the trace file instead but
527
## print_stats seems hardcoded to stdout
528
stats.print_stats(20)
535
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
536
from bzrlib.lsprof import profile
538
ret, stats = profile(the_callable, *args, **kwargs)
544
cPickle.dump(stats, open(filename, 'w'), 2)
545
print 'Profile data written to %r.' % filename
549
def get_alias(cmd, config=None):
550
"""Return an expanded alias, or None if no alias exists.
553
Command to be checked for an alias.
555
Used to specify an alternative config to use,
556
which is especially useful for testing.
557
If it is unspecified, the global config will be used.
561
config = bzrlib.config.GlobalConfig()
562
alias = config.get_alias(cmd)
565
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
570
"""Execute a command.
572
This is similar to main(), but without all the trappings for
573
logging and error handling.
576
The command-line arguments, without the program name from argv[0]
577
These should already be decoded. All library/test code calling
578
run_bzr should be passing valid strings (don't need decoding).
580
Returns a command status or raises an exception.
582
Special master options: these must come before the command because
583
they control how the command is interpreted.
586
Do not load plugin modules at all
592
Only use builtin commands. (Plugins are still allowed to change
596
Run under the Python hotshot profiler.
599
Run under the Python lsprof profiler.
602
trace.mutter("bzr arguments: %r", argv)
604
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
605
opt_no_aliases = False
606
opt_lsprof_file = None
608
# --no-plugins is handled specially at a very early stage. We need
609
# to load plugins before doing other command parsing so that they
610
# can override commands, but this needs to happen first.
618
elif a == '--lsprof':
620
elif a == '--lsprof-file':
622
opt_lsprof_file = argv[i + 1]
624
elif a == '--no-plugins':
625
opt_no_plugins = True
626
elif a == '--no-aliases':
627
opt_no_aliases = True
628
elif a == '--builtin':
630
elif a in ('--quiet', '-q'):
632
elif a.startswith('-D'):
633
debug.debug_flags.add(a[2:])
640
from bzrlib.builtins import cmd_help
641
cmd_help().run_argv_aliases([])
644
if argv[0] == '--version':
645
from bzrlib.version import show_version
649
if not opt_no_plugins:
650
from bzrlib.plugin import load_plugins
653
from bzrlib.plugin import disable_plugins
658
if not opt_no_aliases:
659
alias_argv = get_alias(argv[0])
661
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
662
argv[0] = alias_argv.pop(0)
665
# We want only 'ascii' command names, but the user may have typed
666
# in a Unicode name. In that case, they should just get a
667
# 'command not found' error later.
669
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
670
run = cmd_obj.run_argv_aliases
671
run_argv = [argv, alias_argv]
675
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
677
ret = apply_profiled(run, *run_argv)
682
# reset, in case we may do other commands later within the same process
683
trace.be_quiet(False)
685
def display_command(func):
686
"""Decorator that suppresses pipe/interrupt errors."""
687
def ignore_pipe(*args, **kwargs):
689
result = func(*args, **kwargs)
693
if getattr(e, 'errno', None) is None:
695
if e.errno != errno.EPIPE:
696
# Win32 raises IOError with errno=0 on a broken pipe
697
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
700
except KeyboardInterrupt:
707
from bzrlib.ui.text import TextUIFactory
708
bzrlib.ui.ui_factory = TextUIFactory()
709
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
710
ret = run_bzr_catch_errors(argv)
711
trace.mutter("return code %d", ret)
715
def run_bzr_catch_errors(argv):
720
# do this here inside the exception wrappers to catch EPIPE
722
except (KeyboardInterrupt, Exception), e:
723
# used to handle AssertionError and KeyboardInterrupt
724
# specially here, but hopefully they're handled ok by the logger now
725
trace.report_exception(sys.exc_info(), sys.stderr)
726
if os.environ.get('BZR_PDB'):
727
print '**** entering debugger'
729
pdb.post_mortem(sys.exc_traceback)
733
class HelpCommandIndex(object):
734
"""A index for bzr help that returns commands."""
737
self.prefix = 'commands/'
739
def get_topics(self, topic):
740
"""Search for topic amongst commands.
742
:param topic: A topic to search for.
743
:return: A list which is either empty or contains a single
746
if topic and topic.startswith(self.prefix):
747
topic = topic[len(self.prefix):]
749
cmd = _get_cmd_object(topic)
756
if __name__ == '__main__':
757
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
