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
54
from bzrlib.hooks import HookPoint, Hooks
55
# Compatibility - Option used to be in commands.
44
56
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
57
from bzrlib import registry
58
from bzrlib.symbol_versioning import (
62
suppress_deprecation_warnings,
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."""
189
@deprecated_function(deprecated_in((1, 17, 0)))
190
def get_all_cmds(plugins_override=False):
191
"""Return canonical name and class for most commands.
193
NB: This does not return all commands since the introduction of
194
command hooks, and returning the class is not sufficient to
195
get correctly setup commands, which is why it is deprecated.
197
Use 'all_command_names' + 'get_cmd_object' instead.
112
199
d = _builtin_commands()
113
200
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():
201
d.update(plugin_cmds.iteritems())
202
for k, v in d.iteritems():
124
206
def get_cmd_object(cmd_name, plugins_override=True):
125
"""Return the canonical name and command class for a command.
207
"""Return the command object for a command.
128
210
If true, plugin commands can override builtins.
130
from bzrlib.externalcommand import ExternalCommand
213
return _get_cmd_object(cmd_name, plugins_override)
215
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
218
def _get_cmd_object(cmd_name, plugins_override=True):
219
"""Get a command object.
221
:param cmd_name: The name of the command.
222
:param plugins_override: Allow plugins to override builtins.
223
:return: A Command object instance
224
:raises KeyError: If no command is found.
132
226
# We want only 'ascii' command names, but the user may have typed
133
227
# in a Unicode name. In that case, they should just get a
134
228
# 'command not found' error later.
135
229
# 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)
232
for hook in Command.hooks['get_command']:
233
cmd = hook(cmd, cmd_name)
234
if cmd is not None and not plugins_override and not cmd.plugin_name():
235
# We've found a non-plugin command, don't permit it to be
239
for hook in Command.hooks['get_missing_command']:
246
# Allow plugins to extend commands
247
for hook in Command.hooks['extend_command']:
252
def _try_plugin_provider(cmd_name):
253
"""Probe for a plugin provider having cmd_name."""
255
plugin_metadata, provider = probe_for_provider(cmd_name)
256
raise errors.CommandAvailableInPlugin(cmd_name,
257
plugin_metadata, provider)
258
except errors.NoPluginAvailable:
262
def probe_for_provider(cmd_name):
263
"""Look for a provider for cmd_name.
265
:param cmd_name: The command name.
266
:return: plugin_metadata, provider for getting cmd_name.
267
:raises NoPluginAvailable: When no provider can supply the plugin.
269
# look for providers that provide this command but aren't installed
270
for provider in command_providers_registry:
272
return provider.plugin_for_command(cmd_name), provider
273
except errors.NoPluginAvailable:
275
raise errors.NoPluginAvailable(cmd_name)
278
def _get_bzr_command(cmd_or_None, cmd_name):
279
"""Get a command from bzr's core."""
280
cmds = _builtin_commands()
140
282
return cmds[cmd_name]()
144
285
# look for any command which claims this as an alias
145
286
for real_cmd_name, cmd_class in cmds.iteritems():
146
287
if cmd_name in cmd_class.aliases:
147
288
return cmd_class()
292
def _get_external_command(cmd_or_None, cmd_name):
293
"""Lookup a command that is a shell script."""
294
# Only do external command lookups when no command is found so far.
295
if cmd_or_None is not None:
297
from bzrlib.externalcommand import ExternalCommand
149
298
cmd_obj = ExternalCommand.find_command(cmd_name)
153
raise BzrCommandError('unknown command "%s"' % cmd_name)
303
def _get_plugin_command(cmd_or_None, cmd_name):
304
"""Get a command from bzr's plugins."""
306
return plugin_cmds.get(cmd_name)()
309
for key in plugin_cmds.keys():
310
info = plugin_cmds.get_info(key)
311
if cmd_name in info.aliases:
312
return plugin_cmds.get(key)()
156
316
class Command(object):
211
378
encoding_type = 'strict'
215
382
def __init__(self):
216
383
"""Construct an instance of this command."""
217
384
if self.__doc__ == Command.__doc__:
218
385
warn("No help message set for %r" % self)
386
# List of standard options directly supported
387
self.supported_std_options = []
388
self._operation = cleanup.OperationWithCleanups(self.run)
390
def add_cleanup(self, cleanup_func, *args, **kwargs):
391
"""Register a function to call after self.run returns or raises.
393
Functions will be called in LIFO order.
395
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
397
def cleanup_now(self):
398
"""Execute and empty pending cleanup functions immediately.
400
After cleanup_now all registered cleanups are forgotten. add_cleanup
401
may be called again after cleanup_now; these cleanups will be called
402
after self.run returns or raises (or when cleanup_now is next called).
404
This is useful for releasing expensive or contentious resources (such
405
as write locks) before doing further work that does not require those
406
resources (such as writing results to self.outf).
408
self._operation.cleanup_now()
410
@deprecated_method(deprecated_in((2, 1, 0)))
411
def _maybe_expand_globs(self, file_list):
412
"""Glob expand file_list if the platform does not do that itself.
414
Not used anymore, now that the bzr command-line parser globs on
417
:return: A possibly empty list of unicode paths.
419
Introduced in bzrlib 0.18.
424
"""Return single-line grammar for this command.
426
Only describes arguments, not options.
428
s = 'bzr ' + self.name() + ' '
429
for aname in self.takes_args:
430
aname = aname.upper()
431
if aname[-1] in ['$', '+']:
432
aname = aname[:-1] + '...'
433
elif aname[-1] == '?':
434
aname = '[' + aname[:-1] + ']'
435
elif aname[-1] == '*':
436
aname = '[' + aname[:-1] + '...]'
438
s = s[:-1] # remove last space
441
def get_help_text(self, additional_see_also=None, plain=True,
442
see_also_as_links=False, verbose=True):
443
"""Return a text string with help for this command.
445
:param additional_see_also: Additional help topics to be
447
:param plain: if False, raw help (reStructuredText) is
448
returned instead of plain text.
449
:param see_also_as_links: if True, convert items in 'See also'
450
list to internal links (used by bzr_man rstx generator)
451
:param verbose: if True, display the full help, otherwise
452
leave out the descriptive sections and just display
453
usage help (e.g. Purpose, Usage, Options) with a
454
message explaining how to obtain full help.
458
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
460
# Extract the summary (purpose) and sections out from the text
461
purpose,sections,order = self._get_help_parts(doc)
463
# If a custom usage section was provided, use it
464
if sections.has_key('Usage'):
465
usage = sections.pop('Usage')
467
usage = self._usage()
469
# The header is the purpose and usage
471
result += ':Purpose: %s\n' % purpose
472
if usage.find('\n') >= 0:
473
result += ':Usage:\n%s\n' % usage
475
result += ':Usage: %s\n' % usage
480
# XXX: optparse implicitly rewraps the help, and not always perfectly,
481
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
483
options = option.get_optparser(self.options()).format_option_help()
484
# XXX: According to the spec, ReST option lists actually don't support
485
# options like --1.9 so that causes syntax errors (in Sphinx at least).
486
# As that pattern always appears in the commands that break, we trap
487
# on that and then format that block of 'format' options as a literal
489
if not plain and options.find(' --1.9 ') != -1:
490
options = options.replace(' format:\n', ' format::\n\n', 1)
491
if options.startswith('Options:'):
492
result += ':' + options
493
elif options.startswith('options:'):
494
# Python 2.4 version of optparse
495
result += ':Options:' + options[len('options:'):]
501
# Add the description, indenting it 2 spaces
502
# to match the indentation of the options
503
if sections.has_key(None):
504
text = sections.pop(None)
505
text = '\n '.join(text.splitlines())
506
result += ':%s:\n %s\n\n' % ('Description',text)
508
# Add the custom sections (e.g. Examples). Note that there's no need
509
# to indent these as they must be indented already in the source.
512
if sections.has_key(label):
513
result += ':%s:\n%s\n' % (label,sections[label])
516
result += ("See bzr help %s for more details and examples.\n\n"
519
# Add the aliases, source (plug-in) and see also links, if any
521
result += ':Aliases: '
522
result += ', '.join(self.aliases) + '\n'
523
plugin_name = self.plugin_name()
524
if plugin_name is not None:
525
result += ':From: plugin "%s"\n' % plugin_name
526
see_also = self.get_see_also(additional_see_also)
528
if not plain and see_also_as_links:
530
for item in see_also:
532
# topics doesn't have an independent section
533
# so don't create a real link
534
see_also_links.append(item)
536
# Use a Sphinx link for this entry
537
link_text = ":doc:`%s <%s-help>`" % (item, item)
538
see_also_links.append(link_text)
539
see_also = see_also_links
540
result += ':See also: '
541
result += ', '.join(see_also) + '\n'
543
# If this will be rendered as plain text, convert it
545
import bzrlib.help_topics
546
result = bzrlib.help_topics.help_as_plain_text(result)
550
def _get_help_parts(text):
551
"""Split help text into a summary and named sections.
553
:return: (summary,sections,order) where summary is the top line and
554
sections is a dictionary of the rest indexed by section name.
555
order is the order the section appear in the text.
556
A section starts with a heading line of the form ":xxx:".
557
Indented text on following lines is the section value.
558
All text found outside a named section is assigned to the
559
default section which is given the key of None.
561
def save_section(sections, order, label, section):
563
if sections.has_key(label):
564
sections[label] += '\n' + section
567
sections[label] = section
569
lines = text.rstrip().splitlines()
570
summary = lines.pop(0)
573
label,section = None,''
575
if line.startswith(':') and line.endswith(':') and len(line) > 2:
576
save_section(sections, order, label, section)
577
label,section = line[1:-1],''
578
elif (label is not None) and len(line) > 1 and not line[0].isspace():
579
save_section(sections, order, label, section)
580
label,section = None,line
583
section += '\n' + line
586
save_section(sections, order, label, section)
587
return summary, sections, order
589
def get_help_topic(self):
590
"""Return the commands help topic - its name."""
593
def get_see_also(self, additional_terms=None):
594
"""Return a list of help topics that are related to this command.
596
The list is derived from the content of the _see_also attribute. Any
597
duplicates are removed and the result is in lexical order.
598
:param additional_terms: Additional help topics to cross-reference.
599
:return: A list of help topics.
601
see_also = set(getattr(self, '_see_also', []))
603
see_also.update(additional_terms)
604
return sorted(see_also)
220
606
def options(self):
221
607
"""Return dict of valid options for this command.
223
609
Maps from long option name to option object."""
225
r['help'] = Option.OPTIONS['help']
610
r = Option.STD_OPTIONS.copy()
226
612
for o in self.takes_options:
227
613
if isinstance(o, basestring):
228
o = Option.OPTIONS[o]
614
o = option.Option.OPTIONS[o]
616
if o.name in std_names:
617
self.supported_std_options.append(o.name)
232
620
def _setup_outf(self):
233
621
"""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)
622
self.outf = ui.ui_factory.make_output_stream(
623
encoding_type=self.encoding_type)
260
625
def run_argv_aliases(self, argv, alias_argv=None):
261
626
"""Parse the command line and run with extra aliases in alias_argv."""
263
warn("Passing None for [] is deprecated from bzrlib 0.10",
628
warn("Passing None for [] is deprecated from bzrlib 0.10",
264
629
DeprecationWarning, stacklevel=2)
266
631
args, opts = parse_args(self, argv, alias_argv)
633
# Process the standard options
267
634
if 'help' in opts: # e.g. bzr add --help
268
from bzrlib.help import help_on_command
269
help_on_command(self.name())
635
sys.stdout.write(self.get_help_text())
637
if 'usage' in opts: # e.g. bzr add --usage
638
sys.stdout.write(self.get_help_text(verbose=False))
640
trace.set_verbosity_level(option._verbosity_level)
641
if 'verbose' in self.supported_std_options:
642
opts['verbose'] = trace.is_verbose()
643
elif opts.has_key('verbose'):
645
if 'quiet' in self.supported_std_options:
646
opts['quiet'] = trace.is_quiet()
647
elif opts.has_key('quiet'):
271
650
# mix arguments and options into one dictionary
272
651
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]
702
class CommandHooks(Hooks):
703
"""Hooks related to Command object creation/enumeration."""
706
"""Create the default hooks.
708
These are all empty initially, because by default nothing should get
712
self.create_hook(HookPoint('extend_command',
713
"Called after creating a command object to allow modifications "
714
"such as adding or removing options, docs etc. Called with the "
715
"new bzrlib.commands.Command object.", (1, 13), None))
716
self.create_hook(HookPoint('get_command',
717
"Called when creating a single command. Called with "
718
"(cmd_or_None, command_name). get_command should either return "
719
"the cmd_or_None parameter, or a replacement Command object that "
720
"should be used for the command. Note that the Command.hooks "
721
"hooks are core infrastructure. Many users will prefer to use "
722
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
724
self.create_hook(HookPoint('get_missing_command',
725
"Called when creating a single command if no command could be "
726
"found. Called with (command_name). get_missing_command should "
727
"either return None, or a Command object to be used for the "
728
"command.", (1, 17), None))
729
self.create_hook(HookPoint('list_commands',
730
"Called when enumerating commands. Called with a set of "
731
"cmd_name strings for all the commands found so far. This set "
732
" is safe to mutate - e.g. to remove a command. "
733
"list_commands should return the updated set of command names.",
736
Command.hooks = CommandHooks()
350
739
def parse_args(command, argv, alias_argv=None):
351
740
"""Parse command line.
353
742
Arguments and options are parsed at this level before being passed
354
743
down to specific command handlers. This routine knows, from a
355
744
lookup table, something about the available options, what optargs
436
842
os.remove(pfname)
845
def exception_to_return_code(the_callable, *args, **kwargs):
846
"""UI level helper for profiling and coverage.
848
This transforms exceptions into a return value of 3. As such its only
849
relevant to the UI layer, and should never be called where catching
850
exceptions may be desirable.
853
return the_callable(*args, **kwargs)
854
except (KeyboardInterrupt, Exception), e:
855
# used to handle AssertionError and KeyboardInterrupt
856
# specially here, but hopefully they're handled ok by the logger now
857
exc_info = sys.exc_info()
858
exitcode = trace.report_exception(exc_info, sys.stderr)
859
if os.environ.get('BZR_PDB'):
860
print '**** entering debugger'
863
if sys.version_info[:2] < (2, 6):
865
# pdb.post_mortem(tb)
866
# but because pdb.post_mortem gives bad results for tracebacks
867
# from inside generators, we do it manually.
868
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
870
# Setup pdb on the traceback
873
p.setup(tb.tb_frame, tb)
874
# Point the debugger at the deepest frame of the stack
875
p.curindex = len(p.stack) - 1
876
p.curframe = p.stack[p.curindex][0]
877
# Start the pdb prompt.
878
p.print_stack_entry(p.stack[p.curindex])
439
886
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
440
887
from bzrlib.lsprof import profile
442
ret, stats = profile(the_callable, *args, **kwargs)
888
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
444
890
if filename is None:
448
cPickle.dump(stats, open(filename, 'w'), 2)
449
print 'Profile data written to %r.' % filename
894
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)
898
def shlex_split_unicode(unsplit):
900
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
903
def get_alias(cmd, config=None):
904
"""Return an expanded alias, or None if no alias exists.
907
Command to be checked for an alias.
909
Used to specify an alternative config to use,
910
which is especially useful for testing.
911
If it is unspecified, the global config will be used.
915
config = bzrlib.config.GlobalConfig()
916
alias = config.get_alias(cmd)
458
return alias.split(' ')
918
return shlex_split_unicode(alias)
462
922
def run_bzr(argv):
463
923
"""Execute a command.
465
This is similar to main(), but without all the trappings for
466
logging and error handling.
469
926
The command-line arguments, without the program name from argv[0]
470
927
These should already be decoded. All library/test code calling
471
928
run_bzr should be passing valid strings (don't need decoding).
473
930
Returns a command status or raises an exception.
475
932
Special master options: these must come before the command because
596
1083
return ignore_pipe
1086
def install_bzr_command_hooks():
1087
"""Install the hooks to supply bzr's own commands."""
1088
if _list_bzr_commands in Command.hooks["list_commands"]:
1090
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1092
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1094
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1095
"bzr plugin commands")
1096
Command.hooks.install_named_hook("get_command", _get_external_command,
1097
"bzr external command lookup")
1098
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1099
"bzr plugin-provider-db check")
1102
def main(argv=None):
1103
"""Main entry point of command-line interface.
1105
:param argv: list of unicode command-line arguments similar to sys.argv.
1106
argv[0] is script name usually, it will be ignored.
1107
Don't pass here sys.argv because this list contains plain strings
1108
and not unicode; pass None instead.
1110
:return: exit code of bzr command.
600
1112
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:]]
1113
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1114
sys.stdin, sys.stdout, sys.stderr)
1116
# Is this a final release version? If so, we should suppress warnings
1117
if bzrlib.version_info[3] == 'final':
1118
suppress_deprecation_warnings(override=True)
1120
argv = osutils.get_unicode_argv()
1124
# ensure all arguments are unicode strings
1126
if isinstance(a, unicode):
1129
new_argv.append(a.decode('ascii'))
1130
except UnicodeDecodeError:
1131
raise errors.BzrError("argv should be list of unicode strings.")
604
1133
ret = run_bzr_catch_errors(argv)
605
mutter("return code %d", ret)
1134
bzrlib.ui.ui_factory.log_transport_activity(
1135
display=('bytes' in debug.debug_flags))
1136
trace.mutter("return code %d", ret)
1137
osutils.report_extension_load_failures()
609
1141
def run_bzr_catch_errors(argv):
1142
"""Run a bzr command with parameters as described by argv.
1144
This function assumed that that UI layer is setup, that symbol deprecations
1145
are already applied, and that unicode decoding has already been performed on argv.
1147
install_bzr_command_hooks()
1148
return exception_to_return_code(run_bzr, argv)
1151
def run_bzr_catch_user_errors(argv):
1152
"""Run bzr and report user errors, but let internal errors propagate.
1154
This is used for the test suite, and might be useful for other programs
1155
that want to wrap the commandline interface.
1157
install_bzr_command_hooks()
611
1159
return run_bzr(argv)
612
# do this here inside the exception wrappers to catch EPIPE
614
1160
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)
1161
if (isinstance(e, (OSError, IOError))
1162
or not getattr(e, 'internal_error', True)):
1163
trace.report_exception(sys.exc_info(), sys.stderr)
1169
class HelpCommandIndex(object):
1170
"""A index for bzr help that returns commands."""
1173
self.prefix = 'commands/'
1175
def get_topics(self, topic):
1176
"""Search for topic amongst commands.
1178
:param topic: A topic to search for.
1179
:return: A list which is either empty or contains a single
1182
if topic and topic.startswith(self.prefix):
1183
topic = topic[len(self.prefix):]
1185
cmd = _get_cmd_object(topic)
1192
class Provider(object):
1193
'''Generic class to be overriden by plugins'''
1195
def plugin_for_command(self, cmd_name):
1196
'''Takes a command and returns the information for that plugin
1198
:return: A dictionary with all the available information
1199
for the requested plugin
1201
raise NotImplementedError
1204
class ProvidersRegistry(registry.Registry):
1205
'''This registry exists to allow other providers to exist'''
1208
for key, provider in self.iteritems():
1211
command_providers_registry = ProvidersRegistry()
624
1214
if __name__ == '__main__':
625
1215
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
