165
130
return cmd[4:].replace('_','-')
168
@deprecated_function(deprecated_in((2, 2, 0)))
169
133
def _builtin_commands():
170
"""Return a dict of {name: cmd_class} for builtin commands.
172
:deprecated: Use the builtin_command_registry registry instead
174
# return dict(name: cmd_class)
175
return dict(builtin_command_registry.items())
178
def _register_builtin_commands():
179
if builtin_command_registry.keys():
182
134
import bzrlib.builtins
183
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
184
builtin_command_registry.register(cmd_class)
185
bzrlib.builtins._register_lazy_builtins()
188
def _scan_module_for_commands(module):
190
for name, obj in module.__dict__.iteritems():
136
builtins = bzrlib.builtins.__dict__
137
for name in builtins:
191
138
if name.startswith("cmd_"):
192
139
real_name = _unsquish_command_name(name)
140
r[real_name] = builtins[name]
197
def _list_bzr_commands(names):
198
"""Find commands from bzr's core and plugins.
200
This is not the public interface, just the default hook called by all_command_names.
202
# to eliminate duplicates
203
names.update(builtin_command_names())
204
names.update(plugin_command_names())
208
def all_command_names():
209
"""Return a set of all command names."""
211
for hook in Command.hooks['list_commands']:
214
raise AssertionError(
215
'hook %s returned None' % Command.hooks.get_hook_name(hook))
219
144
def builtin_command_names():
220
"""Return list of builtin command names.
145
"""Return list of builtin command names."""
146
return _builtin_commands().keys()
222
Use of all_command_names() is encouraged rather than builtin_command_names
223
and/or plugin_command_names.
225
return builtin_command_registry.keys()
228
149
def plugin_command_names():
229
"""Returns command names from commands registered by plugins."""
230
150
return plugin_cmds.keys()
153
def _get_cmd_dict(plugins_override=True):
154
"""Return name->class mapping for all commands."""
155
d = _builtin_commands()
157
d.update(plugin_cmds.iteritems())
161
def get_all_cmds(plugins_override=True):
162
"""Return canonical name and class for all registered commands."""
163
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
233
167
def get_cmd_object(cmd_name, plugins_override=True):
234
"""Return the command object for a command.
168
"""Return the canonical name and command class for a command.
237
171
If true, plugin commands can override builtins.
240
return _get_cmd_object(cmd_name, plugins_override)
174
cmd = _get_cmd_object(cmd_name, plugins_override)
175
# Allow plugins to extend commands
176
for hook in Command.hooks['extend_command']:
242
180
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
246
"""Get a command object.
183
def _get_cmd_object(cmd_name, plugins_override=True):
184
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
185
from bzrlib.externalcommand import ExternalCommand
248
:param cmd_name: The name of the command.
249
:param plugins_override: Allow plugins to override builtins.
250
:param check_missing: Look up commands not found in the regular index via
251
the get_missing_command hook.
252
:return: A Command object instance
253
:raises KeyError: If no command is found.
255
187
# We want only 'ascii' command names, but the user may have typed
256
188
# in a Unicode name. In that case, they should just get a
257
189
# 'command not found' error later.
258
190
# In the future, we may actually support Unicode command names.
261
for hook in Command.hooks['get_command']:
262
cmd = hook(cmd, cmd_name)
263
if cmd is not None and not plugins_override and not cmd.plugin_name():
264
# We've found a non-plugin command, don't permit it to be
267
if cmd is None and check_missing:
268
for hook in Command.hooks['get_missing_command']:
275
# Allow plugins to extend commands
276
for hook in Command.hooks['extend_command']:
281
def _try_plugin_provider(cmd_name):
282
"""Probe for a plugin provider having cmd_name."""
284
plugin_metadata, provider = probe_for_provider(cmd_name)
285
raise errors.CommandAvailableInPlugin(cmd_name,
286
plugin_metadata, provider)
287
except errors.NoPluginAvailable:
291
def probe_for_provider(cmd_name):
292
"""Look for a provider for cmd_name.
294
:param cmd_name: The command name.
295
:return: plugin_metadata, provider for getting cmd_name.
296
:raises NoPluginAvailable: When no provider can supply the plugin.
298
# look for providers that provide this command but aren't installed
299
for provider in command_providers_registry:
192
# first look up this command under the specified name
301
return provider.plugin_for_command(cmd_name), provider
302
except errors.NoPluginAvailable:
195
return plugin_cmds.get(cmd_name)()
304
raise errors.NoPluginAvailable(cmd_name)
307
def _get_bzr_command(cmd_or_None, cmd_name):
308
"""Get a command from bzr's core."""
198
cmds = _get_cmd_dict(plugins_override=False)
310
cmd_class = builtin_command_registry.get(cmd_name)
200
return cmds[cmd_name]()
318
def _get_external_command(cmd_or_None, cmd_name):
319
"""Lookup a command that is a shell script."""
320
# Only do external command lookups when no command is found so far.
321
if cmd_or_None is not None:
323
from bzrlib.externalcommand import ExternalCommand
204
for key in plugin_cmds.keys():
205
info = plugin_cmds.get_info(key)
206
if cmd_name in info.aliases:
207
return plugin_cmds.get(key)()
208
# look for any command which claims this as an alias
209
for real_cmd_name, cmd_class in cmds.iteritems():
210
if cmd_name in cmd_class.aliases:
324
213
cmd_obj = ExternalCommand.find_command(cmd_name)
329
def _get_plugin_command(cmd_or_None, cmd_name):
330
"""Get a command from bzr's plugins."""
332
return plugin_cmds.get(cmd_name)()
335
for key in plugin_cmds.keys():
336
info = plugin_cmds.get_info(key)
337
if cmd_name in info.aliases:
338
return plugin_cmds.get(key)()
217
# look for plugins that provide this command but aren't installed
218
for provider in command_providers_registry:
220
plugin_metadata = provider.plugin_for_command(cmd_name)
221
except errors.NoPluginAvailable:
224
raise errors.CommandAvailableInPlugin(cmd_name,
225
plugin_metadata, provider)
342
229
class Command(object):
404
291
encoding_type = 'strict'
408
295
def __init__(self):
409
296
"""Construct an instance of this command."""
410
297
if self.__doc__ == Command.__doc__:
411
298
warn("No help message set for %r" % self)
412
299
# List of standard options directly supported
413
300
self.supported_std_options = []
416
def add_cleanup(self, cleanup_func, *args, **kwargs):
417
"""Register a function to call after self.run returns or raises.
419
Functions will be called in LIFO order.
421
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
423
def cleanup_now(self):
424
"""Execute and empty pending cleanup functions immediately.
426
After cleanup_now all registered cleanups are forgotten. add_cleanup
427
may be called again after cleanup_now; these cleanups will be called
428
after self.run returns or raises (or when cleanup_now is next called).
430
This is useful for releasing expensive or contentious resources (such
431
as write locks) before doing further work that does not require those
432
resources (such as writing results to self.outf). Note though, that
433
as it releases all resources, this may release locks that the command
434
wants to hold, so use should be done with care.
436
self._operation.cleanup_now()
438
@deprecated_method(deprecated_in((2, 1, 0)))
439
302
def _maybe_expand_globs(self, file_list):
440
303
"""Glob expand file_list if the platform does not do that itself.
442
Not used anymore, now that the bzr command-line parser globs on
445
305
:return: A possibly empty list of unicode paths.
447
307
Introduced in bzrlib 0.18.
311
if sys.platform == 'win32':
312
file_list = win32utils.glob_expand(file_list)
313
return list(file_list)
451
315
def _usage(self):
452
316
"""Return single-line grammar for this command.
469
333
def get_help_text(self, additional_see_also=None, plain=True,
470
see_also_as_links=False, verbose=True):
334
see_also_as_links=False):
471
335
"""Return a text string with help for this command.
473
337
:param additional_see_also: Additional help topics to be
474
338
cross-referenced.
475
339
:param plain: if False, raw help (reStructuredText) is
476
340
returned instead of plain text.
477
341
:param see_also_as_links: if True, convert items in 'See also'
478
342
list to internal links (used by bzr_man rstx generator)
479
:param verbose: if True, display the full help, otherwise
480
leave out the descriptive sections and just display
481
usage help (e.g. Purpose, Usage, Options) with a
482
message explaining how to obtain full help.
484
344
doc = self.help()
486
346
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
488
348
# Extract the summary (purpose) and sections out from the text
489
purpose,sections,order = self._get_help_parts(doc)
349
purpose,sections = self._get_help_parts(doc)
491
351
# If a custom usage section was provided, use it
492
352
if sections.has_key('Usage'):
525
374
result += options
529
# Add the description, indenting it 2 spaces
530
# to match the indentation of the options
531
if sections.has_key(None):
532
text = sections.pop(None)
533
text = '\n '.join(text.splitlines())
534
result += ':%s:\n %s\n\n' % ('Description',text)
377
# Add the description, indenting it 2 spaces
378
# to match the indentation of the options
379
if sections.has_key(None):
380
text = sections.pop(None)
381
text = '\n '.join(text.splitlines())
382
result += ':%s:\n %s\n\n' % ('Description',text)
536
# Add the custom sections (e.g. Examples). Note that there's no need
537
# to indent these as they must be indented already in the source.
540
if sections.has_key(label):
541
result += ':%s:\n%s\n' % (label,sections[label])
544
result += ("See bzr help %s for more details and examples.\n\n"
384
# Add the custom sections (e.g. Examples). Note that there's no need
385
# to indent these as they must be indented already in the source.
387
labels = sorted(sections.keys())
389
result += ':%s:\n%s\n\n' % (label,sections[label])
547
391
# Add the aliases, source (plug-in) and see also links, if any
578
421
def _get_help_parts(text):
579
422
"""Split help text into a summary and named sections.
581
:return: (summary,sections,order) where summary is the top line and
424
:return: (summary,sections) where summary is the top line and
582
425
sections is a dictionary of the rest indexed by section name.
583
order is the order the section appear in the text.
584
426
A section starts with a heading line of the form ":xxx:".
585
427
Indented text on following lines is the section value.
586
428
All text found outside a named section is assigned to the
587
429
default section which is given the key of None.
589
def save_section(sections, order, label, section):
431
def save_section(sections, label, section):
590
432
if len(section) > 0:
591
433
if sections.has_key(label):
592
434
sections[label] += '\n' + section
595
436
sections[label] = section
597
438
lines = text.rstrip().splitlines()
598
439
summary = lines.pop(0)
601
441
label,section = None,''
602
442
for line in lines:
603
443
if line.startswith(':') and line.endswith(':') and len(line) > 2:
604
save_section(sections, order, label, section)
444
save_section(sections, label, section)
605
445
label,section = line[1:-1],''
606
446
elif (label is not None) and len(line) > 1 and not line[0].isspace():
607
save_section(sections, order, label, section)
447
save_section(sections, label, section)
608
448
label,section = None,line
610
450
if len(section) > 0:
611
451
section += '\n' + line
614
save_section(sections, order, label, section)
615
return summary, sections, order
454
save_section(sections, label, section)
455
return summary, sections
617
457
def get_help_topic(self):
618
458
"""Return the commands help topic - its name."""
648
488
def _setup_outf(self):
649
489
"""Return a file linked to stdout, which has proper encoding."""
650
self.outf = ui.ui_factory.make_output_stream(
651
encoding_type=self.encoding_type)
490
# Originally I was using self.stdout, but that looks
491
# *way* too much like sys.stdout
492
if self.encoding_type == 'exact':
493
# force sys.stdout to be binary stream on win32
494
if sys.platform == 'win32':
495
fileno = getattr(sys.stdout, 'fileno', None)
498
msvcrt.setmode(fileno(), os.O_BINARY)
499
self.outf = sys.stdout
502
output_encoding = osutils.get_terminal_encoding()
504
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
505
errors=self.encoding_type)
506
# For whatever reason codecs.getwriter() does not advertise its encoding
507
# it just returns the encoding of the wrapped file, which is completely
508
# bogus. So set the attribute, so we can find the correct encoding later.
509
self.outf.encoding = output_encoding
653
511
def run_argv_aliases(self, argv, alias_argv=None):
654
512
"""Parse the command line and run with extra aliases in alias_argv."""
514
warn("Passing None for [] is deprecated from bzrlib 0.10",
515
DeprecationWarning, stacklevel=2)
655
517
args, opts = parse_args(self, argv, alias_argv)
657
519
# Process the standard options
658
520
if 'help' in opts: # e.g. bzr add --help
659
521
sys.stdout.write(self.get_help_text())
661
if 'usage' in opts: # e.g. bzr add --usage
662
sys.stdout.write(self.get_help_text(verbose=False))
664
523
trace.set_verbosity_level(option._verbosity_level)
665
524
if 'verbose' in self.supported_std_options:
666
525
opts['verbose'] = trace.is_verbose()
765
590
Hooks.__init__(self)
766
self.create_hook(HookPoint('extend_command',
767
"Called after creating a command object to allow modifications "
768
"such as adding or removing options, docs etc. Called with the "
769
"new bzrlib.commands.Command object.", (1, 13), None))
770
self.create_hook(HookPoint('get_command',
771
"Called when creating a single command. Called with "
772
"(cmd_or_None, command_name). get_command should either return "
773
"the cmd_or_None parameter, or a replacement Command object that "
774
"should be used for the command. Note that the Command.hooks "
775
"hooks are core infrastructure. Many users will prefer to use "
776
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
778
self.create_hook(HookPoint('get_missing_command',
779
"Called when creating a single command if no command could be "
780
"found. Called with (command_name). get_missing_command should "
781
"either return None, or a Command object to be used for the "
782
"command.", (1, 17), None))
783
self.create_hook(HookPoint('list_commands',
784
"Called when enumerating commands. Called with a set of "
785
"cmd_name strings for all the commands found so far. This set "
786
" is safe to mutate - e.g. to remove a command. "
787
"list_commands should return the updated set of command names.",
591
# Introduced in 0.13:
592
# invoked after creating a command object to allow modifications such
593
# as adding or removing options, docs etc. Invoked with the command
595
self['extend_command'] = []
790
597
Command.hooks = CommandHooks()
793
600
def parse_args(command, argv, alias_argv=None):
794
601
"""Parse command line.
796
603
Arguments and options are parsed at this level before being passed
797
604
down to specific command handlers. This routine knows, from a
798
605
lookup table, something about the available options, what optargs
896
700
os.remove(pfname)
899
def exception_to_return_code(the_callable, *args, **kwargs):
900
"""UI level helper for profiling and coverage.
902
This transforms exceptions into a return value of 3. As such its only
903
relevant to the UI layer, and should never be called where catching
904
exceptions may be desirable.
907
return the_callable(*args, **kwargs)
908
except (KeyboardInterrupt, Exception), e:
909
# used to handle AssertionError and KeyboardInterrupt
910
# specially here, but hopefully they're handled ok by the logger now
911
exc_info = sys.exc_info()
912
exitcode = trace.report_exception(exc_info, sys.stderr)
913
if os.environ.get('BZR_PDB'):
914
print '**** entering debugger'
917
if sys.version_info[:2] < (2, 6):
919
# pdb.post_mortem(tb)
920
# but because pdb.post_mortem gives bad results for tracebacks
921
# from inside generators, we do it manually.
922
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
924
# Setup pdb on the traceback
927
p.setup(tb.tb_frame, tb)
928
# Point the debugger at the deepest frame of the stack
929
p.curindex = len(p.stack) - 1
930
p.curframe = p.stack[p.curindex][0]
931
# Start the pdb prompt.
932
p.print_stack_entry(p.stack[p.curindex])
940
703
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
941
704
from bzrlib.lsprof import profile
942
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
705
ret, stats = profile(the_callable, *args, **kwargs)
944
707
if filename is None:
969
732
config = bzrlib.config.GlobalConfig()
970
733
alias = config.get_alias(cmd)
972
return cmdline.split(alias)
735
return shlex_split_unicode(alias)
976
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
977
740
"""Execute a command.
979
:param argv: The command-line arguments, without the program name from
980
argv[0] These should already be decoded. All library/test code calling
981
run_bzr should be passing valid strings (don't need decoding).
982
:param load_plugins: What function to call when triggering plugin loading.
983
This function should take no arguments and cause all plugins to be
985
:param disable_plugins: What function to call when disabling plugin
986
loading. This function should take no arguments and cause all plugin
987
loading to be prohibited (so that code paths in your application that
988
know about some plugins possibly being present will fail to import
989
those plugins even if they are installed.)
990
:return: Returns a command exit code or raises an exception.
743
The command-line arguments, without the program name from argv[0]
744
These should already be decoded. All library/test code calling
745
run_bzr should be passing valid strings (don't need decoding).
747
Returns a command status or raises an exception.
992
749
Special master options: these must come before the command because
993
750
they control how the command is interpreted.
1139
891
return ignore_pipe
1142
def install_bzr_command_hooks():
1143
"""Install the hooks to supply bzr's own commands."""
1144
if _list_bzr_commands in Command.hooks["list_commands"]:
1146
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1148
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1150
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1151
"bzr plugin commands")
1152
Command.hooks.install_named_hook("get_command", _get_external_command,
1153
"bzr external command lookup")
1154
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1155
"bzr plugin-provider-db check")
1159
def _specified_or_unicode_argv(argv):
1160
# For internal or testing use, argv can be passed. Otherwise, get it from
1161
# the process arguments in a unicode-safe way.
1163
return osutils.get_unicode_argv()
1167
# ensure all arguments are unicode strings
1169
if isinstance(a, unicode):
1172
new_argv.append(a.decode('ascii'))
1173
except UnicodeDecodeError:
1174
raise errors.BzrError("argv should be list of unicode strings.")
1178
def main(argv=None):
1179
"""Main entry point of command-line interface.
1181
Typically `bzrlib.initialize` should be called first.
1183
:param argv: list of unicode command-line arguments similar to sys.argv.
1184
argv[0] is script name usually, it will be ignored.
1185
Don't pass here sys.argv because this list contains plain strings
1186
and not unicode; pass None instead.
1188
:return: exit code of bzr command.
1190
argv = _specified_or_unicode_argv(argv)
1191
_register_builtin_commands()
896
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
897
sys.stdin, sys.stdout, sys.stderr)
899
# Is this a final release version? If so, we should suppress warnings
900
if bzrlib.version_info[3] == 'final':
901
from bzrlib import symbol_versioning
902
symbol_versioning.suppress_deprecation_warnings(override=False)
904
user_encoding = osutils.get_user_encoding()
905
argv = [a.decode(user_encoding) for a in argv[1:]]
906
except UnicodeDecodeError:
907
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
1192
909
ret = run_bzr_catch_errors(argv)
1193
bzrlib.ui.ui_factory.log_transport_activity(
1194
display=('bytes' in debug.debug_flags))
1195
910
trace.mutter("return code %d", ret)
1199
914
def run_bzr_catch_errors(argv):
1200
"""Run a bzr command with parameters as described by argv.
1202
This function assumed that that UI layer is setup, that symbol deprecations
1203
are already applied, and that unicode decoding has already been performed on argv.
1205
# done here so that they're covered for every test run
1206
install_bzr_command_hooks()
1207
return exception_to_return_code(run_bzr, argv)
915
# Note: The except clause logic below should be kept in sync with the
916
# profile() routine in lsprof.py.
919
except (KeyboardInterrupt, Exception), e:
920
# used to handle AssertionError and KeyboardInterrupt
921
# specially here, but hopefully they're handled ok by the logger now
922
exc_info = sys.exc_info()
923
exitcode = trace.report_exception(exc_info, sys.stderr)
924
if os.environ.get('BZR_PDB'):
925
print '**** entering debugger'
928
if sys.version_info[:2] < (2, 6):
930
# pdb.post_mortem(tb)
931
# but because pdb.post_mortem gives bad results for tracebacks
932
# from inside generators, we do it manually.
933
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
935
# Setup pdb on the traceback
938
p.setup(tb.tb_frame, tb)
939
# Point the debugger at the deepest frame of the stack
940
p.curindex = len(p.stack) - 1
941
p.curframe = p.stack[p.curindex]
942
# Start the pdb prompt.
943
p.print_stack_entry(p.stack[p.curindex])
1210
951
def run_bzr_catch_user_errors(argv):
added
removed
bzrlib/commands.py
