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
382
411
warn("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.
457
509
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
459
511
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)
460
519
if options.startswith('Options:'):
461
520
result += ':' + options
462
521
elif options.startswith('options:'):
502
561
# so don't create a real link
503
562
see_also_links.append(item)
505
# Use a reST link for this entry
506
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)
507
567
see_also = see_also_links
508
568
result += ':See also: '
509
569
result += ', '.join(see_also) + '\n'
588
648
def _setup_outf(self):
589
649
"""Return a file linked to stdout, which has proper encoding."""
590
# Originally I was using self.stdout, but that looks
591
# *way* too much like sys.stdout
592
if self.encoding_type == 'exact':
593
# force sys.stdout to be binary stream on win32
594
if sys.platform == 'win32':
595
fileno = getattr(sys.stdout, 'fileno', None)
598
msvcrt.setmode(fileno(), os.O_BINARY)
599
self.outf = sys.stdout
602
output_encoding = osutils.get_terminal_encoding()
604
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
605
errors=self.encoding_type)
606
# For whatever reason codecs.getwriter() does not advertise its encoding
607
# it just returns the encoding of the wrapped file, which is completely
608
# bogus. So set the attribute, so we can find the correct encoding later.
609
self.outf.encoding = output_encoding
650
self.outf = ui.ui_factory.make_output_stream(
651
encoding_type=self.encoding_type)
611
653
def run_argv_aliases(self, argv, alias_argv=None):
612
654
"""Parse the command line and run with extra aliases in alias_argv."""
614
warn("Passing None for [] is deprecated from bzrlib 0.10",
615
DeprecationWarning, stacklevel=2)
617
655
args, opts = parse_args(self, argv, alias_argv)
619
657
# Process the standard options
647
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)
650
711
"""Actually run the command.
655
716
Return 0 or None if the command was successful, or a non-zero
656
717
shell error code if not. It's OK for this method to allow
657
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):
659
731
raise NotImplementedError('no implementation of command %r'
952
@deprecated_function(deprecated_in((2, 2, 0)))
880
953
def shlex_split_unicode(unsplit):
882
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
954
return cmdline.split(unsplit)
885
957
def get_alias(cmd, config=None):
897
969
config = bzrlib.config.GlobalConfig()
898
970
alias = config.get_alias(cmd)
900
return shlex_split_unicode(alias)
972
return cmdline.split(alias)
976
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
905
977
"""Execute a command.
908
The command-line arguments, without the program name from argv[0]
909
These should already be decoded. All library/test code calling
910
run_bzr should be passing valid strings (don't need decoding).
912
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.
914
992
Special master options: these must come before the command because
915
993
they control how the command is interpreted.
934
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__)
936
1018
argv = list(argv)
937
1019
trace.mutter("bzr arguments: %r", argv)
974
1059
debug.set_debug_flags_from_config()
1061
if not opt_no_plugins:
976
1066
argv = argv_copy
978
from bzrlib.builtins import cmd_help
979
cmd_help().run_argv_aliases([])
1068
get_cmd_object('help').run_argv_aliases([])
982
1071
if argv[0] == '--version':
983
from bzrlib.builtins import cmd_version
984
cmd_version().run_argv_aliases([])
1072
get_cmd_object('version').run_argv_aliases([])
987
if not opt_no_plugins:
988
from bzrlib.plugin import load_plugins
991
from bzrlib.plugin import disable_plugins
994
1075
alias_argv = None
996
1077
if not opt_no_aliases:
997
1078
alias_argv = get_alias(argv[0])
999
user_encoding = osutils.get_user_encoding()
1000
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1001
1080
argv[0] = alias_argv.pop(0)
1003
1082
cmd = argv.pop(0)
1004
# We want only 'ascii' command names, but the user may have typed
1005
# in a Unicode name. In that case, they should just get a
1006
# 'command not found' error later.
1008
1083
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1009
1084
run = cmd_obj.run_argv_aliases
1010
1085
run_argv = [argv, alias_argv]
1028
1103
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1030
1105
ret = run(*run_argv)
1031
if 'memory' in debug.debug_flags:
1032
trace.debug_memory('Process status after command:', short=False)
1033
1106
return ret or 0
1035
1108
# reset, in case we may do other commands later within the same
1036
1109
# process. Commands that want to execute sub-commands must propagate
1037
1110
# --verbose in their own way.
1111
if 'memory' in debug.debug_flags:
1112
trace.debug_memory('Process status after command:', short=False)
1038
1113
option._verbosity_level = saved_verbosity_level
1074
1149
"bzr plugin-provider-db check")
1077
def main(argv=None):
1078
"""Main entry point of command-line interface.
1080
:param argv: list of unicode command-line arguments similar to sys.argv.
1081
argv[0] is script name usually, it will be ignored.
1082
Don't pass here sys.argv because this list contains plain strings
1083
and not unicode; pass None instead.
1085
:return: exit code of bzr command.
1088
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1089
sys.stdin, sys.stdout, sys.stderr)
1091
# Is this a final release version? If so, we should suppress warnings
1092
if bzrlib.version_info[3] == 'final':
1093
suppress_deprecation_warnings(override=False)
1153
def _specified_or_unicode_argv(argv):
1154
# For internal or testing use, argv can be passed. Otherwise, get it from
1155
# the process arguments in a unicode-safe way.
1094
1156
if argv is None:
1095
argv = osutils.get_unicode_argv()
1157
return osutils.get_unicode_argv()
1104
1166
new_argv.append(a.decode('ascii'))
1105
1167
except UnicodeDecodeError:
1106
1168
raise errors.BzrError("argv should be list of unicode strings.")
1172
def main(argv=None):
1173
"""Main entry point of command-line interface.
1175
Typically `bzrlib.initialize` should be called first.
1177
:param argv: list of unicode command-line arguments similar to sys.argv.
1178
argv[0] is script name usually, it will be ignored.
1179
Don't pass here sys.argv because this list contains plain strings
1180
and not unicode; pass None instead.
1182
:return: exit code of bzr command.
1184
argv = _specified_or_unicode_argv(argv)
1185
_register_builtin_commands()
1108
1186
ret = run_bzr_catch_errors(argv)
1187
bzrlib.ui.ui_factory.log_transport_activity(
1188
display=('bytes' in debug.debug_flags))
1109
1189
trace.mutter("return code %d", ret)
1116
1196
This function assumed that that UI layer is setup, that symbol deprecations
1117
1197
are already applied, and that unicode decoding has already been performed on argv.
1199
# done here so that they're covered for every test run
1119
1200
install_bzr_command_hooks()
1120
1201
return exception_to_return_code(run_bzr, argv)
1126
1207
This is used for the test suite, and might be useful for other programs
1127
1208
that want to wrap the commandline interface.
1210
# done here so that they're covered for every test run
1129
1211
install_bzr_command_hooks()
1131
1213
return run_bzr(argv)
1154
1236
if topic and topic.startswith(self.prefix):
1155
1237
topic = topic[len(self.prefix):]
1157
cmd = _get_cmd_object(topic)
1239
cmd = _get_cmd_object(topic, check_missing=False)
1158
1240
except KeyError:
added
removed
bzrlib/commands.py
