1
# Copyright (C) 2006, 2008 Canonical Ltd
1
# Copyright (C) 2005-2010 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.
21
18
# TODO: Define arguments by objects, rather than just using names.
22
19
# Those objects can specify the expected type of the argument, which
23
20
# would help with validation and shell completion. They could also provide
52
49
from bzrlib.hooks import HookPoint, Hooks
53
50
# Compatibility - Option used to be in commands.
54
51
from bzrlib.option import Option
52
from bzrlib.plugin import disable_plugins, load_plugins
55
53
from bzrlib import registry
56
54
from bzrlib.symbol_versioning import (
57
55
deprecated_function,
60
suppress_deprecation_warnings,
77
74
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)
80
93
def _get_name(command_name):
97
110
previous = self.get(k_unsquished)
99
previous = _builtin_commands().get(k_unsquished)
113
if self.overridden_registry:
115
previous = self.overridden_registry.get(k_unsquished)
100
118
info = CommandInfo.from_command(cmd)
102
120
registry.Registry.register(self, k_unsquished, cmd,
107
125
sys.modules[cmd.__module__])
108
126
trace.warning('Previously this command was registered from %r' %
109
127
sys.modules[previous.__module__])
128
for a in cmd.aliases:
129
self._alias_dict[a] = k_unsquished
112
132
def register_lazy(self, command_name, aliases, module_name):
119
139
key = self._get_name(command_name)
120
140
registry.Registry.register_lazy(self, key, module_name, command_name,
121
141
info=CommandInfo(aliases))
143
self._alias_dict[a] = key
124
146
plugin_cmds = CommandRegistry()
147
builtin_command_registry = CommandRegistry()
148
plugin_cmds.overridden_registry = builtin_command_registry
127
151
def register_command(cmd, decorate=False):
152
"""Register a plugin command.
154
Should generally be avoided in favor of lazy registration.
128
156
global plugin_cmds
129
157
return plugin_cmds.register(cmd, decorate)
137
165
return cmd[4:].replace('_','-')
168
@deprecated_function(deprecated_in((2, 2, 0)))
140
169
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():
141
182
import bzrlib.builtins
142
return _scan_module_for_commands(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()
145
188
def _scan_module_for_commands(module):
154
197
def _list_bzr_commands(names):
155
"""Find commands from bzr's core and plugins."""
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.
156
202
# to eliminate duplicates
157
203
names.update(builtin_command_names())
158
204
names.update(plugin_command_names())
176
222
Use of all_command_names() is encouraged rather than builtin_command_names
177
223
and/or plugin_command_names.
179
return _builtin_commands().keys()
225
return builtin_command_registry.keys()
182
228
def plugin_command_names():
184
230
return plugin_cmds.keys()
187
@deprecated_function(deprecated_in((1, 17, 0)))
188
def get_all_cmds(plugins_override=False):
189
"""Return canonical name and class for most commands.
191
NB: This does not return all commands since the introduction of
192
command hooks, and returning the class is not sufficient to
193
get correctly setup commands, which is why it is deprecated.
195
Use 'all_command_names' + 'get_cmd_object' instead.
197
d = _builtin_commands()
199
d.update(plugin_cmds.iteritems())
200
for k, v in d.iteritems():
204
233
def get_cmd_object(cmd_name, plugins_override=True):
205
234
"""Return the command object for a command.
213
242
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
216
def _get_cmd_object(cmd_name, plugins_override=True):
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
217
246
"""Get a command object.
219
248
:param cmd_name: The name of the command.
220
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.
221
252
:return: A Command object instance
222
253
:raises KeyError: If no command is found.
276
307
def _get_bzr_command(cmd_or_None, cmd_name):
277
308
"""Get a command from bzr's core."""
278
cmds = _builtin_commands()
280
return cmds[cmd_name]()
310
cmd_class = builtin_command_registry.get(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:
287
315
return cmd_or_None
383
411
warn("No help message set for %r" % self)
384
412
# List of standard options directly supported
385
413
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()
387
438
@deprecated_method(deprecated_in((2, 1, 0)))
388
439
def _maybe_expand_globs(self, file_list):
510
561
# so don't create a real link
511
562
see_also_links.append(item)
513
# Use a reST link for this entry
514
see_also_links.append("`%s`_" % (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)
515
567
see_also = see_also_links
516
568
result += ':See also: '
517
569
result += ', '.join(see_also) + '\n'
596
648
def _setup_outf(self):
597
649
"""Return a file linked to stdout, which has proper encoding."""
598
# Originally I was using self.stdout, but that looks
599
# *way* too much like sys.stdout
600
if self.encoding_type == 'exact':
601
# force sys.stdout to be binary stream on win32
602
if sys.platform == 'win32':
603
fileno = getattr(sys.stdout, 'fileno', None)
606
msvcrt.setmode(fileno(), os.O_BINARY)
607
self.outf = sys.stdout
610
output_encoding = osutils.get_terminal_encoding()
612
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
613
errors=self.encoding_type)
614
# For whatever reason codecs.getwriter() does not advertise its encoding
615
# it just returns the encoding of the wrapped file, which is completely
616
# bogus. So set the attribute, so we can find the correct encoding later.
617
self.outf.encoding = output_encoding
650
self.outf = ui.ui_factory.make_output_stream(
651
encoding_type=self.encoding_type)
619
653
def run_argv_aliases(self, argv, alias_argv=None):
620
654
"""Parse the command line and run with extra aliases in alias_argv."""
622
warn("Passing None for [] is deprecated from bzrlib 0.10",
623
DeprecationWarning, stacklevel=2)
625
655
args, opts = parse_args(self, argv, alias_argv)
627
657
# Process the standard options
655
685
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)
658
711
"""Actually run the command.
663
716
Return 0 or None if the command was successful, or a non-zero
664
717
shell error code if not. It's OK for this method to allow
665
718
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):
667
731
raise NotImplementedError('no implementation of command %r'
952
@deprecated_function(deprecated_in((2, 2, 0)))
888
953
def shlex_split_unicode(unsplit):
890
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
954
return cmdline.split(unsplit)
893
957
def get_alias(cmd, config=None):
905
969
config = bzrlib.config.GlobalConfig()
906
970
alias = config.get_alias(cmd)
908
return shlex_split_unicode(alias)
972
return cmdline.split(alias)
976
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
913
977
"""Execute a command.
916
The command-line arguments, without the program name from argv[0]
917
These should already be decoded. All library/test code calling
918
run_bzr should be passing valid strings (don't need decoding).
920
Returns a command status or raises an exception.
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.
922
992
Special master options: these must come before the command because
923
993
they control how the command is interpreted.
942
1012
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__)
944
1018
argv = list(argv)
945
1019
trace.mutter("bzr arguments: %r", argv)
982
1059
debug.set_debug_flags_from_config()
1061
if not opt_no_plugins:
984
1066
argv = argv_copy
986
from bzrlib.builtins import cmd_help
987
cmd_help().run_argv_aliases([])
1068
get_cmd_object('help').run_argv_aliases([])
990
1071
if argv[0] == '--version':
991
from bzrlib.builtins import cmd_version
992
cmd_version().run_argv_aliases([])
1072
get_cmd_object('version').run_argv_aliases([])
995
if not opt_no_plugins:
996
from bzrlib.plugin import load_plugins
999
from bzrlib.plugin import disable_plugins
1002
1075
alias_argv = None
1004
1077
if not opt_no_aliases:
1082
1155
"bzr plugin-provider-db check")
1085
def main(argv=None):
1086
"""Main entry point of command-line interface.
1088
:param argv: list of unicode command-line arguments similar to sys.argv.
1089
argv[0] is script name usually, it will be ignored.
1090
Don't pass here sys.argv because this list contains plain strings
1091
and not unicode; pass None instead.
1093
:return: exit code of bzr command.
1096
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1097
sys.stdin, sys.stdout, sys.stderr)
1099
# Is this a final release version? If so, we should suppress warnings
1100
if bzrlib.version_info[3] == 'final':
1101
suppress_deprecation_warnings(override=True)
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.
1102
1162
if argv is None:
1103
argv = osutils.get_unicode_argv()
1163
return osutils.get_unicode_argv()
1112
1172
new_argv.append(a.decode('ascii'))
1113
1173
except UnicodeDecodeError:
1114
1174
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()
1116
1192
ret = run_bzr_catch_errors(argv)
1193
bzrlib.ui.ui_factory.log_transport_activity(
1194
display=('bytes' in debug.debug_flags))
1117
1195
trace.mutter("return code %d", ret)
1118
osutils.report_extension_load_failures()
1125
1202
This function assumed that that UI layer is setup, that symbol deprecations
1126
1203
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
1128
1206
install_bzr_command_hooks()
1129
1207
return exception_to_return_code(run_bzr, argv)
1135
1213
This is used for the test suite, and might be useful for other programs
1136
1214
that want to wrap the commandline interface.
1216
# done here so that they're covered for every test run
1138
1217
install_bzr_command_hooks()
1140
1219
return run_bzr(argv)
1163
1242
if topic and topic.startswith(self.prefix):
1164
1243
topic = topic[len(self.prefix):]
1166
cmd = _get_cmd_object(topic)
1245
cmd = _get_cmd_object(topic, check_missing=False)
1167
1246
except KeyError:
added
removed
bzrlib/commands.py
