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
51
from bzrlib.symbol_versioning import (
56
from bzrlib.option import Option
62
def register_command(cmd, decorate=False):
63
"""Utility function to help register a command
65
:param cmd: Command subclass to register
66
:param decorate: If true, allow overriding an existing command
67
of the same name; the old command is returned by this function.
68
Otherwise it is an error to try to override an existing command.
72
if k.startswith("cmd_"):
73
k_unsquished = _unsquish_command_name(k)
76
if k_unsquished not in plugin_cmds:
77
plugin_cmds[k_unsquished] = cmd
78
## trace.mutter('registered plugin command %s', k_unsquished)
79
if decorate and k_unsquished in builtin_command_names():
80
return _builtin_commands()[k_unsquished]
82
result = plugin_cmds[k_unsquished]
83
plugin_cmds[k_unsquished] = cmd
86
trace.log_error('Two plugins defined the same command: %r' % k)
87
trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
90
def _squish_command_name(cmd):
91
return 'cmd_' + cmd.replace('-', '_')
94
def _unsquish_command_name(cmd):
95
assert cmd.startswith("cmd_")
96
return cmd[4:].replace('_','-')
99
def _builtin_commands():
100
import bzrlib.builtins
102
builtins = bzrlib.builtins.__dict__
103
for name in builtins:
104
if name.startswith("cmd_"):
105
real_name = _unsquish_command_name(name)
106
r[real_name] = builtins[name]
110
def builtin_command_names():
111
"""Return list of builtin command names."""
112
return _builtin_commands().keys()
115
def plugin_command_names():
116
return plugin_cmds.keys()
119
def _get_cmd_dict(plugins_override=True):
120
"""Return name->class mapping for all commands."""
121
d = _builtin_commands()
123
d.update(plugin_cmds)
127
def get_all_cmds(plugins_override=True):
128
"""Return canonical name and class for all registered commands."""
129
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
133
def get_cmd_object(cmd_name, plugins_override=True):
134
"""Return the canonical name and command class for a command.
137
If true, plugin commands can override builtins.
140
return _get_cmd_object(cmd_name, plugins_override)
142
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
145
def _get_cmd_object(cmd_name, plugins_override=True):
146
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
147
from bzrlib.externalcommand import ExternalCommand
149
# We want only 'ascii' command names, but the user may have typed
150
# in a Unicode name. In that case, they should just get a
151
# 'command not found' error later.
152
# In the future, we may actually support Unicode command names.
154
# first look up this command under the specified name
155
cmds = _get_cmd_dict(plugins_override=plugins_override)
157
return cmds[cmd_name]()
161
# look for any command which claims this as an alias
162
for real_cmd_name, cmd_class in cmds.iteritems():
163
if cmd_name in cmd_class.aliases:
166
cmd_obj = ExternalCommand.find_command(cmd_name)
172
class Command(object):
173
"""Base class for commands.
175
Commands are the heart of the command-line bzr interface.
177
The command object mostly handles the mapping of command-line
178
parameters into one or more bzrlib operations, and of the results
181
Commands normally don't have any state. All their arguments are
182
passed in to the run method. (Subclasses may take a different
183
policy if the behaviour of the instance needs to depend on e.g. a
184
shell plugin and not just its Python class.)
186
The docstring for an actual command should give a single-line
187
summary, then a complete description of the command. A grammar
188
description will be inserted.
191
Other accepted names for this command.
194
List of argument forms, marked with whether they are optional,
199
['to_location', 'from_branch?', 'file*']
201
'to_location' is required
202
'from_branch' is optional
203
'file' can be specified 0 or more times
206
List of options that may be given for this command. These can
207
be either strings, referring to globally-defined options,
208
or option objects. Retrieve through options().
211
If true, this command isn't advertised. This is typically
212
for commands intended for expert users.
215
Command objects will get a 'outf' attribute, which has been
216
setup to properly handle encoding of unicode strings.
217
encoding_type determines what will happen when characters cannot
219
strict - abort if we cannot decode
220
replace - put in a bogus character (typically '?')
221
exact - do not encode sys.stdout
223
NOTE: by default on Windows, sys.stdout is opened as a text
224
stream, therefore LF line-endings are converted to CRLF.
225
When a command uses encoding_type = 'exact', then
226
sys.stdout is forced to be a binary stream, and line-endings
233
encoding_type = 'strict'
238
"""Construct an instance of this command."""
239
if self.__doc__ == Command.__doc__:
240
warn("No help message set for %r" % self)
241
# List of standard options directly supported
242
self.supported_std_options = []
244
def _maybe_expand_globs(self, file_list):
245
"""Glob expand file_list if the platform does not do that itself.
247
:return: A possibly empty list of unicode paths.
249
Introduced in bzrlib 0.18.
253
if sys.platform == 'win32':
254
file_list = win32utils.glob_expand(file_list)
255
return list(file_list)
258
"""Return single-line grammar for this command.
260
Only describes arguments, not options.
262
s = 'bzr ' + self.name() + ' '
263
for aname in self.takes_args:
264
aname = aname.upper()
265
if aname[-1] in ['$', '+']:
266
aname = aname[:-1] + '...'
267
elif aname[-1] == '?':
268
aname = '[' + aname[:-1] + ']'
269
elif aname[-1] == '*':
270
aname = '[' + aname[:-1] + '...]'
277
def get_help_text(self, additional_see_also=None, plain=True,
278
see_also_as_links=False):
279
"""Return a text string with help for this command.
281
:param additional_see_also: Additional help topics to be
283
:param plain: if False, raw help (reStructuredText) is
284
returned instead of plain text.
285
:param see_also_as_links: if True, convert items in 'See also'
286
list to internal links (used by bzr_man rstx generator)
290
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
292
# Extract the summary (purpose) and sections out from the text
293
purpose,sections = self._get_help_parts(doc)
295
# If a custom usage section was provided, use it
296
if sections.has_key('Usage'):
297
usage = sections.pop('Usage')
299
usage = self._usage()
301
# The header is the purpose and usage
303
result += ':Purpose: %s\n' % purpose
304
if usage.find('\n') >= 0:
305
result += ':Usage:\n%s\n' % usage
307
result += ':Usage: %s\n' % usage
311
options = option.get_optparser(self.options()).format_option_help()
312
if options.startswith('Options:'):
313
result += ':' + options
314
elif options.startswith('options:'):
315
# Python 2.4 version of optparse
316
result += ':Options:' + options[len('options:'):]
321
# Add the description, indenting it 2 spaces
322
# to match the indentation of the options
323
if sections.has_key(None):
324
text = sections.pop(None)
325
text = '\n '.join(text.splitlines())
326
result += ':%s:\n %s\n\n' % ('Description',text)
328
# Add the custom sections (e.g. Examples). Note that there's no need
329
# to indent these as they must be indented already in the source.
331
labels = sorted(sections.keys())
333
result += ':%s:\n%s\n\n' % (label,sections[label])
335
# Add the aliases, source (plug-in) and see also links, if any
337
result += ':Aliases: '
338
result += ', '.join(self.aliases) + '\n'
339
plugin_name = self.plugin_name()
340
if plugin_name is not None:
341
result += ':From: plugin "%s"\n' % plugin_name
342
see_also = self.get_see_also(additional_see_also)
344
if not plain and see_also_as_links:
346
for item in see_also:
348
# topics doesn't have an independent section
349
# so don't create a real link
350
see_also_links.append(item)
352
# Use a reST link for this entry
353
see_also_links.append("`%s`_" % (item,))
354
see_also = see_also_links
355
result += ':See also: '
356
result += ', '.join(see_also) + '\n'
358
# If this will be rendered as plan text, convert it
360
import bzrlib.help_topics
361
result = bzrlib.help_topics.help_as_plain_text(result)
365
def _get_help_parts(text):
366
"""Split help text into a summary and named sections.
368
:return: (summary,sections) where summary is the top line and
369
sections is a dictionary of the rest indexed by section name.
370
A section starts with a heading line of the form ":xxx:".
371
Indented text on following lines is the section value.
372
All text found outside a named section is assigned to the
373
default section which is given the key of None.
375
def save_section(sections, label, section):
377
if sections.has_key(label):
378
sections[label] += '\n' + section
380
sections[label] = section
382
lines = text.rstrip().splitlines()
383
summary = lines.pop(0)
385
label,section = None,''
387
if line.startswith(':') and line.endswith(':') and len(line) > 2:
388
save_section(sections, label, section)
389
label,section = line[1:-1],''
390
elif label != None and len(line) > 1 and not line[0].isspace():
391
save_section(sections, label, section)
392
label,section = None,line
395
section += '\n' + line
398
save_section(sections, label, section)
399
return summary, sections
401
def get_help_topic(self):
402
"""Return the commands help topic - its name."""
405
def get_see_also(self, additional_terms=None):
406
"""Return a list of help topics that are related to this command.
408
The list is derived from the content of the _see_also attribute. Any
409
duplicates are removed and the result is in lexical order.
410
:param additional_terms: Additional help topics to cross-reference.
411
:return: A list of help topics.
413
see_also = set(getattr(self, '_see_also', []))
415
see_also.update(additional_terms)
416
return sorted(see_also)
419
"""Return dict of valid options for this command.
421
Maps from long option name to option object."""
422
r = Option.STD_OPTIONS.copy()
424
for o in self.takes_options:
425
if isinstance(o, basestring):
426
o = option.Option.OPTIONS[o]
428
if o.name in std_names:
429
self.supported_std_options.append(o.name)
432
def _setup_outf(self):
433
"""Return a file linked to stdout, which has proper encoding."""
434
assert self.encoding_type in ['strict', 'exact', 'replace']
436
# Originally I was using self.stdout, but that looks
437
# *way* too much like sys.stdout
438
if self.encoding_type == 'exact':
439
# force sys.stdout to be binary stream on win32
440
if sys.platform == 'win32':
441
fileno = getattr(sys.stdout, 'fileno', None)
444
msvcrt.setmode(fileno(), os.O_BINARY)
445
self.outf = sys.stdout
448
output_encoding = osutils.get_terminal_encoding()
450
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
451
errors=self.encoding_type)
452
# For whatever reason codecs.getwriter() does not advertise its encoding
453
# it just returns the encoding of the wrapped file, which is completely
454
# bogus. So set the attribute, so we can find the correct encoding later.
455
self.outf.encoding = output_encoding
457
def run_argv_aliases(self, argv, alias_argv=None):
458
"""Parse the command line and run with extra aliases in alias_argv."""
460
warn("Passing None for [] is deprecated from bzrlib 0.10",
461
DeprecationWarning, stacklevel=2)
463
args, opts = parse_args(self, argv, alias_argv)
465
# Process the standard options
466
if 'help' in opts: # e.g. bzr add --help
467
sys.stdout.write(self.get_help_text())
469
trace.set_verbosity_level(option._verbosity_level)
470
if 'verbose' in self.supported_std_options:
471
opts['verbose'] = trace.is_verbose()
472
elif opts.has_key('verbose'):
474
if 'quiet' in self.supported_std_options:
475
opts['quiet'] = trace.is_quiet()
476
elif opts.has_key('quiet'):
479
# mix arguments and options into one dictionary
480
cmdargs = _match_argform(self.name(), self.takes_args, args)
482
for k, v in opts.items():
483
cmdopts[k.replace('-', '_')] = v
485
all_cmd_args = cmdargs.copy()
486
all_cmd_args.update(cmdopts)
490
return self.run(**all_cmd_args)
493
"""Actually run the command.
495
This is invoked with the options and arguments bound to
498
Return 0 or None if the command was successful, or a non-zero
499
shell error code if not. It's OK for this method to allow
500
an exception to raise up.
502
raise NotImplementedError('no implementation of command %r'
506
"""Return help message for this class."""
507
from inspect import getdoc
508
if self.__doc__ is Command.__doc__:
513
return _unsquish_command_name(self.__class__.__name__)
515
def plugin_name(self):
516
"""Get the name of the plugin that provides this command.
518
:return: The name of the plugin or None if the command is builtin.
520
mod_parts = self.__module__.split('.')
521
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
527
def parse_args(command, argv, alias_argv=None):
528
"""Parse command line.
530
Arguments and options are parsed at this level before being passed
531
down to specific command handlers. This routine knows, from a
532
lookup table, something about the available options, what optargs
533
they take, and which commands will accept them.
535
# TODO: make it a method of the Command?
536
parser = option.get_optparser(command.options())
537
if alias_argv is not None:
538
args = alias_argv + argv
542
options, args = parser.parse_args(args)
543
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
544
v is not option.OptionParser.DEFAULT_VALUE])
548
def _match_argform(cmd, takes_args, args):
551
# step through args and takes_args, allowing appropriate 0-many matches
552
for ap in takes_args:
556
argdict[argname] = args.pop(0)
557
elif ap[-1] == '*': # all remaining arguments
559
argdict[argname + '_list'] = args[:]
562
argdict[argname + '_list'] = None
565
raise errors.BzrCommandError("command %r needs one or more %s"
566
% (cmd, argname.upper()))
568
argdict[argname + '_list'] = args[:]
570
elif ap[-1] == '$': # all but one
572
raise errors.BzrCommandError("command %r needs one or more %s"
573
% (cmd, argname.upper()))
574
argdict[argname + '_list'] = args[:-1]
580
raise errors.BzrCommandError("command %r requires argument %s"
581
% (cmd, argname.upper()))
583
argdict[argname] = args.pop(0)
586
raise errors.BzrCommandError("extra argument to command %s: %s"
593
def apply_profiled(the_callable, *args, **kwargs):
597
pffileno, pfname = tempfile.mkstemp()
599
prof = hotshot.Profile(pfname)
601
ret = prof.runcall(the_callable, *args, **kwargs) or 0
604
stats = hotshot.stats.load(pfname)
606
stats.sort_stats('cum') # 'time'
607
## XXX: Might like to write to stderr or the trace file instead but
608
## print_stats seems hardcoded to stdout
609
stats.print_stats(20)
616
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
617
from bzrlib.lsprof import profile
618
ret, stats = profile(the_callable, *args, **kwargs)
624
trace.note('Profile data written to "%s".', filename)
628
def get_alias(cmd, config=None):
629
"""Return an expanded alias, or None if no alias exists.
632
Command to be checked for an alias.
634
Used to specify an alternative config to use,
635
which is especially useful for testing.
636
If it is unspecified, the global config will be used.
640
config = bzrlib.config.GlobalConfig()
641
alias = config.get_alias(cmd)
644
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
649
"""Execute a command.
651
This is similar to main(), but without all the trappings for
652
logging and error handling.
655
The command-line arguments, without the program name from argv[0]
656
These should already be decoded. All library/test code calling
657
run_bzr should be passing valid strings (don't need decoding).
659
Returns a command status or raises an exception.
661
Special master options: these must come before the command because
662
they control how the command is interpreted.
665
Do not load plugin modules at all
671
Only use builtin commands. (Plugins are still allowed to change
675
Run under the Python hotshot profiler.
678
Run under the Python lsprof profiler.
681
trace.mutter("bzr arguments: %r", argv)
683
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
684
opt_no_aliases = False
685
opt_lsprof_file = None
687
# --no-plugins is handled specially at a very early stage. We need
688
# to load plugins before doing other command parsing so that they
689
# can override commands, but this needs to happen first.
697
elif a == '--lsprof':
699
elif a == '--lsprof-file':
701
opt_lsprof_file = argv[i + 1]
703
elif a == '--no-plugins':
704
opt_no_plugins = True
705
elif a == '--no-aliases':
706
opt_no_aliases = True
707
elif a == '--builtin':
709
elif a.startswith('-D'):
710
debug.debug_flags.add(a[2:])
717
from bzrlib.builtins import cmd_help
718
cmd_help().run_argv_aliases([])
721
if argv[0] == '--version':
722
from bzrlib.builtins import cmd_version
723
cmd_version().run_argv_aliases([])
726
if not opt_no_plugins:
727
from bzrlib.plugin import load_plugins
730
from bzrlib.plugin import disable_plugins
735
if not opt_no_aliases:
736
alias_argv = get_alias(argv[0])
738
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
739
argv[0] = alias_argv.pop(0)
742
# We want only 'ascii' command names, but the user may have typed
743
# in a Unicode name. In that case, they should just get a
744
# 'command not found' error later.
746
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
747
run = cmd_obj.run_argv_aliases
748
run_argv = [argv, alias_argv]
752
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
754
ret = apply_profiled(run, *run_argv)
759
# reset, in case we may do other commands later within the same process
760
option._verbosity_level = 0
762
def display_command(func):
763
"""Decorator that suppresses pipe/interrupt errors."""
764
def ignore_pipe(*args, **kwargs):
766
result = func(*args, **kwargs)
770
if getattr(e, 'errno', None) is None:
772
if e.errno != errno.EPIPE:
773
# Win32 raises IOError with errno=0 on a broken pipe
774
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
777
except KeyboardInterrupt:
784
from bzrlib.ui.text import TextUIFactory
785
bzrlib.ui.ui_factory = TextUIFactory()
787
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
788
except UnicodeDecodeError:
789
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
791
ret = run_bzr_catch_errors(argv)
792
trace.mutter("return code %d", ret)
796
def run_bzr_catch_errors(argv):
799
except (KeyboardInterrupt, Exception), e:
800
# used to handle AssertionError and KeyboardInterrupt
801
# specially here, but hopefully they're handled ok by the logger now
802
trace.report_exception(sys.exc_info(), sys.stderr)
803
if os.environ.get('BZR_PDB'):
804
print '**** entering debugger'
806
pdb.post_mortem(sys.exc_traceback)
810
class HelpCommandIndex(object):
811
"""A index for bzr help that returns commands."""
814
self.prefix = 'commands/'
816
def get_topics(self, topic):
817
"""Search for topic amongst commands.
819
:param topic: A topic to search for.
820
:return: A list which is either empty or contains a single
823
if topic and topic.startswith(self.prefix):
824
topic = topic[len(self.prefix):]
826
cmd = _get_cmd_object(topic)
833
if __name__ == '__main__':
834
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
