52
from bzrlib.hooks import HookPoint, Hooks
53
# Compatibility - Option used to be in commands.
54
from bzrlib.option import Option
55
from bzrlib import registry
56
52
from bzrlib.symbol_versioning import (
57
53
deprecated_function,
59
suppress_deprecation_warnings,
63
class CommandInfo(object):
64
"""Information about a command."""
66
def __init__(self, aliases):
67
"""The list of aliases for the command."""
68
self.aliases = aliases
71
def from_command(klass, command):
72
"""Factory to construct a CommandInfo from a command."""
73
return klass(command.aliases)
76
class CommandRegistry(registry.Registry):
79
def _get_name(command_name):
80
if command_name.startswith("cmd_"):
81
return _unsquish_command_name(command_name)
85
def register(self, cmd, decorate=False):
86
"""Utility function to help register a command
88
:param cmd: Command subclass to register
89
:param decorate: If true, allow overriding an existing command
90
of the same name; the old command is returned by this function.
91
Otherwise it is an error to try to override an existing command.
94
k_unsquished = self._get_name(k)
96
previous = self.get(k_unsquished)
98
previous = _builtin_commands().get(k_unsquished)
99
info = CommandInfo.from_command(cmd)
101
registry.Registry.register(self, k_unsquished, cmd,
102
override_existing=decorate, info=info)
104
trace.log_error('Two plugins defined the same command: %r' % k)
105
trace.log_error('Not loading the one in %r' %
106
sys.modules[cmd.__module__])
107
trace.log_error('Previously this command was registered from %r' %
108
sys.modules[previous.__module__])
111
def register_lazy(self, command_name, aliases, module_name):
112
"""Register a command without loading its module.
114
:param command_name: The primary name of the command.
115
:param aliases: A list of aliases for the command.
116
:module_name: The module that the command lives in.
118
key = self._get_name(command_name)
119
registry.Registry.register_lazy(self, key, module_name, command_name,
120
info=CommandInfo(aliases))
123
plugin_cmds = CommandRegistry()
57
from bzrlib.option import Option
126
63
def register_command(cmd, decorate=False):
64
"""Utility function to help register a 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.
127
71
global plugin_cmds
128
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__])
89
trace.log_error('Previously this command was registered from %r' %
90
sys.modules[plugin_cmds[k_unsquished].__module__])
131
93
def _squish_command_name(cmd):
135
97
def _unsquish_command_name(cmd):
98
assert cmd.startswith("cmd_")
136
99
return cmd[4:].replace('_','-')
139
102
def _builtin_commands():
140
103
import bzrlib.builtins
141
return _scan_module_for_commands(bzrlib.builtins)
144
def _scan_module_for_commands(module):
146
for name, obj in module.__dict__.iteritems():
105
builtins = bzrlib.builtins.__dict__
106
for name in builtins:
147
107
if name.startswith("cmd_"):
148
108
real_name = _unsquish_command_name(name)
109
r[real_name] = builtins[name]
153
def _list_bzr_commands(names):
154
"""Find commands from bzr's core and plugins."""
155
# to eliminate duplicates
156
names.update(builtin_command_names())
157
names.update(plugin_command_names())
161
def all_command_names():
162
"""Return a set of all command names."""
164
for hook in Command.hooks['list_commands']:
167
raise AssertionError(
168
'hook %s returned None' % Command.hooks.get_hook_name(hook))
172
113
def builtin_command_names():
173
"""Return list of builtin command names.
175
Use of all_command_names() is encouraged rather than builtin_command_names
176
and/or plugin_command_names.
114
"""Return list of builtin command names."""
178
115
return _builtin_commands().keys()
181
118
def plugin_command_names():
182
"""Returns command names from commands registered by plugins."""
183
119
return plugin_cmds.keys()
186
@deprecated_function(deprecated_in((1, 17, 0)))
187
def get_all_cmds(plugins_override=False):
188
"""Return canonical name and class for most commands.
190
NB: This does not return all commands since the introduction of
191
command hooks, and returning the class is not sufficient to
192
get correctly setup commands, which is why it is deprecated.
194
Use 'all_command_names' + 'get_cmd_object' instead.
122
def _get_cmd_dict(plugins_override=True):
123
"""Return name->class mapping for all commands."""
196
124
d = _builtin_commands()
197
125
if plugins_override:
198
d.update(plugin_cmds.iteritems())
199
for k, v in d.iteritems():
126
d.update(plugin_cmds)
130
def get_all_cmds(plugins_override=True):
131
"""Return canonical name and class for all registered commands."""
132
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
203
136
def get_cmd_object(cmd_name, plugins_override=True):
204
"""Return the command object for a command.
137
"""Return the canonical name and command class for a command.
207
140
If true, plugin commands can override builtins.
215
148
def _get_cmd_object(cmd_name, plugins_override=True):
216
"""Get a command object.
149
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
150
from bzrlib.externalcommand import ExternalCommand
218
:param cmd_name: The name of the command.
219
:param plugins_override: Allow plugins to override builtins.
220
:return: A Command object instance
221
:raises KeyError: If no command is found.
223
152
# We want only 'ascii' command names, but the user may have typed
224
153
# in a Unicode name. In that case, they should just get a
225
154
# 'command not found' error later.
226
155
# In the future, we may actually support Unicode command names.
229
for hook in Command.hooks['get_command']:
230
cmd = hook(cmd, cmd_name)
231
if cmd is not None and not plugins_override and not cmd.plugin_name():
232
# We've found a non-plugin command, don't permit it to be
236
for hook in Command.hooks['get_missing_command']:
243
# Allow plugins to extend commands
244
for hook in Command.hooks['extend_command']:
249
def _try_plugin_provider(cmd_name):
250
"""Probe for a plugin provider having cmd_name."""
252
plugin_metadata, provider = probe_for_provider(cmd_name)
253
raise errors.CommandAvailableInPlugin(cmd_name,
254
plugin_metadata, provider)
255
except errors.NoPluginAvailable:
259
def probe_for_provider(cmd_name):
260
"""Look for a provider for cmd_name.
262
:param cmd_name: The command name.
263
:return: plugin_metadata, provider for getting cmd_name.
264
:raises NoPluginAvailable: When no provider can supply the plugin.
266
# look for providers that provide this command but aren't installed
267
for provider in command_providers_registry:
269
return provider.plugin_for_command(cmd_name), provider
270
except errors.NoPluginAvailable:
272
raise errors.NoPluginAvailable(cmd_name)
275
def _get_bzr_command(cmd_or_None, cmd_name):
276
"""Get a command from bzr's core."""
277
cmds = _builtin_commands()
157
# first look up this command under the specified name
158
cmds = _get_cmd_dict(plugins_override=plugins_override)
279
160
return cmds[cmd_name]()
282
164
# look for any command which claims this as an alias
283
165
for real_cmd_name, cmd_class in cmds.iteritems():
284
166
if cmd_name in cmd_class.aliases:
285
167
return cmd_class()
289
def _get_external_command(cmd_or_None, cmd_name):
290
"""Lookup a command that is a shell script."""
291
# Only do external command lookups when no command is found so far.
292
if cmd_or_None is not None:
294
from bzrlib.externalcommand import ExternalCommand
295
169
cmd_obj = ExternalCommand.find_command(cmd_name)
173
# look for plugins that provide this command but aren't installed
174
for provider in command_providers_registry:
176
plugin_metadata = provider.plugin_for_command(cmd_name)
177
except errors.NoPluginAvailable:
180
raise errors.CommandAvailableInPlugin(cmd_name,
181
plugin_metadata, provider)
300
def _get_plugin_command(cmd_or_None, cmd_name):
301
"""Get a command from bzr's plugins."""
303
return plugin_cmds.get(cmd_name)()
306
for key in plugin_cmds.keys():
307
info = plugin_cmds.get_info(key)
308
if cmd_name in info.aliases:
309
return plugin_cmds.get(key)()
313
186
class Command(object):
411
283
elif aname[-1] == '*':
412
284
aname = '[' + aname[:-1] + '...]'
414
s = s[:-1] # remove last space
417
291
def get_help_text(self, additional_see_also=None, plain=True,
418
see_also_as_links=False, verbose=True):
292
see_also_as_links=False):
419
293
"""Return a text string with help for this command.
421
295
:param additional_see_also: Additional help topics to be
422
296
cross-referenced.
423
297
:param plain: if False, raw help (reStructuredText) is
424
298
returned instead of plain text.
425
299
:param see_also_as_links: if True, convert items in 'See also'
426
300
list to internal links (used by bzr_man rstx generator)
427
:param verbose: if True, display the full help, otherwise
428
leave out the descriptive sections and just display
429
usage help (e.g. Purpose, Usage, Options) with a
430
message explaining how to obtain full help.
432
302
doc = self.help()
434
304
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
436
306
# Extract the summary (purpose) and sections out from the text
437
purpose,sections,order = self._get_help_parts(doc)
307
purpose,sections = self._get_help_parts(doc)
439
309
# If a custom usage section was provided, use it
440
310
if sections.has_key('Usage'):
454
324
# Add the options
456
# XXX: optparse implicitly rewraps the help, and not always perfectly,
457
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
459
325
options = option.get_optparser(self.options()).format_option_help()
460
# XXX: According to the spec, ReST option lists actually don't support
461
# options like --1.9 so that causes syntax errors (in Sphinx at least).
462
# As that pattern always appears in the commands that break, we trap
463
# on that and then format that block of 'format' options as a literal
465
if not plain and options.find(' --1.9 ') != -1:
466
options = options.replace(' format:\n', ' format::\n\n', 1)
467
326
if options.startswith('Options:'):
468
327
result += ':' + options
469
328
elif options.startswith('options:'):
473
332
result += options
477
# Add the description, indenting it 2 spaces
478
# to match the indentation of the options
479
if sections.has_key(None):
480
text = sections.pop(None)
481
text = '\n '.join(text.splitlines())
482
result += ':%s:\n %s\n\n' % ('Description',text)
335
# Add the description, indenting it 2 spaces
336
# to match the indentation of the options
337
if sections.has_key(None):
338
text = sections.pop(None)
339
text = '\n '.join(text.splitlines())
340
result += ':%s:\n %s\n\n' % ('Description',text)
484
# Add the custom sections (e.g. Examples). Note that there's no need
485
# to indent these as they must be indented already in the source.
488
if sections.has_key(label):
489
result += ':%s:\n%s\n' % (label,sections[label])
492
result += ("See bzr help %s for more details and examples.\n\n"
342
# Add the custom sections (e.g. Examples). Note that there's no need
343
# to indent these as they must be indented already in the source.
345
labels = sorted(sections.keys())
347
result += ':%s:\n%s\n\n' % (label,sections[label])
495
349
# Add the aliases, source (plug-in) and see also links, if any
525
379
def _get_help_parts(text):
526
380
"""Split help text into a summary and named sections.
528
:return: (summary,sections,order) where summary is the top line and
382
:return: (summary,sections) where summary is the top line and
529
383
sections is a dictionary of the rest indexed by section name.
530
order is the order the section appear in the text.
531
384
A section starts with a heading line of the form ":xxx:".
532
385
Indented text on following lines is the section value.
533
386
All text found outside a named section is assigned to the
534
387
default section which is given the key of None.
536
def save_section(sections, order, label, section):
389
def save_section(sections, label, section):
537
390
if len(section) > 0:
538
391
if sections.has_key(label):
539
392
sections[label] += '\n' + section
542
394
sections[label] = section
544
396
lines = text.rstrip().splitlines()
545
397
summary = lines.pop(0)
548
399
label,section = None,''
549
400
for line in lines:
550
401
if line.startswith(':') and line.endswith(':') and len(line) > 2:
551
save_section(sections, order, label, section)
402
save_section(sections, label, section)
552
403
label,section = line[1:-1],''
553
elif (label is not None) and len(line) > 1 and not line[0].isspace():
554
save_section(sections, order, label, section)
404
elif label != None and len(line) > 1 and not line[0].isspace():
405
save_section(sections, label, section)
555
406
label,section = None,line
557
408
if len(section) > 0:
558
409
section += '\n' + line
561
save_section(sections, order, label, section)
562
return summary, sections, order
412
save_section(sections, label, section)
413
return summary, sections
564
415
def get_help_topic(self):
565
416
"""Return the commands help topic - its name."""
691
class CommandHooks(Hooks):
692
"""Hooks related to Command object creation/enumeration."""
695
"""Create the default hooks.
697
These are all empty initially, because by default nothing should get
701
self.create_hook(HookPoint('extend_command',
702
"Called after creating a command object to allow modifications "
703
"such as adding or removing options, docs etc. Called with the "
704
"new bzrlib.commands.Command object.", (1, 13), None))
705
self.create_hook(HookPoint('get_command',
706
"Called when creating a single command. Called with "
707
"(cmd_or_None, command_name). get_command should either return "
708
"the cmd_or_None parameter, or a replacement Command object that "
709
"should be used for the command. Note that the Command.hooks "
710
"hooks are core infrastructure. Many users will prefer to use "
711
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
713
self.create_hook(HookPoint('get_missing_command',
714
"Called when creating a single command if no command could be "
715
"found. Called with (command_name). get_missing_command should "
716
"either return None, or a Command object to be used for the "
717
"command.", (1, 17), None))
718
self.create_hook(HookPoint('list_commands',
719
"Called when enumerating commands. Called with a set of "
720
"cmd_name strings for all the commands found so far. This set "
721
" is safe to mutate - e.g. to remove a command. "
722
"list_commands should return the updated set of command names.",
725
Command.hooks = CommandHooks()
728
541
def parse_args(command, argv, alias_argv=None):
729
542
"""Parse command line.
731
544
Arguments and options are parsed at this level before being passed
732
545
down to specific command handlers. This routine knows, from a
733
546
lookup table, something about the available options, what optargs
797
610
tracer = trace.Trace(count=1, trace=0)
798
611
sys.settrace(tracer.globaltrace)
799
threading.settrace(tracer.globaltrace)
802
return exception_to_return_code(the_callable, *args, **kwargs)
805
results = tracer.results()
806
results.write_results(show_missing=1, summary=False,
613
ret = the_callable(*args, **kwargs)
616
results = tracer.results()
617
results.write_results(show_missing=1, summary=False,
810
621
def apply_profiled(the_callable, *args, **kwargs):
831
641
os.remove(pfname)
834
def exception_to_return_code(the_callable, *args, **kwargs):
835
"""UI level helper for profiling and coverage.
837
This transforms exceptions into a return value of 3. As such its only
838
relevant to the UI layer, and should never be called where catching
839
exceptions may be desirable.
842
return the_callable(*args, **kwargs)
843
except (KeyboardInterrupt, Exception), e:
844
# used to handle AssertionError and KeyboardInterrupt
845
# specially here, but hopefully they're handled ok by the logger now
846
exc_info = sys.exc_info()
847
exitcode = trace.report_exception(exc_info, sys.stderr)
848
if os.environ.get('BZR_PDB'):
849
print '**** entering debugger'
852
if sys.version_info[:2] < (2, 6):
854
# pdb.post_mortem(tb)
855
# but because pdb.post_mortem gives bad results for tracebacks
856
# from inside generators, we do it manually.
857
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
859
# Setup pdb on the traceback
862
p.setup(tb.tb_frame, tb)
863
# Point the debugger at the deepest frame of the stack
864
p.curindex = len(p.stack) - 1
865
p.curframe = p.stack[p.curindex][0]
866
# Start the pdb prompt.
867
p.print_stack_entry(p.stack[p.curindex])
875
644
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
876
645
from bzrlib.lsprof import profile
877
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
646
ret, stats = profile(the_callable, *args, **kwargs)
879
648
if filename is None:
1035
800
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1037
802
ret = run(*run_argv)
1038
if 'memory' in debug.debug_flags:
1039
trace.debug_memory('Process status after command:', short=False)
1042
# reset, in case we may do other commands later within the same
1043
# process. Commands that want to execute sub-commands must propagate
1044
# --verbose in their own way.
1045
option._verbosity_level = saved_verbosity_level
805
# reset, in case we may do other commands later within the same process
806
option._verbosity_level = 0
1048
808
def display_command(func):
1049
809
"""Decorator that suppresses pipe/interrupt errors."""
1065
825
return ignore_pipe
1068
def install_bzr_command_hooks():
1069
"""Install the hooks to supply bzr's own commands."""
1070
if _list_bzr_commands in Command.hooks["list_commands"]:
1072
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1074
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1076
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1077
"bzr plugin commands")
1078
Command.hooks.install_named_hook("get_command", _get_external_command,
1079
"bzr external command lookup")
1080
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1081
"bzr plugin-provider-db check")
1084
def main(argv=None):
1085
"""Main entry point of command-line interface.
1087
:param argv: list of unicode command-line arguments similar to sys.argv.
1088
argv[0] is script name usually, it will be ignored.
1089
Don't pass here sys.argv because this list contains plain strings
1090
and not unicode; pass None instead.
1092
:return: exit code of bzr command.
1094
829
import bzrlib.ui
1095
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1096
sys.stdin, sys.stdout, sys.stderr)
1098
# Is this a final release version? If so, we should suppress warnings
1099
if bzrlib.version_info[3] == 'final':
1100
suppress_deprecation_warnings(override=True)
1102
argv = osutils.get_unicode_argv()
1106
# ensure all arguments are unicode strings
1108
if isinstance(a, unicode):
1111
new_argv.append(a.decode('ascii'))
1112
except UnicodeDecodeError:
1113
raise errors.BzrError("argv should be list of unicode strings.")
830
from bzrlib.ui.text import TextUIFactory
831
bzrlib.ui.ui_factory = TextUIFactory()
833
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
834
except UnicodeDecodeError:
835
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
1115
837
ret = run_bzr_catch_errors(argv)
1116
838
trace.mutter("return code %d", ret)
1120
842
def run_bzr_catch_errors(argv):
1121
"""Run a bzr command with parameters as described by argv.
1123
This function assumed that that UI layer is setup, that symbol deprecations
1124
are already applied, and that unicode decoding has already been performed on argv.
1126
install_bzr_command_hooks()
1127
return exception_to_return_code(run_bzr, argv)
843
# Note: The except clause logic below should be kept in sync with the
844
# profile() routine in lsprof.py.
847
except (KeyboardInterrupt, Exception), e:
848
# used to handle AssertionError and KeyboardInterrupt
849
# specially here, but hopefully they're handled ok by the logger now
850
exitcode = trace.report_exception(sys.exc_info(), sys.stderr)
851
if os.environ.get('BZR_PDB'):
852
print '**** entering debugger'
854
pdb.post_mortem(sys.exc_traceback)
1130
858
def run_bzr_catch_user_errors(argv):
added
removed
bzrlib/commands.py
