1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2006, 2008 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
# TODO: probably should say which arguments are candidates for glob
19
# expansion on windows and do that at the command level.
18
21
# TODO: Define arguments by objects, rather than just using names.
19
22
# Those objects can specify the expected type of the argument, which
20
23
# would help with validation and shell completion. They could also provide
49
52
from bzrlib.hooks import HookPoint, Hooks
50
53
# Compatibility - Option used to be in commands.
51
54
from bzrlib.option import Option
52
from bzrlib.plugin import disable_plugins, load_plugins
53
55
from bzrlib import registry
54
from bzrlib.symbol_versioning import (
56
from bzrlib.symbol_versioning import deprecated_function, deprecated_in
61
59
class CommandInfo(object):
74
72
class CommandRegistry(registry.Registry):
75
"""Special registry mapping command names to command classes.
77
:ivar overridden_registry: Look in this registry for commands being
78
overridden by this registry. This can be used to tell plugin commands
79
about the builtin they're decorating.
83
registry.Registry.__init__(self)
84
self.overridden_registry = None
85
# map from aliases to the real command that implements the name
88
def get(self, command_name):
89
real_name = self._alias_dict.get(command_name, command_name)
90
return registry.Registry.get(self, real_name)
93
75
def _get_name(command_name):
110
92
previous = self.get(k_unsquished)
113
if self.overridden_registry:
115
previous = self.overridden_registry.get(k_unsquished)
94
previous = _builtin_commands().get(k_unsquished)
118
95
info = CommandInfo.from_command(cmd)
120
97
registry.Registry.register(self, k_unsquished, cmd,
121
98
override_existing=decorate, info=info)
123
trace.warning('Two plugins defined the same command: %r' % k)
124
trace.warning('Not loading the one in %r' %
125
sys.modules[cmd.__module__])
126
trace.warning('Previously this command was registered from %r' %
127
sys.modules[previous.__module__])
128
for a in cmd.aliases:
129
self._alias_dict[a] = k_unsquished
100
trace.log_error('Two plugins defined the same command: %r' % k)
101
trace.log_error('Not loading the one in %r' %
102
sys.modules[cmd.__module__])
103
trace.log_error('Previously this command was registered from %r' %
104
sys.modules[previous.__module__])
132
107
def register_lazy(self, command_name, aliases, module_name):
139
114
key = self._get_name(command_name)
140
115
registry.Registry.register_lazy(self, key, module_name, command_name,
141
116
info=CommandInfo(aliases))
143
self._alias_dict[a] = key
146
119
plugin_cmds = CommandRegistry()
147
builtin_command_registry = CommandRegistry()
148
plugin_cmds.overridden_registry = builtin_command_registry
151
122
def register_command(cmd, decorate=False):
152
"""Register a plugin command.
154
Should generally be avoided in favor of lazy registration.
156
123
global plugin_cmds
157
124
return plugin_cmds.register(cmd, decorate)
165
132
return cmd[4:].replace('_','-')
168
@deprecated_function(deprecated_in((2, 2, 0)))
169
135
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
136
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()
137
return _scan_module_for_commands(bzrlib.builtins)
188
140
def _scan_module_for_commands(module):
197
149
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.
150
"""Return a list of all the registered commands.
152
This searches plugins and the core.
202
154
# to eliminate duplicates
203
155
names.update(builtin_command_names())
222
175
Use of all_command_names() is encouraged rather than builtin_command_names
223
176
and/or plugin_command_names.
225
return builtin_command_registry.keys()
178
return _builtin_commands().keys()
228
181
def plugin_command_names():
230
183
return plugin_cmds.keys()
186
@deprecated_function(deprecated_in((1, 16, 0)))
188
"""Return canonical name and class for most commands.
190
NB: This does not return all commands since the introduction of
191
command hooks, and returning the class is not sufficient to
192
get correctly setup commands, which is why it is deprecated.
194
Use 'all_command_names' + 'get_cmd_object' instead.
196
d = _builtin_commands()
198
d.update(plugin_cmds.iteritems())
199
for k, v in d.iteritems():
233
203
def get_cmd_object(cmd_name, plugins_override=True):
234
204
"""Return the command object for a command.
242
212
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
215
def _get_cmd_object(cmd_name, plugins_override=True):
246
216
"""Get a command object.
248
218
:param cmd_name: The name of the command.
249
219
: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
220
:return: A Command object instance
253
:raises KeyError: If no command is found.
221
:raises: KeyError if no command is found.
255
223
# We want only 'ascii' command names, but the user may have typed
256
224
# in a Unicode name. In that case, they should just get a
261
229
for hook in Command.hooks['get_command']:
262
230
cmd = hook(cmd, cmd_name)
263
if cmd is not None and not plugins_override and not cmd.plugin_name():
231
if cmd is not None and not plugins_override:
264
232
# We've found a non-plugin command, don't permit it to be
267
if cmd is None and check_missing:
234
if not cmd.plugin_name():
268
237
for hook in Command.hooks['get_missing_command']:
269
238
cmd = hook(cmd_name)
270
239
if cmd is not None:
307
276
def _get_bzr_command(cmd_or_None, cmd_name):
308
277
"""Get a command from bzr's core."""
278
cmds = _builtin_commands()
310
cmd_class = builtin_command_registry.get(cmd_name)
280
return cmds[cmd_name]()
283
# look for any command which claims this as an alias
284
for real_cmd_name, cmd_class in cmds.iteritems():
285
if cmd_name in cmd_class.aliases:
315
287
return cmd_or_None
411
383
warn("No help message set for %r" % self)
412
384
# List of standard options directly supported
413
385
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
387
def _maybe_expand_globs(self, file_list):
440
388
"""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
390
:return: A possibly empty list of unicode paths.
447
392
Introduced in bzrlib 0.18.
396
if sys.platform == 'win32':
397
file_list = win32utils.glob_expand(file_list)
398
return list(file_list)
451
400
def _usage(self):
452
401
"""Return single-line grammar for this command.
506
455
# Add the options
508
# XXX: optparse implicitly rewraps the help, and not always perfectly,
509
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
511
456
options = option.get_optparser(self.options()).format_option_help()
512
# XXX: According to the spec, ReST option lists actually don't support
513
# options like --1.9 so that causes syntax errors (in Sphinx at least).
514
# As that pattern always appears in the commands that break, we trap
515
# on that and then format that block of 'format' options as a literal
517
if not plain and options.find(' --1.9 ') != -1:
518
options = options.replace(' format:\n', ' format::\n\n', 1)
519
457
if options.startswith('Options:'):
520
458
result += ':' + options
521
459
elif options.startswith('options:'):
561
499
# so don't create a real link
562
500
see_also_links.append(item)
564
# Use a Sphinx link for this entry
565
link_text = ":doc:`%s <%s-help>`" % (item, item)
566
see_also_links.append(link_text)
502
# Use a reST link for this entry
503
see_also_links.append("`%s`_" % (item,))
567
504
see_also = see_also_links
568
505
result += ':See also: '
569
506
result += ', '.join(see_also) + '\n'
648
585
def _setup_outf(self):
649
586
"""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)
587
# Originally I was using self.stdout, but that looks
588
# *way* too much like sys.stdout
589
if self.encoding_type == 'exact':
590
# force sys.stdout to be binary stream on win32
591
if sys.platform == 'win32':
592
fileno = getattr(sys.stdout, 'fileno', None)
595
msvcrt.setmode(fileno(), os.O_BINARY)
596
self.outf = sys.stdout
599
output_encoding = osutils.get_terminal_encoding()
601
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
602
errors=self.encoding_type)
603
# For whatever reason codecs.getwriter() does not advertise its encoding
604
# it just returns the encoding of the wrapped file, which is completely
605
# bogus. So set the attribute, so we can find the correct encoding later.
606
self.outf.encoding = output_encoding
653
608
def run_argv_aliases(self, argv, alias_argv=None):
654
609
"""Parse the command line and run with extra aliases in alias_argv."""
611
warn("Passing None for [] is deprecated from bzrlib 0.10",
612
DeprecationWarning, stacklevel=2)
655
614
args, opts = parse_args(self, argv, alias_argv)
657
616
# Process the standard options
685
644
return self.run(**all_cmd_args)
687
def _setup_run(self):
688
"""Wrap the defined run method on self with a cleanup.
690
This is called by __init__ to make the Command be able to be run
691
by just calling run(), as it could be before cleanups were added.
693
If a different form of cleanups are in use by your Command subclass,
694
you can override this method.
697
def run(*args, **kwargs):
698
self._operation = cleanup.OperationWithCleanups(class_run)
700
return self._operation.run_simple(*args, **kwargs)
705
@deprecated_method(deprecated_in((2, 2, 0)))
706
def run_direct(self, *args, **kwargs):
707
"""Deprecated thunk from bzrlib 2.1."""
708
return self.run(*args, **kwargs)
711
647
"""Actually run the command.
716
652
Return 0 or None if the command was successful, or a non-zero
717
653
shell error code if not. It's OK for this method to allow
718
654
an exception to raise up.
720
This method is automatically wrapped by Command.__init__ with a
721
cleanup operation, stored as self._operation. This can be used
722
via self.add_cleanup to perform automatic cleanups at the end of
725
The argument for run are assembled by introspection. So for instance,
726
if your command takes an argument files, you would declare::
728
def run(self, files=None):
731
656
raise NotImplementedError('no implementation of command %r'
771
696
"Called when creating a single command. Called with "
772
697
"(cmd_or_None, command_name). get_command should either return "
773
698
"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.",
699
"should be used for the command.", (1, 16), None))
778
700
self.create_hook(HookPoint('get_missing_command',
779
701
"Called when creating a single command if no command could be "
780
702
"found. Called with (command_name). get_missing_command should "
781
703
"either return None, or a Command object to be used for the "
782
"command.", (1, 17), None))
704
"command.", (1, 16), None))
783
705
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.",
706
"Called when enumerating commands. Called with a dict of "
707
"cmd_name: cmd_class tuples for all the commands found "
708
"so far. This dict is safe to mutate - to remove a command or "
709
"to replace it with another (eg plugin supplied) version. "
710
"list_commands should return the updated dict of commands.",
790
713
Command.hooks = CommandHooks()
952
@deprecated_function(deprecated_in((2, 2, 0)))
953
875
def shlex_split_unicode(unsplit):
954
return cmdline.split(unsplit)
877
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
957
880
def get_alias(cmd, config=None):
969
892
config = bzrlib.config.GlobalConfig()
970
893
alias = config.get_alias(cmd)
972
return cmdline.split(alias)
895
return shlex_split_unicode(alias)
976
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
977
900
"""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.
903
The command-line arguments, without the program name from argv[0]
904
These should already be decoded. All library/test code calling
905
run_bzr should be passing valid strings (don't need decoding).
907
Returns a command status or raises an exception.
992
909
Special master options: these must come before the command because
993
910
they control how the command is interpreted.
1012
929
Generate line coverage report in the specified directory.
1015
Specify the number of processes that can be run concurrently (selftest).
1017
trace.mutter("bazaar version: " + bzrlib.__version__)
1018
931
argv = list(argv)
1019
932
trace.mutter("bzr arguments: %r", argv)
1059
969
debug.set_debug_flags_from_config()
973
from bzrlib.builtins import cmd_help
974
cmd_help().run_argv_aliases([])
977
if argv[0] == '--version':
978
from bzrlib.builtins import cmd_version
979
cmd_version().run_argv_aliases([])
1061
982
if not opt_no_plugins:
983
from bzrlib.plugin import load_plugins
986
from bzrlib.plugin import disable_plugins
1064
987
disable_plugins()
1068
get_cmd_object('help').run_argv_aliases([])
1071
if argv[0] == '--version':
1072
get_cmd_object('version').run_argv_aliases([])
1075
989
alias_argv = None
1077
991
if not opt_no_aliases:
1109
1023
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1111
1025
ret = run(*run_argv)
1026
if 'memory' in debug.debug_flags:
1027
trace.debug_memory('Process status after command:', short=False)
1112
1028
return ret or 0
1114
1030
# reset, in case we may do other commands later within the same
1115
1031
# process. Commands that want to execute sub-commands must propagate
1116
1032
# --verbose in their own way.
1117
if 'memory' in debug.debug_flags:
1118
trace.debug_memory('Process status after command:', short=False)
1119
1033
option._verbosity_level = saved_verbosity_level
1142
1056
def install_bzr_command_hooks():
1143
1057
"""Install the hooks to supply bzr's own commands."""
1144
if _list_bzr_commands in Command.hooks["list_commands"]:
1146
1058
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1147
1059
"bzr commands")
1148
1060
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1155
1067
"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.
1070
def main(argv=None):
1071
"""Main entry point of command-line interface.
1073
:param argv: list of unicode command-line arguments similar to sys.argv.
1074
argv[0] is script name usually, it will be ignored.
1075
Don't pass here sys.argv because this list contains plain strings
1076
and not unicode; pass None instead.
1078
:return: exit code of bzr command.
1081
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1082
sys.stdin, sys.stdout, sys.stderr)
1084
# Is this a final release version? If so, we should suppress warnings
1085
if bzrlib.version_info[3] == 'final':
1086
symbol_versioning.suppress_deprecation_warnings(override=False)
1162
1087
if argv is None:
1163
return osutils.get_unicode_argv()
1088
argv = osutils.get_unicode_argv()
1172
1097
new_argv.append(a.decode('ascii'))
1173
1098
except UnicodeDecodeError:
1174
1099
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()
1101
install_bzr_command_hooks()
1192
1102
ret = run_bzr_catch_errors(argv)
1193
bzrlib.ui.ui_factory.log_transport_activity(
1194
display=('bytes' in debug.debug_flags))
1195
1103
trace.mutter("return code %d", ret)
1202
1110
This function assumed that that UI layer is setup, that symbol deprecations
1203
1111
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
1113
return exception_to_return_code(run_bzr, argv)
1213
1119
This is used for the test suite, and might be useful for other programs
1214
1120
that want to wrap the commandline interface.
1216
# done here so that they're covered for every test run
1217
install_bzr_command_hooks()
1219
1123
return run_bzr(argv)
1220
1124
except Exception, e:
1242
1146
if topic and topic.startswith(self.prefix):
1243
1147
topic = topic[len(self.prefix):]
1245
cmd = _get_cmd_object(topic, check_missing=False)
1149
cmd = _get_cmd_object(topic)
1246
1150
except KeyError:
added
removed
bzrlib/commands.py
