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
56
from bzrlib.symbol_versioning import (
55
57
deprecated_function,
59
suppress_deprecation_warnings,
74
76
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
79
def _get_name(command_name):
110
96
previous = self.get(k_unsquished)
113
if self.overridden_registry:
115
previous = self.overridden_registry.get(k_unsquished)
98
previous = _builtin_commands().get(k_unsquished)
118
99
info = CommandInfo.from_command(cmd)
120
101
registry.Registry.register(self, k_unsquished, cmd,
121
102
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
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__])
132
111
def register_lazy(self, command_name, aliases, module_name):
139
118
key = self._get_name(command_name)
140
119
registry.Registry.register_lazy(self, key, module_name, command_name,
141
120
info=CommandInfo(aliases))
143
self._alias_dict[a] = key
146
123
plugin_cmds = CommandRegistry()
147
builtin_command_registry = CommandRegistry()
148
plugin_cmds.overridden_registry = builtin_command_registry
151
126
def register_command(cmd, decorate=False):
152
"""Register a plugin command.
154
Should generally be avoided in favor of lazy registration.
156
127
global plugin_cmds
157
128
return plugin_cmds.register(cmd, decorate)
165
136
return cmd[4:].replace('_','-')
168
@deprecated_function(deprecated_in((2, 2, 0)))
169
139
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
140
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()
141
return _scan_module_for_commands(bzrlib.builtins)
188
144
def _scan_module_for_commands(module):
197
153
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.
154
"""Find commands from bzr's core and plugins."""
202
155
# to eliminate duplicates
203
156
names.update(builtin_command_names())
204
157
names.update(plugin_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, 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():
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
221
:raises KeyError: If no command is found.
307
275
def _get_bzr_command(cmd_or_None, cmd_name):
308
276
"""Get a command from bzr's core."""
277
cmds = _builtin_commands()
310
cmd_class = builtin_command_registry.get(cmd_name)
279
return cmds[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:
315
286
return cmd_or_None
411
382
warn("No help message set for %r" % self)
412
383
# List of standard options directly supported
413
384
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
386
def _maybe_expand_globs(self, file_list):
440
387
"""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
389
:return: A possibly empty list of unicode paths.
447
391
Introduced in bzrlib 0.18.
395
if sys.platform == 'win32':
396
file_list = win32utils.glob_expand(file_list)
397
return list(file_list)
451
399
def _usage(self):
452
400
"""Return single-line grammar for this command.
506
454
# 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
455
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
456
if options.startswith('Options:'):
520
457
result += ':' + options
521
458
elif options.startswith('options:'):
561
498
# so don't create a real link
562
499
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)
501
# Use a reST link for this entry
502
see_also_links.append("`%s`_" % (item,))
567
503
see_also = see_also_links
568
504
result += ':See also: '
569
505
result += ', '.join(see_also) + '\n'
648
584
def _setup_outf(self):
649
585
"""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)
586
# Originally I was using self.stdout, but that looks
587
# *way* too much like sys.stdout
588
if self.encoding_type == 'exact':
589
# force sys.stdout to be binary stream on win32
590
if sys.platform == 'win32':
591
fileno = getattr(sys.stdout, 'fileno', None)
594
msvcrt.setmode(fileno(), os.O_BINARY)
595
self.outf = sys.stdout
598
output_encoding = osutils.get_terminal_encoding()
600
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
601
errors=self.encoding_type)
602
# For whatever reason codecs.getwriter() does not advertise its encoding
603
# it just returns the encoding of the wrapped file, which is completely
604
# bogus. So set the attribute, so we can find the correct encoding later.
605
self.outf.encoding = output_encoding
653
607
def run_argv_aliases(self, argv, alias_argv=None):
654
608
"""Parse the command line and run with extra aliases in alias_argv."""
610
warn("Passing None for [] is deprecated from bzrlib 0.10",
611
DeprecationWarning, stacklevel=2)
655
613
args, opts = parse_args(self, argv, alias_argv)
657
615
# Process the standard options
685
643
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
646
"""Actually run the command.
716
651
Return 0 or None if the command was successful, or a non-zero
717
652
shell error code if not. It's OK for this method to allow
718
653
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
655
raise NotImplementedError('no implementation of command %r'
952
@deprecated_function(deprecated_in((2, 2, 0)))
953
876
def shlex_split_unicode(unsplit):
954
return cmdline.split(unsplit)
878
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
957
881
def get_alias(cmd, config=None):
969
893
config = bzrlib.config.GlobalConfig()
970
894
alias = config.get_alias(cmd)
972
return cmdline.split(alias)
896
return shlex_split_unicode(alias)
976
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
977
901
"""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.
904
The command-line arguments, without the program name from argv[0]
905
These should already be decoded. All library/test code calling
906
run_bzr should be passing valid strings (don't need decoding).
908
Returns a command status or raises an exception.
992
910
Special master options: these must come before the command because
993
911
they control how the command is interpreted.
1012
930
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
932
argv = list(argv)
1019
933
trace.mutter("bzr arguments: %r", argv)
1059
970
debug.set_debug_flags_from_config()
974
from bzrlib.builtins import cmd_help
975
cmd_help().run_argv_aliases([])
978
if argv[0] == '--version':
979
from bzrlib.builtins import cmd_version
980
cmd_version().run_argv_aliases([])
1061
983
if not opt_no_plugins:
984
from bzrlib.plugin import load_plugins
987
from bzrlib.plugin import disable_plugins
1064
988
disable_plugins()
1068
get_cmd_object('help').run_argv_aliases([])
1071
if argv[0] == '--version':
1072
get_cmd_object('version').run_argv_aliases([])
1075
990
alias_argv = None
1077
992
if not opt_no_aliases:
1109
1024
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1111
1026
ret = run(*run_argv)
1027
if 'memory' in debug.debug_flags:
1028
trace.debug_memory('Process status after command:', short=False)
1112
1029
return ret or 0
1114
1031
# reset, in case we may do other commands later within the same
1115
1032
# process. Commands that want to execute sub-commands must propagate
1116
1033
# --verbose in their own way.
1117
if 'memory' in debug.debug_flags:
1118
trace.debug_memory('Process status after command:', short=False)
1119
1034
option._verbosity_level = saved_verbosity_level
1155
1070
"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.
1073
def main(argv=None):
1074
"""Main entry point of command-line interface.
1076
:param argv: list of unicode command-line arguments similar to sys.argv.
1077
argv[0] is script name usually, it will be ignored.
1078
Don't pass here sys.argv because this list contains plain strings
1079
and not unicode; pass None instead.
1081
:return: exit code of bzr command.
1084
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1085
sys.stdin, sys.stdout, sys.stderr)
1087
# Is this a final release version? If so, we should suppress warnings
1088
if bzrlib.version_info[3] == 'final':
1089
suppress_deprecation_warnings(override=False)
1162
1090
if argv is None:
1163
return osutils.get_unicode_argv()
1091
argv = osutils.get_unicode_argv()
1172
1100
new_argv.append(a.decode('ascii'))
1173
1101
except UnicodeDecodeError:
1174
1102
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()
1192
1104
ret = run_bzr_catch_errors(argv)
1193
bzrlib.ui.ui_factory.log_transport_activity(
1194
display=('bytes' in debug.debug_flags))
1195
1105
trace.mutter("return code %d", ret)
1202
1112
This function assumed that that UI layer is setup, that symbol deprecations
1203
1113
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
1115
install_bzr_command_hooks()
1207
1116
return exception_to_return_code(run_bzr, argv)
1213
1122
This is used for the test suite, and might be useful for other programs
1214
1123
that want to wrap the commandline interface.
1216
# done here so that they're covered for every test run
1217
1125
install_bzr_command_hooks()
1219
1127
return run_bzr(argv)
1242
1150
if topic and topic.startswith(self.prefix):
1243
1151
topic = topic[len(self.prefix):]
1245
cmd = _get_cmd_object(topic, check_missing=False)
1153
cmd = _get_cmd_object(topic)
1246
1154
except KeyError:
added
removed
bzrlib/commands.py
