28
28
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
29
29
# the profile output behind so it can be interactively examined?
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
34
39
from warnings import warn
38
import bzrlib.errors as errors
39
from bzrlib.errors import (BzrError,
43
from bzrlib import option
52
from bzrlib.hooks import HookPoint, Hooks
53
# Compatibility - Option used to be in commands.
44
54
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
55
from bzrlib import registry
56
from bzrlib.symbol_versioning import (
60
suppress_deprecation_warnings,
64
class CommandInfo(object):
65
"""Information about a command."""
67
def __init__(self, aliases):
68
"""The list of aliases for the command."""
69
self.aliases = aliases
72
def from_command(klass, command):
73
"""Factory to construct a CommandInfo from a command."""
74
return klass(command.aliases)
77
class CommandRegistry(registry.Registry):
80
def _get_name(command_name):
81
if command_name.startswith("cmd_"):
82
return _unsquish_command_name(command_name)
86
def register(self, cmd, decorate=False):
87
"""Utility function to help register a command
89
:param cmd: Command subclass to register
90
:param decorate: If true, allow overriding an existing command
91
of the same name; the old command is returned by this function.
92
Otherwise it is an error to try to override an existing command.
95
k_unsquished = self._get_name(k)
97
previous = self.get(k_unsquished)
99
previous = _builtin_commands().get(k_unsquished)
100
info = CommandInfo.from_command(cmd)
102
registry.Registry.register(self, k_unsquished, cmd,
103
override_existing=decorate, info=info)
105
trace.warning('Two plugins defined the same command: %r' % k)
106
trace.warning('Not loading the one in %r' %
107
sys.modules[cmd.__module__])
108
trace.warning('Previously this command was registered from %r' %
109
sys.modules[previous.__module__])
112
def register_lazy(self, command_name, aliases, module_name):
113
"""Register a command without loading its module.
115
:param command_name: The primary name of the command.
116
:param aliases: A list of aliases for the command.
117
:module_name: The module that the command lives in.
119
key = self._get_name(command_name)
120
registry.Registry.register_lazy(self, key, module_name, command_name,
121
info=CommandInfo(aliases))
124
plugin_cmds = CommandRegistry()
53
127
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.
61
128
global plugin_cmds
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__])
129
return plugin_cmds.register(cmd, decorate)
81
132
def _squish_command_name(cmd):
85
136
def _unsquish_command_name(cmd):
86
assert cmd.startswith("cmd_")
87
137
return cmd[4:].replace('_','-')
90
140
def _builtin_commands():
91
141
import bzrlib.builtins
142
return _scan_module_for_commands(bzrlib.builtins)
145
def _scan_module_for_commands(module):
93
builtins = bzrlib.builtins.__dict__
147
for name, obj in module.__dict__.iteritems():
95
148
if name.startswith("cmd_"):
96
149
real_name = _unsquish_command_name(name)
97
r[real_name] = builtins[name]
154
def _list_bzr_commands(names):
155
"""Find commands from bzr's core and plugins."""
156
# to eliminate duplicates
157
names.update(builtin_command_names())
158
names.update(plugin_command_names())
162
def all_command_names():
163
"""Return a set of all command names."""
165
for hook in Command.hooks['list_commands']:
168
raise AssertionError(
169
'hook %s returned None' % Command.hooks.get_hook_name(hook))
101
173
def builtin_command_names():
102
"""Return list of builtin command names."""
174
"""Return list of builtin command names.
176
Use of all_command_names() is encouraged rather than builtin_command_names
177
and/or plugin_command_names.
103
179
return _builtin_commands().keys()
106
182
def plugin_command_names():
183
"""Returns command names from commands registered by plugins."""
107
184
return plugin_cmds.keys()
110
def _get_cmd_dict(plugins_override=True):
111
"""Return name->class mapping for all commands."""
187
@deprecated_function(deprecated_in((1, 17, 0)))
188
def get_all_cmds(plugins_override=False):
189
"""Return canonical name and class for most commands.
191
NB: This does not return all commands since the introduction of
192
command hooks, and returning the class is not sufficient to
193
get correctly setup commands, which is why it is deprecated.
195
Use 'all_command_names' + 'get_cmd_object' instead.
112
197
d = _builtin_commands()
113
198
if plugins_override:
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():
199
d.update(plugin_cmds.iteritems())
200
for k, v in d.iteritems():
124
204
def get_cmd_object(cmd_name, plugins_override=True):
125
"""Return the canonical name and command class for a command.
205
"""Return the command object for a command.
128
208
If true, plugin commands can override builtins.
130
from bzrlib.externalcommand import ExternalCommand
211
return _get_cmd_object(cmd_name, plugins_override)
213
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
216
def _get_cmd_object(cmd_name, plugins_override=True):
217
"""Get a command object.
219
:param cmd_name: The name of the command.
220
:param plugins_override: Allow plugins to override builtins.
221
:return: A Command object instance
222
:raises KeyError: If no command is found.
132
224
# We want only 'ascii' command names, but the user may have typed
133
225
# in a Unicode name. In that case, they should just get a
134
226
# 'command not found' error later.
135
227
# 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)
230
for hook in Command.hooks['get_command']:
231
cmd = hook(cmd, cmd_name)
232
if cmd is not None and not plugins_override and not cmd.plugin_name():
233
# We've found a non-plugin command, don't permit it to be
237
for hook in Command.hooks['get_missing_command']:
244
# Allow plugins to extend commands
245
for hook in Command.hooks['extend_command']:
250
def _try_plugin_provider(cmd_name):
251
"""Probe for a plugin provider having cmd_name."""
253
plugin_metadata, provider = probe_for_provider(cmd_name)
254
raise errors.CommandAvailableInPlugin(cmd_name,
255
plugin_metadata, provider)
256
except errors.NoPluginAvailable:
260
def probe_for_provider(cmd_name):
261
"""Look for a provider for cmd_name.
263
:param cmd_name: The command name.
264
:return: plugin_metadata, provider for getting cmd_name.
265
:raises NoPluginAvailable: When no provider can supply the plugin.
267
# look for providers that provide this command but aren't installed
268
for provider in command_providers_registry:
270
return provider.plugin_for_command(cmd_name), provider
271
except errors.NoPluginAvailable:
273
raise errors.NoPluginAvailable(cmd_name)
276
def _get_bzr_command(cmd_or_None, cmd_name):
277
"""Get a command from bzr's core."""
278
cmds = _builtin_commands()
140
280
return cmds[cmd_name]()
144
283
# look for any command which claims this as an alias
145
284
for real_cmd_name, cmd_class in cmds.iteritems():
146
285
if cmd_name in cmd_class.aliases:
147
286
return cmd_class()
290
def _get_external_command(cmd_or_None, cmd_name):
291
"""Lookup a command that is a shell script."""
292
# Only do external command lookups when no command is found so far.
293
if cmd_or_None is not None:
295
from bzrlib.externalcommand import ExternalCommand
149
296
cmd_obj = ExternalCommand.find_command(cmd_name)
153
raise BzrCommandError('unknown command "%s"' % cmd_name)
301
def _get_plugin_command(cmd_or_None, cmd_name):
302
"""Get a command from bzr's plugins."""
304
return plugin_cmds.get(cmd_name)()
307
for key in plugin_cmds.keys():
308
info = plugin_cmds.get_info(key)
309
if cmd_name in info.aliases:
310
return plugin_cmds.get(key)()
156
314
class Command(object):
211
376
encoding_type = 'strict'
215
380
def __init__(self):
216
381
"""Construct an instance of this command."""
217
382
if self.__doc__ == Command.__doc__:
218
383
warn("No help message set for %r" % self)
384
# List of standard options directly supported
385
self.supported_std_options = []
387
@deprecated_method(deprecated_in((2, 1, 0)))
388
def _maybe_expand_globs(self, file_list):
389
"""Glob expand file_list if the platform does not do that itself.
391
Not used anymore, now that the bzr command-line parser globs on
394
:return: A possibly empty list of unicode paths.
396
Introduced in bzrlib 0.18.
401
"""Return single-line grammar for this command.
403
Only describes arguments, not options.
405
s = 'bzr ' + self.name() + ' '
406
for aname in self.takes_args:
407
aname = aname.upper()
408
if aname[-1] in ['$', '+']:
409
aname = aname[:-1] + '...'
410
elif aname[-1] == '?':
411
aname = '[' + aname[:-1] + ']'
412
elif aname[-1] == '*':
413
aname = '[' + aname[:-1] + '...]'
415
s = s[:-1] # remove last space
418
def get_help_text(self, additional_see_also=None, plain=True,
419
see_also_as_links=False, verbose=True):
420
"""Return a text string with help for this command.
422
:param additional_see_also: Additional help topics to be
424
:param plain: if False, raw help (reStructuredText) is
425
returned instead of plain text.
426
:param see_also_as_links: if True, convert items in 'See also'
427
list to internal links (used by bzr_man rstx generator)
428
:param verbose: if True, display the full help, otherwise
429
leave out the descriptive sections and just display
430
usage help (e.g. Purpose, Usage, Options) with a
431
message explaining how to obtain full help.
435
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
437
# Extract the summary (purpose) and sections out from the text
438
purpose,sections,order = self._get_help_parts(doc)
440
# If a custom usage section was provided, use it
441
if sections.has_key('Usage'):
442
usage = sections.pop('Usage')
444
usage = self._usage()
446
# The header is the purpose and usage
448
result += ':Purpose: %s\n' % purpose
449
if usage.find('\n') >= 0:
450
result += ':Usage:\n%s\n' % usage
452
result += ':Usage: %s\n' % usage
457
# XXX: optparse implicitly rewraps the help, and not always perfectly,
458
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
460
options = option.get_optparser(self.options()).format_option_help()
461
# XXX: According to the spec, ReST option lists actually don't support
462
# options like --1.9 so that causes syntax errors (in Sphinx at least).
463
# As that pattern always appears in the commands that break, we trap
464
# on that and then format that block of 'format' options as a literal
466
if not plain and options.find(' --1.9 ') != -1:
467
options = options.replace(' format:\n', ' format::\n\n', 1)
468
if options.startswith('Options:'):
469
result += ':' + options
470
elif options.startswith('options:'):
471
# Python 2.4 version of optparse
472
result += ':Options:' + options[len('options:'):]
478
# Add the description, indenting it 2 spaces
479
# to match the indentation of the options
480
if sections.has_key(None):
481
text = sections.pop(None)
482
text = '\n '.join(text.splitlines())
483
result += ':%s:\n %s\n\n' % ('Description',text)
485
# Add the custom sections (e.g. Examples). Note that there's no need
486
# to indent these as they must be indented already in the source.
489
if sections.has_key(label):
490
result += ':%s:\n%s\n' % (label,sections[label])
493
result += ("See bzr help %s for more details and examples.\n\n"
496
# Add the aliases, source (plug-in) and see also links, if any
498
result += ':Aliases: '
499
result += ', '.join(self.aliases) + '\n'
500
plugin_name = self.plugin_name()
501
if plugin_name is not None:
502
result += ':From: plugin "%s"\n' % plugin_name
503
see_also = self.get_see_also(additional_see_also)
505
if not plain and see_also_as_links:
507
for item in see_also:
509
# topics doesn't have an independent section
510
# so don't create a real link
511
see_also_links.append(item)
513
# Use a reST link for this entry
514
see_also_links.append("`%s`_" % (item,))
515
see_also = see_also_links
516
result += ':See also: '
517
result += ', '.join(see_also) + '\n'
519
# If this will be rendered as plain text, convert it
521
import bzrlib.help_topics
522
result = bzrlib.help_topics.help_as_plain_text(result)
526
def _get_help_parts(text):
527
"""Split help text into a summary and named sections.
529
:return: (summary,sections,order) where summary is the top line and
530
sections is a dictionary of the rest indexed by section name.
531
order is the order the section appear in the text.
532
A section starts with a heading line of the form ":xxx:".
533
Indented text on following lines is the section value.
534
All text found outside a named section is assigned to the
535
default section which is given the key of None.
537
def save_section(sections, order, label, section):
539
if sections.has_key(label):
540
sections[label] += '\n' + section
543
sections[label] = section
545
lines = text.rstrip().splitlines()
546
summary = lines.pop(0)
549
label,section = None,''
551
if line.startswith(':') and line.endswith(':') and len(line) > 2:
552
save_section(sections, order, label, section)
553
label,section = line[1:-1],''
554
elif (label is not None) and len(line) > 1 and not line[0].isspace():
555
save_section(sections, order, label, section)
556
label,section = None,line
559
section += '\n' + line
562
save_section(sections, order, label, section)
563
return summary, sections, order
565
def get_help_topic(self):
566
"""Return the commands help topic - its name."""
569
def get_see_also(self, additional_terms=None):
570
"""Return a list of help topics that are related to this command.
572
The list is derived from the content of the _see_also attribute. Any
573
duplicates are removed and the result is in lexical order.
574
:param additional_terms: Additional help topics to cross-reference.
575
:return: A list of help topics.
577
see_also = set(getattr(self, '_see_also', []))
579
see_also.update(additional_terms)
580
return sorted(see_also)
220
582
def options(self):
221
583
"""Return dict of valid options for this command.
223
585
Maps from long option name to option object."""
225
r['help'] = Option.OPTIONS['help']
586
r = Option.STD_OPTIONS.copy()
226
588
for o in self.takes_options:
227
589
if isinstance(o, basestring):
228
o = Option.OPTIONS[o]
590
o = option.Option.OPTIONS[o]
592
if o.name in std_names:
593
self.supported_std_options.append(o.name)
232
596
def _setup_outf(self):
233
597
"""Return a file linked to stdout, which has proper encoding."""
234
assert self.encoding_type in ['strict', 'exact', 'replace']
236
598
# Originally I was using self.stdout, but that looks
237
599
# *way* too much like sys.stdout
238
600
if self.encoding_type == 'exact':
601
# force sys.stdout to be binary stream on win32
602
if sys.platform == 'win32':
603
fileno = getattr(sys.stdout, 'fileno', None)
606
msvcrt.setmode(fileno(), os.O_BINARY)
239
607
self.outf = sys.stdout
242
output_encoding = bzrlib.osutils.get_terminal_encoding()
610
output_encoding = 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)
612
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
613
errors=self.encoding_type)
247
614
# For whatever reason codecs.getwriter() does not advertise its encoding
248
615
# it just returns the encoding of the wrapped file, which is completely
249
616
# bogus. So set the attribute, so we can find the correct encoding later.
250
617
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
619
def run_argv_aliases(self, argv, alias_argv=None):
261
620
"""Parse the command line and run with extra aliases in alias_argv."""
263
warn("Passing None for [] is deprecated from bzrlib 0.10",
622
warn("Passing None for [] is deprecated from bzrlib 0.10",
264
623
DeprecationWarning, stacklevel=2)
266
625
args, opts = parse_args(self, argv, alias_argv)
627
# Process the standard options
267
628
if 'help' in opts: # e.g. bzr add --help
268
from bzrlib.help import help_on_command
269
help_on_command(self.name())
629
sys.stdout.write(self.get_help_text())
631
if 'usage' in opts: # e.g. bzr add --usage
632
sys.stdout.write(self.get_help_text(verbose=False))
634
trace.set_verbosity_level(option._verbosity_level)
635
if 'verbose' in self.supported_std_options:
636
opts['verbose'] = trace.is_verbose()
637
elif opts.has_key('verbose'):
639
if 'quiet' in self.supported_std_options:
640
opts['quiet'] = trace.is_quiet()
641
elif opts.has_key('quiet'):
271
644
# mix arguments and options into one dictionary
272
645
cmdargs = _match_argform(self.name(), self.takes_args, args)
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]
692
class CommandHooks(Hooks):
693
"""Hooks related to Command object creation/enumeration."""
696
"""Create the default hooks.
698
These are all empty initially, because by default nothing should get
702
self.create_hook(HookPoint('extend_command',
703
"Called after creating a command object to allow modifications "
704
"such as adding or removing options, docs etc. Called with the "
705
"new bzrlib.commands.Command object.", (1, 13), None))
706
self.create_hook(HookPoint('get_command',
707
"Called when creating a single command. Called with "
708
"(cmd_or_None, command_name). get_command should either return "
709
"the cmd_or_None parameter, or a replacement Command object that "
710
"should be used for the command. Note that the Command.hooks "
711
"hooks are core infrastructure. Many users will prefer to use "
712
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
714
self.create_hook(HookPoint('get_missing_command',
715
"Called when creating a single command if no command could be "
716
"found. Called with (command_name). get_missing_command should "
717
"either return None, or a Command object to be used for the "
718
"command.", (1, 17), None))
719
self.create_hook(HookPoint('list_commands',
720
"Called when enumerating commands. Called with a set of "
721
"cmd_name strings for all the commands found so far. This set "
722
" is safe to mutate - e.g. to remove a command. "
723
"list_commands should return the updated set of command names.",
726
Command.hooks = CommandHooks()
350
729
def parse_args(command, argv, alias_argv=None):
351
730
"""Parse command line.
353
732
Arguments and options are parsed at this level before being passed
354
733
down to specific command handlers. This routine knows, from a
355
734
lookup table, something about the available options, what optargs
436
832
os.remove(pfname)
835
def exception_to_return_code(the_callable, *args, **kwargs):
836
"""UI level helper for profiling and coverage.
838
This transforms exceptions into a return value of 3. As such its only
839
relevant to the UI layer, and should never be called where catching
840
exceptions may be desirable.
843
return the_callable(*args, **kwargs)
844
except (KeyboardInterrupt, Exception), e:
845
# used to handle AssertionError and KeyboardInterrupt
846
# specially here, but hopefully they're handled ok by the logger now
847
exc_info = sys.exc_info()
848
exitcode = trace.report_exception(exc_info, sys.stderr)
849
if os.environ.get('BZR_PDB'):
850
print '**** entering debugger'
853
if sys.version_info[:2] < (2, 6):
855
# pdb.post_mortem(tb)
856
# but because pdb.post_mortem gives bad results for tracebacks
857
# from inside generators, we do it manually.
858
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
860
# Setup pdb on the traceback
863
p.setup(tb.tb_frame, tb)
864
# Point the debugger at the deepest frame of the stack
865
p.curindex = len(p.stack) - 1
866
p.curframe = p.stack[p.curindex][0]
867
# Start the pdb prompt.
868
p.print_stack_entry(p.stack[p.curindex])
439
876
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
440
877
from bzrlib.lsprof import profile
442
ret, stats = profile(the_callable, *args, **kwargs)
878
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
444
880
if filename is None:
448
cPickle.dump(stats, open(filename, 'w'), 2)
449
print 'Profile data written to %r.' % filename
884
trace.note('Profile data written to "%s".', filename)
454
"""Return an expanded alias, or None if no alias exists"""
456
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
888
def shlex_split_unicode(unsplit):
890
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
893
def get_alias(cmd, config=None):
894
"""Return an expanded alias, or None if no alias exists.
897
Command to be checked for an alias.
899
Used to specify an alternative config to use,
900
which is especially useful for testing.
901
If it is unspecified, the global config will be used.
905
config = bzrlib.config.GlobalConfig()
906
alias = config.get_alias(cmd)
458
return alias.split(' ')
908
return shlex_split_unicode(alias)
462
912
def run_bzr(argv):
463
913
"""Execute a command.
465
This is similar to main(), but without all the trappings for
466
logging and error handling.
469
916
The command-line arguments, without the program name from argv[0]
470
917
These should already be decoded. All library/test code calling
471
918
run_bzr should be passing valid strings (don't need decoding).
473
920
Returns a command status or raises an exception.
475
922
Special master options: these must come before the command because
596
1072
return ignore_pipe
1075
def install_bzr_command_hooks():
1076
"""Install the hooks to supply bzr's own commands."""
1077
if _list_bzr_commands in Command.hooks["list_commands"]:
1079
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1081
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1083
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1084
"bzr plugin commands")
1085
Command.hooks.install_named_hook("get_command", _get_external_command,
1086
"bzr external command lookup")
1087
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1088
"bzr plugin-provider-db check")
1091
def main(argv=None):
1092
"""Main entry point of command-line interface.
1094
:param argv: list of unicode command-line arguments similar to sys.argv.
1095
argv[0] is script name usually, it will be ignored.
1096
Don't pass here sys.argv because this list contains plain strings
1097
and not unicode; pass None instead.
1099
:return: exit code of bzr command.
600
1101
import bzrlib.ui
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:]]
1102
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1103
sys.stdin, sys.stdout, sys.stderr)
1105
# Is this a final release version? If so, we should suppress warnings
1106
if bzrlib.version_info[3] == 'final':
1107
suppress_deprecation_warnings(override=True)
1109
argv = osutils.get_unicode_argv()
1113
# ensure all arguments are unicode strings
1115
if isinstance(a, unicode):
1118
new_argv.append(a.decode('ascii'))
1119
except UnicodeDecodeError:
1120
raise errors.BzrError("argv should be list of unicode strings.")
604
1122
ret = run_bzr_catch_errors(argv)
605
mutter("return code %d", ret)
1123
trace.mutter("return code %d", ret)
1124
osutils.report_extension_load_failures()
609
1128
def run_bzr_catch_errors(argv):
1129
"""Run a bzr command with parameters as described by argv.
1131
This function assumed that that UI layer is setup, that symbol deprecations
1132
are already applied, and that unicode decoding has already been performed on argv.
1134
install_bzr_command_hooks()
1135
return exception_to_return_code(run_bzr, argv)
1138
def run_bzr_catch_user_errors(argv):
1139
"""Run bzr and report user errors, but let internal errors propagate.
1141
This is used for the test suite, and might be useful for other programs
1142
that want to wrap the commandline interface.
1144
install_bzr_command_hooks()
611
1146
return run_bzr(argv)
612
# do this here inside the exception wrappers to catch EPIPE
614
1147
except Exception, e:
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)
1148
if (isinstance(e, (OSError, IOError))
1149
or not getattr(e, 'internal_error', True)):
1150
trace.report_exception(sys.exc_info(), sys.stderr)
1156
class HelpCommandIndex(object):
1157
"""A index for bzr help that returns commands."""
1160
self.prefix = 'commands/'
1162
def get_topics(self, topic):
1163
"""Search for topic amongst commands.
1165
:param topic: A topic to search for.
1166
:return: A list which is either empty or contains a single
1169
if topic and topic.startswith(self.prefix):
1170
topic = topic[len(self.prefix):]
1172
cmd = _get_cmd_object(topic)
1179
class Provider(object):
1180
'''Generic class to be overriden by plugins'''
1182
def plugin_for_command(self, cmd_name):
1183
'''Takes a command and returns the information for that plugin
1185
:return: A dictionary with all the available information
1186
for the requested plugin
1188
raise NotImplementedError
1191
class ProvidersRegistry(registry.Registry):
1192
'''This registry exists to allow other providers to exist'''
1195
for key, provider in self.iteritems():
1198
command_providers_registry = ProvidersRegistry()
624
1201
if __name__ == '__main__':
625
1202
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
