130
161
return cmd[4:].replace('_','-')
133
def _builtin_commands():
164
def _register_builtin_commands():
165
if builtin_command_registry.keys():
134
168
import bzrlib.builtins
169
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
170
builtin_command_registry.register(cmd_class)
171
bzrlib.builtins._register_lazy_builtins()
174
def _scan_module_for_commands(module):
136
builtins = bzrlib.builtins.__dict__
137
for name in builtins:
176
for name, obj in module.__dict__.iteritems():
138
177
if name.startswith("cmd_"):
139
178
real_name = _unsquish_command_name(name)
140
r[real_name] = builtins[name]
183
def _list_bzr_commands(names):
184
"""Find commands from bzr's core and plugins.
186
This is not the public interface, just the default hook called by all_command_names.
188
# to eliminate duplicates
189
names.update(builtin_command_names())
190
names.update(plugin_command_names())
194
def all_command_names():
195
"""Return a set of all command names."""
197
for hook in Command.hooks['list_commands']:
200
raise AssertionError(
201
'hook %s returned None' % Command.hooks.get_hook_name(hook))
144
205
def builtin_command_names():
145
"""Return list of builtin command names."""
146
return _builtin_commands().keys()
206
"""Return list of builtin command names.
208
Use of all_command_names() is encouraged rather than builtin_command_names
209
and/or plugin_command_names.
211
_register_builtin_commands()
212
return builtin_command_registry.keys()
149
215
def plugin_command_names():
216
"""Returns command names from commands registered by plugins."""
150
217
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():
167
220
def get_cmd_object(cmd_name, plugins_override=True):
168
"""Return the canonical name and command class for a command.
221
"""Return the command object for a command.
171
224
If true, plugin commands can override builtins.
174
cmd = _get_cmd_object(cmd_name, plugins_override)
175
# Allow plugins to extend commands
176
for hook in Command.hooks['extend_command']:
180
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
183
def _get_cmd_object(cmd_name, plugins_override=True):
184
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
227
return _get_cmd_object(cmd_name, plugins_override)
229
raise errors.BzrCommandError(gettext('unknown command "%s"') % cmd_name)
232
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
233
"""Get a command object.
235
:param cmd_name: The name of the command.
236
:param plugins_override: Allow plugins to override builtins.
237
:param check_missing: Look up commands not found in the regular index via
238
the get_missing_command hook.
239
:return: A Command object instance
240
:raises KeyError: If no command is found.
242
# We want only 'ascii' command names, but the user may have typed
243
# in a Unicode name. In that case, they should just get a
244
# 'command not found' error later.
245
# In the future, we may actually support Unicode command names.
248
for hook in Command.hooks['get_command']:
249
cmd = hook(cmd, cmd_name)
250
if cmd is not None and not plugins_override and not cmd.plugin_name():
251
# We've found a non-plugin command, don't permit it to be
254
if cmd is None and check_missing:
255
for hook in Command.hooks['get_missing_command']:
262
# Allow plugins to extend commands
263
for hook in Command.hooks['extend_command']:
265
if getattr(cmd, 'invoked_as', None) is None:
266
cmd.invoked_as = cmd_name
270
def _try_plugin_provider(cmd_name):
271
"""Probe for a plugin provider having cmd_name."""
273
plugin_metadata, provider = probe_for_provider(cmd_name)
274
raise errors.CommandAvailableInPlugin(cmd_name,
275
plugin_metadata, provider)
276
except errors.NoPluginAvailable:
280
def probe_for_provider(cmd_name):
281
"""Look for a provider for cmd_name.
283
:param cmd_name: The command name.
284
:return: plugin_metadata, provider for getting cmd_name.
285
:raises NoPluginAvailable: When no provider can supply the plugin.
287
# look for providers that provide this command but aren't installed
288
for provider in command_providers_registry:
290
return provider.plugin_for_command(cmd_name), provider
291
except errors.NoPluginAvailable:
293
raise errors.NoPluginAvailable(cmd_name)
296
def _get_bzr_command(cmd_or_None, cmd_name):
297
"""Get a command from bzr's core."""
299
cmd_class = builtin_command_registry.get(cmd_name)
307
def _get_external_command(cmd_or_None, cmd_name):
308
"""Lookup a command that is a shell script."""
309
# Only do external command lookups when no command is found so far.
310
if cmd_or_None is not None:
185
312
from bzrlib.externalcommand import ExternalCommand
187
# We want only 'ascii' command names, but the user may have typed
188
# in a Unicode name. In that case, they should just get a
189
# 'command not found' error later.
190
# In the future, we may actually support Unicode command names.
192
# first look up this command under the specified name
195
return plugin_cmds.get(cmd_name)()
198
cmds = _get_cmd_dict(plugins_override=False)
200
return cmds[cmd_name]()
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:
213
313
cmd_obj = ExternalCommand.find_command(cmd_name)
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)
318
def _get_plugin_command(cmd_or_None, cmd_name):
319
"""Get a command from bzr's plugins."""
321
return plugin_cmds.get(cmd_name)()
324
for key in plugin_cmds.keys():
325
info = plugin_cmds.get_info(key)
326
if cmd_name in info.aliases:
327
return plugin_cmds.get(key)()
229
331
class Command(object):
244
346
summary, then a complete description of the command. A grammar
245
347
description will be inserted.
248
Other accepted names for this command.
251
List of argument forms, marked with whether they are optional,
256
['to_location', 'from_branch?', 'file*']
258
'to_location' is required
259
'from_branch' is optional
260
'file' can be specified 0 or more times
263
List of options that may be given for this command. These can
264
be either strings, referring to globally-defined options,
265
or option objects. Retrieve through options().
268
If true, this command isn't advertised. This is typically
349
:cvar aliases: Other accepted names for this command.
351
:cvar takes_args: List of argument forms, marked with whether they are
352
optional, repeated, etc. Examples::
354
['to_location', 'from_branch?', 'file*']
356
* 'to_location' is required
357
* 'from_branch' is optional
358
* 'file' can be specified 0 or more times
360
:cvar takes_options: List of options that may be given for this command.
361
These can be either strings, referring to globally-defined options, or
362
option objects. Retrieve through options().
364
:cvar hidden: If true, this command isn't advertised. This is typically
269
365
for commands intended for expert users.
272
Command objects will get a 'outf' attribute, which has been
273
setup to properly handle encoding of unicode strings.
274
encoding_type determines what will happen when characters cannot
276
strict - abort if we cannot decode
277
replace - put in a bogus character (typically '?')
278
exact - do not encode sys.stdout
280
NOTE: by default on Windows, sys.stdout is opened as a text
281
stream, therefore LF line-endings are converted to CRLF.
282
When a command uses encoding_type = 'exact', then
283
sys.stdout is forced to be a binary stream, and line-endings
367
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
368
been setup to properly handle encoding of unicode strings.
369
encoding_type determines what will happen when characters cannot be
372
* strict - abort if we cannot decode
373
* replace - put in a bogus character (typically '?')
374
* exact - do not encode sys.stdout
376
NOTE: by default on Windows, sys.stdout is opened as a text stream,
377
therefore LF line-endings are converted to CRLF. When a command uses
378
encoding_type = 'exact', then sys.stdout is forced to be a binary
379
stream, and line-endings will not mangled.
382
A string indicating the real name under which this command was
383
invoked, before expansion of aliases.
384
(This may be None if the command was constructed and run in-process.)
286
386
:cvar hooks: An instance of CommandHooks.
388
:cvar __doc__: The help shown by 'bzr help command' for this command.
389
This is set by assigning explicitly to __doc__ so that -OO can
393
__doc__ = "My help goes here"
290
397
takes_options = []
291
398
encoding_type = 'strict'
295
404
def __init__(self):
296
405
"""Construct an instance of this command."""
297
if self.__doc__ == Command.__doc__:
298
warn("No help message set for %r" % self)
299
406
# List of standard options directly supported
300
407
self.supported_std_options = []
302
def _maybe_expand_globs(self, file_list):
303
"""Glob expand file_list if the platform does not do that itself.
305
:return: A possibly empty list of unicode paths.
307
Introduced in bzrlib 0.18.
311
if sys.platform == 'win32':
312
file_list = win32utils.glob_expand(file_list)
313
return list(file_list)
410
def add_cleanup(self, cleanup_func, *args, **kwargs):
411
"""Register a function to call after self.run returns or raises.
413
Functions will be called in LIFO order.
415
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
417
def cleanup_now(self):
418
"""Execute and empty pending cleanup functions immediately.
420
After cleanup_now all registered cleanups are forgotten. add_cleanup
421
may be called again after cleanup_now; these cleanups will be called
422
after self.run returns or raises (or when cleanup_now is next called).
424
This is useful for releasing expensive or contentious resources (such
425
as write locks) before doing further work that does not require those
426
resources (such as writing results to self.outf). Note though, that
427
as it releases all resources, this may release locks that the command
428
wants to hold, so use should be done with care.
430
self._operation.cleanup_now()
315
432
def _usage(self):
316
433
"""Return single-line grammar for this command.
361
487
# The header is the purpose and usage
363
result += ':Purpose: %s\n' % purpose
489
result += gettext(':Purpose: %s\n') % (purpose,)
364
490
if usage.find('\n') >= 0:
365
result += ':Usage:\n%s\n' % usage
491
result += gettext(':Usage:\n%s\n') % (usage,)
367
result += ':Usage: %s\n' % usage
493
result += gettext(':Usage: %s\n') % (usage,)
370
496
# Add the options
371
options = option.get_optparser(self.options()).format_option_help()
498
# XXX: optparse implicitly rewraps the help, and not always perfectly,
499
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
501
parser = option.get_optparser(self.options())
502
options = parser.format_option_help()
503
# FIXME: According to the spec, ReST option lists actually don't
504
# support options like --1.14 so that causes syntax errors (in Sphinx
505
# at least). As that pattern always appears in the commands that
506
# break, we trap on that and then format that block of 'format' options
507
# as a literal block. We use the most recent format still listed so we
508
# don't have to do that too often -- vila 20110514
509
if not plain and options.find(' --1.14 ') != -1:
510
options = options.replace(' format:\n', ' format::\n\n', 1)
372
511
if options.startswith('Options:'):
373
result += ':' + options
374
elif options.startswith('options:'):
375
# Python 2.4 version of optparse
376
result += ':Options:' + options[len('options:'):]
512
result += gettext(':Options:%s') % (options[len('options:'):],)
378
514
result += options
384
520
if sections.has_key(None):
385
521
text = sections.pop(None)
386
522
text = '\n '.join(text.splitlines())
387
result += ':%s:\n %s\n\n' % ('Description',text)
523
result += gettext(':Description:\n %s\n\n') % (text,)
389
525
# Add the custom sections (e.g. Examples). Note that there's no need
390
526
# to indent these as they must be indented already in the source.
392
528
for label in order:
393
if sections.has_key(label):
394
result += ':%s:\n%s\n' % (label,sections[label])
529
if label in sections:
530
result += ':%s:\n%s\n' % (label, sections[label])
397
result += ("See bzr help %s for more details and examples.\n\n"
533
result += (gettext("See bzr help %s for more details and examples.\n\n")
400
536
# Add the aliases, source (plug-in) and see also links, if any
402
result += ':Aliases: '
538
result += gettext(':Aliases: ')
403
539
result += ', '.join(self.aliases) + '\n'
404
540
plugin_name = self.plugin_name()
405
541
if plugin_name is not None:
406
result += ':From: plugin "%s"\n' % plugin_name
542
result += gettext(':From: plugin "%s"\n') % plugin_name
407
543
see_also = self.get_see_also(additional_see_also)
409
545
if not plain and see_also_as_links:
500
637
def _setup_outf(self):
501
638
"""Return a file linked to stdout, which has proper encoding."""
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
639
self.outf = ui.ui_factory.make_output_stream(
640
encoding_type=self.encoding_type)
523
642
def run_argv_aliases(self, argv, alias_argv=None):
524
643
"""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)
529
644
args, opts = parse_args(self, argv, alias_argv)
531
647
# Process the standard options
532
648
if 'help' in opts: # e.g. bzr add --help
533
sys.stdout.write(self.get_help_text())
649
self.outf.write(self.get_help_text())
535
651
if 'usage' in opts: # e.g. bzr add --usage
536
sys.stdout.write(self.get_help_text(verbose=False))
652
self.outf.write(self.get_help_text(verbose=False))
538
654
trace.set_verbosity_level(option._verbosity_level)
539
655
if 'verbose' in self.supported_std_options:
602
768
These are all empty initially, because by default nothing should get
606
self.create_hook(HookPoint('extend_command',
771
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
772
self.add_hook('extend_command',
607
773
"Called after creating a command object to allow modifications "
608
774
"such as adding or removing options, docs etc. Called with the "
609
"new bzrlib.commands.Command object.", (1, 13), None))
775
"new bzrlib.commands.Command object.", (1, 13))
776
self.add_hook('get_command',
777
"Called when creating a single command. Called with "
778
"(cmd_or_None, command_name). get_command should either return "
779
"the cmd_or_None parameter, or a replacement Command object that "
780
"should be used for the command. Note that the Command.hooks "
781
"hooks are core infrastructure. Many users will prefer to use "
782
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
784
self.add_hook('get_missing_command',
785
"Called when creating a single command if no command could be "
786
"found. Called with (command_name). get_missing_command should "
787
"either return None, or a Command object to be used for the "
789
self.add_hook('list_commands',
790
"Called when enumerating commands. Called with a set of "
791
"cmd_name strings for all the commands found so far. This set "
792
" is safe to mutate - e.g. to remove a command. "
793
"list_commands should return the updated set of command names.",
795
self.add_hook('pre_command',
796
"Called prior to executing a command. Called with the command "
798
self.add_hook('post_command',
799
"Called after executing a command. Called with the command "
611
802
Command.hooks = CommandHooks()
732
935
exitcode = trace.report_exception(exc_info, sys.stderr)
733
936
if os.environ.get('BZR_PDB'):
734
937
print '**** entering debugger'
737
if sys.version_info[:2] < (2, 6):
739
# pdb.post_mortem(tb)
740
# but because pdb.post_mortem gives bad results for tracebacks
741
# from inside generators, we do it manually.
742
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
744
# Setup pdb on the traceback
747
p.setup(tb.tb_frame, tb)
748
# Point the debugger at the deepest frame of the stack
749
p.curindex = len(p.stack) - 1
750
p.curframe = p.stack[p.curindex][0]
751
# Start the pdb prompt.
752
p.print_stack_entry(p.stack[p.curindex])
939
pdb.post_mortem(exc_info[2])
760
943
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
761
944
from bzrlib.lsprof import profile
762
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
945
ret, stats = profile(exception_to_return_code, the_callable,
764
948
if filename is None:
767
951
stats.save(filename)
768
trace.note('Profile data written to "%s".', filename)
952
trace.note(gettext('Profile data written to "%s".'), filename)
772
def shlex_split_unicode(unsplit):
774
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
777
956
def get_alias(cmd, config=None):
778
957
"""Return an expanded alias, or None if no alias exists.
789
968
config = bzrlib.config.GlobalConfig()
790
969
alias = config.get_alias(cmd)
792
return shlex_split_unicode(alias)
971
return cmdline.split(alias)
975
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
797
976
"""Execute a command.
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.
978
:param argv: The command-line arguments, without the program name from
979
argv[0] These should already be decoded. All library/test code calling
980
run_bzr should be passing valid strings (don't need decoding).
981
:param load_plugins: What function to call when triggering plugin loading.
982
This function should take no arguments and cause all plugins to be
984
:param disable_plugins: What function to call when disabling plugin
985
loading. This function should take no arguments and cause all plugin
986
loading to be prohibited (so that code paths in your application that
987
know about some plugins possibly being present will fail to import
988
those plugins even if they are installed.)
989
:return: Returns a command exit code or raises an exception.
806
991
Special master options: these must come before the command because
807
992
they control how the command is interpreted.
852
1042
opt_no_plugins = True
853
1043
elif a == '--no-aliases':
854
1044
opt_no_aliases = True
1045
elif a == '--no-l10n':
855
1047
elif a == '--builtin':
856
1048
opt_builtin = True
1049
elif a == '--concurrency':
1050
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
857
1052
elif a == '--coverage':
858
1053
opt_coverage_dir = argv[i + 1]
1055
elif a == '--profile-imports':
1056
pass # already handled in startup script Bug #588277
860
1057
elif a.startswith('-D'):
861
1058
debug.debug_flags.add(a[2:])
1059
elif a.startswith('-O'):
1060
override_config.append(a[2:])
863
1062
argv_copy.append(a)
1065
if bzrlib.global_state is None:
1066
# FIXME: Workaround for users that imported bzrlib but didn't call
1067
# bzrlib.initialize -- vila 2012-01-19
1068
cmdline_overrides = config.CommandLineStore()
1070
cmdline_overrides = bzrlib.global_state.cmdline_overrides
1071
cmdline_overrides._from_cmdline(override_config)
866
1073
debug.set_debug_flags_from_config()
1075
if not opt_no_plugins:
868
1080
argv = argv_copy
870
from bzrlib.builtins import cmd_help
871
cmd_help().run_argv_aliases([])
1082
get_cmd_object('help').run_argv_aliases([])
874
1085
if argv[0] == '--version':
875
from bzrlib.builtins import cmd_version
876
cmd_version().run_argv_aliases([])
1086
get_cmd_object('version').run_argv_aliases([])
879
if not opt_no_plugins:
880
from bzrlib.plugin import load_plugins
883
from bzrlib.plugin import disable_plugins
886
1089
alias_argv = None
888
1091
if not opt_no_aliases:
889
1092
alias_argv = get_alias(argv[0])
891
user_encoding = osutils.get_user_encoding()
892
alias_argv = [a.decode(user_encoding) for a in alias_argv]
893
1094
argv[0] = alias_argv.pop(0)
895
1096
cmd = argv.pop(0)
896
# We want only 'ascii' command names, but the user may have typed
897
# in a Unicode name. In that case, they should just get a
898
# 'command not found' error later.
900
1097
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
901
1100
run = cmd_obj.run_argv_aliases
902
1101
run_argv = [argv, alias_argv]
950
1151
return ignore_pipe
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 "
1154
def install_bzr_command_hooks():
1155
"""Install the hooks to supply bzr's own commands."""
1156
if _list_bzr_commands in Command.hooks["list_commands"]:
1158
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1160
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1162
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1163
"bzr plugin commands")
1164
Command.hooks.install_named_hook("get_command", _get_external_command,
1165
"bzr external command lookup")
1166
Command.hooks.install_named_hook("get_missing_command",
1167
_try_plugin_provider,
1168
"bzr plugin-provider-db check")
1172
def _specified_or_unicode_argv(argv):
1173
# For internal or testing use, argv can be passed. Otherwise, get it from
1174
# the process arguments in a unicode-safe way.
1176
return osutils.get_unicode_argv()
1180
# ensure all arguments are unicode strings
1182
if isinstance(a, unicode):
1185
new_argv.append(a.decode('ascii'))
1186
except UnicodeDecodeError:
1187
raise errors.BzrError("argv should be list of unicode strings.")
1191
def main(argv=None):
1192
"""Main entry point of command-line interface.
1194
Typically `bzrlib.initialize` should be called first.
1196
:param argv: list of unicode command-line arguments similar to sys.argv.
1197
argv[0] is script name usually, it will be ignored.
1198
Don't pass here sys.argv because this list contains plain strings
1199
and not unicode; pass None instead.
1201
:return: exit code of bzr command.
1203
if argv is not None:
1205
_register_builtin_commands()
968
1206
ret = run_bzr_catch_errors(argv)
969
1207
trace.mutter("return code %d", ret)
added
removed
bzrlib/commands.py
