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
55
from bzrlib.hooks import HookPoint, Hooks
56
# Compatibility - Option used to be in commands.
44
57
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
58
from bzrlib import registry
59
from bzrlib.symbol_versioning import (
66
class CommandInfo(object):
67
"""Information about a command."""
69
def __init__(self, aliases):
70
"""The list of aliases for the command."""
71
self.aliases = aliases
74
def from_command(klass, command):
75
"""Factory to construct a CommandInfo from a command."""
76
return klass(command.aliases)
79
class CommandRegistry(registry.Registry):
82
def _get_name(command_name):
83
if command_name.startswith("cmd_"):
84
return _unsquish_command_name(command_name)
88
def register(self, cmd, decorate=False):
89
"""Utility function to help register a command
91
:param cmd: Command subclass to register
92
:param decorate: If true, allow overriding an existing command
93
of the same name; the old command is returned by this function.
94
Otherwise it is an error to try to override an existing command.
97
k_unsquished = self._get_name(k)
99
previous = self.get(k_unsquished)
101
previous = _builtin_commands().get(k_unsquished)
102
info = CommandInfo.from_command(cmd)
104
registry.Registry.register(self, k_unsquished, cmd,
105
override_existing=decorate, info=info)
107
trace.warning('Two plugins defined the same command: %r' % k)
108
trace.warning('Not loading the one in %r' %
109
sys.modules[cmd.__module__])
110
trace.warning('Previously this command was registered from %r' %
111
sys.modules[previous.__module__])
114
def register_lazy(self, command_name, aliases, module_name):
115
"""Register a command without loading its module.
117
:param command_name: The primary name of the command.
118
:param aliases: A list of aliases for the command.
119
:module_name: The module that the command lives in.
121
key = self._get_name(command_name)
122
registry.Registry.register_lazy(self, key, module_name, command_name,
123
info=CommandInfo(aliases))
126
plugin_cmds = CommandRegistry()
53
129
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
130
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__])
131
return plugin_cmds.register(cmd, decorate)
81
134
def _squish_command_name(cmd):
85
138
def _unsquish_command_name(cmd):
86
assert cmd.startswith("cmd_")
87
139
return cmd[4:].replace('_','-')
90
142
def _builtin_commands():
91
143
import bzrlib.builtins
144
return _scan_module_for_commands(bzrlib.builtins)
147
def _scan_module_for_commands(module):
93
builtins = bzrlib.builtins.__dict__
149
for name, obj in module.__dict__.iteritems():
95
150
if name.startswith("cmd_"):
96
151
real_name = _unsquish_command_name(name)
97
r[real_name] = builtins[name]
156
def _list_bzr_commands(names):
157
"""Find commands from bzr's core and plugins."""
158
# to eliminate duplicates
159
names.update(builtin_command_names())
160
names.update(plugin_command_names())
164
def all_command_names():
165
"""Return a set of all command names."""
167
for hook in Command.hooks['list_commands']:
170
raise AssertionError(
171
'hook %s returned None' % Command.hooks.get_hook_name(hook))
101
175
def builtin_command_names():
102
"""Return list of builtin command names."""
176
"""Return list of builtin command names.
178
Use of all_command_names() is encouraged rather than builtin_command_names
179
and/or plugin_command_names.
103
181
return _builtin_commands().keys()
106
184
def plugin_command_names():
185
"""Returns command names from commands registered by plugins."""
107
186
return plugin_cmds.keys()
110
def _get_cmd_dict(plugins_override=True):
111
"""Return name->class mapping for all commands."""
112
d = _builtin_commands()
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():
124
189
def get_cmd_object(cmd_name, plugins_override=True):
125
"""Return the canonical name and command class for a command.
190
"""Return the command object for a command.
128
193
If true, plugin commands can override builtins.
130
from bzrlib.externalcommand import ExternalCommand
196
return _get_cmd_object(cmd_name, plugins_override)
198
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
201
def _get_cmd_object(cmd_name, plugins_override=True):
202
"""Get a command object.
204
:param cmd_name: The name of the command.
205
:param plugins_override: Allow plugins to override builtins.
206
:return: A Command object instance
207
:raises KeyError: If no command is found.
132
209
# We want only 'ascii' command names, but the user may have typed
133
210
# in a Unicode name. In that case, they should just get a
134
211
# 'command not found' error later.
135
212
# 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)
215
for hook in Command.hooks['get_command']:
216
cmd = hook(cmd, cmd_name)
217
if cmd is not None and not plugins_override and not cmd.plugin_name():
218
# We've found a non-plugin command, don't permit it to be
222
for hook in Command.hooks['get_missing_command']:
229
# Allow plugins to extend commands
230
for hook in Command.hooks['extend_command']:
235
def _try_plugin_provider(cmd_name):
236
"""Probe for a plugin provider having cmd_name."""
238
plugin_metadata, provider = probe_for_provider(cmd_name)
239
raise errors.CommandAvailableInPlugin(cmd_name,
240
plugin_metadata, provider)
241
except errors.NoPluginAvailable:
245
def probe_for_provider(cmd_name):
246
"""Look for a provider for cmd_name.
248
:param cmd_name: The command name.
249
:return: plugin_metadata, provider for getting cmd_name.
250
:raises NoPluginAvailable: When no provider can supply the plugin.
252
# look for providers that provide this command but aren't installed
253
for provider in command_providers_registry:
255
return provider.plugin_for_command(cmd_name), provider
256
except errors.NoPluginAvailable:
258
raise errors.NoPluginAvailable(cmd_name)
261
def _get_bzr_command(cmd_or_None, cmd_name):
262
"""Get a command from bzr's core."""
263
cmds = _builtin_commands()
140
265
return cmds[cmd_name]()
144
268
# look for any command which claims this as an alias
145
269
for real_cmd_name, cmd_class in cmds.iteritems():
146
270
if cmd_name in cmd_class.aliases:
147
271
return cmd_class()
275
def _get_external_command(cmd_or_None, cmd_name):
276
"""Lookup a command that is a shell script."""
277
# Only do external command lookups when no command is found so far.
278
if cmd_or_None is not None:
280
from bzrlib.externalcommand import ExternalCommand
149
281
cmd_obj = ExternalCommand.find_command(cmd_name)
153
raise BzrCommandError('unknown command "%s"' % cmd_name)
286
def _get_plugin_command(cmd_or_None, cmd_name):
287
"""Get a command from bzr's plugins."""
289
return plugin_cmds.get(cmd_name)()
292
for key in plugin_cmds.keys():
293
info = plugin_cmds.get_info(key)
294
if cmd_name in info.aliases:
295
return plugin_cmds.get(key)()
156
299
class Command(object):
211
361
encoding_type = 'strict'
215
365
def __init__(self):
216
366
"""Construct an instance of this command."""
217
367
if self.__doc__ == Command.__doc__:
218
368
warn("No help message set for %r" % self)
369
# List of standard options directly supported
370
self.supported_std_options = []
371
self._operation = cleanup.OperationWithCleanups(self.run)
373
def add_cleanup(self, cleanup_func, *args, **kwargs):
374
"""Register a function to call after self.run returns or raises.
376
Functions will be called in LIFO order.
378
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
380
def cleanup_now(self):
381
"""Execute and empty pending cleanup functions immediately.
383
After cleanup_now all registered cleanups are forgotten. add_cleanup
384
may be called again after cleanup_now; these cleanups will be called
385
after self.run returns or raises (or when cleanup_now is next called).
387
This is useful for releasing expensive or contentious resources (such
388
as write locks) before doing further work that does not require those
389
resources (such as writing results to self.outf).
391
self._operation.cleanup_now()
393
@deprecated_method(deprecated_in((2, 1, 0)))
394
def _maybe_expand_globs(self, file_list):
395
"""Glob expand file_list if the platform does not do that itself.
397
Not used anymore, now that the bzr command-line parser globs on
400
:return: A possibly empty list of unicode paths.
402
Introduced in bzrlib 0.18.
407
"""Return single-line grammar for this command.
409
Only describes arguments, not options.
411
s = 'bzr ' + self.name() + ' '
412
for aname in self.takes_args:
413
aname = aname.upper()
414
if aname[-1] in ['$', '+']:
415
aname = aname[:-1] + '...'
416
elif aname[-1] == '?':
417
aname = '[' + aname[:-1] + ']'
418
elif aname[-1] == '*':
419
aname = '[' + aname[:-1] + '...]'
421
s = s[:-1] # remove last space
424
def get_help_text(self, additional_see_also=None, plain=True,
425
see_also_as_links=False, verbose=True):
426
"""Return a text string with help for this command.
428
:param additional_see_also: Additional help topics to be
430
:param plain: if False, raw help (reStructuredText) is
431
returned instead of plain text.
432
:param see_also_as_links: if True, convert items in 'See also'
433
list to internal links (used by bzr_man rstx generator)
434
:param verbose: if True, display the full help, otherwise
435
leave out the descriptive sections and just display
436
usage help (e.g. Purpose, Usage, Options) with a
437
message explaining how to obtain full help.
441
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
443
# Extract the summary (purpose) and sections out from the text
444
purpose,sections,order = self._get_help_parts(doc)
446
# If a custom usage section was provided, use it
447
if sections.has_key('Usage'):
448
usage = sections.pop('Usage')
450
usage = self._usage()
452
# The header is the purpose and usage
454
result += ':Purpose: %s\n' % purpose
455
if usage.find('\n') >= 0:
456
result += ':Usage:\n%s\n' % usage
458
result += ':Usage: %s\n' % usage
463
# XXX: optparse implicitly rewraps the help, and not always perfectly,
464
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
466
options = option.get_optparser(self.options()).format_option_help()
467
# XXX: According to the spec, ReST option lists actually don't support
468
# options like --1.9 so that causes syntax errors (in Sphinx at least).
469
# As that pattern always appears in the commands that break, we trap
470
# on that and then format that block of 'format' options as a literal
472
if not plain and options.find(' --1.9 ') != -1:
473
options = options.replace(' format:\n', ' format::\n\n', 1)
474
if options.startswith('Options:'):
475
result += ':' + options
476
elif options.startswith('options:'):
477
# Python 2.4 version of optparse
478
result += ':Options:' + options[len('options:'):]
484
# Add the description, indenting it 2 spaces
485
# to match the indentation of the options
486
if sections.has_key(None):
487
text = sections.pop(None)
488
text = '\n '.join(text.splitlines())
489
result += ':%s:\n %s\n\n' % ('Description',text)
491
# Add the custom sections (e.g. Examples). Note that there's no need
492
# to indent these as they must be indented already in the source.
495
if sections.has_key(label):
496
result += ':%s:\n%s\n' % (label,sections[label])
499
result += ("See bzr help %s for more details and examples.\n\n"
502
# Add the aliases, source (plug-in) and see also links, if any
504
result += ':Aliases: '
505
result += ', '.join(self.aliases) + '\n'
506
plugin_name = self.plugin_name()
507
if plugin_name is not None:
508
result += ':From: plugin "%s"\n' % plugin_name
509
see_also = self.get_see_also(additional_see_also)
511
if not plain and see_also_as_links:
513
for item in see_also:
515
# topics doesn't have an independent section
516
# so don't create a real link
517
see_also_links.append(item)
519
# Use a Sphinx link for this entry
520
link_text = ":doc:`%s <%s-help>`" % (item, item)
521
see_also_links.append(link_text)
522
see_also = see_also_links
523
result += ':See also: '
524
result += ', '.join(see_also) + '\n'
526
# If this will be rendered as plain text, convert it
528
import bzrlib.help_topics
529
result = bzrlib.help_topics.help_as_plain_text(result)
533
def _get_help_parts(text):
534
"""Split help text into a summary and named sections.
536
:return: (summary,sections,order) where summary is the top line and
537
sections is a dictionary of the rest indexed by section name.
538
order is the order the section appear in the text.
539
A section starts with a heading line of the form ":xxx:".
540
Indented text on following lines is the section value.
541
All text found outside a named section is assigned to the
542
default section which is given the key of None.
544
def save_section(sections, order, label, section):
546
if sections.has_key(label):
547
sections[label] += '\n' + section
550
sections[label] = section
552
lines = text.rstrip().splitlines()
553
summary = lines.pop(0)
556
label,section = None,''
558
if line.startswith(':') and line.endswith(':') and len(line) > 2:
559
save_section(sections, order, label, section)
560
label,section = line[1:-1],''
561
elif (label is not None) and len(line) > 1 and not line[0].isspace():
562
save_section(sections, order, label, section)
563
label,section = None,line
566
section += '\n' + line
569
save_section(sections, order, label, section)
570
return summary, sections, order
572
def get_help_topic(self):
573
"""Return the commands help topic - its name."""
576
def get_see_also(self, additional_terms=None):
577
"""Return a list of help topics that are related to this command.
579
The list is derived from the content of the _see_also attribute. Any
580
duplicates are removed and the result is in lexical order.
581
:param additional_terms: Additional help topics to cross-reference.
582
:return: A list of help topics.
584
see_also = set(getattr(self, '_see_also', []))
586
see_also.update(additional_terms)
587
return sorted(see_also)
220
589
def options(self):
221
590
"""Return dict of valid options for this command.
223
592
Maps from long option name to option object."""
225
r['help'] = Option.OPTIONS['help']
593
r = Option.STD_OPTIONS.copy()
226
595
for o in self.takes_options:
227
596
if isinstance(o, basestring):
228
o = Option.OPTIONS[o]
597
o = option.Option.OPTIONS[o]
599
if o.name in std_names:
600
self.supported_std_options.append(o.name)
232
603
def _setup_outf(self):
233
604
"""Return a file linked to stdout, which has proper encoding."""
234
assert self.encoding_type in ['strict', 'exact', 'replace']
236
# Originally I was using self.stdout, but that looks
237
# *way* too much like sys.stdout
238
if self.encoding_type == 'exact':
239
self.outf = sys.stdout
242
output_encoding = bzrlib.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)
247
# For whatever reason codecs.getwriter() does not advertise its encoding
248
# it just returns the encoding of the wrapped file, which is completely
249
# bogus. So set the attribute, so we can find the correct encoding later.
250
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)
605
self.outf = ui.ui_factory.make_output_stream(
606
encoding_type=self.encoding_type)
260
608
def run_argv_aliases(self, argv, alias_argv=None):
261
609
"""Parse the command line and run with extra aliases in alias_argv."""
263
warn("Passing None for [] is deprecated from bzrlib 0.10",
264
DeprecationWarning, stacklevel=2)
266
610
args, opts = parse_args(self, argv, alias_argv)
612
# Process the standard options
267
613
if 'help' in opts: # e.g. bzr add --help
268
from bzrlib.help import help_on_command
269
help_on_command(self.name())
614
sys.stdout.write(self.get_help_text())
616
if 'usage' in opts: # e.g. bzr add --usage
617
sys.stdout.write(self.get_help_text(verbose=False))
619
trace.set_verbosity_level(option._verbosity_level)
620
if 'verbose' in self.supported_std_options:
621
opts['verbose'] = trace.is_verbose()
622
elif opts.has_key('verbose'):
624
if 'quiet' in self.supported_std_options:
625
opts['quiet'] = trace.is_quiet()
626
elif opts.has_key('quiet'):
271
629
# mix arguments and options into one dictionary
272
630
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]
681
class CommandHooks(Hooks):
682
"""Hooks related to Command object creation/enumeration."""
685
"""Create the default hooks.
687
These are all empty initially, because by default nothing should get
691
self.create_hook(HookPoint('extend_command',
692
"Called after creating a command object to allow modifications "
693
"such as adding or removing options, docs etc. Called with the "
694
"new bzrlib.commands.Command object.", (1, 13), None))
695
self.create_hook(HookPoint('get_command',
696
"Called when creating a single command. Called with "
697
"(cmd_or_None, command_name). get_command should either return "
698
"the cmd_or_None parameter, or a replacement Command object that "
699
"should be used for the command. Note that the Command.hooks "
700
"hooks are core infrastructure. Many users will prefer to use "
701
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
703
self.create_hook(HookPoint('get_missing_command',
704
"Called when creating a single command if no command could be "
705
"found. Called with (command_name). get_missing_command should "
706
"either return None, or a Command object to be used for the "
707
"command.", (1, 17), None))
708
self.create_hook(HookPoint('list_commands',
709
"Called when enumerating commands. Called with a set of "
710
"cmd_name strings for all the commands found so far. This set "
711
" is safe to mutate - e.g. to remove a command. "
712
"list_commands should return the updated set of command names.",
715
Command.hooks = CommandHooks()
350
718
def parse_args(command, argv, alias_argv=None):
351
719
"""Parse command line.
353
721
Arguments and options are parsed at this level before being passed
354
722
down to specific command handlers. This routine knows, from a
355
723
lookup table, something about the available options, what optargs
436
821
os.remove(pfname)
824
def exception_to_return_code(the_callable, *args, **kwargs):
825
"""UI level helper for profiling and coverage.
827
This transforms exceptions into a return value of 3. As such its only
828
relevant to the UI layer, and should never be called where catching
829
exceptions may be desirable.
832
return the_callable(*args, **kwargs)
833
except (KeyboardInterrupt, Exception), e:
834
# used to handle AssertionError and KeyboardInterrupt
835
# specially here, but hopefully they're handled ok by the logger now
836
exc_info = sys.exc_info()
837
exitcode = trace.report_exception(exc_info, sys.stderr)
838
if os.environ.get('BZR_PDB'):
839
print '**** entering debugger'
842
if sys.version_info[:2] < (2, 6):
844
# pdb.post_mortem(tb)
845
# but because pdb.post_mortem gives bad results for tracebacks
846
# from inside generators, we do it manually.
847
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
849
# Setup pdb on the traceback
852
p.setup(tb.tb_frame, tb)
853
# Point the debugger at the deepest frame of the stack
854
p.curindex = len(p.stack) - 1
855
p.curframe = p.stack[p.curindex][0]
856
# Start the pdb prompt.
857
p.print_stack_entry(p.stack[p.curindex])
439
865
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
440
866
from bzrlib.lsprof import profile
442
ret, stats = profile(the_callable, *args, **kwargs)
867
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
444
869
if filename is None:
448
cPickle.dump(stats, open(filename, 'w'), 2)
449
print 'Profile data written to %r.' % filename
873
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)
877
@deprecated_method(deprecated_in((2, 2, 0)))
878
def shlex_split_unicode(unsplit):
879
return cmdline.split(unsplit)
882
def get_alias(cmd, config=None):
883
"""Return an expanded alias, or None if no alias exists.
886
Command to be checked for an alias.
888
Used to specify an alternative config to use,
889
which is especially useful for testing.
890
If it is unspecified, the global config will be used.
894
config = bzrlib.config.GlobalConfig()
895
alias = config.get_alias(cmd)
458
return alias.split(' ')
897
return cmdline.split(alias)
462
901
def run_bzr(argv):
463
902
"""Execute a command.
465
This is similar to main(), but without all the trappings for
466
logging and error handling.
469
905
The command-line arguments, without the program name from argv[0]
470
906
These should already be decoded. All library/test code calling
471
907
run_bzr should be passing valid strings (don't need decoding).
473
909
Returns a command status or raises an exception.
475
911
Special master options: these must come before the command because
596
1062
return ignore_pipe
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:]]
1065
def install_bzr_command_hooks():
1066
"""Install the hooks to supply bzr's own commands."""
1067
if _list_bzr_commands in Command.hooks["list_commands"]:
1069
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1071
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1073
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1074
"bzr plugin commands")
1075
Command.hooks.install_named_hook("get_command", _get_external_command,
1076
"bzr external command lookup")
1077
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1078
"bzr plugin-provider-db check")
1082
def _specified_or_unicode_argv(argv):
1083
# For internal or testing use, argv can be passed. Otherwise, get it from
1084
# the process arguments in a unicode-safe way.
1086
return osutils.get_unicode_argv()
1090
# ensure all arguments are unicode strings
1092
if isinstance(a, unicode):
1095
new_argv.append(a.decode('ascii'))
1096
except UnicodeDecodeError:
1097
raise errors.BzrError("argv should be list of unicode strings.")
1101
def main(argv=None):
1102
"""Main entry point of command-line interface.
1104
Typically `bzrlib.initialize` should be called first.
1106
:param argv: list of unicode command-line arguments similar to sys.argv.
1107
argv[0] is script name usually, it will be ignored.
1108
Don't pass here sys.argv because this list contains plain strings
1109
and not unicode; pass None instead.
1111
:return: exit code of bzr command.
1113
argv = _specified_or_unicode_argv(argv)
604
1114
ret = run_bzr_catch_errors(argv)
605
mutter("return code %d", ret)
1115
bzrlib.ui.ui_factory.log_transport_activity(
1116
display=('bytes' in debug.debug_flags))
1117
trace.mutter("return code %d", ret)
609
1121
def run_bzr_catch_errors(argv):
1122
"""Run a bzr command with parameters as described by argv.
1124
This function assumed that that UI layer is setup, that symbol deprecations
1125
are already applied, and that unicode decoding has already been performed on argv.
1127
# done here so that they're covered for every test run
1128
install_bzr_command_hooks()
1129
return exception_to_return_code(run_bzr, argv)
1132
def run_bzr_catch_user_errors(argv):
1133
"""Run bzr and report user errors, but let internal errors propagate.
1135
This is used for the test suite, and might be useful for other programs
1136
that want to wrap the commandline interface.
1138
# done here so that they're covered for every test run
1139
install_bzr_command_hooks()
611
1141
return run_bzr(argv)
612
# do this here inside the exception wrappers to catch EPIPE
614
1142
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)
624
if __name__ == '__main__':
625
sys.exit(main(sys.argv))
1143
if (isinstance(e, (OSError, IOError))
1144
or not getattr(e, 'internal_error', True)):
1145
trace.report_exception(sys.exc_info(), sys.stderr)
1151
class HelpCommandIndex(object):
1152
"""A index for bzr help that returns commands."""
1155
self.prefix = 'commands/'
1157
def get_topics(self, topic):
1158
"""Search for topic amongst commands.
1160
:param topic: A topic to search for.
1161
:return: A list which is either empty or contains a single
1164
if topic and topic.startswith(self.prefix):
1165
topic = topic[len(self.prefix):]
1167
cmd = _get_cmd_object(topic)
1174
class Provider(object):
1175
'''Generic class to be overriden by plugins'''
1177
def plugin_for_command(self, cmd_name):
1178
'''Takes a command and returns the information for that plugin
1180
:return: A dictionary with all the available information
1181
for the requested plugin
1183
raise NotImplementedError
1186
class ProvidersRegistry(registry.Registry):
1187
'''This registry exists to allow other providers to exist'''
1190
for key, provider in self.iteritems():
1193
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
