35
35
lazy_import(globals(), """
39
38
from warnings import warn
42
41
from bzrlib import (
54
from bzrlib.hooks import HookPoint, Hooks
55
# Compatibility - Option used to be in commands.
56
from bzrlib.option import Option
57
from bzrlib import registry
58
51
from bzrlib.symbol_versioning import (
59
52
deprecated_function,
65
class CommandInfo(object):
66
"""Information about a command."""
68
def __init__(self, aliases):
69
"""The list of aliases for the command."""
70
self.aliases = aliases
73
def from_command(klass, command):
74
"""Factory to construct a CommandInfo from a command."""
75
return klass(command.aliases)
78
class CommandRegistry(registry.Registry):
81
def _get_name(command_name):
82
if command_name.startswith("cmd_"):
83
return _unsquish_command_name(command_name)
87
def register(self, cmd, decorate=False):
88
"""Utility function to help register a command
90
:param cmd: Command subclass to register
91
:param decorate: If true, allow overriding an existing command
92
of the same name; the old command is returned by this function.
93
Otherwise it is an error to try to override an existing command.
96
k_unsquished = self._get_name(k)
98
previous = self.get(k_unsquished)
100
previous = _builtin_commands().get(k_unsquished)
101
info = CommandInfo.from_command(cmd)
103
registry.Registry.register(self, k_unsquished, cmd,
104
override_existing=decorate, info=info)
106
trace.warning('Two plugins defined the same command: %r' % k)
107
trace.warning('Not loading the one in %r' %
108
sys.modules[cmd.__module__])
109
trace.warning('Previously this command was registered from %r' %
110
sys.modules[previous.__module__])
113
def register_lazy(self, command_name, aliases, module_name):
114
"""Register a command without loading its module.
116
:param command_name: The primary name of the command.
117
:param aliases: A list of aliases for the command.
118
:module_name: The module that the command lives in.
120
key = self._get_name(command_name)
121
registry.Registry.register_lazy(self, key, module_name, command_name,
122
info=CommandInfo(aliases))
125
plugin_cmds = CommandRegistry()
56
from bzrlib.option import Option
128
62
def register_command(cmd, decorate=False):
63
"""Utility function to help register a command
65
:param cmd: Command subclass to register
66
:param decorate: If true, allow overriding an existing command
67
of the same name; the old command is returned by this function.
68
Otherwise it is an error to try to override an existing command.
129
70
global plugin_cmds
130
return plugin_cmds.register(cmd, decorate)
72
if k.startswith("cmd_"):
73
k_unsquished = _unsquish_command_name(k)
76
if k_unsquished not in plugin_cmds:
77
plugin_cmds[k_unsquished] = cmd
78
## trace.mutter('registered plugin command %s', k_unsquished)
79
if decorate and k_unsquished in builtin_command_names():
80
return _builtin_commands()[k_unsquished]
82
result = plugin_cmds[k_unsquished]
83
plugin_cmds[k_unsquished] = cmd
86
trace.log_error('Two plugins defined the same command: %r' % k)
87
trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
88
trace.log_error('Previously this command was registered from %r' %
89
sys.modules[plugin_cmds[k_unsquished].__module__])
133
92
def _squish_command_name(cmd):
137
96
def _unsquish_command_name(cmd):
97
assert cmd.startswith("cmd_")
138
98
return cmd[4:].replace('_','-')
141
101
def _builtin_commands():
142
102
import bzrlib.builtins
143
return _scan_module_for_commands(bzrlib.builtins)
146
def _scan_module_for_commands(module):
148
for name, obj in module.__dict__.iteritems():
104
builtins = bzrlib.builtins.__dict__
105
for name in builtins:
149
106
if name.startswith("cmd_"):
150
107
real_name = _unsquish_command_name(name)
108
r[real_name] = builtins[name]
155
def _list_bzr_commands(names):
156
"""Find commands from bzr's core and plugins."""
157
# to eliminate duplicates
158
names.update(builtin_command_names())
159
names.update(plugin_command_names())
163
def all_command_names():
164
"""Return a set of all command names."""
166
for hook in Command.hooks['list_commands']:
169
raise AssertionError(
170
'hook %s returned None' % Command.hooks.get_hook_name(hook))
174
112
def builtin_command_names():
175
"""Return list of builtin command names.
177
Use of all_command_names() is encouraged rather than builtin_command_names
178
and/or plugin_command_names.
113
"""Return list of builtin command names."""
180
114
return _builtin_commands().keys()
183
117
def plugin_command_names():
184
"""Returns command names from commands registered by plugins."""
185
118
return plugin_cmds.keys()
121
def _get_cmd_dict(plugins_override=True):
122
"""Return name->class mapping for all commands."""
123
d = _builtin_commands()
125
d.update(plugin_cmds)
129
def get_all_cmds(plugins_override=True):
130
"""Return canonical name and class for all registered commands."""
131
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
188
135
def get_cmd_object(cmd_name, plugins_override=True):
189
"""Return the command object for a command.
136
"""Return the canonical name and command class for a command.
192
139
If true, plugin commands can override builtins.
200
147
def _get_cmd_object(cmd_name, plugins_override=True):
201
"""Get a command object.
148
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
149
from bzrlib.externalcommand import ExternalCommand
203
:param cmd_name: The name of the command.
204
:param plugins_override: Allow plugins to override builtins.
205
:return: A Command object instance
206
:raises KeyError: If no command is found.
208
151
# We want only 'ascii' command names, but the user may have typed
209
152
# in a Unicode name. In that case, they should just get a
210
153
# 'command not found' error later.
211
154
# In the future, we may actually support Unicode command names.
214
for hook in Command.hooks['get_command']:
215
cmd = hook(cmd, cmd_name)
216
if cmd is not None and not plugins_override and not cmd.plugin_name():
217
# We've found a non-plugin command, don't permit it to be
221
for hook in Command.hooks['get_missing_command']:
228
# Allow plugins to extend commands
229
for hook in Command.hooks['extend_command']:
234
def _try_plugin_provider(cmd_name):
235
"""Probe for a plugin provider having cmd_name."""
237
plugin_metadata, provider = probe_for_provider(cmd_name)
238
raise errors.CommandAvailableInPlugin(cmd_name,
239
plugin_metadata, provider)
240
except errors.NoPluginAvailable:
244
def probe_for_provider(cmd_name):
245
"""Look for a provider for cmd_name.
247
:param cmd_name: The command name.
248
:return: plugin_metadata, provider for getting cmd_name.
249
:raises NoPluginAvailable: When no provider can supply the plugin.
251
# look for providers that provide this command but aren't installed
252
for provider in command_providers_registry:
254
return provider.plugin_for_command(cmd_name), provider
255
except errors.NoPluginAvailable:
257
raise errors.NoPluginAvailable(cmd_name)
260
def _get_bzr_command(cmd_or_None, cmd_name):
261
"""Get a command from bzr's core."""
262
cmds = _builtin_commands()
156
# first look up this command under the specified name
157
cmds = _get_cmd_dict(plugins_override=plugins_override)
264
159
return cmds[cmd_name]()
267
163
# look for any command which claims this as an alias
268
164
for real_cmd_name, cmd_class in cmds.iteritems():
269
165
if cmd_name in cmd_class.aliases:
270
166
return cmd_class()
274
def _get_external_command(cmd_or_None, cmd_name):
275
"""Lookup a command that is a shell script."""
276
# Only do external command lookups when no command is found so far.
277
if cmd_or_None is not None:
279
from bzrlib.externalcommand import ExternalCommand
280
168
cmd_obj = ExternalCommand.find_command(cmd_name)
285
def _get_plugin_command(cmd_or_None, cmd_name):
286
"""Get a command from bzr's plugins."""
288
return plugin_cmds.get(cmd_name)()
291
for key in plugin_cmds.keys():
292
info = plugin_cmds.get_info(key)
293
if cmd_name in info.aliases:
294
return plugin_cmds.get(key)()
298
174
class Command(object):
360
235
encoding_type = 'strict'
364
239
def __init__(self):
365
240
"""Construct an instance of this command."""
366
241
if self.__doc__ == Command.__doc__:
367
242
warn("No help message set for %r" % self)
368
243
# List of standard options directly supported
369
244
self.supported_std_options = []
370
self._operation = cleanup.OperationWithCleanups(self.run)
372
def add_cleanup(self, cleanup_func, *args, **kwargs):
373
"""Register a function to call after self.run returns or raises.
375
Functions will be called in LIFO order.
377
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
379
def cleanup_now(self):
380
"""Execute and empty pending cleanup functions immediately.
382
After cleanup_now all registered cleanups are forgotten. add_cleanup
383
may be called again after cleanup_now; these cleanups will be called
384
after self.run returns or raises (or when cleanup_now is next called).
386
This is useful for releasing expensive or contentious resources (such
387
as write locks) before doing further work that does not require those
388
resources (such as writing results to self.outf).
390
self._operation.cleanup_now()
392
@deprecated_method(deprecated_in((2, 1, 0)))
393
246
def _maybe_expand_globs(self, file_list):
394
247
"""Glob expand file_list if the platform does not do that itself.
396
Not used anymore, now that the bzr command-line parser globs on
399
249
:return: A possibly empty list of unicode paths.
401
251
Introduced in bzrlib 0.18.
255
if sys.platform == 'win32':
256
file_list = win32utils.glob_expand(file_list)
257
return list(file_list)
405
259
def _usage(self):
406
260
"""Return single-line grammar for this command.
417
271
elif aname[-1] == '*':
418
272
aname = '[' + aname[:-1] + '...]'
420
s = s[:-1] # remove last space
423
279
def get_help_text(self, additional_see_also=None, plain=True,
424
see_also_as_links=False, verbose=True):
280
see_also_as_links=False):
425
281
"""Return a text string with help for this command.
427
283
:param additional_see_also: Additional help topics to be
428
284
cross-referenced.
429
285
:param plain: if False, raw help (reStructuredText) is
430
286
returned instead of plain text.
431
287
:param see_also_as_links: if True, convert items in 'See also'
432
288
list to internal links (used by bzr_man rstx generator)
433
:param verbose: if True, display the full help, otherwise
434
leave out the descriptive sections and just display
435
usage help (e.g. Purpose, Usage, Options) with a
436
message explaining how to obtain full help.
438
290
doc = self.help()
440
292
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
442
294
# Extract the summary (purpose) and sections out from the text
443
purpose,sections,order = self._get_help_parts(doc)
295
purpose,sections = self._get_help_parts(doc)
445
297
# If a custom usage section was provided, use it
446
298
if sections.has_key('Usage'):
460
312
# Add the options
462
# XXX: optparse implicitly rewraps the help, and not always perfectly,
463
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
465
313
options = option.get_optparser(self.options()).format_option_help()
466
# XXX: According to the spec, ReST option lists actually don't support
467
# options like --1.9 so that causes syntax errors (in Sphinx at least).
468
# As that pattern always appears in the commands that break, we trap
469
# on that and then format that block of 'format' options as a literal
471
if not plain and options.find(' --1.9 ') != -1:
472
options = options.replace(' format:\n', ' format::\n\n', 1)
473
314
if options.startswith('Options:'):
474
315
result += ':' + options
475
316
elif options.startswith('options:'):
479
320
result += options
483
# Add the description, indenting it 2 spaces
484
# to match the indentation of the options
485
if sections.has_key(None):
486
text = sections.pop(None)
487
text = '\n '.join(text.splitlines())
488
result += ':%s:\n %s\n\n' % ('Description',text)
323
# Add the description, indenting it 2 spaces
324
# to match the indentation of the options
325
if sections.has_key(None):
326
text = sections.pop(None)
327
text = '\n '.join(text.splitlines())
328
result += ':%s:\n %s\n\n' % ('Description',text)
490
# Add the custom sections (e.g. Examples). Note that there's no need
491
# to indent these as they must be indented already in the source.
494
if sections.has_key(label):
495
result += ':%s:\n%s\n' % (label,sections[label])
498
result += ("See bzr help %s for more details and examples.\n\n"
330
# Add the custom sections (e.g. Examples). Note that there's no need
331
# to indent these as they must be indented already in the source.
333
labels = sorted(sections.keys())
335
result += ':%s:\n%s\n\n' % (label,sections[label])
501
337
# Add the aliases, source (plug-in) and see also links, if any
515
351
# so don't create a real link
516
352
see_also_links.append(item)
518
# Use a Sphinx link for this entry
519
link_text = ":doc:`%s <%s-help>`" % (item, item)
520
see_also_links.append(link_text)
354
# Use a reST link for this entry
355
see_also_links.append("`%s`_" % (item,))
521
356
see_also = see_also_links
522
357
result += ':See also: '
523
358
result += ', '.join(see_also) + '\n'
525
# If this will be rendered as plain text, convert it
360
# If this will be rendered as plan text, convert it
527
362
import bzrlib.help_topics
528
363
result = bzrlib.help_topics.help_as_plain_text(result)
532
367
def _get_help_parts(text):
533
368
"""Split help text into a summary and named sections.
535
:return: (summary,sections,order) where summary is the top line and
370
:return: (summary,sections) where summary is the top line and
536
371
sections is a dictionary of the rest indexed by section name.
537
order is the order the section appear in the text.
538
372
A section starts with a heading line of the form ":xxx:".
539
373
Indented text on following lines is the section value.
540
374
All text found outside a named section is assigned to the
541
375
default section which is given the key of None.
543
def save_section(sections, order, label, section):
377
def save_section(sections, label, section):
544
378
if len(section) > 0:
545
379
if sections.has_key(label):
546
380
sections[label] += '\n' + section
549
382
sections[label] = section
551
384
lines = text.rstrip().splitlines()
552
385
summary = lines.pop(0)
555
387
label,section = None,''
556
388
for line in lines:
557
389
if line.startswith(':') and line.endswith(':') and len(line) > 2:
558
save_section(sections, order, label, section)
390
save_section(sections, label, section)
559
391
label,section = line[1:-1],''
560
elif (label is not None) and len(line) > 1 and not line[0].isspace():
561
save_section(sections, order, label, section)
392
elif label != None and len(line) > 1 and not line[0].isspace():
393
save_section(sections, label, section)
562
394
label,section = None,line
564
396
if len(section) > 0:
565
397
section += '\n' + line
568
save_section(sections, order, label, section)
569
return summary, sections, order
400
save_section(sections, label, section)
401
return summary, sections
571
403
def get_help_topic(self):
572
404
"""Return the commands help topic - its name."""
602
434
def _setup_outf(self):
603
435
"""Return a file linked to stdout, which has proper encoding."""
604
self.outf = ui.ui_factory.make_output_stream(
605
encoding_type=self.encoding_type)
436
assert self.encoding_type in ['strict', 'exact', 'replace']
438
# Originally I was using self.stdout, but that looks
439
# *way* too much like sys.stdout
440
if self.encoding_type == 'exact':
441
# force sys.stdout to be binary stream on win32
442
if sys.platform == 'win32':
443
fileno = getattr(sys.stdout, 'fileno', None)
446
msvcrt.setmode(fileno(), os.O_BINARY)
447
self.outf = sys.stdout
450
output_encoding = osutils.get_terminal_encoding()
452
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
453
errors=self.encoding_type)
454
# For whatever reason codecs.getwriter() does not advertise its encoding
455
# it just returns the encoding of the wrapped file, which is completely
456
# bogus. So set the attribute, so we can find the correct encoding later.
457
self.outf.encoding = output_encoding
607
459
def run_argv_aliases(self, argv, alias_argv=None):
608
460
"""Parse the command line and run with extra aliases in alias_argv."""
462
warn("Passing None for [] is deprecated from bzrlib 0.10",
463
DeprecationWarning, stacklevel=2)
609
465
args, opts = parse_args(self, argv, alias_argv)
611
467
# Process the standard options
612
468
if 'help' in opts: # e.g. bzr add --help
613
469
sys.stdout.write(self.get_help_text())
615
if 'usage' in opts: # e.g. bzr add --usage
616
sys.stdout.write(self.get_help_text(verbose=False))
618
471
trace.set_verbosity_level(option._verbosity_level)
619
472
if 'verbose' in self.supported_std_options:
620
473
opts['verbose'] = trace.is_verbose()
680
class CommandHooks(Hooks):
681
"""Hooks related to Command object creation/enumeration."""
684
"""Create the default hooks.
686
These are all empty initially, because by default nothing should get
690
self.create_hook(HookPoint('extend_command',
691
"Called after creating a command object to allow modifications "
692
"such as adding or removing options, docs etc. Called with the "
693
"new bzrlib.commands.Command object.", (1, 13), None))
694
self.create_hook(HookPoint('get_command',
695
"Called when creating a single command. Called with "
696
"(cmd_or_None, command_name). get_command should either return "
697
"the cmd_or_None parameter, or a replacement Command object that "
698
"should be used for the command. Note that the Command.hooks "
699
"hooks are core infrastructure. Many users will prefer to use "
700
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
702
self.create_hook(HookPoint('get_missing_command',
703
"Called when creating a single command if no command could be "
704
"found. Called with (command_name). get_missing_command should "
705
"either return None, or a Command object to be used for the "
706
"command.", (1, 17), None))
707
self.create_hook(HookPoint('list_commands',
708
"Called when enumerating commands. Called with a set of "
709
"cmd_name strings for all the commands found so far. This set "
710
" is safe to mutate - e.g. to remove a command. "
711
"list_commands should return the updated set of command names.",
714
Command.hooks = CommandHooks()
717
529
def parse_args(command, argv, alias_argv=None):
718
530
"""Parse command line.
720
532
Arguments and options are parsed at this level before being passed
721
533
down to specific command handlers. This routine knows, from a
722
534
lookup table, something about the available options, what optargs
786
598
tracer = trace.Trace(count=1, trace=0)
787
599
sys.settrace(tracer.globaltrace)
788
threading.settrace(tracer.globaltrace)
791
return exception_to_return_code(the_callable, *args, **kwargs)
794
results = tracer.results()
795
results.write_results(show_missing=1, summary=False,
601
ret = the_callable(*args, **kwargs)
604
results = tracer.results()
605
results.write_results(show_missing=1, summary=False,
799
609
def apply_profiled(the_callable, *args, **kwargs):
820
629
os.remove(pfname)
823
def exception_to_return_code(the_callable, *args, **kwargs):
824
"""UI level helper for profiling and coverage.
826
This transforms exceptions into a return value of 3. As such its only
827
relevant to the UI layer, and should never be called where catching
828
exceptions may be desirable.
831
return the_callable(*args, **kwargs)
832
except (KeyboardInterrupt, Exception), e:
833
# used to handle AssertionError and KeyboardInterrupt
834
# specially here, but hopefully they're handled ok by the logger now
835
exc_info = sys.exc_info()
836
exitcode = trace.report_exception(exc_info, sys.stderr)
837
if os.environ.get('BZR_PDB'):
838
print '**** entering debugger'
841
if sys.version_info[:2] < (2, 6):
843
# pdb.post_mortem(tb)
844
# but because pdb.post_mortem gives bad results for tracebacks
845
# from inside generators, we do it manually.
846
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
848
# Setup pdb on the traceback
851
p.setup(tb.tb_frame, tb)
852
# Point the debugger at the deepest frame of the stack
853
p.curindex = len(p.stack) - 1
854
p.curframe = p.stack[p.curindex][0]
855
# Start the pdb prompt.
856
p.print_stack_entry(p.stack[p.curindex])
864
632
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
865
633
from bzrlib.lsprof import profile
866
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
634
ret, stats = profile(the_callable, *args, **kwargs)
868
636
if filename is None:
1061
813
return ignore_pipe
1064
def install_bzr_command_hooks():
1065
"""Install the hooks to supply bzr's own commands."""
1066
if _list_bzr_commands in Command.hooks["list_commands"]:
1068
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1070
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1072
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1073
"bzr plugin commands")
1074
Command.hooks.install_named_hook("get_command", _get_external_command,
1075
"bzr external command lookup")
1076
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1077
"bzr plugin-provider-db check")
1081
def _specified_or_unicode_argv(argv):
1082
# For internal or testing use, argv can be passed. Otherwise, get it from
1083
# the process arguments in a unicode-safe way.
1085
return osutils.get_unicode_argv()
1089
# ensure all arguments are unicode strings
1091
if isinstance(a, unicode):
1094
new_argv.append(a.decode('ascii'))
1095
except UnicodeDecodeError:
1096
raise errors.BzrError("argv should be list of unicode strings.")
1100
def main(argv=None):
1101
"""Main entry point of command-line interface.
1103
Typically `bzrlib.initialize` should be called first.
1105
:param argv: list of unicode command-line arguments similar to sys.argv.
1106
argv[0] is script name usually, it will be ignored.
1107
Don't pass here sys.argv because this list contains plain strings
1108
and not unicode; pass None instead.
1110
:return: exit code of bzr command.
1112
argv = _specified_or_unicode_argv(argv)
818
from bzrlib.ui.text import TextUIFactory
819
bzrlib.ui.ui_factory = TextUIFactory()
821
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
822
except UnicodeDecodeError:
823
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
1113
825
ret = run_bzr_catch_errors(argv)
1114
bzrlib.ui.ui_factory.log_transport_activity(
1115
display=('bytes' in debug.debug_flags))
1116
826
trace.mutter("return code %d", ret)
1120
830
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
# done here so that they're covered for every test run
1127
install_bzr_command_hooks()
1128
return exception_to_return_code(run_bzr, argv)
831
# Note: The except clause logic below should be kept in sync with the
832
# profile() routine in lsprof.py.
835
except (KeyboardInterrupt, Exception), e:
836
# used to handle AssertionError and KeyboardInterrupt
837
# specially here, but hopefully they're handled ok by the logger now
838
exitcode = trace.report_exception(sys.exc_info(), sys.stderr)
839
if os.environ.get('BZR_PDB'):
840
print '**** entering debugger'
842
pdb.post_mortem(sys.exc_traceback)
1131
846
def run_bzr_catch_user_errors(argv):
added
removed
bzrlib/commands.py
