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
_register_builtin_commands()
226
return builtin_command_registry.keys()
178
return _builtin_commands().keys()
229
181
def plugin_command_names():
231
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():
234
203
def get_cmd_object(cmd_name, plugins_override=True):
235
204
"""Return the command object for a command.
243
212
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
246
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
215
def _get_cmd_object(cmd_name, plugins_override=True):
247
216
"""Get a command object.
249
218
:param cmd_name: The name of the command.
250
219
:param plugins_override: Allow plugins to override builtins.
251
:param check_missing: Look up commands not found in the regular index via
252
the get_missing_command hook.
253
220
:return: A Command object instance
254
221
:raises KeyError: If no command is found.
308
275
def _get_bzr_command(cmd_or_None, cmd_name):
309
276
"""Get a command from bzr's core."""
277
cmds = _builtin_commands()
311
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:
316
286
return cmd_or_None
398
368
will not mangled.
400
370
:cvar hooks: An instance of CommandHooks.
401
:ivar __doc__: The help shown by 'bzr help command' for this command.
402
This is set by assigning explicitly to __doc__ so that -OO can
406
__doc__ = "My help goes here"
415
379
def __init__(self):
416
380
"""Construct an instance of this command."""
381
if self.__doc__ == Command.__doc__:
382
warn("No help message set for %r" % self)
417
383
# List of standard options directly supported
418
384
self.supported_std_options = []
421
def add_cleanup(self, cleanup_func, *args, **kwargs):
422
"""Register a function to call after self.run returns or raises.
424
Functions will be called in LIFO order.
426
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
428
def cleanup_now(self):
429
"""Execute and empty pending cleanup functions immediately.
431
After cleanup_now all registered cleanups are forgotten. add_cleanup
432
may be called again after cleanup_now; these cleanups will be called
433
after self.run returns or raises (or when cleanup_now is next called).
435
This is useful for releasing expensive or contentious resources (such
436
as write locks) before doing further work that does not require those
437
resources (such as writing results to self.outf). Note though, that
438
as it releases all resources, this may release locks that the command
439
wants to hold, so use should be done with care.
441
self._operation.cleanup_now()
443
@deprecated_method(deprecated_in((2, 1, 0)))
444
386
def _maybe_expand_globs(self, file_list):
445
387
"""Glob expand file_list if the platform does not do that itself.
447
Not used anymore, now that the bzr command-line parser globs on
450
389
:return: A possibly empty list of unicode paths.
452
391
Introduced in bzrlib 0.18.
395
if sys.platform == 'win32':
396
file_list = win32utils.glob_expand(file_list)
397
return list(file_list)
456
399
def _usage(self):
457
400
"""Return single-line grammar for this command.
487
430
message explaining how to obtain full help.
489
432
doc = self.help()
491
doc = "No help for this command."
434
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
493
436
# Extract the summary (purpose) and sections out from the text
494
437
purpose,sections,order = self._get_help_parts(doc)
514
457
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
516
459
options = option.get_optparser(self.options()).format_option_help()
517
# XXX: According to the spec, ReST option lists actually don't support
518
# options like --1.9 so that causes syntax errors (in Sphinx at least).
519
# As that pattern always appears in the commands that break, we trap
520
# on that and then format that block of 'format' options as a literal
522
if not plain and options.find(' --1.9 ') != -1:
523
options = options.replace(' format:\n', ' format::\n\n', 1)
524
460
if options.startswith('Options:'):
525
461
result += ':' + options
526
462
elif options.startswith('options:'):
566
502
# so don't create a real link
567
503
see_also_links.append(item)
569
# Use a Sphinx link for this entry
570
link_text = ":doc:`%s <%s-help>`" % (item, item)
571
see_also_links.append(link_text)
505
# Use a reST link for this entry
506
see_also_links.append("`%s`_" % (item,))
572
507
see_also = see_also_links
573
508
result += ':See also: '
574
509
result += ', '.join(see_also) + '\n'
653
588
def _setup_outf(self):
654
589
"""Return a file linked to stdout, which has proper encoding."""
655
self.outf = ui.ui_factory.make_output_stream(
656
encoding_type=self.encoding_type)
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
658
611
def run_argv_aliases(self, argv, alias_argv=None):
659
612
"""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)
660
617
args, opts = parse_args(self, argv, alias_argv)
662
619
# Process the standard options
690
647
return self.run(**all_cmd_args)
692
def _setup_run(self):
693
"""Wrap the defined run method on self with a cleanup.
695
This is called by __init__ to make the Command be able to be run
696
by just calling run(), as it could be before cleanups were added.
698
If a different form of cleanups are in use by your Command subclass,
699
you can override this method.
702
def run(*args, **kwargs):
703
self._operation = cleanup.OperationWithCleanups(class_run)
705
return self._operation.run_simple(*args, **kwargs)
710
@deprecated_method(deprecated_in((2, 2, 0)))
711
def run_direct(self, *args, **kwargs):
712
"""Deprecated thunk from bzrlib 2.1."""
713
return self.run(*args, **kwargs)
716
650
"""Actually run the command.
721
655
Return 0 or None if the command was successful, or a non-zero
722
656
shell error code if not. It's OK for this method to allow
723
657
an exception to raise up.
725
This method is automatically wrapped by Command.__init__ with a
726
cleanup operation, stored as self._operation. This can be used
727
via self.add_cleanup to perform automatic cleanups at the end of
730
The argument for run are assembled by introspection. So for instance,
731
if your command takes an argument files, you would declare::
733
def run(self, files=None):
736
659
raise NotImplementedError('no implementation of command %r'
957
@deprecated_function(deprecated_in((2, 2, 0)))
958
880
def shlex_split_unicode(unsplit):
959
return cmdline.split(unsplit)
882
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
962
885
def get_alias(cmd, config=None):
974
897
config = bzrlib.config.GlobalConfig()
975
898
alias = config.get_alias(cmd)
977
return cmdline.split(alias)
900
return shlex_split_unicode(alias)
981
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
982
905
"""Execute a command.
984
:param argv: The command-line arguments, without the program name from
985
argv[0] These should already be decoded. All library/test code calling
986
run_bzr should be passing valid strings (don't need decoding).
987
:param load_plugins: What function to call when triggering plugin loading.
988
This function should take no arguments and cause all plugins to be
990
:param disable_plugins: What function to call when disabling plugin
991
loading. This function should take no arguments and cause all plugin
992
loading to be prohibited (so that code paths in your application that
993
know about some plugins possibly being present will fail to import
994
those plugins even if they are installed.)
995
:return: Returns a command exit code or raises an exception.
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.
997
914
Special master options: these must come before the command because
998
915
they control how the command is interpreted.
1017
934
Generate line coverage report in the specified directory.
1020
Specify the number of processes that can be run concurrently (selftest).
1022
trace.mutter("bazaar version: " + bzrlib.__version__)
1023
936
argv = list(argv)
1024
937
trace.mutter("bzr arguments: %r", argv)
1049
962
opt_no_aliases = True
1050
963
elif a == '--builtin':
1051
964
opt_builtin = True
1052
elif a == '--concurrency':
1053
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1055
965
elif a == '--coverage':
1056
966
opt_coverage_dir = argv[i + 1]
1058
elif a == '--profile-imports':
1059
pass # already handled in startup script Bug #588277
1060
968
elif a.startswith('-D'):
1061
969
debug.debug_flags.add(a[2:])
1066
974
debug.set_debug_flags_from_config()
978
from bzrlib.builtins import cmd_help
979
cmd_help().run_argv_aliases([])
982
if argv[0] == '--version':
983
from bzrlib.builtins import cmd_version
984
cmd_version().run_argv_aliases([])
1068
987
if not opt_no_plugins:
988
from bzrlib.plugin import load_plugins
991
from bzrlib.plugin import disable_plugins
1071
992
disable_plugins()
1075
get_cmd_object('help').run_argv_aliases([])
1078
if argv[0] == '--version':
1079
get_cmd_object('version').run_argv_aliases([])
1082
994
alias_argv = None
1084
996
if not opt_no_aliases:
1085
997
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]
1087
1001
argv[0] = alias_argv.pop(0)
1089
1003
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.
1090
1008
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1091
1009
run = cmd_obj.run_argv_aliases
1092
1010
run_argv = [argv, alias_argv]
1110
1028
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1112
1030
ret = run(*run_argv)
1031
if 'memory' in debug.debug_flags:
1032
trace.debug_memory('Process status after command:', short=False)
1113
1033
return ret or 0
1115
1035
# reset, in case we may do other commands later within the same
1116
1036
# process. Commands that want to execute sub-commands must propagate
1117
1037
# --verbose in their own way.
1118
if 'memory' in debug.debug_flags:
1119
trace.debug_memory('Process status after command:', short=False)
1120
1038
option._verbosity_level = saved_verbosity_level
1156
1074
"bzr plugin-provider-db check")
1160
def _specified_or_unicode_argv(argv):
1161
# For internal or testing use, argv can be passed. Otherwise, get it from
1162
# the process arguments in a unicode-safe way.
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)
1163
1094
if argv is None:
1164
return osutils.get_unicode_argv()
1095
argv = osutils.get_unicode_argv()
1173
1104
new_argv.append(a.decode('ascii'))
1174
1105
except UnicodeDecodeError:
1175
1106
raise errors.BzrError("argv should be list of unicode strings.")
1179
def main(argv=None):
1180
"""Main entry point of command-line interface.
1182
Typically `bzrlib.initialize` should be called first.
1184
:param argv: list of unicode command-line arguments similar to sys.argv.
1185
argv[0] is script name usually, it will be ignored.
1186
Don't pass here sys.argv because this list contains plain strings
1187
and not unicode; pass None instead.
1189
:return: exit code of bzr command.
1191
argv = _specified_or_unicode_argv(argv)
1192
_register_builtin_commands()
1193
1108
ret = run_bzr_catch_errors(argv)
1194
bzrlib.ui.ui_factory.log_transport_activity(
1195
display=('bytes' in debug.debug_flags))
1196
1109
trace.mutter("return code %d", ret)
1203
1116
This function assumed that that UI layer is setup, that symbol deprecations
1204
1117
are already applied, and that unicode decoding has already been performed on argv.
1206
# done here so that they're covered for every test run
1207
1119
install_bzr_command_hooks()
1208
1120
return exception_to_return_code(run_bzr, argv)
1214
1126
This is used for the test suite, and might be useful for other programs
1215
1127
that want to wrap the commandline interface.
1217
# done here so that they're covered for every test run
1218
1129
install_bzr_command_hooks()
1220
1131
return run_bzr(argv)
1243
1154
if topic and topic.startswith(self.prefix):
1244
1155
topic = topic[len(self.prefix):]
1246
cmd = _get_cmd_object(topic, check_missing=False)
1157
cmd = _get_cmd_object(topic)
1247
1158
except KeyError:
added
removed
bzrlib/commands.py
