29
35
lazy_import(globals(), """
33
38
from warnings import warn
36
41
from bzrlib import (
49
from bzrlib.hooks import HookPoint, Hooks
50
# Compatibility - Option used to be in commands.
51
from bzrlib.option import Option
52
from bzrlib.plugin import disable_plugins, load_plugins
53
from bzrlib import registry
54
50
from bzrlib.symbol_versioning import (
55
51
deprecated_function,
61
class CommandInfo(object):
62
"""Information about a command."""
64
def __init__(self, aliases):
65
"""The list of aliases for the command."""
66
self.aliases = aliases
69
def from_command(klass, command):
70
"""Factory to construct a CommandInfo from a command."""
71
return klass(command.aliases)
74
class CommandRegistry(registry.Registry):
75
"""Special registry mapping command names to command classes.
77
:ivar overridden_registry: Look in this registry for commands being
78
overridden by this registry. This can be used to tell plugin commands
79
about the builtin they're decorating.
83
registry.Registry.__init__(self)
84
self.overridden_registry = None
85
# map from aliases to the real command that implements the name
88
def get(self, command_name):
89
real_name = self._alias_dict.get(command_name, command_name)
90
return registry.Registry.get(self, real_name)
93
def _get_name(command_name):
94
if command_name.startswith("cmd_"):
95
return _unsquish_command_name(command_name)
99
def register(self, cmd, decorate=False):
100
"""Utility function to help register a command
102
:param cmd: Command subclass to register
103
:param decorate: If true, allow overriding an existing command
104
of the same name; the old command is returned by this function.
105
Otherwise it is an error to try to override an existing command.
108
k_unsquished = self._get_name(k)
110
previous = self.get(k_unsquished)
113
if self.overridden_registry:
115
previous = self.overridden_registry.get(k_unsquished)
118
info = CommandInfo.from_command(cmd)
120
registry.Registry.register(self, k_unsquished, cmd,
121
override_existing=decorate, info=info)
123
trace.warning('Two plugins defined the same command: %r' % k)
124
trace.warning('Not loading the one in %r' %
125
sys.modules[cmd.__module__])
126
trace.warning('Previously this command was registered from %r' %
127
sys.modules[previous.__module__])
128
for a in cmd.aliases:
129
self._alias_dict[a] = k_unsquished
132
def register_lazy(self, command_name, aliases, module_name):
133
"""Register a command without loading its module.
135
:param command_name: The primary name of the command.
136
:param aliases: A list of aliases for the command.
137
:module_name: The module that the command lives in.
139
key = self._get_name(command_name)
140
registry.Registry.register_lazy(self, key, module_name, command_name,
141
info=CommandInfo(aliases))
143
self._alias_dict[a] = key
146
plugin_cmds = CommandRegistry()
147
builtin_command_registry = CommandRegistry()
148
plugin_cmds.overridden_registry = builtin_command_registry
57
from bzrlib.option import Option
151
63
def register_command(cmd, decorate=False):
152
"""Register a plugin command.
64
"""Utility function to help register a command
154
Should generally be avoided in favor of lazy registration.
66
:param cmd: Command subclass to register
67
:param decorate: If true, allow overriding an existing command
68
of the same name; the old command is returned by this function.
69
Otherwise it is an error to try to override an existing command.
156
71
global plugin_cmds
157
return plugin_cmds.register(cmd, decorate)
73
if k.startswith("cmd_"):
74
k_unsquished = _unsquish_command_name(k)
77
if k_unsquished not in plugin_cmds:
78
plugin_cmds[k_unsquished] = cmd
79
trace.mutter('registered plugin command %s', k_unsquished)
80
if decorate and k_unsquished in builtin_command_names():
81
return _builtin_commands()[k_unsquished]
83
result = plugin_cmds[k_unsquished]
84
plugin_cmds[k_unsquished] = cmd
87
trace.log_error('Two plugins defined the same command: %r' % k)
88
trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
160
91
def _squish_command_name(cmd):
164
95
def _unsquish_command_name(cmd):
96
assert cmd.startswith("cmd_")
165
97
return cmd[4:].replace('_','-')
168
@deprecated_function(deprecated_in((2, 2, 0)))
169
100
def _builtin_commands():
170
"""Return a dict of {name: cmd_class} for builtin commands.
172
:deprecated: Use the builtin_command_registry registry instead
174
# return dict(name: cmd_class)
175
return dict(builtin_command_registry.items())
178
def _register_builtin_commands():
179
if builtin_command_registry.keys():
182
101
import bzrlib.builtins
183
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
184
builtin_command_registry.register(cmd_class)
185
bzrlib.builtins._register_lazy_builtins()
188
def _scan_module_for_commands(module):
190
for name, obj in module.__dict__.iteritems():
103
builtins = bzrlib.builtins.__dict__
104
for name in builtins:
191
105
if name.startswith("cmd_"):
192
106
real_name = _unsquish_command_name(name)
107
r[real_name] = builtins[name]
197
def _list_bzr_commands(names):
198
"""Find commands from bzr's core and plugins.
200
This is not the public interface, just the default hook called by all_command_names.
202
# to eliminate duplicates
203
names.update(builtin_command_names())
204
names.update(plugin_command_names())
208
def all_command_names():
209
"""Return a set of all command names."""
211
for hook in Command.hooks['list_commands']:
214
raise AssertionError(
215
'hook %s returned None' % Command.hooks.get_hook_name(hook))
219
111
def builtin_command_names():
220
"""Return list of builtin command names.
112
"""Return list of builtin command names."""
113
return _builtin_commands().keys()
222
Use of all_command_names() is encouraged rather than builtin_command_names
223
and/or plugin_command_names.
225
return builtin_command_registry.keys()
228
116
def plugin_command_names():
229
"""Returns command names from commands registered by plugins."""
230
117
return plugin_cmds.keys()
120
def _get_cmd_dict(plugins_override=True):
121
"""Return name->class mapping for all commands."""
122
d = _builtin_commands()
124
d.update(plugin_cmds)
128
def get_all_cmds(plugins_override=True):
129
"""Return canonical name and class for all registered commands."""
130
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
233
134
def get_cmd_object(cmd_name, plugins_override=True):
234
"""Return the command object for a command.
135
"""Return the canonical name and command class for a command.
237
138
If true, plugin commands can override builtins.
240
return _get_cmd_object(cmd_name, plugins_override)
242
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
246
"""Get a command object.
248
:param cmd_name: The name of the command.
249
:param plugins_override: Allow plugins to override builtins.
250
:param check_missing: Look up commands not found in the regular index via
251
the get_missing_command hook.
252
:return: A Command object instance
253
:raises KeyError: If no command is found.
140
from bzrlib.externalcommand import ExternalCommand
255
142
# We want only 'ascii' command names, but the user may have typed
256
143
# in a Unicode name. In that case, they should just get a
257
144
# 'command not found' error later.
258
145
# In the future, we may actually support Unicode command names.
261
for hook in Command.hooks['get_command']:
262
cmd = hook(cmd, cmd_name)
263
if cmd is not None and not plugins_override and not cmd.plugin_name():
264
# We've found a non-plugin command, don't permit it to be
267
if cmd is None and check_missing:
268
for hook in Command.hooks['get_missing_command']:
275
# Allow plugins to extend commands
276
for hook in Command.hooks['extend_command']:
281
def _try_plugin_provider(cmd_name):
282
"""Probe for a plugin provider having cmd_name."""
284
plugin_metadata, provider = probe_for_provider(cmd_name)
285
raise errors.CommandAvailableInPlugin(cmd_name,
286
plugin_metadata, provider)
287
except errors.NoPluginAvailable:
291
def probe_for_provider(cmd_name):
292
"""Look for a provider for cmd_name.
294
:param cmd_name: The command name.
295
:return: plugin_metadata, provider for getting cmd_name.
296
:raises NoPluginAvailable: When no provider can supply the plugin.
298
# look for providers that provide this command but aren't installed
299
for provider in command_providers_registry:
301
return provider.plugin_for_command(cmd_name), provider
302
except errors.NoPluginAvailable:
304
raise errors.NoPluginAvailable(cmd_name)
307
def _get_bzr_command(cmd_or_None, cmd_name):
308
"""Get a command from bzr's core."""
310
cmd_class = builtin_command_registry.get(cmd_name)
147
# first look up this command under the specified name
148
cmds = _get_cmd_dict(plugins_override=plugins_override)
150
return cmds[cmd_name]()
318
def _get_external_command(cmd_or_None, cmd_name):
319
"""Lookup a command that is a shell script."""
320
# Only do external command lookups when no command is found so far.
321
if cmd_or_None is not None:
323
from bzrlib.externalcommand import ExternalCommand
154
# look for any command which claims this as an alias
155
for real_cmd_name, cmd_class in cmds.iteritems():
156
if cmd_name in cmd_class.aliases:
324
159
cmd_obj = ExternalCommand.find_command(cmd_name)
329
def _get_plugin_command(cmd_or_None, cmd_name):
330
"""Get a command from bzr's plugins."""
332
return plugin_cmds.get(cmd_name)()
335
for key in plugin_cmds.keys():
336
info = plugin_cmds.get_info(key)
337
if cmd_name in info.aliases:
338
return plugin_cmds.get(key)()
163
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
342
166
class Command(object):
404
221
encoding_type = 'strict'
408
225
def __init__(self):
409
226
"""Construct an instance of this command."""
410
227
if self.__doc__ == Command.__doc__:
411
228
warn("No help message set for %r" % self)
412
# List of standard options directly supported
413
self.supported_std_options = []
416
def add_cleanup(self, cleanup_func, *args, **kwargs):
417
"""Register a function to call after self.run returns or raises.
419
Functions will be called in LIFO order.
421
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
423
def cleanup_now(self):
424
"""Execute and empty pending cleanup functions immediately.
426
After cleanup_now all registered cleanups are forgotten. add_cleanup
427
may be called again after cleanup_now; these cleanups will be called
428
after self.run returns or raises (or when cleanup_now is next called).
430
This is useful for releasing expensive or contentious resources (such
431
as write locks) before doing further work that does not require those
432
resources (such as writing results to self.outf). Note though, that
433
as it releases all resources, this may release locks that the command
434
wants to hold, so use should be done with care.
436
self._operation.cleanup_now()
438
@deprecated_method(deprecated_in((2, 1, 0)))
439
def _maybe_expand_globs(self, file_list):
440
"""Glob expand file_list if the platform does not do that itself.
442
Not used anymore, now that the bzr command-line parser globs on
445
:return: A possibly empty list of unicode paths.
447
Introduced in bzrlib 0.18.
452
"""Return single-line grammar for this command.
454
Only describes arguments, not options.
456
s = 'bzr ' + self.name() + ' '
457
for aname in self.takes_args:
458
aname = aname.upper()
459
if aname[-1] in ['$', '+']:
460
aname = aname[:-1] + '...'
461
elif aname[-1] == '?':
462
aname = '[' + aname[:-1] + ']'
463
elif aname[-1] == '*':
464
aname = '[' + aname[:-1] + '...]'
466
s = s[:-1] # remove last space
469
def get_help_text(self, additional_see_also=None, plain=True,
470
see_also_as_links=False, verbose=True):
471
"""Return a text string with help for this command.
473
:param additional_see_also: Additional help topics to be
475
:param plain: if False, raw help (reStructuredText) is
476
returned instead of plain text.
477
:param see_also_as_links: if True, convert items in 'See also'
478
list to internal links (used by bzr_man rstx generator)
479
:param verbose: if True, display the full help, otherwise
480
leave out the descriptive sections and just display
481
usage help (e.g. Purpose, Usage, Options) with a
482
message explaining how to obtain full help.
486
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
488
# Extract the summary (purpose) and sections out from the text
489
purpose,sections,order = self._get_help_parts(doc)
491
# If a custom usage section was provided, use it
492
if sections.has_key('Usage'):
493
usage = sections.pop('Usage')
495
usage = self._usage()
497
# The header is the purpose and usage
499
result += ':Purpose: %s\n' % purpose
500
if usage.find('\n') >= 0:
501
result += ':Usage:\n%s\n' % usage
503
result += ':Usage: %s\n' % usage
508
# XXX: optparse implicitly rewraps the help, and not always perfectly,
509
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
511
options = option.get_optparser(self.options()).format_option_help()
512
# XXX: According to the spec, ReST option lists actually don't support
513
# options like --1.9 so that causes syntax errors (in Sphinx at least).
514
# As that pattern always appears in the commands that break, we trap
515
# on that and then format that block of 'format' options as a literal
517
if not plain and options.find(' --1.9 ') != -1:
518
options = options.replace(' format:\n', ' format::\n\n', 1)
519
if options.startswith('Options:'):
520
result += ':' + options
521
elif options.startswith('options:'):
522
# Python 2.4 version of optparse
523
result += ':Options:' + options[len('options:'):]
529
# Add the description, indenting it 2 spaces
530
# to match the indentation of the options
531
if sections.has_key(None):
532
text = sections.pop(None)
533
text = '\n '.join(text.splitlines())
534
result += ':%s:\n %s\n\n' % ('Description',text)
536
# Add the custom sections (e.g. Examples). Note that there's no need
537
# to indent these as they must be indented already in the source.
540
if sections.has_key(label):
541
result += ':%s:\n%s\n' % (label,sections[label])
544
result += ("See bzr help %s for more details and examples.\n\n"
547
# Add the aliases, source (plug-in) and see also links, if any
549
result += ':Aliases: '
550
result += ', '.join(self.aliases) + '\n'
551
plugin_name = self.plugin_name()
552
if plugin_name is not None:
553
result += ':From: plugin "%s"\n' % plugin_name
554
see_also = self.get_see_also(additional_see_also)
556
if not plain and see_also_as_links:
558
for item in see_also:
560
# topics doesn't have an independent section
561
# so don't create a real link
562
see_also_links.append(item)
564
# Use a Sphinx link for this entry
565
link_text = ":doc:`%s <%s-help>`" % (item, item)
566
see_also_links.append(link_text)
567
see_also = see_also_links
568
result += ':See also: '
569
result += ', '.join(see_also) + '\n'
571
# If this will be rendered as plain text, convert it
573
import bzrlib.help_topics
574
result = bzrlib.help_topics.help_as_plain_text(result)
578
def _get_help_parts(text):
579
"""Split help text into a summary and named sections.
581
:return: (summary,sections,order) where summary is the top line and
582
sections is a dictionary of the rest indexed by section name.
583
order is the order the section appear in the text.
584
A section starts with a heading line of the form ":xxx:".
585
Indented text on following lines is the section value.
586
All text found outside a named section is assigned to the
587
default section which is given the key of None.
589
def save_section(sections, order, label, section):
591
if sections.has_key(label):
592
sections[label] += '\n' + section
595
sections[label] = section
597
lines = text.rstrip().splitlines()
598
summary = lines.pop(0)
601
label,section = None,''
603
if line.startswith(':') and line.endswith(':') and len(line) > 2:
604
save_section(sections, order, label, section)
605
label,section = line[1:-1],''
606
elif (label is not None) and len(line) > 1 and not line[0].isspace():
607
save_section(sections, order, label, section)
608
label,section = None,line
611
section += '\n' + line
614
save_section(sections, order, label, section)
615
return summary, sections, order
617
def get_help_topic(self):
618
"""Return the commands help topic - its name."""
621
def get_see_also(self, additional_terms=None):
622
"""Return a list of help topics that are related to this command.
624
The list is derived from the content of the _see_also attribute. Any
625
duplicates are removed and the result is in lexical order.
626
:param additional_terms: Additional help topics to cross-reference.
627
:return: A list of help topics.
629
see_also = set(getattr(self, '_see_also', []))
631
see_also.update(additional_terms)
632
return sorted(see_also)
634
230
def options(self):
635
231
"""Return dict of valid options for this command.
637
233
Maps from long option name to option object."""
638
r = Option.STD_OPTIONS.copy()
235
r['help'] = option.Option.OPTIONS['help']
640
236
for o in self.takes_options:
641
237
if isinstance(o, basestring):
642
238
o = option.Option.OPTIONS[o]
644
if o.name in std_names:
645
self.supported_std_options.append(o.name)
648
242
def _setup_outf(self):
649
243
"""Return a file linked to stdout, which has proper encoding."""
650
self.outf = ui.ui_factory.make_output_stream(
651
encoding_type=self.encoding_type)
244
assert self.encoding_type in ['strict', 'exact', 'replace']
246
# Originally I was using self.stdout, but that looks
247
# *way* too much like sys.stdout
248
if self.encoding_type == 'exact':
249
self.outf = sys.stdout
252
output_encoding = osutils.get_terminal_encoding()
254
# use 'replace' so that we don't abort if trying to write out
255
# in e.g. the default C locale.
256
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
257
# For whatever reason codecs.getwriter() does not advertise its encoding
258
# it just returns the encoding of the wrapped file, which is completely
259
# bogus. So set the attribute, so we can find the correct encoding later.
260
self.outf.encoding = output_encoding
262
@deprecated_method(zero_eight)
263
def run_argv(self, argv):
264
"""Parse command line and run.
266
See run_argv_aliases for the 0.8 and beyond api.
268
return self.run_argv_aliases(argv)
653
270
def run_argv_aliases(self, argv, alias_argv=None):
654
271
"""Parse the command line and run with extra aliases in alias_argv."""
273
warn("Passing None for [] is deprecated from bzrlib 0.10",
274
DeprecationWarning, stacklevel=2)
655
276
args, opts = parse_args(self, argv, alias_argv)
657
# Process the standard options
658
277
if 'help' in opts: # e.g. bzr add --help
659
sys.stdout.write(self.get_help_text())
661
if 'usage' in opts: # e.g. bzr add --usage
662
sys.stdout.write(self.get_help_text(verbose=False))
664
trace.set_verbosity_level(option._verbosity_level)
665
if 'verbose' in self.supported_std_options:
666
opts['verbose'] = trace.is_verbose()
667
elif opts.has_key('verbose'):
669
if 'quiet' in self.supported_std_options:
670
opts['quiet'] = trace.is_quiet()
671
elif opts.has_key('quiet'):
278
from bzrlib.help import help_on_command
279
help_on_command(self.name())
674
281
# mix arguments and options into one dictionary
675
282
cmdargs = _match_argform(self.name(), self.takes_args, args)
756
class CommandHooks(Hooks):
757
"""Hooks related to Command object creation/enumeration."""
760
"""Create the default hooks.
762
These are all empty initially, because by default nothing should get
766
self.create_hook(HookPoint('extend_command',
767
"Called after creating a command object to allow modifications "
768
"such as adding or removing options, docs etc. Called with the "
769
"new bzrlib.commands.Command object.", (1, 13), None))
770
self.create_hook(HookPoint('get_command',
771
"Called when creating a single command. Called with "
772
"(cmd_or_None, command_name). get_command should either return "
773
"the cmd_or_None parameter, or a replacement Command object that "
774
"should be used for the command. Note that the Command.hooks "
775
"hooks are core infrastructure. Many users will prefer to use "
776
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
778
self.create_hook(HookPoint('get_missing_command',
779
"Called when creating a single command if no command could be "
780
"found. Called with (command_name). get_missing_command should "
781
"either return None, or a Command object to be used for the "
782
"command.", (1, 17), None))
783
self.create_hook(HookPoint('list_commands',
784
"Called when enumerating commands. Called with a set of "
785
"cmd_name strings for all the commands found so far. This set "
786
" is safe to mutate - e.g. to remove a command. "
787
"list_commands should return the updated set of command names.",
790
Command.hooks = CommandHooks()
329
# Technically, this function hasn't been use in a *really* long time
330
# but we are only deprecating it now.
331
@deprecated_function(zero_eleven)
332
def parse_spec(spec):
338
>>> parse_spec("../@")
340
>>> parse_spec("../f/@35")
342
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
343
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
348
parsed = spec.split('/@')
349
assert len(parsed) == 2
354
parsed[1] = int(parsed[1])
356
pass # We can allow stuff like ./@revid:blahblahblah
360
parsed = [spec, None]
793
363
def parse_args(command, argv, alias_argv=None):
794
364
"""Parse command line.
796
366
Arguments and options are parsed at this level before being passed
797
367
down to specific command handlers. This routine knows, from a
798
368
lookup table, something about the available options, what optargs
896
449
os.remove(pfname)
899
def exception_to_return_code(the_callable, *args, **kwargs):
900
"""UI level helper for profiling and coverage.
902
This transforms exceptions into a return value of 3. As such its only
903
relevant to the UI layer, and should never be called where catching
904
exceptions may be desirable.
907
return the_callable(*args, **kwargs)
908
except (KeyboardInterrupt, Exception), e:
909
# used to handle AssertionError and KeyboardInterrupt
910
# specially here, but hopefully they're handled ok by the logger now
911
exc_info = sys.exc_info()
912
exitcode = trace.report_exception(exc_info, sys.stderr)
913
if os.environ.get('BZR_PDB'):
914
print '**** entering debugger'
917
if sys.version_info[:2] < (2, 6):
919
# pdb.post_mortem(tb)
920
# but because pdb.post_mortem gives bad results for tracebacks
921
# from inside generators, we do it manually.
922
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
924
# Setup pdb on the traceback
927
p.setup(tb.tb_frame, tb)
928
# Point the debugger at the deepest frame of the stack
929
p.curindex = len(p.stack) - 1
930
p.curframe = p.stack[p.curindex][0]
931
# Start the pdb prompt.
932
p.print_stack_entry(p.stack[p.curindex])
940
452
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
941
453
from bzrlib.lsprof import profile
942
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
455
ret, stats = profile(the_callable, *args, **kwargs)
944
457
if filename is None:
948
trace.note('Profile data written to "%s".', filename)
461
cPickle.dump(stats, open(filename, 'w'), 2)
462
print 'Profile data written to %r.' % filename
952
@deprecated_function(deprecated_in((2, 2, 0)))
953
def shlex_split_unicode(unsplit):
954
return cmdline.split(unsplit)
957
def get_alias(cmd, config=None):
958
"""Return an expanded alias, or None if no alias exists.
961
Command to be checked for an alias.
963
Used to specify an alternative config to use,
964
which is especially useful for testing.
965
If it is unspecified, the global config will be used.
969
config = bzrlib.config.GlobalConfig()
970
alias = config.get_alias(cmd)
467
"""Return an expanded alias, or None if no alias exists"""
469
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
972
return cmdline.split(alias)
471
return alias.split(' ')
976
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
977
476
"""Execute a command.
979
:param argv: The command-line arguments, without the program name from
980
argv[0] These should already be decoded. All library/test code calling
981
run_bzr should be passing valid strings (don't need decoding).
982
:param load_plugins: What function to call when triggering plugin loading.
983
This function should take no arguments and cause all plugins to be
985
:param disable_plugins: What function to call when disabling plugin
986
loading. This function should take no arguments and cause all plugin
987
loading to be prohibited (so that code paths in your application that
988
know about some plugins possibly being present will fail to import
989
those plugins even if they are installed.)
990
:return: Returns a command exit code or raises an exception.
478
This is similar to main(), but without all the trappings for
479
logging and error handling.
482
The command-line arguments, without the program name from argv[0]
483
These should already be decoded. All library/test code calling
484
run_bzr should be passing valid strings (don't need decoding).
486
Returns a command status or raises an exception.
992
488
Special master options: these must come before the command because
993
489
they control how the command is interpreted.
1139
611
return ignore_pipe
1142
def install_bzr_command_hooks():
1143
"""Install the hooks to supply bzr's own commands."""
1144
if _list_bzr_commands in Command.hooks["list_commands"]:
1146
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1148
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1150
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1151
"bzr plugin commands")
1152
Command.hooks.install_named_hook("get_command", _get_external_command,
1153
"bzr external command lookup")
1154
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1155
"bzr plugin-provider-db check")
1159
def _specified_or_unicode_argv(argv):
1160
# For internal or testing use, argv can be passed. Otherwise, get it from
1161
# the process arguments in a unicode-safe way.
1163
return osutils.get_unicode_argv()
1167
# ensure all arguments are unicode strings
1169
if isinstance(a, unicode):
1172
new_argv.append(a.decode('ascii'))
1173
except UnicodeDecodeError:
1174
raise errors.BzrError("argv should be list of unicode strings.")
1178
def main(argv=None):
1179
"""Main entry point of command-line interface.
1181
Typically `bzrlib.initialize` should be called first.
1183
:param argv: list of unicode command-line arguments similar to sys.argv.
1184
argv[0] is script name usually, it will be ignored.
1185
Don't pass here sys.argv because this list contains plain strings
1186
and not unicode; pass None instead.
1188
:return: exit code of bzr command.
1190
argv = _specified_or_unicode_argv(argv)
1191
_register_builtin_commands()
616
from bzrlib.ui.text import TextUIFactory
617
bzrlib.ui.ui_factory = TextUIFactory()
618
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
1192
619
ret = run_bzr_catch_errors(argv)
1193
bzrlib.ui.ui_factory.log_transport_activity(
1194
display=('bytes' in debug.debug_flags))
1195
620
trace.mutter("return code %d", ret)
1199
624
def run_bzr_catch_errors(argv):
1200
"""Run a bzr command with parameters as described by argv.
1202
This function assumed that that UI layer is setup, that symbol deprecations
1203
are already applied, and that unicode decoding has already been performed on argv.
1205
# done here so that they're covered for every test run
1206
install_bzr_command_hooks()
1207
return exception_to_return_code(run_bzr, argv)
1210
def run_bzr_catch_user_errors(argv):
1211
"""Run bzr and report user errors, but let internal errors propagate.
1213
This is used for the test suite, and might be useful for other programs
1214
that want to wrap the commandline interface.
1216
# done here so that they're covered for every test run
1217
install_bzr_command_hooks()
1219
626
return run_bzr(argv)
1220
except Exception, e:
1221
if (isinstance(e, (OSError, IOError))
1222
or not getattr(e, 'internal_error', True)):
1223
trace.report_exception(sys.exc_info(), sys.stderr)
1229
class HelpCommandIndex(object):
1230
"""A index for bzr help that returns commands."""
1233
self.prefix = 'commands/'
1235
def get_topics(self, topic):
1236
"""Search for topic amongst commands.
1238
:param topic: A topic to search for.
1239
:return: A list which is either empty or contains a single
1242
if topic and topic.startswith(self.prefix):
1243
topic = topic[len(self.prefix):]
1245
cmd = _get_cmd_object(topic, check_missing=False)
1252
class Provider(object):
1253
'''Generic class to be overriden by plugins'''
1255
def plugin_for_command(self, cmd_name):
1256
'''Takes a command and returns the information for that plugin
1258
:return: A dictionary with all the available information
1259
for the requested plugin
1261
raise NotImplementedError
1264
class ProvidersRegistry(registry.Registry):
1265
'''This registry exists to allow other providers to exist'''
1268
for key, provider in self.iteritems():
1271
command_providers_registry = ProvidersRegistry()
627
# do this here inside the exception wrappers to catch EPIPE
629
except (KeyboardInterrupt, Exception), e:
630
# used to handle AssertionError and KeyboardInterrupt
631
# specially here, but hopefully they're handled ok by the logger now
632
trace.report_exception(sys.exc_info(), sys.stderr)
633
if os.environ.get('BZR_PDB'):
634
print '**** entering debugger'
636
pdb.post_mortem(sys.exc_traceback)
639
if __name__ == '__main__':
640
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
