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.
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()
145
"""Return list of builtin command names."""
146
return _builtin_commands().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):
408
295
def __init__(self):
409
296
"""Construct an instance of this command."""
410
if self.__doc__ == Command.__doc__ or not self.__doc__:
411
raise ValueError("No help message set for %r" % self)
297
if self.__doc__ == Command.__doc__:
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.
650
500
def _setup_outf(self):
651
501
"""Return a file linked to stdout, which has proper encoding."""
652
self.outf = ui.ui_factory.make_output_stream(
653
encoding_type=self.encoding_type)
502
# Originally I was using self.stdout, but that looks
503
# *way* too much like sys.stdout
504
if self.encoding_type == 'exact':
505
# force sys.stdout to be binary stream on win32
506
if sys.platform == 'win32':
507
fileno = getattr(sys.stdout, 'fileno', None)
510
msvcrt.setmode(fileno(), os.O_BINARY)
511
self.outf = sys.stdout
514
output_encoding = osutils.get_terminal_encoding()
516
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
517
errors=self.encoding_type)
518
# For whatever reason codecs.getwriter() does not advertise its encoding
519
# it just returns the encoding of the wrapped file, which is completely
520
# bogus. So set the attribute, so we can find the correct encoding later.
521
self.outf.encoding = output_encoding
655
523
def run_argv_aliases(self, argv, alias_argv=None):
656
524
"""Parse the command line and run with extra aliases in alias_argv."""
526
warn("Passing None for [] is deprecated from bzrlib 0.10",
527
DeprecationWarning, stacklevel=2)
657
529
args, opts = parse_args(self, argv, alias_argv)
659
531
# Process the standard options
769
607
"Called after creating a command object to allow modifications "
770
608
"such as adding or removing options, docs etc. Called with the "
771
609
"new bzrlib.commands.Command object.", (1, 13), None))
772
self.create_hook(HookPoint('get_command',
773
"Called when creating a single command. Called with "
774
"(cmd_or_None, command_name). get_command should either return "
775
"the cmd_or_None parameter, or a replacement Command object that "
776
"should be used for the command. Note that the Command.hooks "
777
"hooks are core infrastructure. Many users will prefer to use "
778
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
780
self.create_hook(HookPoint('get_missing_command',
781
"Called when creating a single command if no command could be "
782
"found. Called with (command_name). get_missing_command should "
783
"either return None, or a Command object to be used for the "
784
"command.", (1, 17), None))
785
self.create_hook(HookPoint('list_commands',
786
"Called when enumerating commands. Called with a set of "
787
"cmd_name strings for all the commands found so far. This set "
788
" is safe to mutate - e.g. to remove a command. "
789
"list_commands should return the updated set of command names.",
792
611
Command.hooks = CommandHooks()
971
789
config = bzrlib.config.GlobalConfig()
972
790
alias = config.get_alias(cmd)
974
return cmdline.split(alias)
792
return shlex_split_unicode(alias)
978
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
979
797
"""Execute a command.
981
:param argv: The command-line arguments, without the program name from
982
argv[0] These should already be decoded. All library/test code calling
983
run_bzr should be passing valid strings (don't need decoding).
984
:param load_plugins: What function to call when triggering plugin loading.
985
This function should take no arguments and cause all plugins to be
987
:param disable_plugins: What function to call when disabling plugin
988
loading. This function should take no arguments and cause all plugin
989
loading to be prohibited (so that code paths in your application that
990
know about some plugins possibly being present will fail to import
991
those plugins even if they are installed.)
992
:return: Returns a command exit code or raises an exception.
800
The command-line arguments, without the program name from argv[0]
801
These should already be decoded. All library/test code calling
802
run_bzr should be passing valid strings (don't need decoding).
804
Returns a command status or raises an exception.
994
806
Special master options: these must come before the command because
995
807
they control how the command is interpreted.
1135
950
return ignore_pipe
1138
def install_bzr_command_hooks():
1139
"""Install the hooks to supply bzr's own commands."""
1140
if _list_bzr_commands in Command.hooks["list_commands"]:
1142
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1144
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1146
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1147
"bzr plugin commands")
1148
Command.hooks.install_named_hook("get_command", _get_external_command,
1149
"bzr external command lookup")
1150
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1151
"bzr plugin-provider-db check")
1155
def _specified_or_unicode_argv(argv):
1156
# For internal or testing use, argv can be passed. Otherwise, get it from
1157
# the process arguments in a unicode-safe way.
1159
return osutils.get_unicode_argv()
1163
# ensure all arguments are unicode strings
1165
if isinstance(a, unicode):
1168
new_argv.append(a.decode('ascii'))
1169
except UnicodeDecodeError:
1170
raise errors.BzrError("argv should be list of unicode strings.")
1174
def main(argv=None):
1175
"""Main entry point of command-line interface.
1177
Typically `bzrlib.initialize` should be called first.
1179
:param argv: list of unicode command-line arguments similar to sys.argv.
1180
argv[0] is script name usually, it will be ignored.
1181
Don't pass here sys.argv because this list contains plain strings
1182
and not unicode; pass None instead.
1184
:return: exit code of bzr command.
1186
argv = _specified_or_unicode_argv(argv)
1187
_register_builtin_commands()
955
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
956
sys.stdin, sys.stdout, sys.stderr)
958
# Is this a final release version? If so, we should suppress warnings
959
if bzrlib.version_info[3] == 'final':
960
from bzrlib import symbol_versioning
961
symbol_versioning.suppress_deprecation_warnings(override=False)
963
user_encoding = osutils.get_user_encoding()
964
argv = [a.decode(user_encoding) for a in argv[1:]]
965
except UnicodeDecodeError:
966
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
1188
968
ret = run_bzr_catch_errors(argv)
1189
bzrlib.ui.ui_factory.log_transport_activity(
1190
display=('bytes' in debug.debug_flags))
1191
969
trace.mutter("return code %d", ret)
added
removed
bzrlib/commands.py
