164
131
return cmd[4:].replace('_','-')
167
def _register_builtin_commands():
168
if builtin_command_registry.keys():
134
def _builtin_commands():
171
135
import bzrlib.builtins
172
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
173
builtin_command_registry.register(cmd_class)
174
bzrlib.builtins._register_lazy_builtins()
177
def _scan_module_for_commands(module):
179
for name, obj in module.__dict__.iteritems():
137
builtins = bzrlib.builtins.__dict__
138
for name in builtins:
180
139
if name.startswith("cmd_"):
181
140
real_name = _unsquish_command_name(name)
141
r[real_name] = builtins[name]
186
def _list_bzr_commands(names):
187
"""Find commands from bzr's core and plugins.
189
This is not the public interface, just the default hook called by all_command_names.
191
# to eliminate duplicates
192
names.update(builtin_command_names())
193
names.update(plugin_command_names())
197
def all_command_names():
198
"""Return a set of all command names."""
200
for hook in Command.hooks['list_commands']:
203
raise AssertionError(
204
'hook %s returned None' % Command.hooks.get_hook_name(hook))
208
145
def builtin_command_names():
209
"""Return list of builtin command names.
211
Use of all_command_names() is encouraged rather than builtin_command_names
212
and/or plugin_command_names.
214
_register_builtin_commands()
215
return builtin_command_registry.keys()
146
"""Return list of builtin command names."""
147
return _builtin_commands().keys()
218
150
def plugin_command_names():
219
"""Returns command names from commands registered by plugins."""
220
151
return plugin_cmds.keys()
154
def _get_cmd_dict(plugins_override=True):
155
"""Return name->class mapping for all commands."""
156
d = _builtin_commands()
158
d.update(plugin_cmds.iteritems())
162
def get_all_cmds(plugins_override=True):
163
"""Return canonical name and class for all registered commands."""
164
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
223
168
def get_cmd_object(cmd_name, plugins_override=True):
224
"""Return the command object for a command.
169
"""Return the canonical name and command class for a command.
227
172
If true, plugin commands can override builtins.
230
return _get_cmd_object(cmd_name, plugins_override)
175
cmd = _get_cmd_object(cmd_name, plugins_override)
176
# Allow plugins to extend commands
177
for hook in Command.hooks['extend_command']:
232
181
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
235
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
236
"""Get a command object.
184
def _get_cmd_object(cmd_name, plugins_override=True):
185
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
186
from bzrlib.externalcommand import ExternalCommand
238
:param cmd_name: The name of the command.
239
:param plugins_override: Allow plugins to override builtins.
240
:param check_missing: Look up commands not found in the regular index via
241
the get_missing_command hook.
242
:return: A Command object instance
243
:raises KeyError: If no command is found.
245
188
# We want only 'ascii' command names, but the user may have typed
246
189
# in a Unicode name. In that case, they should just get a
247
190
# 'command not found' error later.
248
191
# In the future, we may actually support Unicode command names.
251
for hook in Command.hooks['get_command']:
252
cmd = hook(cmd, cmd_name)
253
if cmd is not None and not plugins_override and not cmd.plugin_name():
254
# We've found a non-plugin command, don't permit it to be
257
if cmd is None and check_missing:
258
for hook in Command.hooks['get_missing_command']:
265
# Allow plugins to extend commands
266
for hook in Command.hooks['extend_command']:
268
if getattr(cmd, 'invoked_as', None) is None:
269
cmd.invoked_as = cmd_name
273
def _try_plugin_provider(cmd_name):
274
"""Probe for a plugin provider having cmd_name."""
276
plugin_metadata, provider = probe_for_provider(cmd_name)
277
raise errors.CommandAvailableInPlugin(cmd_name,
278
plugin_metadata, provider)
279
except errors.NoPluginAvailable:
283
def probe_for_provider(cmd_name):
284
"""Look for a provider for cmd_name.
286
:param cmd_name: The command name.
287
:return: plugin_metadata, provider for getting cmd_name.
288
:raises NoPluginAvailable: When no provider can supply the plugin.
290
# look for providers that provide this command but aren't installed
291
for provider in command_providers_registry:
193
# first look up this command under the specified name
293
return provider.plugin_for_command(cmd_name), provider
294
except errors.NoPluginAvailable:
196
return plugin_cmds.get(cmd_name)()
296
raise errors.NoPluginAvailable(cmd_name)
299
def _get_bzr_command(cmd_or_None, cmd_name):
300
"""Get a command from bzr's core."""
199
cmds = _get_cmd_dict(plugins_override=False)
302
cmd_class = builtin_command_registry.get(cmd_name)
201
return cmds[cmd_name]()
310
def _get_external_command(cmd_or_None, cmd_name):
311
"""Lookup a command that is a shell script."""
312
# Only do external command lookups when no command is found so far.
313
if cmd_or_None is not None:
315
from bzrlib.externalcommand import ExternalCommand
205
for key in plugin_cmds.keys():
206
info = plugin_cmds.get_info(key)
207
if cmd_name in info.aliases:
208
return plugin_cmds.get(key)()
209
# look for any command which claims this as an alias
210
for real_cmd_name, cmd_class in cmds.iteritems():
211
if cmd_name in cmd_class.aliases:
316
214
cmd_obj = ExternalCommand.find_command(cmd_name)
321
def _get_plugin_command(cmd_or_None, cmd_name):
322
"""Get a command from bzr's plugins."""
324
return plugin_cmds.get(cmd_name)()
327
for key in plugin_cmds.keys():
328
info = plugin_cmds.get_info(key)
329
if cmd_name in info.aliases:
330
return plugin_cmds.get(key)()
218
# look for plugins that provide this command but aren't installed
219
for provider in command_providers_registry:
221
plugin_metadata = provider.plugin_for_command(cmd_name)
222
except errors.NoPluginAvailable:
225
raise errors.CommandAvailableInPlugin(cmd_name,
226
plugin_metadata, provider)
334
230
class Command(object):
349
245
summary, then a complete description of the command. A grammar
350
246
description will be inserted.
352
:cvar aliases: Other accepted names for this command.
354
:cvar takes_args: List of argument forms, marked with whether they are
355
optional, repeated, etc. Examples::
357
['to_location', 'from_branch?', 'file*']
359
* 'to_location' is required
360
* 'from_branch' is optional
361
* 'file' can be specified 0 or more times
363
:cvar takes_options: List of options that may be given for this command.
364
These can be either strings, referring to globally-defined options, or
365
option objects. Retrieve through options().
367
:cvar hidden: If true, this command isn't advertised. This is typically
249
Other accepted names for this command.
252
List of argument forms, marked with whether they are optional,
257
['to_location', 'from_branch?', 'file*']
259
'to_location' is required
260
'from_branch' is optional
261
'file' can be specified 0 or more times
264
List of options that may be given for this command. These can
265
be either strings, referring to globally-defined options,
266
or option objects. Retrieve through options().
269
If true, this command isn't advertised. This is typically
368
270
for commands intended for expert users.
370
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
371
been setup to properly handle encoding of unicode strings.
372
encoding_type determines what will happen when characters cannot be
375
* strict - abort if we cannot decode
376
* replace - put in a bogus character (typically '?')
377
* exact - do not encode sys.stdout
379
NOTE: by default on Windows, sys.stdout is opened as a text stream,
380
therefore LF line-endings are converted to CRLF. When a command uses
381
encoding_type = 'exact', then sys.stdout is forced to be a binary
382
stream, and line-endings will not mangled.
385
A string indicating the real name under which this command was
386
invoked, before expansion of aliases.
387
(This may be None if the command was constructed and run in-process.)
273
Command objects will get a 'outf' attribute, which has been
274
setup to properly handle encoding of unicode strings.
275
encoding_type determines what will happen when characters cannot
277
strict - abort if we cannot decode
278
replace - put in a bogus character (typically '?')
279
exact - do not encode sys.stdout
281
NOTE: by default on Windows, sys.stdout is opened as a text
282
stream, therefore LF line-endings are converted to CRLF.
283
When a command uses encoding_type = 'exact', then
284
sys.stdout is forced to be a binary stream, and line-endings
389
287
:cvar hooks: An instance of CommandHooks.
391
:cvar __doc__: The help shown by 'bzr help command' for this command.
392
This is set by assigning explicitly to __doc__ so that -OO can
396
__doc__ = "My help goes here"
400
291
takes_options = []
401
292
encoding_type = 'strict'
407
296
def __init__(self):
408
297
"""Construct an instance of this command."""
298
if self.__doc__ == Command.__doc__:
299
warn("No help message set for %r" % self)
409
300
# List of standard options directly supported
410
301
self.supported_std_options = []
413
def add_cleanup(self, cleanup_func, *args, **kwargs):
414
"""Register a function to call after self.run returns or raises.
416
Functions will be called in LIFO order.
418
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
420
def cleanup_now(self):
421
"""Execute and empty pending cleanup functions immediately.
423
After cleanup_now all registered cleanups are forgotten. add_cleanup
424
may be called again after cleanup_now; these cleanups will be called
425
after self.run returns or raises (or when cleanup_now is next called).
427
This is useful for releasing expensive or contentious resources (such
428
as write locks) before doing further work that does not require those
429
resources (such as writing results to self.outf). Note though, that
430
as it releases all resources, this may release locks that the command
431
wants to hold, so use should be done with care.
433
self._operation.cleanup_now()
303
def _maybe_expand_globs(self, file_list):
304
"""Glob expand file_list if the platform does not do that itself.
306
:return: A possibly empty list of unicode paths.
308
Introduced in bzrlib 0.18.
312
if sys.platform == 'win32':
313
file_list = win32utils.glob_expand(file_list)
314
return list(file_list)
435
316
def _usage(self):
436
317
"""Return single-line grammar for this command.
490
362
# The header is the purpose and usage
492
result += gettext(':Purpose: %s\n') % (purpose,)
364
result += ':Purpose: %s\n' % purpose
493
365
if usage.find('\n') >= 0:
494
result += gettext(':Usage:\n%s\n') % (usage,)
366
result += ':Usage:\n%s\n' % usage
496
result += gettext(':Usage: %s\n') % (usage,)
368
result += ':Usage: %s\n' % usage
499
371
# Add the options
501
# XXX: optparse implicitly rewraps the help, and not always perfectly,
502
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
504
parser = option.get_optparser(self.options())
505
options = parser.format_option_help()
506
# FIXME: According to the spec, ReST option lists actually don't
507
# support options like --1.14 so that causes syntax errors (in Sphinx
508
# at least). As that pattern always appears in the commands that
509
# break, we trap on that and then format that block of 'format' options
510
# as a literal block. We use the most recent format still listed so we
511
# don't have to do that too often -- vila 20110514
512
if not plain and options.find(' --1.14 ') != -1:
513
options = options.replace(' format:\n', ' format::\n\n', 1)
372
options = option.get_optparser(self.options()).format_option_help()
514
373
if options.startswith('Options:'):
515
result += gettext(':Options:%s') % (options[len('options:'):],)
374
result += ':' + options
375
elif options.startswith('options:'):
376
# Python 2.4 version of optparse
377
result += ':Options:' + options[len('options:'):]
517
379
result += options
523
385
if sections.has_key(None):
524
386
text = sections.pop(None)
525
387
text = '\n '.join(text.splitlines())
526
result += gettext(':Description:\n %s\n\n') % (text,)
388
result += ':%s:\n %s\n\n' % ('Description',text)
528
390
# Add the custom sections (e.g. Examples). Note that there's no need
529
391
# to indent these as they must be indented already in the source.
531
393
for label in order:
532
if label in sections:
533
result += ':%s:\n%s\n' % (label, sections[label])
394
if sections.has_key(label):
395
result += ':%s:\n%s\n' % (label,sections[label])
536
result += (gettext("See bzr help %s for more details and examples.\n\n")
398
result += ("See bzr help %s for more details and examples.\n\n"
539
401
# Add the aliases, source (plug-in) and see also links, if any
541
result += gettext(':Aliases: ')
403
result += ':Aliases: '
542
404
result += ', '.join(self.aliases) + '\n'
543
405
plugin_name = self.plugin_name()
544
406
if plugin_name is not None:
545
result += gettext(':From: plugin "%s"\n') % plugin_name
407
result += ':From: plugin "%s"\n' % plugin_name
546
408
see_also = self.get_see_also(additional_see_also)
548
410
if not plain and see_also_as_links:
639
501
def _setup_outf(self):
640
502
"""Return a file linked to stdout, which has proper encoding."""
641
self.outf = ui.ui_factory.make_output_stream(
642
encoding_type=self.encoding_type)
503
# Originally I was using self.stdout, but that looks
504
# *way* too much like sys.stdout
505
if self.encoding_type == 'exact':
506
# force sys.stdout to be binary stream on win32
507
if sys.platform == 'win32':
508
fileno = getattr(sys.stdout, 'fileno', None)
511
msvcrt.setmode(fileno(), os.O_BINARY)
512
self.outf = sys.stdout
515
output_encoding = osutils.get_terminal_encoding()
517
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
518
errors=self.encoding_type)
519
# For whatever reason codecs.getwriter() does not advertise its encoding
520
# it just returns the encoding of the wrapped file, which is completely
521
# bogus. So set the attribute, so we can find the correct encoding later.
522
self.outf.encoding = output_encoding
644
524
def run_argv_aliases(self, argv, alias_argv=None):
645
525
"""Parse the command line and run with extra aliases in alias_argv."""
527
warn("Passing None for [] is deprecated from bzrlib 0.10",
528
DeprecationWarning, stacklevel=2)
646
530
args, opts = parse_args(self, argv, alias_argv)
649
532
# Process the standard options
650
533
if 'help' in opts: # e.g. bzr add --help
651
self.outf.write(self.get_help_text())
534
sys.stdout.write(self.get_help_text())
653
536
if 'usage' in opts: # e.g. bzr add --usage
654
self.outf.write(self.get_help_text(verbose=False))
537
sys.stdout.write(self.get_help_text(verbose=False))
656
539
trace.set_verbosity_level(option._verbosity_level)
657
540
if 'verbose' in self.supported_std_options:
767
603
These are all empty initially, because by default nothing should get
770
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
771
self.add_hook('extend_command',
607
self.create_hook(HookPoint('extend_command',
772
608
"Called after creating a command object to allow modifications "
773
609
"such as adding or removing options, docs etc. Called with the "
774
"new bzrlib.commands.Command object.", (1, 13))
775
self.add_hook('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.add_hook('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 "
788
self.add_hook('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.",
610
"new bzrlib.commands.Command object.", (1, 13), None))
795
612
Command.hooks = CommandHooks()
976
791
config = bzrlib.config.GlobalConfig()
977
792
alias = config.get_alias(cmd)
979
return cmdline.split(alias)
794
return shlex_split_unicode(alias)
983
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
984
799
"""Execute a command.
986
:param argv: The command-line arguments, without the program name from
987
argv[0] These should already be decoded. All library/test code calling
988
run_bzr should be passing valid strings (don't need decoding).
989
:param load_plugins: What function to call when triggering plugin loading.
990
This function should take no arguments and cause all plugins to be
992
:param disable_plugins: What function to call when disabling plugin
993
loading. This function should take no arguments and cause all plugin
994
loading to be prohibited (so that code paths in your application that
995
know about some plugins possibly being present will fail to import
996
those plugins even if they are installed.)
997
:return: Returns a command exit code or raises an exception.
802
The command-line arguments, without the program name from argv[0]
803
These should already be decoded. All library/test code calling
804
run_bzr should be passing valid strings (don't need decoding).
806
Returns a command status or raises an exception.
999
808
Special master options: these must come before the command because
1000
809
they control how the command is interpreted.
1146
952
return ignore_pipe
1149
def install_bzr_command_hooks():
1150
"""Install the hooks to supply bzr's own commands."""
1151
if _list_bzr_commands in Command.hooks["list_commands"]:
1153
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1155
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1157
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1158
"bzr plugin commands")
1159
Command.hooks.install_named_hook("get_command", _get_external_command,
1160
"bzr external command lookup")
1161
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1162
"bzr plugin-provider-db check")
1166
def _specified_or_unicode_argv(argv):
1167
# For internal or testing use, argv can be passed. Otherwise, get it from
1168
# the process arguments in a unicode-safe way.
956
"""Main entry point of command-line interface.
958
:param argv: list of unicode command-line arguments similar to sys.argv.
959
argv[0] is script name usually, it will be ignored.
960
Don't pass here sys.argv because this list contains plain strings
961
and not unicode; pass None instead.
963
:return: exit code of bzr command.
966
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
967
sys.stdin, sys.stdout, sys.stderr)
969
# Is this a final release version? If so, we should suppress warnings
970
if bzrlib.version_info[3] == 'final':
971
from bzrlib import symbol_versioning
972
symbol_versioning.suppress_deprecation_warnings(override=False)
1169
973
if argv is None:
1170
return osutils.get_unicode_argv()
974
argv = osutils.get_unicode_argv()
1174
978
# ensure all arguments are unicode strings
1176
980
if isinstance(a, unicode):
1177
981
new_argv.append(a)
1179
983
new_argv.append(a.decode('ascii'))
1180
984
except UnicodeDecodeError:
1181
985
raise errors.BzrError("argv should be list of unicode strings.")
1185
def main(argv=None):
1186
"""Main entry point of command-line interface.
1188
Typically `bzrlib.initialize` should be called first.
1190
:param argv: list of unicode command-line arguments similar to sys.argv.
1191
argv[0] is script name usually, it will be ignored.
1192
Don't pass here sys.argv because this list contains plain strings
1193
and not unicode; pass None instead.
1195
:return: exit code of bzr command.
1197
if argv is not None:
1199
_register_builtin_commands()
1200
987
ret = run_bzr_catch_errors(argv)
1201
988
trace.mutter("return code %d", ret)
added
removed
bzrlib/commands.py
