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,
59
suppress_deprecation_warnings,
76
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)
79
93
def _get_name(command_name):
96
110
previous = self.get(k_unsquished)
98
previous = _builtin_commands().get(k_unsquished)
113
if self.overridden_registry:
115
previous = self.overridden_registry.get(k_unsquished)
99
118
info = CommandInfo.from_command(cmd)
101
120
registry.Registry.register(self, k_unsquished, cmd,
102
121
override_existing=decorate, info=info)
104
trace.log_error('Two plugins defined the same command: %r' % k)
105
trace.log_error('Not loading the one in %r' %
106
sys.modules[cmd.__module__])
107
trace.log_error('Previously this command was registered from %r' %
108
sys.modules[previous.__module__])
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
111
132
def register_lazy(self, command_name, aliases, module_name):
118
139
key = self._get_name(command_name)
119
140
registry.Registry.register_lazy(self, key, module_name, command_name,
120
141
info=CommandInfo(aliases))
143
self._alias_dict[a] = key
123
146
plugin_cmds = CommandRegistry()
147
builtin_command_registry = CommandRegistry()
148
plugin_cmds.overridden_registry = builtin_command_registry
126
151
def register_command(cmd, decorate=False):
152
"""Register a plugin command.
154
Should generally be avoided in favor of lazy registration.
127
156
global plugin_cmds
128
157
return plugin_cmds.register(cmd, decorate)
136
165
return cmd[4:].replace('_','-')
168
@deprecated_function(deprecated_in((2, 2, 0)))
139
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():
140
182
import bzrlib.builtins
141
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()
144
188
def _scan_module_for_commands(module):
153
197
def _list_bzr_commands(names):
154
"""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.
155
202
# to eliminate duplicates
156
203
names.update(builtin_command_names())
157
204
names.update(plugin_command_names())
175
222
Use of all_command_names() is encouraged rather than builtin_command_names
176
223
and/or plugin_command_names.
178
return _builtin_commands().keys()
225
return builtin_command_registry.keys()
181
228
def plugin_command_names():
183
230
return plugin_cmds.keys()
186
@deprecated_function(deprecated_in((1, 17, 0)))
187
def get_all_cmds(plugins_override=False):
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():
203
233
def get_cmd_object(cmd_name, plugins_override=True):
204
234
"""Return the command object for a command.
212
242
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
215
def _get_cmd_object(cmd_name, plugins_override=True):
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
216
246
"""Get a command object.
218
248
:param cmd_name: The name of the command.
219
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.
220
252
:return: A Command object instance
221
253
:raises KeyError: If no command is found.
275
307
def _get_bzr_command(cmd_or_None, cmd_name):
276
308
"""Get a command from bzr's core."""
277
cmds = _builtin_commands()
279
return cmds[cmd_name]()
310
cmd_class = builtin_command_registry.get(cmd_name)
282
# look for any command which claims this as an alias
283
for real_cmd_name, cmd_class in cmds.iteritems():
284
if cmd_name in cmd_class.aliases:
286
315
return cmd_or_None
379
408
def __init__(self):
380
409
"""Construct an instance of this command."""
381
if self.__doc__ == Command.__doc__:
382
warn("No help message set for %r" % self)
410
if self.__doc__ == Command.__doc__ or not self.__doc__:
411
raise ValueError("No help message set for %r" % self)
383
412
# List of standard options directly supported
384
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()
438
@deprecated_method(deprecated_in((2, 1, 0)))
386
439
def _maybe_expand_globs(self, file_list):
387
440
"""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
389
445
:return: A possibly empty list of unicode paths.
391
447
Introduced in bzrlib 0.18.
395
if sys.platform == 'win32':
396
file_list = win32utils.glob_expand(file_list)
397
return list(file_list)
399
451
def _usage(self):
400
452
"""Return single-line grammar for this command.
432
484
doc = self.help()
434
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
486
raise NotImplementedError(
487
"self.help() returned None - no detailed help yet for %r" %
436
490
# Extract the summary (purpose) and sections out from the text
437
491
purpose,sections,order = self._get_help_parts(doc)
509
563
# so don't create a real link
510
564
see_also_links.append(item)
512
# Use a reST link for this entry
513
see_also_links.append("`%s`_" % (item,))
566
# Use a Sphinx link for this entry
567
link_text = ":doc:`%s <%s-help>`" % (item, item)
568
see_also_links.append(link_text)
514
569
see_also = see_also_links
515
570
result += ':See also: '
516
571
result += ', '.join(see_also) + '\n'
595
650
def _setup_outf(self):
596
651
"""Return a file linked to stdout, which has proper encoding."""
597
# Originally I was using self.stdout, but that looks
598
# *way* too much like sys.stdout
599
if self.encoding_type == 'exact':
600
# force sys.stdout to be binary stream on win32
601
if sys.platform == 'win32':
602
fileno = getattr(sys.stdout, 'fileno', None)
605
msvcrt.setmode(fileno(), os.O_BINARY)
606
self.outf = sys.stdout
609
output_encoding = osutils.get_terminal_encoding()
611
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
612
errors=self.encoding_type)
613
# For whatever reason codecs.getwriter() does not advertise its encoding
614
# it just returns the encoding of the wrapped file, which is completely
615
# bogus. So set the attribute, so we can find the correct encoding later.
616
self.outf.encoding = output_encoding
652
self.outf = ui.ui_factory.make_output_stream(
653
encoding_type=self.encoding_type)
618
655
def run_argv_aliases(self, argv, alias_argv=None):
619
656
"""Parse the command line and run with extra aliases in alias_argv."""
621
warn("Passing None for [] is deprecated from bzrlib 0.10",
622
DeprecationWarning, stacklevel=2)
624
657
args, opts = parse_args(self, argv, alias_argv)
626
659
# Process the standard options
654
687
return self.run(**all_cmd_args)
689
def _setup_run(self):
690
"""Wrap the defined run method on self with a cleanup.
692
This is called by __init__ to make the Command be able to be run
693
by just calling run(), as it could be before cleanups were added.
695
If a different form of cleanups are in use by your Command subclass,
696
you can override this method.
699
def run(*args, **kwargs):
700
self._operation = cleanup.OperationWithCleanups(class_run)
702
return self._operation.run_simple(*args, **kwargs)
707
@deprecated_method(deprecated_in((2, 2, 0)))
708
def run_direct(self, *args, **kwargs):
709
"""Deprecated thunk from bzrlib 2.1."""
710
return self.run(*args, **kwargs)
657
713
"""Actually run the command.
662
718
Return 0 or None if the command was successful, or a non-zero
663
719
shell error code if not. It's OK for this method to allow
664
720
an exception to raise up.
722
This method is automatically wrapped by Command.__init__ with a
723
cleanup operation, stored as self._operation. This can be used
724
via self.add_cleanup to perform automatic cleanups at the end of
727
The argument for run are assembled by introspection. So for instance,
728
if your command takes an argument files, you would declare::
730
def run(self, files=None):
666
733
raise NotImplementedError('no implementation of command %r'
954
@deprecated_function(deprecated_in((2, 2, 0)))
887
955
def shlex_split_unicode(unsplit):
889
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
956
return cmdline.split(unsplit)
892
959
def get_alias(cmd, config=None):
904
971
config = bzrlib.config.GlobalConfig()
905
972
alias = config.get_alias(cmd)
907
return shlex_split_unicode(alias)
974
return cmdline.split(alias)
978
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
912
979
"""Execute a command.
915
The command-line arguments, without the program name from argv[0]
916
These should already be decoded. All library/test code calling
917
run_bzr should be passing valid strings (don't need decoding).
919
Returns a command status or raises an exception.
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.
921
994
Special master options: these must come before the command because
922
995
they control how the command is interpreted.
941
1014
Generate line coverage report in the specified directory.
1017
Specify the number of processes that can be run concurrently (selftest).
1019
trace.mutter("bazaar version: " + bzrlib.__version__)
943
1020
argv = list(argv)
944
1021
trace.mutter("bzr arguments: %r", argv)
981
1061
debug.set_debug_flags_from_config()
1063
if not opt_no_plugins:
983
1068
argv = argv_copy
985
from bzrlib.builtins import cmd_help
986
cmd_help().run_argv_aliases([])
1070
get_cmd_object('help').run_argv_aliases([])
989
1073
if argv[0] == '--version':
990
from bzrlib.builtins import cmd_version
991
cmd_version().run_argv_aliases([])
1074
get_cmd_object('version').run_argv_aliases([])
994
if not opt_no_plugins:
995
from bzrlib.plugin import load_plugins
998
from bzrlib.plugin import disable_plugins
1001
1077
alias_argv = None
1003
1079
if not opt_no_aliases:
1004
1080
alias_argv = get_alias(argv[0])
1006
user_encoding = osutils.get_user_encoding()
1007
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1008
1082
argv[0] = alias_argv.pop(0)
1010
1084
cmd = argv.pop(0)
1011
# We want only 'ascii' command names, but the user may have typed
1012
# in a Unicode name. In that case, they should just get a
1013
# 'command not found' error later.
1015
1085
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1016
1086
run = cmd_obj.run_argv_aliases
1017
1087
run_argv = [argv, alias_argv]
1081
1151
"bzr plugin-provider-db check")
1084
def main(argv=None):
1085
"""Main entry point of command-line interface.
1087
:param argv: list of unicode command-line arguments similar to sys.argv.
1088
argv[0] is script name usually, it will be ignored.
1089
Don't pass here sys.argv because this list contains plain strings
1090
and not unicode; pass None instead.
1092
:return: exit code of bzr command.
1095
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1096
sys.stdin, sys.stdout, sys.stderr)
1098
# Is this a final release version? If so, we should suppress warnings
1099
if bzrlib.version_info[3] == 'final':
1100
suppress_deprecation_warnings(override=False)
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.
1101
1158
if argv is None:
1102
argv = osutils.get_unicode_argv()
1159
return osutils.get_unicode_argv()
1111
1168
new_argv.append(a.decode('ascii'))
1112
1169
except UnicodeDecodeError:
1113
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()
1115
1188
ret = run_bzr_catch_errors(argv)
1189
bzrlib.ui.ui_factory.log_transport_activity(
1190
display=('bytes' in debug.debug_flags))
1116
1191
trace.mutter("return code %d", ret)
1117
osutils.report_extension_load_failures()
1124
1198
This function assumed that that UI layer is setup, that symbol deprecations
1125
1199
are already applied, and that unicode decoding has already been performed on argv.
1201
# done here so that they're covered for every test run
1127
1202
install_bzr_command_hooks()
1128
1203
return exception_to_return_code(run_bzr, argv)
1134
1209
This is used for the test suite, and might be useful for other programs
1135
1210
that want to wrap the commandline interface.
1212
# done here so that they're covered for every test run
1137
1213
install_bzr_command_hooks()
1139
1215
return run_bzr(argv)
1162
1238
if topic and topic.startswith(self.prefix):
1163
1239
topic = topic[len(self.prefix):]
1165
cmd = _get_cmd_object(topic)
1241
cmd = _get_cmd_object(topic, check_missing=False)
1166
1242
except KeyError:
added
removed
bzrlib/commands.py
