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
_register_builtin_commands()
226
return builtin_command_registry.keys()
229
149
def plugin_command_names():
230
"""Returns command names from commands registered by plugins."""
231
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():
234
167
def get_cmd_object(cmd_name, plugins_override=True):
235
"""Return the command object for a command.
168
"""Return the canonical name and command class for a command.
238
171
If true, plugin commands can override builtins.
241
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']:
243
180
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
246
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
247
"""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
249
:param cmd_name: The name of the command.
250
:param plugins_override: Allow plugins to override builtins.
251
:param check_missing: Look up commands not found in the regular index via
252
the get_missing_command hook.
253
:return: A Command object instance
254
:raises KeyError: If no command is found.
256
187
# We want only 'ascii' command names, but the user may have typed
257
188
# in a Unicode name. In that case, they should just get a
258
189
# 'command not found' error later.
259
190
# In the future, we may actually support Unicode command names.
262
for hook in Command.hooks['get_command']:
263
cmd = hook(cmd, cmd_name)
264
if cmd is not None and not plugins_override and not cmd.plugin_name():
265
# We've found a non-plugin command, don't permit it to be
268
if cmd is None and check_missing:
269
for hook in Command.hooks['get_missing_command']:
276
# Allow plugins to extend commands
277
for hook in Command.hooks['extend_command']:
282
def _try_plugin_provider(cmd_name):
283
"""Probe for a plugin provider having cmd_name."""
285
plugin_metadata, provider = probe_for_provider(cmd_name)
286
raise errors.CommandAvailableInPlugin(cmd_name,
287
plugin_metadata, provider)
288
except errors.NoPluginAvailable:
292
def probe_for_provider(cmd_name):
293
"""Look for a provider for cmd_name.
295
:param cmd_name: The command name.
296
:return: plugin_metadata, provider for getting cmd_name.
297
:raises NoPluginAvailable: When no provider can supply the plugin.
299
# look for providers that provide this command but aren't installed
300
for provider in command_providers_registry:
192
# first look up this command under the specified name
302
return provider.plugin_for_command(cmd_name), provider
303
except errors.NoPluginAvailable:
195
return plugin_cmds.get(cmd_name)()
305
raise errors.NoPluginAvailable(cmd_name)
308
def _get_bzr_command(cmd_or_None, cmd_name):
309
"""Get a command from bzr's core."""
198
cmds = _get_cmd_dict(plugins_override=False)
311
cmd_class = builtin_command_registry.get(cmd_name)
200
return cmds[cmd_name]()
319
def _get_external_command(cmd_or_None, cmd_name):
320
"""Lookup a command that is a shell script."""
321
# Only do external command lookups when no command is found so far.
322
if cmd_or_None is not None:
324
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:
325
213
cmd_obj = ExternalCommand.find_command(cmd_name)
330
def _get_plugin_command(cmd_or_None, cmd_name):
331
"""Get a command from bzr's plugins."""
333
return plugin_cmds.get(cmd_name)()
336
for key in plugin_cmds.keys():
337
info = plugin_cmds.get_info(key)
338
if cmd_name in info.aliases:
339
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)
343
229
class Command(object):
411
291
encoding_type = 'strict'
415
295
def __init__(self):
416
296
"""Construct an instance of this command."""
297
if self.__doc__ == Command.__doc__:
298
warn("No help message set for %r" % self)
417
299
# List of standard options directly supported
418
300
self.supported_std_options = []
421
def add_cleanup(self, cleanup_func, *args, **kwargs):
422
"""Register a function to call after self.run returns or raises.
424
Functions will be called in LIFO order.
426
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
428
def cleanup_now(self):
429
"""Execute and empty pending cleanup functions immediately.
431
After cleanup_now all registered cleanups are forgotten. add_cleanup
432
may be called again after cleanup_now; these cleanups will be called
433
after self.run returns or raises (or when cleanup_now is next called).
435
This is useful for releasing expensive or contentious resources (such
436
as write locks) before doing further work that does not require those
437
resources (such as writing results to self.outf). Note though, that
438
as it releases all resources, this may release locks that the command
439
wants to hold, so use should be done with care.
441
self._operation.cleanup_now()
443
@deprecated_method(deprecated_in((2, 1, 0)))
444
302
def _maybe_expand_globs(self, file_list):
445
303
"""Glob expand file_list if the platform does not do that itself.
447
Not used anymore, now that the bzr command-line parser globs on
450
305
:return: A possibly empty list of unicode paths.
452
307
Introduced in bzrlib 0.18.
311
if sys.platform == 'win32':
312
file_list = win32utils.glob_expand(file_list)
313
return list(file_list)
456
315
def _usage(self):
457
316
"""Return single-line grammar for this command.
530
374
result += options
534
# Add the description, indenting it 2 spaces
535
# to match the indentation of the options
536
if sections.has_key(None):
537
text = sections.pop(None)
538
text = '\n '.join(text.splitlines())
539
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)
541
# Add the custom sections (e.g. Examples). Note that there's no need
542
# to indent these as they must be indented already in the source.
545
if sections.has_key(label):
546
result += ':%s:\n%s\n' % (label,sections[label])
549
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.
388
if sections.has_key(label):
389
result += ':%s:\n%s\n\n' % (label,sections[label])
552
391
# Add the aliases, source (plug-in) and see also links, if any
653
491
def _setup_outf(self):
654
492
"""Return a file linked to stdout, which has proper encoding."""
655
self.outf = ui.ui_factory.make_output_stream(
656
encoding_type=self.encoding_type)
493
# Originally I was using self.stdout, but that looks
494
# *way* too much like sys.stdout
495
if self.encoding_type == 'exact':
496
# force sys.stdout to be binary stream on win32
497
if sys.platform == 'win32':
498
fileno = getattr(sys.stdout, 'fileno', None)
501
msvcrt.setmode(fileno(), os.O_BINARY)
502
self.outf = sys.stdout
505
output_encoding = osutils.get_terminal_encoding()
507
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
508
errors=self.encoding_type)
509
# For whatever reason codecs.getwriter() does not advertise its encoding
510
# it just returns the encoding of the wrapped file, which is completely
511
# bogus. So set the attribute, so we can find the correct encoding later.
512
self.outf.encoding = output_encoding
658
514
def run_argv_aliases(self, argv, alias_argv=None):
659
515
"""Parse the command line and run with extra aliases in alias_argv."""
517
warn("Passing None for [] is deprecated from bzrlib 0.10",
518
DeprecationWarning, stacklevel=2)
660
520
args, opts = parse_args(self, argv, alias_argv)
662
522
# Process the standard options
663
523
if 'help' in opts: # e.g. bzr add --help
664
524
sys.stdout.write(self.get_help_text())
666
if 'usage' in opts: # e.g. bzr add --usage
667
sys.stdout.write(self.get_help_text(verbose=False))
669
526
trace.set_verbosity_level(option._verbosity_level)
670
527
if 'verbose' in self.supported_std_options:
671
528
opts['verbose'] = trace.is_verbose()
770
593
Hooks.__init__(self)
771
self.create_hook(HookPoint('extend_command',
772
"Called after creating a command object to allow modifications "
773
"such as adding or removing options, docs etc. Called with the "
774
"new bzrlib.commands.Command object.", (1, 13), None))
775
self.create_hook(HookPoint('get_command',
776
"Called when creating a single command. Called with "
777
"(cmd_or_None, command_name). get_command should either return "
778
"the cmd_or_None parameter, or a replacement Command object that "
779
"should be used for the command. Note that the Command.hooks "
780
"hooks are core infrastructure. Many users will prefer to use "
781
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
783
self.create_hook(HookPoint('get_missing_command',
784
"Called when creating a single command if no command could be "
785
"found. Called with (command_name). get_missing_command should "
786
"either return None, or a Command object to be used for the "
787
"command.", (1, 17), None))
788
self.create_hook(HookPoint('list_commands',
789
"Called when enumerating commands. Called with a set of "
790
"cmd_name strings for all the commands found so far. This set "
791
" is safe to mutate - e.g. to remove a command. "
792
"list_commands should return the updated set of command names.",
594
# Introduced in 1.13:
595
# invoked after creating a command object to allow modifications such
596
# as adding or removing options, docs etc. Invoked with the command
598
self['extend_command'] = []
795
600
Command.hooks = CommandHooks()
798
603
def parse_args(command, argv, alias_argv=None):
799
604
"""Parse command line.
801
606
Arguments and options are parsed at this level before being passed
802
607
down to specific command handlers. This routine knows, from a
803
608
lookup table, something about the available options, what optargs
901
703
os.remove(pfname)
904
def exception_to_return_code(the_callable, *args, **kwargs):
905
"""UI level helper for profiling and coverage.
907
This transforms exceptions into a return value of 3. As such its only
908
relevant to the UI layer, and should never be called where catching
909
exceptions may be desirable.
912
return the_callable(*args, **kwargs)
913
except (KeyboardInterrupt, Exception), e:
914
# used to handle AssertionError and KeyboardInterrupt
915
# specially here, but hopefully they're handled ok by the logger now
916
exc_info = sys.exc_info()
917
exitcode = trace.report_exception(exc_info, sys.stderr)
918
if os.environ.get('BZR_PDB'):
919
print '**** entering debugger'
922
if sys.version_info[:2] < (2, 6):
924
# pdb.post_mortem(tb)
925
# but because pdb.post_mortem gives bad results for tracebacks
926
# from inside generators, we do it manually.
927
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
929
# Setup pdb on the traceback
932
p.setup(tb.tb_frame, tb)
933
# Point the debugger at the deepest frame of the stack
934
p.curindex = len(p.stack) - 1
935
p.curframe = p.stack[p.curindex][0]
936
# Start the pdb prompt.
937
p.print_stack_entry(p.stack[p.curindex])
945
706
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
946
707
from bzrlib.lsprof import profile
947
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
708
ret, stats = profile(the_callable, *args, **kwargs)
949
710
if filename is None:
974
735
config = bzrlib.config.GlobalConfig()
975
736
alias = config.get_alias(cmd)
977
return cmdline.split(alias)
738
return shlex_split_unicode(alias)
981
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
982
743
"""Execute a command.
984
:param argv: The command-line arguments, without the program name from
985
argv[0] These should already be decoded. All library/test code calling
986
run_bzr should be passing valid strings (don't need decoding).
987
:param load_plugins: What function to call when triggering plugin loading.
988
This function should take no arguments and cause all plugins to be
990
:param disable_plugins: What function to call when disabling plugin
991
loading. This function should take no arguments and cause all plugin
992
loading to be prohibited (so that code paths in your application that
993
know about some plugins possibly being present will fail to import
994
those plugins even if they are installed.)
995
:return: Returns a command exit code or raises an exception.
746
The command-line arguments, without the program name from argv[0]
747
These should already be decoded. All library/test code calling
748
run_bzr should be passing valid strings (don't need decoding).
750
Returns a command status or raises an exception.
997
752
Special master options: these must come before the command because
998
753
they control how the command is interpreted.
1049
800
opt_no_aliases = True
1050
801
elif a == '--builtin':
1051
802
opt_builtin = True
1052
elif a == '--concurrency':
1053
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1055
803
elif a == '--coverage':
1056
804
opt_coverage_dir = argv[i + 1]
1058
elif a == '--profile-imports':
1059
pass # already handled in startup script Bug #588277
1060
806
elif a.startswith('-D'):
1061
807
debug.debug_flags.add(a[2:])
1063
809
argv_copy.append(a)
1066
debug.set_debug_flags_from_config()
814
from bzrlib.builtins import cmd_help
815
cmd_help().run_argv_aliases([])
818
if argv[0] == '--version':
819
from bzrlib.builtins import cmd_version
820
cmd_version().run_argv_aliases([])
1068
823
if not opt_no_plugins:
824
from bzrlib.plugin import load_plugins
827
from bzrlib.plugin import disable_plugins
1071
828
disable_plugins()
1075
get_cmd_object('help').run_argv_aliases([])
1078
if argv[0] == '--version':
1079
get_cmd_object('version').run_argv_aliases([])
1082
830
alias_argv = None
1084
832
if not opt_no_aliases:
1085
833
alias_argv = get_alias(argv[0])
835
user_encoding = osutils.get_user_encoding()
836
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1087
837
argv[0] = alias_argv.pop(0)
1089
839
cmd = argv.pop(0)
840
# We want only 'ascii' command names, but the user may have typed
841
# in a Unicode name. In that case, they should just get a
842
# 'command not found' error later.
1090
844
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1091
845
run = cmd_obj.run_argv_aliases
1092
846
run_argv = [argv, alias_argv]
1140
894
return ignore_pipe
1143
def install_bzr_command_hooks():
1144
"""Install the hooks to supply bzr's own commands."""
1145
if _list_bzr_commands in Command.hooks["list_commands"]:
1147
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1149
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1151
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1152
"bzr plugin commands")
1153
Command.hooks.install_named_hook("get_command", _get_external_command,
1154
"bzr external command lookup")
1155
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1156
"bzr plugin-provider-db check")
1160
def _specified_or_unicode_argv(argv):
1161
# For internal or testing use, argv can be passed. Otherwise, get it from
1162
# the process arguments in a unicode-safe way.
1164
return osutils.get_unicode_argv()
1168
# ensure all arguments are unicode strings
1170
if isinstance(a, unicode):
1173
new_argv.append(a.decode('ascii'))
1174
except UnicodeDecodeError:
1175
raise errors.BzrError("argv should be list of unicode strings.")
1179
def main(argv=None):
1180
"""Main entry point of command-line interface.
1182
Typically `bzrlib.initialize` should be called first.
1184
:param argv: list of unicode command-line arguments similar to sys.argv.
1185
argv[0] is script name usually, it will be ignored.
1186
Don't pass here sys.argv because this list contains plain strings
1187
and not unicode; pass None instead.
1189
:return: exit code of bzr command.
1191
argv = _specified_or_unicode_argv(argv)
1192
_register_builtin_commands()
899
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
900
sys.stdin, sys.stdout, sys.stderr)
902
# Is this a final release version? If so, we should suppress warnings
903
if bzrlib.version_info[3] == 'final':
904
from bzrlib import symbol_versioning
905
symbol_versioning.suppress_deprecation_warnings(override=False)
907
user_encoding = osutils.get_user_encoding()
908
argv = [a.decode(user_encoding) for a in argv[1:]]
909
except UnicodeDecodeError:
910
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
1193
912
ret = run_bzr_catch_errors(argv)
1194
bzrlib.ui.ui_factory.log_transport_activity(
1195
display=('bytes' in debug.debug_flags))
1196
913
trace.mutter("return code %d", ret)
1200
917
def run_bzr_catch_errors(argv):
1201
"""Run a bzr command with parameters as described by argv.
1203
This function assumed that that UI layer is setup, that symbol deprecations
1204
are already applied, and that unicode decoding has already been performed on argv.
1206
# done here so that they're covered for every test run
1207
install_bzr_command_hooks()
1208
return exception_to_return_code(run_bzr, argv)
918
# Note: The except clause logic below should be kept in sync with the
919
# profile() routine in lsprof.py.
922
except (KeyboardInterrupt, Exception), e:
923
# used to handle AssertionError and KeyboardInterrupt
924
# specially here, but hopefully they're handled ok by the logger now
925
exc_info = sys.exc_info()
926
exitcode = trace.report_exception(exc_info, sys.stderr)
927
if os.environ.get('BZR_PDB'):
928
print '**** entering debugger'
931
if sys.version_info[:2] < (2, 6):
933
# pdb.post_mortem(tb)
934
# but because pdb.post_mortem gives bad results for tracebacks
935
# from inside generators, we do it manually.
936
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
938
# Setup pdb on the traceback
941
p.setup(tb.tb_frame, tb)
942
# Point the debugger at the deepest frame of the stack
943
p.curindex = len(p.stack) - 1
944
p.curframe = p.stack[p.curindex]
945
# Start the pdb prompt.
946
p.print_stack_entry(p.stack[p.curindex])
1211
954
def run_bzr_catch_user_errors(argv):
added
removed
bzrlib/commands.py
