26
23
# TODO: Specific "examples" property on commands for consistent formatting.
28
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
29
# the profile output behind so it can be interactively examined?
34
28
from bzrlib.lazy_import import lazy_import
35
29
lazy_import(globals(), """
38
from warnings import warn
41
34
from bzrlib import (
47
from bzrlib.hooks import Hooks
48
from bzrlib.i18n import gettext
49
# Compatibility - Option used to be in commands.
50
from bzrlib.option import Option
51
from bzrlib.plugin import disable_plugins, load_plugins
52
from bzrlib import registry
50
53
from bzrlib.symbol_versioning import (
51
54
deprecated_function,
57
from bzrlib.option import Option
60
class CommandInfo(object):
61
"""Information about a command."""
63
def __init__(self, aliases):
64
"""The list of aliases for the command."""
65
self.aliases = aliases
68
def from_command(klass, command):
69
"""Factory to construct a CommandInfo from a command."""
70
return klass(command.aliases)
73
class CommandRegistry(registry.Registry):
74
"""Special registry mapping command names to command classes.
76
:ivar overridden_registry: Look in this registry for commands being
77
overridden by this registry. This can be used to tell plugin commands
78
about the builtin they're decorating.
82
registry.Registry.__init__(self)
83
self.overridden_registry = None
84
# map from aliases to the real command that implements the name
87
def get(self, command_name):
88
real_name = self._alias_dict.get(command_name, command_name)
89
return registry.Registry.get(self, real_name)
92
def _get_name(command_name):
93
if command_name.startswith("cmd_"):
94
return _unsquish_command_name(command_name)
98
def register(self, cmd, decorate=False):
99
"""Utility function to help register a command
101
:param cmd: Command subclass to register
102
:param decorate: If true, allow overriding an existing command
103
of the same name; the old command is returned by this function.
104
Otherwise it is an error to try to override an existing command.
107
k_unsquished = self._get_name(k)
109
previous = self.get(k_unsquished)
112
if self.overridden_registry:
114
previous = self.overridden_registry.get(k_unsquished)
117
info = CommandInfo.from_command(cmd)
119
registry.Registry.register(self, k_unsquished, cmd,
120
override_existing=decorate, info=info)
122
trace.warning('Two plugins defined the same command: %r' % k)
123
trace.warning('Not loading the one in %r' %
124
sys.modules[cmd.__module__])
125
trace.warning('Previously this command was registered from %r' %
126
sys.modules[previous.__module__])
127
for a in cmd.aliases:
128
self._alias_dict[a] = k_unsquished
131
def register_lazy(self, command_name, aliases, module_name):
132
"""Register a command without loading its module.
134
:param command_name: The primary name of the command.
135
:param aliases: A list of aliases for the command.
136
:module_name: The module that the command lives in.
138
key = self._get_name(command_name)
139
registry.Registry.register_lazy(self, key, module_name, command_name,
140
info=CommandInfo(aliases))
142
self._alias_dict[a] = key
145
plugin_cmds = CommandRegistry()
146
builtin_command_registry = CommandRegistry()
147
plugin_cmds.overridden_registry = builtin_command_registry
63
150
def register_command(cmd, decorate=False):
64
"""Utility function to help register a command
151
"""Register a plugin command.
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.
153
Should generally be avoided in favor of lazy registration.
71
155
global plugin_cmds
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__])
156
return plugin_cmds.register(cmd, decorate)
91
159
def _squish_command_name(cmd):
95
163
def _unsquish_command_name(cmd):
96
assert cmd.startswith("cmd_")
97
164
return cmd[4:].replace('_','-')
100
def _builtin_commands():
167
def _register_builtin_commands():
168
if builtin_command_registry.keys():
101
171
import bzrlib.builtins
172
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
173
builtin_command_registry.register(cmd_class)
174
bzrlib.builtins._register_lazy_builtins()
177
def _scan_module_for_commands(module):
103
builtins = bzrlib.builtins.__dict__
104
for name in builtins:
179
for name, obj in module.__dict__.iteritems():
105
180
if name.startswith("cmd_"):
106
181
real_name = _unsquish_command_name(name)
107
r[real_name] = builtins[name]
186
def _list_bzr_commands(names):
187
"""Find commands from bzr's core and plugins.
189
This is not the public interface, just the default hook called by all_command_names.
191
# to eliminate duplicates
192
names.update(builtin_command_names())
193
names.update(plugin_command_names())
197
def all_command_names():
198
"""Return a set of all command names."""
200
for hook in Command.hooks['list_commands']:
203
raise AssertionError(
204
'hook %s returned None' % Command.hooks.get_hook_name(hook))
111
208
def builtin_command_names():
112
"""Return list of builtin command names."""
113
return _builtin_commands().keys()
209
"""Return list of builtin command names.
211
Use of all_command_names() is encouraged rather than builtin_command_names
212
and/or plugin_command_names.
214
_register_builtin_commands()
215
return builtin_command_registry.keys()
116
218
def plugin_command_names():
219
"""Returns command names from commands registered by plugins."""
117
220
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():
134
223
def get_cmd_object(cmd_name, plugins_override=True):
135
"""Return the canonical name and command class for a command.
224
"""Return the command object for a command.
138
227
If true, plugin commands can override builtins.
230
return _get_cmd_object(cmd_name, plugins_override)
232
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
235
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
236
"""Get a command object.
238
:param cmd_name: The name of the command.
239
:param plugins_override: Allow plugins to override builtins.
240
:param check_missing: Look up commands not found in the regular index via
241
the get_missing_command hook.
242
:return: A Command object instance
243
:raises KeyError: If no command is found.
245
# We want only 'ascii' command names, but the user may have typed
246
# in a Unicode name. In that case, they should just get a
247
# 'command not found' error later.
248
# In the future, we may actually support Unicode command names.
251
for hook in Command.hooks['get_command']:
252
cmd = hook(cmd, cmd_name)
253
if cmd is not None and not plugins_override and not cmd.plugin_name():
254
# We've found a non-plugin command, don't permit it to be
257
if cmd is None and check_missing:
258
for hook in Command.hooks['get_missing_command']:
265
# Allow plugins to extend commands
266
for hook in Command.hooks['extend_command']:
268
if getattr(cmd, 'invoked_as', None) is None:
269
cmd.invoked_as = cmd_name
273
def _try_plugin_provider(cmd_name):
274
"""Probe for a plugin provider having cmd_name."""
276
plugin_metadata, provider = probe_for_provider(cmd_name)
277
raise errors.CommandAvailableInPlugin(cmd_name,
278
plugin_metadata, provider)
279
except errors.NoPluginAvailable:
283
def probe_for_provider(cmd_name):
284
"""Look for a provider for cmd_name.
286
:param cmd_name: The command name.
287
:return: plugin_metadata, provider for getting cmd_name.
288
:raises NoPluginAvailable: When no provider can supply the plugin.
290
# look for providers that provide this command but aren't installed
291
for provider in command_providers_registry:
293
return provider.plugin_for_command(cmd_name), provider
294
except errors.NoPluginAvailable:
296
raise errors.NoPluginAvailable(cmd_name)
299
def _get_bzr_command(cmd_or_None, cmd_name):
300
"""Get a command from bzr's core."""
302
cmd_class = builtin_command_registry.get(cmd_name)
310
def _get_external_command(cmd_or_None, cmd_name):
311
"""Lookup a command that is a shell script."""
312
# Only do external command lookups when no command is found so far.
313
if cmd_or_None is not None:
140
315
from bzrlib.externalcommand import ExternalCommand
142
# We want only 'ascii' command names, but the user may have typed
143
# in a Unicode name. In that case, they should just get a
144
# 'command not found' error later.
145
# In the future, we may actually support Unicode command names.
147
# first look up this command under the specified name
148
cmds = _get_cmd_dict(plugins_override=plugins_override)
150
return cmds[cmd_name]()
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:
159
316
cmd_obj = ExternalCommand.find_command(cmd_name)
163
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
321
def _get_plugin_command(cmd_or_None, cmd_name):
322
"""Get a command from bzr's plugins."""
324
return plugin_cmds.get(cmd_name)()
327
for key in plugin_cmds.keys():
328
info = plugin_cmds.get_info(key)
329
if cmd_name in info.aliases:
330
return plugin_cmds.get(key)()
166
334
class Command(object):
181
349
summary, then a complete description of the command. A grammar
182
350
description will be inserted.
185
Other accepted names for this command.
188
List of argument forms, marked with whether they are optional,
193
['to_location', 'from_branch?', 'file*']
195
'to_location' is required
196
'from_branch' is optional
197
'file' can be specified 0 or more times
200
List of options that may be given for this command. These can
201
be either strings, referring to globally-defined options,
202
or option objects. Retrieve through options().
205
If true, this command isn't advertised. This is typically
352
:cvar aliases: Other accepted names for this command.
354
:cvar takes_args: List of argument forms, marked with whether they are
355
optional, repeated, etc. Examples::
357
['to_location', 'from_branch?', 'file*']
359
* 'to_location' is required
360
* 'from_branch' is optional
361
* 'file' can be specified 0 or more times
363
:cvar takes_options: List of options that may be given for this command.
364
These can be either strings, referring to globally-defined options, or
365
option objects. Retrieve through options().
367
:cvar hidden: If true, this command isn't advertised. This is typically
206
368
for commands intended for expert users.
209
Command objects will get a 'outf' attribute, which has been
210
setup to properly handle encoding of unicode strings.
211
encoding_type determines what will happen when characters cannot
213
strict - abort if we cannot decode
214
replace - put in a bogus character (typically '?')
215
exact - do not encode sys.stdout
217
NOTE: by default on Windows, sys.stdout is opened as a text
218
stream, therefore LF line-endings are converted to CRLF.
219
When a command uses encoding_type = 'exact', then
220
sys.stdout is forced to be a binary stream, and line-endings
370
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
371
been setup to properly handle encoding of unicode strings.
372
encoding_type determines what will happen when characters cannot be
375
* strict - abort if we cannot decode
376
* replace - put in a bogus character (typically '?')
377
* exact - do not encode sys.stdout
379
NOTE: by default on Windows, sys.stdout is opened as a text stream,
380
therefore LF line-endings are converted to CRLF. When a command uses
381
encoding_type = 'exact', then sys.stdout is forced to be a binary
382
stream, and line-endings will not mangled.
385
A string indicating the real name under which this command was
386
invoked, before expansion of aliases.
387
(This may be None if the command was constructed and run in-process.)
389
:cvar hooks: An instance of CommandHooks.
391
:cvar __doc__: The help shown by 'bzr help command' for this command.
392
This is set by assigning explicitly to __doc__ so that -OO can
396
__doc__ = "My help goes here"
226
400
takes_options = []
227
401
encoding_type = 'strict'
231
407
def __init__(self):
232
408
"""Construct an instance of this command."""
233
if self.__doc__ == Command.__doc__:
234
warn("No help message set for %r" % self)
409
# List of standard options directly supported
410
self.supported_std_options = []
413
def add_cleanup(self, cleanup_func, *args, **kwargs):
414
"""Register a function to call after self.run returns or raises.
416
Functions will be called in LIFO order.
418
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
420
def cleanup_now(self):
421
"""Execute and empty pending cleanup functions immediately.
423
After cleanup_now all registered cleanups are forgotten. add_cleanup
424
may be called again after cleanup_now; these cleanups will be called
425
after self.run returns or raises (or when cleanup_now is next called).
427
This is useful for releasing expensive or contentious resources (such
428
as write locks) before doing further work that does not require those
429
resources (such as writing results to self.outf). Note though, that
430
as it releases all resources, this may release locks that the command
431
wants to hold, so use should be done with care.
433
self._operation.cleanup_now()
436
"""Return single-line grammar for this command.
438
Only describes arguments, not options.
440
s = 'bzr ' + self.name() + ' '
441
for aname in self.takes_args:
442
aname = aname.upper()
443
if aname[-1] in ['$', '+']:
444
aname = aname[:-1] + '...'
445
elif aname[-1] == '?':
446
aname = '[' + aname[:-1] + ']'
447
elif aname[-1] == '*':
448
aname = '[' + aname[:-1] + '...]'
450
s = s[:-1] # remove last space
453
def get_help_text(self, additional_see_also=None, plain=True,
454
see_also_as_links=False, verbose=True):
455
"""Return a text string with help for this command.
457
:param additional_see_also: Additional help topics to be
459
:param plain: if False, raw help (reStructuredText) is
460
returned instead of plain text.
461
:param see_also_as_links: if True, convert items in 'See also'
462
list to internal links (used by bzr_man rstx generator)
463
:param verbose: if True, display the full help, otherwise
464
leave out the descriptive sections and just display
465
usage help (e.g. Purpose, Usage, Options) with a
466
message explaining how to obtain full help.
468
if self.l10n and not i18n.installed():
469
i18n.install() # Install i18n only for get_help_text for now.
472
# Note: If self.gettext() translates ':Usage:\n', the section will
473
# be shown after "Description" section and we don't want to
474
# translate the usage string.
475
# Though, bzr export-pot don't exports :Usage: section and it must
477
doc = self.gettext(doc)
479
doc = gettext("No help for this command.")
481
# Extract the summary (purpose) and sections out from the text
482
purpose,sections,order = self._get_help_parts(doc)
484
# If a custom usage section was provided, use it
485
if sections.has_key('Usage'):
486
usage = sections.pop('Usage')
488
usage = self._usage()
490
# The header is the purpose and usage
492
result += gettext(':Purpose: %s\n') % (purpose,)
493
if usage.find('\n') >= 0:
494
result += gettext(':Usage:\n%s\n') % (usage,)
496
result += gettext(':Usage: %s\n') % (usage,)
501
# XXX: optparse implicitly rewraps the help, and not always perfectly,
502
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
504
parser = option.get_optparser(self.options())
505
options = parser.format_option_help()
506
# FIXME: According to the spec, ReST option lists actually don't
507
# support options like --1.14 so that causes syntax errors (in Sphinx
508
# at least). As that pattern always appears in the commands that
509
# break, we trap on that and then format that block of 'format' options
510
# as a literal block. We use the most recent format still listed so we
511
# don't have to do that too often -- vila 20110514
512
if not plain and options.find(' --1.14 ') != -1:
513
options = options.replace(' format:\n', ' format::\n\n', 1)
514
if options.startswith('Options:'):
515
result += gettext(':Options:%s') % (options[len('options:'):],)
521
# Add the description, indenting it 2 spaces
522
# to match the indentation of the options
523
if sections.has_key(None):
524
text = sections.pop(None)
525
text = '\n '.join(text.splitlines())
526
result += gettext(':Description:\n %s\n\n') % (text,)
528
# Add the custom sections (e.g. Examples). Note that there's no need
529
# to indent these as they must be indented already in the source.
532
if label in sections:
533
result += ':%s:\n%s\n' % (label, sections[label])
536
result += (gettext("See bzr help %s for more details and examples.\n\n")
539
# Add the aliases, source (plug-in) and see also links, if any
541
result += gettext(':Aliases: ')
542
result += ', '.join(self.aliases) + '\n'
543
plugin_name = self.plugin_name()
544
if plugin_name is not None:
545
result += gettext(':From: plugin "%s"\n') % plugin_name
546
see_also = self.get_see_also(additional_see_also)
548
if not plain and see_also_as_links:
550
for item in see_also:
552
# topics doesn't have an independent section
553
# so don't create a real link
554
see_also_links.append(item)
556
# Use a Sphinx link for this entry
557
link_text = gettext(":doc:`%s <%s-help>`") % (item, item)
558
see_also_links.append(link_text)
559
see_also = see_also_links
560
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
562
# If this will be rendered as plain text, convert it
564
import bzrlib.help_topics
565
result = bzrlib.help_topics.help_as_plain_text(result)
569
def _get_help_parts(text):
570
"""Split help text into a summary and named sections.
572
:return: (summary,sections,order) where summary is the top line and
573
sections is a dictionary of the rest indexed by section name.
574
order is the order the section appear in the text.
575
A section starts with a heading line of the form ":xxx:".
576
Indented text on following lines is the section value.
577
All text found outside a named section is assigned to the
578
default section which is given the key of None.
580
def save_section(sections, order, label, section):
582
if sections.has_key(label):
583
sections[label] += '\n' + section
586
sections[label] = section
588
lines = text.rstrip().splitlines()
589
summary = lines.pop(0)
592
label,section = None,''
594
if line.startswith(':') and line.endswith(':') and len(line) > 2:
595
save_section(sections, order, label, section)
596
label,section = line[1:-1],''
597
elif (label is not None) and len(line) > 1 and not line[0].isspace():
598
save_section(sections, order, label, section)
599
label,section = None,line
602
section += '\n' + line
605
save_section(sections, order, label, section)
606
return summary, sections, order
608
def get_help_topic(self):
609
"""Return the commands help topic - its name."""
612
def get_see_also(self, additional_terms=None):
613
"""Return a list of help topics that are related to this command.
615
The list is derived from the content of the _see_also attribute. Any
616
duplicates are removed and the result is in lexical order.
617
:param additional_terms: Additional help topics to cross-reference.
618
:return: A list of help topics.
620
see_also = set(getattr(self, '_see_also', []))
622
see_also.update(additional_terms)
623
return sorted(see_also)
236
625
def options(self):
237
626
"""Return dict of valid options for this command.
239
628
Maps from long option name to option object."""
241
r['help'] = option.Option.OPTIONS['help']
629
r = Option.STD_OPTIONS.copy()
242
631
for o in self.takes_options:
243
632
if isinstance(o, basestring):
244
633
o = option.Option.OPTIONS[o]
635
if o.name in std_names:
636
self.supported_std_options.append(o.name)
248
639
def _setup_outf(self):
249
640
"""Return a file linked to stdout, which has proper encoding."""
250
assert self.encoding_type in ['strict', 'exact', 'replace']
252
# Originally I was using self.stdout, but that looks
253
# *way* too much like sys.stdout
254
if self.encoding_type == 'exact':
255
# force sys.stdout to be binary stream on win32
256
if sys.platform == 'win32':
257
fileno = getattr(sys.stdout, 'fileno', None)
260
msvcrt.setmode(fileno(), os.O_BINARY)
261
self.outf = sys.stdout
264
output_encoding = osutils.get_terminal_encoding()
266
# use 'replace' so that we don't abort if trying to write out
267
# in e.g. the default C locale.
268
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
269
# For whatever reason codecs.getwriter() does not advertise its encoding
270
# it just returns the encoding of the wrapped file, which is completely
271
# bogus. So set the attribute, so we can find the correct encoding later.
272
self.outf.encoding = output_encoding
274
@deprecated_method(zero_eight)
275
def run_argv(self, argv):
276
"""Parse command line and run.
278
See run_argv_aliases for the 0.8 and beyond api.
280
return self.run_argv_aliases(argv)
641
self.outf = ui.ui_factory.make_output_stream(
642
encoding_type=self.encoding_type)
282
644
def run_argv_aliases(self, argv, alias_argv=None):
283
645
"""Parse the command line and run with extra aliases in alias_argv."""
285
warn("Passing None for [] is deprecated from bzrlib 0.10",
286
DeprecationWarning, stacklevel=2)
288
646
args, opts = parse_args(self, argv, alias_argv)
649
# Process the standard options
289
650
if 'help' in opts: # e.g. bzr add --help
290
from bzrlib.help import help_on_command
291
help_on_command(self.name())
651
self.outf.write(self.get_help_text())
653
if 'usage' in opts: # e.g. bzr add --usage
654
self.outf.write(self.get_help_text(verbose=False))
656
trace.set_verbosity_level(option._verbosity_level)
657
if 'verbose' in self.supported_std_options:
658
opts['verbose'] = trace.is_verbose()
659
elif opts.has_key('verbose'):
661
if 'quiet' in self.supported_std_options:
662
opts['quiet'] = trace.is_quiet()
663
elif opts.has_key('quiet'):
293
666
# mix arguments and options into one dictionary
294
667
cmdargs = _match_argform(self.name(), self.takes_args, args)
554
1049
opt_no_plugins = True
555
1050
elif a == '--no-aliases':
556
1051
opt_no_aliases = True
1052
elif a == '--no-l10n':
557
1054
elif a == '--builtin':
558
1055
opt_builtin = True
559
elif a in ('--quiet', '-q'):
1056
elif a == '--concurrency':
1057
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1059
elif a == '--coverage':
1060
opt_coverage_dir = argv[i + 1]
1062
elif a == '--profile-imports':
1063
pass # already handled in startup script Bug #588277
561
1064
elif a.startswith('-D'):
562
1065
debug.debug_flags.add(a[2:])
564
1067
argv_copy.append(a)
1070
debug.set_debug_flags_from_config()
1072
if not opt_no_plugins:
567
1077
argv = argv_copy
569
from bzrlib.builtins import cmd_help
570
cmd_help().run_argv_aliases([])
1079
get_cmd_object('help').run_argv_aliases([])
573
1082
if argv[0] == '--version':
574
from bzrlib.version import show_version
1083
get_cmd_object('version').run_argv_aliases([])
578
if not opt_no_plugins:
579
from bzrlib.plugin import load_plugins
582
from bzrlib.plugin import disable_plugins
585
1086
alias_argv = None
587
1088
if not opt_no_aliases:
588
1089
alias_argv = get_alias(argv[0])
590
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
591
1091
argv[0] = alias_argv.pop(0)
593
1093
cmd = argv.pop(0)
594
# We want only 'ascii' command names, but the user may have typed
595
# in a Unicode name. In that case, they should just get a
596
# 'command not found' error later.
598
1094
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
599
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
600
run = cmd_obj.run_argv
603
run = cmd_obj.run_argv_aliases
604
run_argv = [argv, alias_argv]
1097
run = cmd_obj.run_argv_aliases
1098
run_argv = [argv, alias_argv]
1101
# We can be called recursively (tests for example), but we don't want
1102
# the verbosity level to propagate.
1103
saved_verbosity_level = option._verbosity_level
1104
option._verbosity_level = 0
1106
if opt_coverage_dir:
1108
'--coverage ignored, because --lsprof is in use.')
608
1109
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
609
1110
elif opt_profile:
1111
if opt_coverage_dir:
1113
'--coverage ignored, because --profile is in use.')
610
1114
ret = apply_profiled(run, *run_argv)
1115
elif opt_coverage_dir:
1116
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
612
1118
ret = run(*run_argv)
615
# reset, in case we may do other commands later within the same process
616
trace.be_quiet(False)
1121
# reset, in case we may do other commands later within the same
1122
# process. Commands that want to execute sub-commands must propagate
1123
# --verbose in their own way.
1124
if 'memory' in debug.debug_flags:
1125
trace.debug_memory('Process status after command:', short=False)
1126
option._verbosity_level = saved_verbosity_level
618
1129
def display_command(func):
619
1130
"""Decorator that suppresses pipe/interrupt errors."""
635
1146
return ignore_pipe
640
from bzrlib.ui.text import TextUIFactory
641
bzrlib.ui.ui_factory = TextUIFactory()
642
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
1149
def install_bzr_command_hooks():
1150
"""Install the hooks to supply bzr's own commands."""
1151
if _list_bzr_commands in Command.hooks["list_commands"]:
1153
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1155
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1157
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1158
"bzr plugin commands")
1159
Command.hooks.install_named_hook("get_command", _get_external_command,
1160
"bzr external command lookup")
1161
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1162
"bzr plugin-provider-db check")
1166
def _specified_or_unicode_argv(argv):
1167
# For internal or testing use, argv can be passed. Otherwise, get it from
1168
# the process arguments in a unicode-safe way.
1170
return osutils.get_unicode_argv()
1174
# ensure all arguments are unicode strings
1176
if isinstance(a, unicode):
1179
new_argv.append(a.decode('ascii'))
1180
except UnicodeDecodeError:
1181
raise errors.BzrError("argv should be list of unicode strings.")
1185
def main(argv=None):
1186
"""Main entry point of command-line interface.
1188
Typically `bzrlib.initialize` should be called first.
1190
:param argv: list of unicode command-line arguments similar to sys.argv.
1191
argv[0] is script name usually, it will be ignored.
1192
Don't pass here sys.argv because this list contains plain strings
1193
and not unicode; pass None instead.
1195
:return: exit code of bzr command.
1197
if argv is not None:
1199
_register_builtin_commands()
643
1200
ret = run_bzr_catch_errors(argv)
644
1201
trace.mutter("return code %d", ret)
648
1205
def run_bzr_catch_errors(argv):
1206
"""Run a bzr command with parameters as described by argv.
1208
This function assumed that that UI layer is setup, that symbol deprecations
1209
are already applied, and that unicode decoding has already been performed on argv.
1211
# done here so that they're covered for every test run
1212
install_bzr_command_hooks()
1213
return exception_to_return_code(run_bzr, argv)
1216
def run_bzr_catch_user_errors(argv):
1217
"""Run bzr and report user errors, but let internal errors propagate.
1219
This is used for the test suite, and might be useful for other programs
1220
that want to wrap the commandline interface.
1222
# done here so that they're covered for every test run
1223
install_bzr_command_hooks()
650
1225
return run_bzr(argv)
651
# do this here inside the exception wrappers to catch EPIPE
653
except (KeyboardInterrupt, Exception), e:
654
# used to handle AssertionError and KeyboardInterrupt
655
# specially here, but hopefully they're handled ok by the logger now
656
trace.report_exception(sys.exc_info(), sys.stderr)
657
if os.environ.get('BZR_PDB'):
658
print '**** entering debugger'
660
pdb.post_mortem(sys.exc_traceback)
663
if __name__ == '__main__':
664
sys.exit(main(sys.argv))
1226
except Exception, e:
1227
if (isinstance(e, (OSError, IOError))
1228
or not getattr(e, 'internal_error', True)):
1229
trace.report_exception(sys.exc_info(), sys.stderr)
1235
class HelpCommandIndex(object):
1236
"""A index for bzr help that returns commands."""
1239
self.prefix = 'commands/'
1241
def get_topics(self, topic):
1242
"""Search for topic amongst commands.
1244
:param topic: A topic to search for.
1245
:return: A list which is either empty or contains a single
1248
if topic and topic.startswith(self.prefix):
1249
topic = topic[len(self.prefix):]
1251
cmd = _get_cmd_object(topic, check_missing=False)
1258
class Provider(object):
1259
"""Generic class to be overriden by plugins"""
1261
def plugin_for_command(self, cmd_name):
1262
"""Takes a command and returns the information for that plugin
1264
:return: A dictionary with all the available information
1265
for the requested plugin
1267
raise NotImplementedError
1270
class ProvidersRegistry(registry.Registry):
1271
"""This registry exists to allow other providers to exist"""
1274
for key, provider in self.iteritems():
1277
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
