26
24
# 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
29
from bzrlib.lazy_import import lazy_import
35
30
lazy_import(globals(), """
38
from warnings import warn
41
35
from bzrlib import (
50
from bzrlib.symbol_versioning import (
48
from bzrlib.hooks import Hooks
49
from bzrlib.i18n import gettext
50
# Compatibility - Option used to be in commands.
57
51
from bzrlib.option import Option
52
from bzrlib.plugin import disable_plugins, load_plugins
53
from bzrlib import registry
56
class CommandInfo(object):
57
"""Information about a command."""
59
def __init__(self, aliases):
60
"""The list of aliases for the command."""
61
self.aliases = aliases
64
def from_command(klass, command):
65
"""Factory to construct a CommandInfo from a command."""
66
return klass(command.aliases)
69
class CommandRegistry(registry.Registry):
70
"""Special registry mapping command names to command classes.
72
:ivar overridden_registry: Look in this registry for commands being
73
overridden by this registry. This can be used to tell plugin commands
74
about the builtin they're decorating.
78
registry.Registry.__init__(self)
79
self.overridden_registry = None
80
# map from aliases to the real command that implements the name
83
def get(self, command_name):
84
real_name = self._alias_dict.get(command_name, command_name)
85
return registry.Registry.get(self, real_name)
88
def _get_name(command_name):
89
if command_name.startswith("cmd_"):
90
return _unsquish_command_name(command_name)
94
def register(self, cmd, decorate=False):
95
"""Utility function to help register a command
97
:param cmd: Command subclass to register
98
:param decorate: If true, allow overriding an existing command
99
of the same name; the old command is returned by this function.
100
Otherwise it is an error to try to override an existing command.
103
k_unsquished = self._get_name(k)
105
previous = self.get(k_unsquished)
108
if self.overridden_registry:
110
previous = self.overridden_registry.get(k_unsquished)
113
info = CommandInfo.from_command(cmd)
115
registry.Registry.register(self, k_unsquished, cmd,
116
override_existing=decorate, info=info)
118
trace.warning('Two plugins defined the same command: %r' % k)
119
trace.warning('Not loading the one in %r' %
120
sys.modules[cmd.__module__])
121
trace.warning('Previously this command was registered from %r' %
122
sys.modules[previous.__module__])
123
for a in cmd.aliases:
124
self._alias_dict[a] = k_unsquished
127
def register_lazy(self, command_name, aliases, module_name):
128
"""Register a command without loading its module.
130
:param command_name: The primary name of the command.
131
:param aliases: A list of aliases for the command.
132
:module_name: The module that the command lives in.
134
key = self._get_name(command_name)
135
registry.Registry.register_lazy(self, key, module_name, command_name,
136
info=CommandInfo(aliases))
138
self._alias_dict[a] = key
141
plugin_cmds = CommandRegistry()
142
builtin_command_registry = CommandRegistry()
143
plugin_cmds.overridden_registry = builtin_command_registry
63
146
def register_command(cmd, decorate=False):
64
"""Utility function to help register a command
147
"""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.
149
Should generally be avoided in favor of lazy registration.
71
151
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__])
152
return plugin_cmds.register(cmd, decorate)
91
155
def _squish_command_name(cmd):
95
159
def _unsquish_command_name(cmd):
96
assert cmd.startswith("cmd_")
97
160
return cmd[4:].replace('_','-')
100
def _builtin_commands():
163
def _register_builtin_commands():
164
if builtin_command_registry.keys():
101
167
import bzrlib.builtins
168
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
169
builtin_command_registry.register(cmd_class)
170
bzrlib.builtins._register_lazy_builtins()
173
def _scan_module_for_commands(module):
103
builtins = bzrlib.builtins.__dict__
104
for name in builtins:
175
for name, obj in module.__dict__.iteritems():
105
176
if name.startswith("cmd_"):
106
177
real_name = _unsquish_command_name(name)
107
r[real_name] = builtins[name]
182
def _list_bzr_commands(names):
183
"""Find commands from bzr's core and plugins.
185
This is not the public interface, just the default hook called by all_command_names.
187
# to eliminate duplicates
188
names.update(builtin_command_names())
189
names.update(plugin_command_names())
193
def all_command_names():
194
"""Return a set of all command names."""
196
for hook in Command.hooks['list_commands']:
199
raise AssertionError(
200
'hook %s returned None' % Command.hooks.get_hook_name(hook))
111
204
def builtin_command_names():
112
"""Return list of builtin command names."""
113
return _builtin_commands().keys()
205
"""Return list of builtin command names.
207
Use of all_command_names() is encouraged rather than builtin_command_names
208
and/or plugin_command_names.
210
_register_builtin_commands()
211
return builtin_command_registry.keys()
116
214
def plugin_command_names():
215
"""Returns command names from commands registered by plugins."""
117
216
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
219
def get_cmd_object(cmd_name, plugins_override=True):
135
"""Return the canonical name and command class for a command.
220
"""Return the command object for a command.
138
223
If true, plugin commands can override builtins.
226
return _get_cmd_object(cmd_name, plugins_override)
228
raise errors.BzrCommandError(gettext('unknown command "%s"') % cmd_name)
231
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
232
"""Get a command object.
234
:param cmd_name: The name of the command.
235
:param plugins_override: Allow plugins to override builtins.
236
:param check_missing: Look up commands not found in the regular index via
237
the get_missing_command hook.
238
:return: A Command object instance
239
:raises KeyError: If no command is found.
241
# We want only 'ascii' command names, but the user may have typed
242
# in a Unicode name. In that case, they should just get a
243
# 'command not found' error later.
244
# In the future, we may actually support Unicode command names.
247
for hook in Command.hooks['get_command']:
248
cmd = hook(cmd, cmd_name)
249
if cmd is not None and not plugins_override and not cmd.plugin_name():
250
# We've found a non-plugin command, don't permit it to be
253
if cmd is None and check_missing:
254
for hook in Command.hooks['get_missing_command']:
261
# Allow plugins to extend commands
262
for hook in Command.hooks['extend_command']:
264
if getattr(cmd, 'invoked_as', None) is None:
265
cmd.invoked_as = cmd_name
269
def _try_plugin_provider(cmd_name):
270
"""Probe for a plugin provider having cmd_name."""
272
plugin_metadata, provider = probe_for_provider(cmd_name)
273
raise errors.CommandAvailableInPlugin(cmd_name,
274
plugin_metadata, provider)
275
except errors.NoPluginAvailable:
279
def probe_for_provider(cmd_name):
280
"""Look for a provider for cmd_name.
282
:param cmd_name: The command name.
283
:return: plugin_metadata, provider for getting cmd_name.
284
:raises NoPluginAvailable: When no provider can supply the plugin.
286
# look for providers that provide this command but aren't installed
287
for provider in command_providers_registry:
289
return provider.plugin_for_command(cmd_name), provider
290
except errors.NoPluginAvailable:
292
raise errors.NoPluginAvailable(cmd_name)
295
def _get_bzr_command(cmd_or_None, cmd_name):
296
"""Get a command from bzr's core."""
298
cmd_class = builtin_command_registry.get(cmd_name)
306
def _get_external_command(cmd_or_None, cmd_name):
307
"""Lookup a command that is a shell script."""
308
# Only do external command lookups when no command is found so far.
309
if cmd_or_None is not None:
140
311
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
312
cmd_obj = ExternalCommand.find_command(cmd_name)
163
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
317
def _get_plugin_command(cmd_or_None, cmd_name):
318
"""Get a command from bzr's plugins."""
320
return plugin_cmds.get(cmd_name)()
323
for key in plugin_cmds.keys():
324
info = plugin_cmds.get_info(key)
325
if cmd_name in info.aliases:
326
return plugin_cmds.get(key)()
166
330
class Command(object):
181
345
summary, then a complete description of the command. A grammar
182
346
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
348
:cvar aliases: Other accepted names for this command.
350
:cvar takes_args: List of argument forms, marked with whether they are
351
optional, repeated, etc. Examples::
353
['to_location', 'from_branch?', 'file*']
355
* 'to_location' is required
356
* 'from_branch' is optional
357
* 'file' can be specified 0 or more times
359
:cvar takes_options: List of options that may be given for this command.
360
These can be either strings, referring to globally-defined options, or
361
option objects. Retrieve through options().
363
:cvar hidden: If true, this command isn't advertised. This is typically
206
364
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
366
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
367
been setup to properly handle encoding of unicode strings.
368
encoding_type determines what will happen when characters cannot be
371
* strict - abort if we cannot decode
372
* replace - put in a bogus character (typically '?')
373
* exact - do not encode sys.stdout
375
NOTE: by default on Windows, sys.stdout is opened as a text stream,
376
therefore LF line-endings are converted to CRLF. When a command uses
377
encoding_type = 'exact', then sys.stdout is forced to be a binary
378
stream, and line-endings will not mangled.
381
A string indicating the real name under which this command was
382
invoked, before expansion of aliases.
383
(This may be None if the command was constructed and run in-process.)
385
:cvar hooks: An instance of CommandHooks.
387
:cvar __doc__: The help shown by 'bzr help command' for this command.
388
This is set by assigning explicitly to __doc__ so that -OO can
392
__doc__ = "My help goes here"
226
396
takes_options = []
227
397
encoding_type = 'strict'
231
403
def __init__(self):
232
404
"""Construct an instance of this command."""
233
if self.__doc__ == Command.__doc__:
234
warn("No help message set for %r" % self)
405
# List of standard options directly supported
406
self.supported_std_options = []
409
def add_cleanup(self, cleanup_func, *args, **kwargs):
410
"""Register a function to call after self.run returns or raises.
412
Functions will be called in LIFO order.
414
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
416
def cleanup_now(self):
417
"""Execute and empty pending cleanup functions immediately.
419
After cleanup_now all registered cleanups are forgotten. add_cleanup
420
may be called again after cleanup_now; these cleanups will be called
421
after self.run returns or raises (or when cleanup_now is next called).
423
This is useful for releasing expensive or contentious resources (such
424
as write locks) before doing further work that does not require those
425
resources (such as writing results to self.outf). Note though, that
426
as it releases all resources, this may release locks that the command
427
wants to hold, so use should be done with care.
429
self._operation.cleanup_now()
432
"""Return single-line grammar for this command.
434
Only describes arguments, not options.
436
s = 'bzr ' + self.name() + ' '
437
for aname in self.takes_args:
438
aname = aname.upper()
439
if aname[-1] in ['$', '+']:
440
aname = aname[:-1] + '...'
441
elif aname[-1] == '?':
442
aname = '[' + aname[:-1] + ']'
443
elif aname[-1] == '*':
444
aname = '[' + aname[:-1] + '...]'
446
s = s[:-1] # remove last space
449
def get_help_text(self, additional_see_also=None, plain=True,
450
see_also_as_links=False, verbose=True):
451
"""Return a text string with help for this command.
453
:param additional_see_also: Additional help topics to be
455
:param plain: if False, raw help (reStructuredText) is
456
returned instead of plain text.
457
:param see_also_as_links: if True, convert items in 'See also'
458
list to internal links (used by bzr_man rstx generator)
459
:param verbose: if True, display the full help, otherwise
460
leave out the descriptive sections and just display
461
usage help (e.g. Purpose, Usage, Options) with a
462
message explaining how to obtain full help.
465
i18n.install() # Install i18n only for get_help_text for now.
468
# Note: If self.gettext() translates ':Usage:\n', the section will
469
# be shown after "Description" section and we don't want to
470
# translate the usage string.
471
# Though, bzr export-pot don't exports :Usage: section and it must
473
doc = self.gettext(doc)
475
doc = gettext("No help for this command.")
477
# Extract the summary (purpose) and sections out from the text
478
purpose,sections,order = self._get_help_parts(doc)
480
# If a custom usage section was provided, use it
481
if sections.has_key('Usage'):
482
usage = sections.pop('Usage')
484
usage = self._usage()
486
# The header is the purpose and usage
488
result += gettext(':Purpose: %s\n') % (purpose,)
489
if usage.find('\n') >= 0:
490
result += gettext(':Usage:\n%s\n') % (usage,)
492
result += gettext(':Usage: %s\n') % (usage,)
497
# XXX: optparse implicitly rewraps the help, and not always perfectly,
498
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
500
parser = option.get_optparser(self.options())
501
options = parser.format_option_help()
502
# FIXME: According to the spec, ReST option lists actually don't
503
# support options like --1.14 so that causes syntax errors (in Sphinx
504
# at least). As that pattern always appears in the commands that
505
# break, we trap on that and then format that block of 'format' options
506
# as a literal block. We use the most recent format still listed so we
507
# don't have to do that too often -- vila 20110514
508
if not plain and options.find(' --1.14 ') != -1:
509
options = options.replace(' format:\n', ' format::\n\n', 1)
510
if options.startswith('Options:'):
511
result += gettext(':Options:%s') % (options[len('options:'):],)
517
# Add the description, indenting it 2 spaces
518
# to match the indentation of the options
519
if sections.has_key(None):
520
text = sections.pop(None)
521
text = '\n '.join(text.splitlines())
522
result += gettext(':Description:\n %s\n\n') % (text,)
524
# Add the custom sections (e.g. Examples). Note that there's no need
525
# to indent these as they must be indented already in the source.
528
if label in sections:
529
result += ':%s:\n%s\n' % (label, sections[label])
532
result += (gettext("See bzr help %s for more details and examples.\n\n")
535
# Add the aliases, source (plug-in) and see also links, if any
537
result += gettext(':Aliases: ')
538
result += ', '.join(self.aliases) + '\n'
539
plugin_name = self.plugin_name()
540
if plugin_name is not None:
541
result += gettext(':From: plugin "%s"\n') % plugin_name
542
see_also = self.get_see_also(additional_see_also)
544
if not plain and see_also_as_links:
546
for item in see_also:
548
# topics doesn't have an independent section
549
# so don't create a real link
550
see_also_links.append(item)
552
# Use a Sphinx link for this entry
553
link_text = gettext(":doc:`{0} <{1}-help>`").format(
555
see_also_links.append(link_text)
556
see_also = see_also_links
557
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
559
# If this will be rendered as plain text, convert it
561
import bzrlib.help_topics
562
result = bzrlib.help_topics.help_as_plain_text(result)
566
def _get_help_parts(text):
567
"""Split help text into a summary and named sections.
569
:return: (summary,sections,order) where summary is the top line and
570
sections is a dictionary of the rest indexed by section name.
571
order is the order the section appear in the text.
572
A section starts with a heading line of the form ":xxx:".
573
Indented text on following lines is the section value.
574
All text found outside a named section is assigned to the
575
default section which is given the key of None.
577
def save_section(sections, order, label, section):
579
if sections.has_key(label):
580
sections[label] += '\n' + section
583
sections[label] = section
585
lines = text.rstrip().splitlines()
586
summary = lines.pop(0)
589
label,section = None,''
591
if line.startswith(':') and line.endswith(':') and len(line) > 2:
592
save_section(sections, order, label, section)
593
label,section = line[1:-1],''
594
elif (label is not None) and len(line) > 1 and not line[0].isspace():
595
save_section(sections, order, label, section)
596
label,section = None,line
599
section += '\n' + line
602
save_section(sections, order, label, section)
603
return summary, sections, order
605
def get_help_topic(self):
606
"""Return the commands help topic - its name."""
609
def get_see_also(self, additional_terms=None):
610
"""Return a list of help topics that are related to this command.
612
The list is derived from the content of the _see_also attribute. Any
613
duplicates are removed and the result is in lexical order.
614
:param additional_terms: Additional help topics to cross-reference.
615
:return: A list of help topics.
617
see_also = set(getattr(self, '_see_also', []))
619
see_also.update(additional_terms)
620
return sorted(see_also)
236
622
def options(self):
237
623
"""Return dict of valid options for this command.
239
625
Maps from long option name to option object."""
241
r['help'] = option.Option.OPTIONS['help']
626
r = Option.STD_OPTIONS.copy()
242
628
for o in self.takes_options:
243
629
if isinstance(o, basestring):
244
630
o = option.Option.OPTIONS[o]
632
if o.name in std_names:
633
self.supported_std_options.append(o.name)
248
636
def _setup_outf(self):
249
637
"""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)
638
self.outf = ui.ui_factory.make_output_stream(
639
encoding_type=self.encoding_type)
282
641
def run_argv_aliases(self, argv, alias_argv=None):
283
642
"""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
643
args, opts = parse_args(self, argv, alias_argv)
646
# Process the standard options
289
647
if 'help' in opts: # e.g. bzr add --help
290
from bzrlib.help import help_on_command
291
help_on_command(self.name())
648
self.outf.write(self.get_help_text())
650
if 'usage' in opts: # e.g. bzr add --usage
651
self.outf.write(self.get_help_text(verbose=False))
653
trace.set_verbosity_level(option._verbosity_level)
654
if 'verbose' in self.supported_std_options:
655
opts['verbose'] = trace.is_verbose()
656
elif opts.has_key('verbose'):
658
if 'quiet' in self.supported_std_options:
659
opts['quiet'] = trace.is_quiet()
660
elif opts.has_key('quiet'):
293
662
# mix arguments and options into one dictionary
294
663
cmdargs = _match_argform(self.name(), self.takes_args, args)
554
1051
opt_no_plugins = True
555
1052
elif a == '--no-aliases':
556
1053
opt_no_aliases = True
1054
elif a == '--no-l10n':
557
1056
elif a == '--builtin':
558
1057
opt_builtin = True
559
elif a in ('--quiet', '-q'):
1058
elif a == '--concurrency':
1059
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1061
elif a == '--coverage':
1062
opt_coverage_dir = argv[i + 1]
1064
elif a == '--profile-imports':
1065
pass # already handled in startup script Bug #588277
561
1066
elif a.startswith('-D'):
562
1067
debug.debug_flags.add(a[2:])
1068
elif a.startswith('-O'):
1069
override_config.append(a[2:])
564
1071
argv_copy.append(a)
1074
bzrlib.global_state.cmdline_overrides._from_cmdline(override_config)
1076
debug.set_debug_flags_from_config()
1078
if not opt_no_plugins:
567
1083
argv = argv_copy
569
from bzrlib.builtins import cmd_help
570
cmd_help().run_argv_aliases([])
1085
get_cmd_object('help').run_argv_aliases([])
573
1088
if argv[0] == '--version':
574
from bzrlib.version import show_version
1089
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
1092
alias_argv = None
587
1094
if not opt_no_aliases:
588
1095
alias_argv = get_alias(argv[0])
590
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
591
1097
argv[0] = alias_argv.pop(0)
593
1099
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
1100
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]
1103
run = cmd_obj.run_argv_aliases
1104
run_argv = [argv, alias_argv]
1107
# We can be called recursively (tests for example), but we don't want
1108
# the verbosity level to propagate.
1109
saved_verbosity_level = option._verbosity_level
1110
option._verbosity_level = 0
1112
if opt_coverage_dir:
1114
'--coverage ignored, because --lsprof is in use.')
608
1115
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
609
1116
elif opt_profile:
1117
if opt_coverage_dir:
1119
'--coverage ignored, because --profile is in use.')
610
1120
ret = apply_profiled(run, *run_argv)
1121
elif opt_coverage_dir:
1122
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
612
1124
ret = run(*run_argv)
615
# reset, in case we may do other commands later within the same process
616
trace.be_quiet(False)
1127
# reset, in case we may do other commands later within the same
1128
# process. Commands that want to execute sub-commands must propagate
1129
# --verbose in their own way.
1130
if 'memory' in debug.debug_flags:
1131
trace.debug_memory('Process status after command:', short=False)
1132
option._verbosity_level = saved_verbosity_level
1133
# Reset the overrides
1134
bzrlib.global_state.cmdline_overrides._reset()
618
1137
def display_command(func):
619
1138
"""Decorator that suppresses pipe/interrupt errors."""
635
1154
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:]]
1157
def install_bzr_command_hooks():
1158
"""Install the hooks to supply bzr's own commands."""
1159
if _list_bzr_commands in Command.hooks["list_commands"]:
1161
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1163
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1165
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1166
"bzr plugin commands")
1167
Command.hooks.install_named_hook("get_command", _get_external_command,
1168
"bzr external command lookup")
1169
Command.hooks.install_named_hook("get_missing_command",
1170
_try_plugin_provider,
1171
"bzr plugin-provider-db check")
1175
def _specified_or_unicode_argv(argv):
1176
# For internal or testing use, argv can be passed. Otherwise, get it from
1177
# the process arguments in a unicode-safe way.
1179
return osutils.get_unicode_argv()
1183
# ensure all arguments are unicode strings
1185
if isinstance(a, unicode):
1188
new_argv.append(a.decode('ascii'))
1189
except UnicodeDecodeError:
1190
raise errors.BzrError("argv should be list of unicode strings.")
1194
def main(argv=None):
1195
"""Main entry point of command-line interface.
1197
Typically `bzrlib.initialize` should be called first.
1199
:param argv: list of unicode command-line arguments similar to sys.argv.
1200
argv[0] is script name usually, it will be ignored.
1201
Don't pass here sys.argv because this list contains plain strings
1202
and not unicode; pass None instead.
1204
:return: exit code of bzr command.
1206
if argv is not None:
1208
_register_builtin_commands()
643
1209
ret = run_bzr_catch_errors(argv)
644
1210
trace.mutter("return code %d", ret)
648
1214
def run_bzr_catch_errors(argv):
1215
"""Run a bzr command with parameters as described by argv.
1217
This function assumed that that UI layer is setup, that symbol deprecations
1218
are already applied, and that unicode decoding has already been performed on argv.
1220
# done here so that they're covered for every test run
1221
install_bzr_command_hooks()
1222
return exception_to_return_code(run_bzr, argv)
1225
def run_bzr_catch_user_errors(argv):
1226
"""Run bzr and report user errors, but let internal errors propagate.
1228
This is used for the test suite, and might be useful for other programs
1229
that want to wrap the commandline interface.
1231
# done here so that they're covered for every test run
1232
install_bzr_command_hooks()
650
1234
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))
1235
except Exception, e:
1236
if (isinstance(e, (OSError, IOError))
1237
or not getattr(e, 'internal_error', True)):
1238
trace.report_exception(sys.exc_info(), sys.stderr)
1244
class HelpCommandIndex(object):
1245
"""A index for bzr help that returns commands."""
1248
self.prefix = 'commands/'
1250
def get_topics(self, topic):
1251
"""Search for topic amongst commands.
1253
:param topic: A topic to search for.
1254
:return: A list which is either empty or contains a single
1257
if topic and topic.startswith(self.prefix):
1258
topic = topic[len(self.prefix):]
1260
cmd = _get_cmd_object(topic, check_missing=False)
1267
class Provider(object):
1268
"""Generic class to be overriden by plugins"""
1270
def plugin_for_command(self, cmd_name):
1271
"""Takes a command and returns the information for that plugin
1273
:return: A dictionary with all the available information
1274
for the requested plugin
1276
raise NotImplementedError
1279
class ProvidersRegistry(registry.Registry):
1280
"""This registry exists to allow other providers to exist"""
1283
for key, provider in self.iteritems():
1286
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
