1
# Copyright (C) 2006, 2008 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 import registry
53
from bzrlib.hooks import HookPoint, Hooks
54
from bzrlib.option import Option
57
class CommandInfo(object):
58
"""Information about a command."""
60
def __init__(self, aliases):
61
"""The list of aliases for the command."""
62
self.aliases = aliases
65
def from_command(klass, command):
66
"""Factory to construct a CommandInfo from a command."""
67
return klass(command.aliases)
70
class CommandRegistry(registry.Registry):
73
def _get_name(command_name):
74
if command_name.startswith("cmd_"):
75
return _unsquish_command_name(command_name)
79
def register(self, cmd, decorate=False):
80
"""Utility function to help register a command
82
:param cmd: Command subclass to register
83
:param decorate: If true, allow overriding an existing command
84
of the same name; the old command is returned by this function.
85
Otherwise it is an error to try to override an existing command.
88
k_unsquished = self._get_name(k)
90
previous = self.get(k_unsquished)
92
previous = _builtin_commands().get(k_unsquished)
93
info = CommandInfo.from_command(cmd)
95
registry.Registry.register(self, k_unsquished, cmd,
96
override_existing=decorate, info=info)
98
trace.log_error('Two plugins defined the same command: %r' % k)
99
trace.log_error('Not loading the one in %r' %
100
sys.modules[cmd.__module__])
101
trace.log_error('Previously this command was registered from %r' %
102
sys.modules[previous.__module__])
105
def register_lazy(self, command_name, aliases, module_name):
106
"""Register a command without loading its module.
108
:param command_name: The primary name of the command.
109
:param aliases: A list of aliases for the command.
110
:module_name: The module that the command lives in.
112
key = self._get_name(command_name)
113
registry.Registry.register_lazy(self, key, module_name, command_name,
114
info=CommandInfo(aliases))
117
plugin_cmds = CommandRegistry()
120
def register_command(cmd, decorate=False):
122
return plugin_cmds.register(cmd, decorate)
125
def _squish_command_name(cmd):
126
return 'cmd_' + cmd.replace('-', '_')
129
def _unsquish_command_name(cmd):
130
return cmd[4:].replace('_','-')
133
def _builtin_commands():
134
import bzrlib.builtins
136
builtins = bzrlib.builtins.__dict__
137
for name in builtins:
138
if name.startswith("cmd_"):
139
real_name = _unsquish_command_name(name)
140
r[real_name] = builtins[name]
144
def builtin_command_names():
145
"""Return list of builtin command names."""
146
return _builtin_commands().keys()
149
def plugin_command_names():
150
return plugin_cmds.keys()
153
def _get_cmd_dict(plugins_override=True):
154
"""Return name->class mapping for all commands."""
155
d = _builtin_commands()
157
d.update(plugin_cmds.iteritems())
161
def get_all_cmds(plugins_override=True):
162
"""Return canonical name and class for all registered commands."""
163
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
167
def get_cmd_object(cmd_name, plugins_override=True):
168
"""Return the canonical name and command class for a command.
171
If true, plugin commands can override builtins.
174
cmd = _get_cmd_object(cmd_name, plugins_override)
175
# Allow plugins to extend commands
176
for hook in Command.hooks['extend_command']:
180
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
183
def _get_cmd_object(cmd_name, plugins_override=True):
184
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
185
from bzrlib.externalcommand import ExternalCommand
187
# We want only 'ascii' command names, but the user may have typed
188
# in a Unicode name. In that case, they should just get a
189
# 'command not found' error later.
190
# In the future, we may actually support Unicode command names.
192
# first look up this command under the specified name
195
return plugin_cmds.get(cmd_name)()
198
cmds = _get_cmd_dict(plugins_override=False)
200
return cmds[cmd_name]()
204
for key in plugin_cmds.keys():
205
info = plugin_cmds.get_info(key)
206
if cmd_name in info.aliases:
207
return plugin_cmds.get(key)()
208
# look for any command which claims this as an alias
209
for real_cmd_name, cmd_class in cmds.iteritems():
210
if cmd_name in cmd_class.aliases:
213
cmd_obj = ExternalCommand.find_command(cmd_name)
217
# look for plugins that provide this command but aren't installed
218
for provider in command_providers_registry:
220
plugin_metadata = provider.plugin_for_command(cmd_name)
221
except errors.NoPluginAvailable:
224
raise errors.CommandAvailableInPlugin(cmd_name,
225
plugin_metadata, provider)
229
class Command(object):
230
"""Base class for commands.
232
Commands are the heart of the command-line bzr interface.
234
The command object mostly handles the mapping of command-line
235
parameters into one or more bzrlib operations, and of the results
238
Commands normally don't have any state. All their arguments are
239
passed in to the run method. (Subclasses may take a different
240
policy if the behaviour of the instance needs to depend on e.g. a
241
shell plugin and not just its Python class.)
243
The docstring for an actual command should give a single-line
244
summary, then a complete description of the command. A grammar
245
description will be inserted.
248
Other accepted names for this command.
251
List of argument forms, marked with whether they are optional,
256
['to_location', 'from_branch?', 'file*']
258
'to_location' is required
259
'from_branch' is optional
260
'file' can be specified 0 or more times
263
List of options that may be given for this command. These can
264
be either strings, referring to globally-defined options,
265
or option objects. Retrieve through options().
268
If true, this command isn't advertised. This is typically
269
for commands intended for expert users.
272
Command objects will get a 'outf' attribute, which has been
273
setup to properly handle encoding of unicode strings.
274
encoding_type determines what will happen when characters cannot
276
strict - abort if we cannot decode
277
replace - put in a bogus character (typically '?')
278
exact - do not encode sys.stdout
280
NOTE: by default on Windows, sys.stdout is opened as a text
281
stream, therefore LF line-endings are converted to CRLF.
282
When a command uses encoding_type = 'exact', then
283
sys.stdout is forced to be a binary stream, and line-endings
286
:cvar hooks: An instance of CommandHooks.
291
encoding_type = 'strict'
296
"""Construct an instance of this command."""
297
if self.__doc__ == Command.__doc__:
298
warn("No help message set for %r" % self)
299
# List of standard options directly supported
300
self.supported_std_options = []
302
def _maybe_expand_globs(self, file_list):
303
"""Glob expand file_list if the platform does not do that itself.
305
:return: A possibly empty list of unicode paths.
307
Introduced in bzrlib 0.18.
311
if sys.platform == 'win32':
312
file_list = win32utils.glob_expand(file_list)
313
return list(file_list)
316
"""Return single-line grammar for this command.
318
Only describes arguments, not options.
320
s = 'bzr ' + self.name() + ' '
321
for aname in self.takes_args:
322
aname = aname.upper()
323
if aname[-1] in ['$', '+']:
324
aname = aname[:-1] + '...'
325
elif aname[-1] == '?':
326
aname = '[' + aname[:-1] + ']'
327
elif aname[-1] == '*':
328
aname = '[' + aname[:-1] + '...]'
330
s = s[:-1] # remove last space
333
def get_help_text(self, additional_see_also=None, plain=True,
334
see_also_as_links=False):
335
"""Return a text string with help for this command.
337
:param additional_see_also: Additional help topics to be
339
:param plain: if False, raw help (reStructuredText) is
340
returned instead of plain text.
341
:param see_also_as_links: if True, convert items in 'See also'
342
list to internal links (used by bzr_man rstx generator)
346
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
348
# Extract the summary (purpose) and sections out from the text
349
purpose,sections,order = self._get_help_parts(doc)
351
# If a custom usage section was provided, use it
352
if sections.has_key('Usage'):
353
usage = sections.pop('Usage')
355
usage = self._usage()
357
# The header is the purpose and usage
359
result += ':Purpose: %s\n' % purpose
360
if usage.find('\n') >= 0:
361
result += ':Usage:\n%s\n' % usage
363
result += ':Usage: %s\n' % usage
367
options = option.get_optparser(self.options()).format_option_help()
368
if options.startswith('Options:'):
369
result += ':' + options
370
elif options.startswith('options:'):
371
# Python 2.4 version of optparse
372
result += ':Options:' + options[len('options:'):]
377
# Add the description, indenting it 2 spaces
378
# to match the indentation of the options
379
if sections.has_key(None):
380
text = sections.pop(None)
381
text = '\n '.join(text.splitlines())
382
result += ':%s:\n %s\n\n' % ('Description',text)
384
# Add the custom sections (e.g. Examples). Note that there's no need
385
# to indent these as they must be indented already in the source.
388
if sections.has_key(label):
389
result += ':%s:\n%s\n\n' % (label,sections[label])
391
# Add the aliases, source (plug-in) and see also links, if any
393
result += ':Aliases: '
394
result += ', '.join(self.aliases) + '\n'
395
plugin_name = self.plugin_name()
396
if plugin_name is not None:
397
result += ':From: plugin "%s"\n' % plugin_name
398
see_also = self.get_see_also(additional_see_also)
400
if not plain and see_also_as_links:
402
for item in see_also:
404
# topics doesn't have an independent section
405
# so don't create a real link
406
see_also_links.append(item)
408
# Use a reST link for this entry
409
see_also_links.append("`%s`_" % (item,))
410
see_also = see_also_links
411
result += ':See also: '
412
result += ', '.join(see_also) + '\n'
414
# If this will be rendered as plain text, convert it
416
import bzrlib.help_topics
417
result = bzrlib.help_topics.help_as_plain_text(result)
421
def _get_help_parts(text):
422
"""Split help text into a summary and named sections.
424
:return: (summary,sections,order) where summary is the top line and
425
sections is a dictionary of the rest indexed by section name.
426
order is the order the section appear in the text.
427
A section starts with a heading line of the form ":xxx:".
428
Indented text on following lines is the section value.
429
All text found outside a named section is assigned to the
430
default section which is given the key of None.
432
def save_section(sections, order, label, section):
434
if sections.has_key(label):
435
sections[label] += '\n' + section
438
sections[label] = section
440
lines = text.rstrip().splitlines()
441
summary = lines.pop(0)
444
label,section = None,''
446
if line.startswith(':') and line.endswith(':') and len(line) > 2:
447
save_section(sections, order, label, section)
448
label,section = line[1:-1],''
449
elif (label is not None) and len(line) > 1 and not line[0].isspace():
450
save_section(sections, order, label, section)
451
label,section = None,line
454
section += '\n' + line
457
save_section(sections, order, label, section)
458
return summary, sections, order
460
def get_help_topic(self):
461
"""Return the commands help topic - its name."""
464
def get_see_also(self, additional_terms=None):
465
"""Return a list of help topics that are related to this command.
467
The list is derived from the content of the _see_also attribute. Any
468
duplicates are removed and the result is in lexical order.
469
:param additional_terms: Additional help topics to cross-reference.
470
:return: A list of help topics.
472
see_also = set(getattr(self, '_see_also', []))
474
see_also.update(additional_terms)
475
return sorted(see_also)
478
"""Return dict of valid options for this command.
480
Maps from long option name to option object."""
481
r = Option.STD_OPTIONS.copy()
483
for o in self.takes_options:
484
if isinstance(o, basestring):
485
o = option.Option.OPTIONS[o]
487
if o.name in std_names:
488
self.supported_std_options.append(o.name)
491
def _setup_outf(self):
492
"""Return a file linked to stdout, which has proper encoding."""
493
# Originally I was using self.stdout, but that looks
494
# *way* too much like sys.stdout
495
if self.encoding_type == 'exact':
496
# force sys.stdout to be binary stream on win32
497
if sys.platform == 'win32':
498
fileno = getattr(sys.stdout, 'fileno', None)
501
msvcrt.setmode(fileno(), os.O_BINARY)
502
self.outf = sys.stdout
505
output_encoding = osutils.get_terminal_encoding()
507
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
508
errors=self.encoding_type)
509
# For whatever reason codecs.getwriter() does not advertise its encoding
510
# it just returns the encoding of the wrapped file, which is completely
511
# bogus. So set the attribute, so we can find the correct encoding later.
512
self.outf.encoding = output_encoding
514
def run_argv_aliases(self, argv, alias_argv=None):
515
"""Parse the command line and run with extra aliases in alias_argv."""
517
warn("Passing None for [] is deprecated from bzrlib 0.10",
518
DeprecationWarning, stacklevel=2)
520
args, opts = parse_args(self, argv, alias_argv)
522
# Process the standard options
523
if 'help' in opts: # e.g. bzr add --help
524
sys.stdout.write(self.get_help_text())
526
trace.set_verbosity_level(option._verbosity_level)
527
if 'verbose' in self.supported_std_options:
528
opts['verbose'] = trace.is_verbose()
529
elif opts.has_key('verbose'):
531
if 'quiet' in self.supported_std_options:
532
opts['quiet'] = trace.is_quiet()
533
elif opts.has_key('quiet'):
536
# mix arguments and options into one dictionary
537
cmdargs = _match_argform(self.name(), self.takes_args, args)
539
for k, v in opts.items():
540
cmdopts[k.replace('-', '_')] = v
542
all_cmd_args = cmdargs.copy()
543
all_cmd_args.update(cmdopts)
547
return self.run(**all_cmd_args)
550
"""Actually run the command.
552
This is invoked with the options and arguments bound to
555
Return 0 or None if the command was successful, or a non-zero
556
shell error code if not. It's OK for this method to allow
557
an exception to raise up.
559
raise NotImplementedError('no implementation of command %r'
563
"""Return help message for this class."""
564
from inspect import getdoc
565
if self.__doc__ is Command.__doc__:
570
return _unsquish_command_name(self.__class__.__name__)
572
def plugin_name(self):
573
"""Get the name of the plugin that provides this command.
575
:return: The name of the plugin or None if the command is builtin.
577
mod_parts = self.__module__.split('.')
578
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
584
class CommandHooks(Hooks):
585
"""Hooks related to Command object creation/enumeration."""
588
"""Create the default hooks.
590
These are all empty initially, because by default nothing should get
594
self.create_hook(HookPoint('extend_command',
595
"Called after creating a command object to allow modifications "
596
"such as adding or removing options, docs etc. Called with the "
597
"new bzrlib.commands.Command object.", (1, 13), None))
599
Command.hooks = CommandHooks()
602
def parse_args(command, argv, alias_argv=None):
603
"""Parse command line.
605
Arguments and options are parsed at this level before being passed
606
down to specific command handlers. This routine knows, from a
607
lookup table, something about the available options, what optargs
608
they take, and which commands will accept them.
610
# TODO: make it a method of the Command?
611
parser = option.get_optparser(command.options())
612
if alias_argv is not None:
613
args = alias_argv + argv
617
options, args = parser.parse_args(args)
618
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
619
v is not option.OptionParser.DEFAULT_VALUE])
623
def _match_argform(cmd, takes_args, args):
626
# step through args and takes_args, allowing appropriate 0-many matches
627
for ap in takes_args:
631
argdict[argname] = args.pop(0)
632
elif ap[-1] == '*': # all remaining arguments
634
argdict[argname + '_list'] = args[:]
637
argdict[argname + '_list'] = None
640
raise errors.BzrCommandError("command %r needs one or more %s"
641
% (cmd, argname.upper()))
643
argdict[argname + '_list'] = args[:]
645
elif ap[-1] == '$': # all but one
647
raise errors.BzrCommandError("command %r needs one or more %s"
648
% (cmd, argname.upper()))
649
argdict[argname + '_list'] = args[:-1]
655
raise errors.BzrCommandError("command %r requires argument %s"
656
% (cmd, argname.upper()))
658
argdict[argname] = args.pop(0)
661
raise errors.BzrCommandError("extra argument to command %s: %s"
666
def apply_coveraged(dirname, the_callable, *args, **kwargs):
667
# Cannot use "import trace", as that would import bzrlib.trace instead of
668
# the standard library's trace.
669
trace = __import__('trace')
671
tracer = trace.Trace(count=1, trace=0)
672
sys.settrace(tracer.globaltrace)
675
return exception_to_return_code(the_callable, *args, **kwargs)
678
results = tracer.results()
679
results.write_results(show_missing=1, summary=False,
683
def apply_profiled(the_callable, *args, **kwargs):
687
pffileno, pfname = tempfile.mkstemp()
689
prof = hotshot.Profile(pfname)
691
ret = prof.runcall(exception_to_return_code, the_callable, *args,
695
stats = hotshot.stats.load(pfname)
697
stats.sort_stats('cum') # 'time'
698
## XXX: Might like to write to stderr or the trace file instead but
699
## print_stats seems hardcoded to stdout
700
stats.print_stats(20)
707
def exception_to_return_code(the_callable, *args, **kwargs):
708
"""UI level helper for profiling and coverage.
710
This transforms exceptions into a return value of 3. As such its only
711
relevant to the UI layer, and should never be called where catching
712
exceptions may be desirable.
715
return the_callable(*args, **kwargs)
716
except (KeyboardInterrupt, Exception), e:
717
# used to handle AssertionError and KeyboardInterrupt
718
# specially here, but hopefully they're handled ok by the logger now
719
exc_info = sys.exc_info()
720
exitcode = trace.report_exception(exc_info, sys.stderr)
721
if os.environ.get('BZR_PDB'):
722
print '**** entering debugger'
725
if sys.version_info[:2] < (2, 6):
727
# pdb.post_mortem(tb)
728
# but because pdb.post_mortem gives bad results for tracebacks
729
# from inside generators, we do it manually.
730
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
732
# Setup pdb on the traceback
735
p.setup(tb.tb_frame, tb)
736
# Point the debugger at the deepest frame of the stack
737
p.curindex = len(p.stack) - 1
738
p.curframe = p.stack[p.curindex][0]
739
# Start the pdb prompt.
740
p.print_stack_entry(p.stack[p.curindex])
748
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
749
from bzrlib.lsprof import profile
750
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
756
trace.note('Profile data written to "%s".', filename)
760
def shlex_split_unicode(unsplit):
762
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
765
def get_alias(cmd, config=None):
766
"""Return an expanded alias, or None if no alias exists.
769
Command to be checked for an alias.
771
Used to specify an alternative config to use,
772
which is especially useful for testing.
773
If it is unspecified, the global config will be used.
777
config = bzrlib.config.GlobalConfig()
778
alias = config.get_alias(cmd)
780
return shlex_split_unicode(alias)
785
"""Execute a command.
788
The command-line arguments, without the program name from argv[0]
789
These should already be decoded. All library/test code calling
790
run_bzr should be passing valid strings (don't need decoding).
792
Returns a command status or raises an exception.
794
Special master options: these must come before the command because
795
they control how the command is interpreted.
798
Do not load plugin modules at all
804
Only use builtin commands. (Plugins are still allowed to change
808
Run under the Python hotshot profiler.
811
Run under the Python lsprof profiler.
814
Generate line coverage report in the specified directory.
817
trace.mutter("bzr arguments: %r", argv)
819
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
820
opt_no_aliases = False
821
opt_lsprof_file = opt_coverage_dir = None
823
# --no-plugins is handled specially at a very early stage. We need
824
# to load plugins before doing other command parsing so that they
825
# can override commands, but this needs to happen first.
833
elif a == '--lsprof':
835
elif a == '--lsprof-file':
837
opt_lsprof_file = argv[i + 1]
839
elif a == '--no-plugins':
840
opt_no_plugins = True
841
elif a == '--no-aliases':
842
opt_no_aliases = True
843
elif a == '--builtin':
845
elif a == '--coverage':
846
opt_coverage_dir = argv[i + 1]
848
elif a.startswith('-D'):
849
debug.debug_flags.add(a[2:])
854
debug.set_debug_flags_from_config()
858
from bzrlib.builtins import cmd_help
859
cmd_help().run_argv_aliases([])
862
if argv[0] == '--version':
863
from bzrlib.builtins import cmd_version
864
cmd_version().run_argv_aliases([])
867
if not opt_no_plugins:
868
from bzrlib.plugin import load_plugins
871
from bzrlib.plugin import disable_plugins
876
if not opt_no_aliases:
877
alias_argv = get_alias(argv[0])
879
user_encoding = osutils.get_user_encoding()
880
alias_argv = [a.decode(user_encoding) for a in alias_argv]
881
argv[0] = alias_argv.pop(0)
884
# We want only 'ascii' command names, but the user may have typed
885
# in a Unicode name. In that case, they should just get a
886
# 'command not found' error later.
888
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
889
run = cmd_obj.run_argv_aliases
890
run_argv = [argv, alias_argv]
893
# We can be called recursively (tests for example), but we don't want
894
# the verbosity level to propagate.
895
saved_verbosity_level = option._verbosity_level
896
option._verbosity_level = 0
900
'--coverage ignored, because --lsprof is in use.')
901
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
905
'--coverage ignored, because --profile is in use.')
906
ret = apply_profiled(run, *run_argv)
907
elif opt_coverage_dir:
908
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
911
if 'memory' in debug.debug_flags:
912
trace.debug_memory('Process status after command:', short=False)
915
# reset, in case we may do other commands later within the same
916
# process. Commands that want to execute sub-commands must propagate
917
# --verbose in their own way.
918
option._verbosity_level = saved_verbosity_level
921
def display_command(func):
922
"""Decorator that suppresses pipe/interrupt errors."""
923
def ignore_pipe(*args, **kwargs):
925
result = func(*args, **kwargs)
929
if getattr(e, 'errno', None) is None:
931
if e.errno != errno.EPIPE:
932
# Win32 raises IOError with errno=0 on a broken pipe
933
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
936
except KeyboardInterrupt:
943
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
944
sys.stdin, sys.stdout, sys.stderr)
946
# Is this a final release version? If so, we should suppress warnings
947
if bzrlib.version_info[3] == 'final':
948
from bzrlib import symbol_versioning
949
symbol_versioning.suppress_deprecation_warnings(override=False)
951
user_encoding = osutils.get_user_encoding()
952
argv = [a.decode(user_encoding) for a in argv[1:]]
953
except UnicodeDecodeError:
954
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
956
ret = run_bzr_catch_errors(argv)
957
trace.mutter("return code %d", ret)
961
def run_bzr_catch_errors(argv):
962
"""Run a bzr command with parameters as described by argv.
964
This function assumed that that UI layer is setup, that symbol deprecations
965
are already applied, and that unicode decoding has already been performed on argv.
967
return exception_to_return_code(run_bzr, argv)
970
def run_bzr_catch_user_errors(argv):
971
"""Run bzr and report user errors, but let internal errors propagate.
973
This is used for the test suite, and might be useful for other programs
974
that want to wrap the commandline interface.
979
if (isinstance(e, (OSError, IOError))
980
or not getattr(e, 'internal_error', True)):
981
trace.report_exception(sys.exc_info(), sys.stderr)
987
class HelpCommandIndex(object):
988
"""A index for bzr help that returns commands."""
991
self.prefix = 'commands/'
993
def get_topics(self, topic):
994
"""Search for topic amongst commands.
996
:param topic: A topic to search for.
997
:return: A list which is either empty or contains a single
1000
if topic and topic.startswith(self.prefix):
1001
topic = topic[len(self.prefix):]
1003
cmd = _get_cmd_object(topic)
1010
class Provider(object):
1011
'''Generic class to be overriden by plugins'''
1013
def plugin_for_command(self, cmd_name):
1014
'''Takes a command and returns the information for that plugin
1016
:return: A dictionary with all the available information
1017
for the requested plugin
1019
raise NotImplementedError
1022
class ProvidersRegistry(registry.Registry):
1023
'''This registry exists to allow other providers to exist'''
1026
for key, provider in self.iteritems():
1029
command_providers_registry = ProvidersRegistry()
1032
if __name__ == '__main__':
1033
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
