26
24
# TODO: Specific "examples" property on commands for consistent formatting.
28
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
29
# the profile output behind so it can be interactively examined?
34
29
from bzrlib.lazy_import import lazy_import
35
30
lazy_import(globals(), """
39
from warnings import warn
42
35
from bzrlib import (
54
from bzrlib.hooks import HookPoint, Hooks
49
from bzrlib.hooks import Hooks
50
from bzrlib.i18n import gettext
55
51
# Compatibility - Option used to be in commands.
56
52
from bzrlib.option import Option
53
from bzrlib.plugin import disable_plugins, load_plugins
57
54
from bzrlib import registry
58
from bzrlib.symbol_versioning import (
62
suppress_deprecation_warnings,
66
57
class CommandInfo(object):
79
70
class CommandRegistry(registry.Registry):
71
"""Special registry mapping command names to command classes.
73
:ivar overridden_registry: Look in this registry for commands being
74
overridden by this registry. This can be used to tell plugin commands
75
about the builtin they're decorating.
79
registry.Registry.__init__(self)
80
self.overridden_registry = None
81
# map from aliases to the real command that implements the name
84
def get(self, command_name):
85
real_name = self._alias_dict.get(command_name, command_name)
86
return registry.Registry.get(self, real_name)
82
89
def _get_name(command_name):
121
135
key = self._get_name(command_name)
122
136
registry.Registry.register_lazy(self, key, module_name, command_name,
123
137
info=CommandInfo(aliases))
139
self._alias_dict[a] = key
126
142
plugin_cmds = CommandRegistry()
143
builtin_command_registry = CommandRegistry()
144
plugin_cmds.overridden_registry = builtin_command_registry
129
147
def register_command(cmd, decorate=False):
148
"""Register a plugin command.
150
Should generally be avoided in favor of lazy registration.
130
152
global plugin_cmds
131
153
return plugin_cmds.register(cmd, decorate)
186
217
return plugin_cmds.keys()
189
@deprecated_function(deprecated_in((1, 17, 0)))
190
def get_all_cmds(plugins_override=False):
191
"""Return canonical name and class for most commands.
193
NB: This does not return all commands since the introduction of
194
command hooks, and returning the class is not sufficient to
195
get correctly setup commands, which is why it is deprecated.
197
Use 'all_command_names' + 'get_cmd_object' instead.
199
d = _builtin_commands()
201
d.update(plugin_cmds.iteritems())
202
for k, v in d.iteritems():
206
220
def get_cmd_object(cmd_name, plugins_override=True):
207
221
"""Return the command object for a command.
213
227
return _get_cmd_object(cmd_name, plugins_override)
215
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
218
def _get_cmd_object(cmd_name, plugins_override=True):
229
raise errors.BzrCommandError(gettext('unknown command "%s"') % cmd_name)
232
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
219
233
"""Get a command object.
221
235
:param cmd_name: The name of the command.
222
236
:param plugins_override: Allow plugins to override builtins.
237
:param check_missing: Look up commands not found in the regular index via
238
the get_missing_command hook.
223
239
:return: A Command object instance
224
240
:raises KeyError: If no command is found.
331
346
summary, then a complete description of the command. A grammar
332
347
description will be inserted.
335
Other accepted names for this command.
338
List of argument forms, marked with whether they are optional,
343
['to_location', 'from_branch?', 'file*']
345
'to_location' is required
346
'from_branch' is optional
347
'file' can be specified 0 or more times
350
List of options that may be given for this command. These can
351
be either strings, referring to globally-defined options,
352
or option objects. Retrieve through options().
355
If true, this command isn't advertised. This is typically
349
:cvar aliases: Other accepted names for this command.
351
:cvar takes_args: List of argument forms, marked with whether they are
352
optional, repeated, etc. Examples::
354
['to_location', 'from_branch?', 'file*']
356
* 'to_location' is required
357
* 'from_branch' is optional
358
* 'file' can be specified 0 or more times
360
:cvar takes_options: List of options that may be given for this command.
361
These can be either strings, referring to globally-defined options, or
362
option objects. Retrieve through options().
364
:cvar hidden: If true, this command isn't advertised. This is typically
356
365
for commands intended for expert users.
359
Command objects will get a 'outf' attribute, which has been
360
setup to properly handle encoding of unicode strings.
361
encoding_type determines what will happen when characters cannot
363
strict - abort if we cannot decode
364
replace - put in a bogus character (typically '?')
365
exact - do not encode sys.stdout
367
NOTE: by default on Windows, sys.stdout is opened as a text
368
stream, therefore LF line-endings are converted to CRLF.
369
When a command uses encoding_type = 'exact', then
370
sys.stdout is forced to be a binary stream, and line-endings
367
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
368
been setup to properly handle encoding of unicode strings.
369
encoding_type determines what will happen when characters cannot be
372
* strict - abort if we cannot decode
373
* replace - put in a bogus character (typically '?')
374
* exact - do not encode sys.stdout
376
NOTE: by default on Windows, sys.stdout is opened as a text stream,
377
therefore LF line-endings are converted to CRLF. When a command uses
378
encoding_type = 'exact', then sys.stdout is forced to be a binary
379
stream, and line-endings will not mangled.
382
A string indicating the real name under which this command was
383
invoked, before expansion of aliases.
384
(This may be None if the command was constructed and run in-process.)
373
386
:cvar hooks: An instance of CommandHooks.
388
:cvar __doc__: The help shown by 'bzr help command' for this command.
389
This is set by assigning explicitly to __doc__ so that -OO can
393
__doc__ = "My help goes here"
377
397
takes_options = []
378
398
encoding_type = 'strict'
382
404
def __init__(self):
383
405
"""Construct an instance of this command."""
384
if self.__doc__ == Command.__doc__:
385
warn("No help message set for %r" % self)
386
406
# List of standard options directly supported
387
407
self.supported_std_options = []
388
self._operation = cleanup.OperationWithCleanups(self.run)
390
410
def add_cleanup(self, cleanup_func, *args, **kwargs):
391
411
"""Register a function to call after self.run returns or raises.
404
424
This is useful for releasing expensive or contentious resources (such
405
425
as write locks) before doing further work that does not require those
406
resources (such as writing results to self.outf).
426
resources (such as writing results to self.outf). Note though, that
427
as it releases all resources, this may release locks that the command
428
wants to hold, so use should be done with care.
408
430
self._operation.cleanup_now()
410
@deprecated_method(deprecated_in((2, 1, 0)))
411
def _maybe_expand_globs(self, file_list):
412
"""Glob expand file_list if the platform does not do that itself.
414
Not used anymore, now that the bzr command-line parser globs on
417
:return: A possibly empty list of unicode paths.
419
Introduced in bzrlib 0.18.
423
432
def _usage(self):
424
433
"""Return single-line grammar for this command.
453
462
usage help (e.g. Purpose, Usage, Options) with a
454
463
message explaining how to obtain full help.
466
i18n.install() # Install i18n only for get_help_text for now.
456
467
doc = self.help()
458
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
469
# Note: If self.gettext() translates ':Usage:\n', the section will
470
# be shown after "Description" section and we don't want to
471
# translate the usage string.
472
# Though, bzr export-pot don't exports :Usage: section and it must
474
doc = self.gettext(doc)
476
doc = gettext("No help for this command.")
460
478
# Extract the summary (purpose) and sections out from the text
461
479
purpose,sections,order = self._get_help_parts(doc)
480
498
# XXX: optparse implicitly rewraps the help, and not always perfectly,
481
499
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
483
options = option.get_optparser(self.options()).format_option_help()
484
# XXX: According to the spec, ReST option lists actually don't support
485
# options like --1.9 so that causes syntax errors (in Sphinx at least).
486
# As that pattern always appears in the commands that break, we trap
487
# on that and then format that block of 'format' options as a literal
489
if not plain and options.find(' --1.9 ') != -1:
501
parser = option.get_optparser(self.options())
502
options = parser.format_option_help()
503
# FIXME: According to the spec, ReST option lists actually don't
504
# support options like --1.14 so that causes syntax errors (in Sphinx
505
# at least). As that pattern always appears in the commands that
506
# break, we trap on that and then format that block of 'format' options
507
# as a literal block. We use the most recent format still listed so we
508
# don't have to do that too often -- vila 20110514
509
if not plain and options.find(' --1.14 ') != -1:
490
510
options = options.replace(' format:\n', ' format::\n\n', 1)
491
511
if options.startswith('Options:'):
492
result += ':' + options
493
elif options.startswith('options:'):
494
# Python 2.4 version of optparse
495
result += ':Options:' + options[len('options:'):]
512
result += gettext(':Options:%s') % (options[len('options:'):],)
497
514
result += options
503
520
if sections.has_key(None):
504
521
text = sections.pop(None)
505
522
text = '\n '.join(text.splitlines())
506
result += ':%s:\n %s\n\n' % ('Description',text)
523
result += gettext(':Description:\n %s\n\n') % (text,)
508
525
# Add the custom sections (e.g. Examples). Note that there's no need
509
526
# to indent these as they must be indented already in the source.
511
528
for label in order:
512
if sections.has_key(label):
513
result += ':%s:\n%s\n' % (label,sections[label])
529
if label in sections:
530
result += ':%s:\n%s\n' % (label, sections[label])
516
result += ("See bzr help %s for more details and examples.\n\n"
533
result += (gettext("See bzr help %s for more details and examples.\n\n")
519
536
# Add the aliases, source (plug-in) and see also links, if any
521
result += ':Aliases: '
538
result += gettext(':Aliases: ')
522
539
result += ', '.join(self.aliases) + '\n'
523
540
plugin_name = self.plugin_name()
524
541
if plugin_name is not None:
525
result += ':From: plugin "%s"\n' % plugin_name
542
result += gettext(':From: plugin "%s"\n') % plugin_name
526
543
see_also = self.get_see_also(additional_see_also)
528
545
if not plain and see_also_as_links:
625
642
def run_argv_aliases(self, argv, alias_argv=None):
626
643
"""Parse the command line and run with extra aliases in alias_argv."""
628
warn("Passing None for [] is deprecated from bzrlib 0.10",
629
DeprecationWarning, stacklevel=2)
631
644
args, opts = parse_args(self, argv, alias_argv)
633
647
# Process the standard options
634
648
if 'help' in opts: # e.g. bzr add --help
635
sys.stdout.write(self.get_help_text())
649
self.outf.write(self.get_help_text())
637
651
if 'usage' in opts: # e.g. bzr add --usage
638
sys.stdout.write(self.get_help_text(verbose=False))
652
self.outf.write(self.get_help_text(verbose=False))
640
654
trace.set_verbosity_level(option._verbosity_level)
641
655
if 'verbose' in self.supported_std_options:
656
669
all_cmd_args = cmdargs.copy()
657
670
all_cmd_args.update(cmdopts)
661
return self.run_direct(**all_cmd_args)
663
def run_direct(self, *args, **kwargs):
664
"""Call run directly with objects (without parsing an argv list)."""
665
return self._operation.run_simple(*args, **kwargs)
673
return self.run(**all_cmd_args)
675
# reset it, so that other commands run in the same process won't
676
# inherit state. Before we reset it, log any activity, so that it
677
# gets properly tracked.
678
ui.ui_factory.log_transport_activity(
679
display=('bytes' in debug.debug_flags))
680
trace.set_verbosity_level(0)
682
def _setup_run(self):
683
"""Wrap the defined run method on self with a cleanup.
685
This is called by __init__ to make the Command be able to be run
686
by just calling run(), as it could be before cleanups were added.
688
If a different form of cleanups are in use by your Command subclass,
689
you can override this method.
692
def run(*args, **kwargs):
693
for hook in Command.hooks['pre_command']:
695
self._operation = cleanup.OperationWithCleanups(class_run)
697
return self._operation.run_simple(*args, **kwargs)
700
for hook in Command.hooks['post_command']:
668
705
"""Actually run the command.
673
710
Return 0 or None if the command was successful, or a non-zero
674
711
shell error code if not. It's OK for this method to allow
675
712
an exception to raise up.
714
This method is automatically wrapped by Command.__init__ with a
715
cleanup operation, stored as self._operation. This can be used
716
via self.add_cleanup to perform automatic cleanups at the end of
719
The argument for run are assembled by introspection. So for instance,
720
if your command takes an argument files, you would declare::
722
def run(self, files=None):
677
725
raise NotImplementedError('no implementation of command %r'
708
768
These are all empty initially, because by default nothing should get
712
self.create_hook(HookPoint('extend_command',
771
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
772
self.add_hook('extend_command',
713
773
"Called after creating a command object to allow modifications "
714
774
"such as adding or removing options, docs etc. Called with the "
715
"new bzrlib.commands.Command object.", (1, 13), None))
716
self.create_hook(HookPoint('get_command',
775
"new bzrlib.commands.Command object.", (1, 13))
776
self.add_hook('get_command',
717
777
"Called when creating a single command. Called with "
718
778
"(cmd_or_None, command_name). get_command should either return "
719
779
"the cmd_or_None parameter, or a replacement Command object that "
720
780
"should be used for the command. Note that the Command.hooks "
721
781
"hooks are core infrastructure. Many users will prefer to use "
722
782
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
724
self.create_hook(HookPoint('get_missing_command',
784
self.add_hook('get_missing_command',
725
785
"Called when creating a single command if no command could be "
726
786
"found. Called with (command_name). get_missing_command should "
727
787
"either return None, or a Command object to be used for the "
728
"command.", (1, 17), None))
729
self.create_hook(HookPoint('list_commands',
789
self.add_hook('list_commands',
730
790
"Called when enumerating commands. Called with a set of "
731
791
"cmd_name strings for all the commands found so far. This set "
732
792
" is safe to mutate - e.g. to remove a command. "
733
793
"list_commands should return the updated set of command names.",
795
self.add_hook('pre_command',
796
"Called prior to executing a command. Called with the command "
798
self.add_hook('post_command',
799
"Called after executing a command. Called with the command "
736
802
Command.hooks = CommandHooks()
754
options, args = parser.parse_args(args)
820
# for python 2.5 and later, optparse raises this exception if a non-ascii
821
# option name is given. See http://bugs.python.org/issue2931
823
options, args = parser.parse_args(args)
824
except UnicodeEncodeError,e:
825
raise errors.BzrCommandError(
826
gettext('Only ASCII permitted in option names'))
755
828
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
756
829
v is not option.OptionParser.DEFAULT_VALUE])
757
830
return args, opts
774
847
argdict[argname + '_list'] = None
775
848
elif ap[-1] == '+':
777
raise errors.BzrCommandError("command %r needs one or more %s"
778
% (cmd, argname.upper()))
850
raise errors.BzrCommandError(gettext(
851
"command {0!r} needs one or more {1}").format(
852
cmd, argname.upper()))
780
854
argdict[argname + '_list'] = args[:]
782
856
elif ap[-1] == '$': # all but one
783
857
if len(args) < 2:
784
raise errors.BzrCommandError("command %r needs one or more %s"
785
% (cmd, argname.upper()))
858
raise errors.BzrCommandError(
859
gettext("command {0!r} needs one or more {1}").format(
860
cmd, argname.upper()))
786
861
argdict[argname + '_list'] = args[:-1]
789
864
# just a plain arg
792
raise errors.BzrCommandError("command %r requires argument %s"
793
% (cmd, argname.upper()))
867
raise errors.BzrCommandError(
868
gettext("command {0!r} requires argument {1}").format(
869
cmd, argname.upper()))
795
871
argdict[argname] = args.pop(0)
798
raise errors.BzrCommandError("extra argument to command %s: %s"
874
raise errors.BzrCommandError( gettext(
875
"extra argument to command {0}: {1}").format(
886
963
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
887
964
from bzrlib.lsprof import profile
888
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
965
ret, stats = profile(exception_to_return_code, the_callable,
890
968
if filename is None:
893
971
stats.save(filename)
894
trace.note('Profile data written to "%s".', filename)
972
trace.note(gettext('Profile data written to "%s".'), filename)
898
def shlex_split_unicode(unsplit):
900
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
903
976
def get_alias(cmd, config=None):
904
977
"""Return an expanded alias, or None if no alias exists.
915
988
config = bzrlib.config.GlobalConfig()
916
989
alias = config.get_alias(cmd)
918
return shlex_split_unicode(alias)
991
return cmdline.split(alias)
995
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
923
996
"""Execute a command.
926
The command-line arguments, without the program name from argv[0]
927
These should already be decoded. All library/test code calling
928
run_bzr should be passing valid strings (don't need decoding).
930
Returns a command status or raises an exception.
998
:param argv: The command-line arguments, without the program name from
999
argv[0] These should already be decoded. All library/test code calling
1000
run_bzr should be passing valid strings (don't need decoding).
1001
:param load_plugins: What function to call when triggering plugin loading.
1002
This function should take no arguments and cause all plugins to be
1004
:param disable_plugins: What function to call when disabling plugin
1005
loading. This function should take no arguments and cause all plugin
1006
loading to be prohibited (so that code paths in your application that
1007
know about some plugins possibly being present will fail to import
1008
those plugins even if they are installed.)
1009
:return: Returns a command exit code or raises an exception.
932
1011
Special master options: these must come before the command because
933
1012
they control how the command is interpreted.
990
1072
elif a == '--coverage':
991
1073
opt_coverage_dir = argv[i + 1]
1075
elif a == '--profile-imports':
1076
pass # already handled in startup script Bug #588277
993
1077
elif a.startswith('-D'):
994
1078
debug.debug_flags.add(a[2:])
1079
elif a.startswith('-O'):
1080
override_config.append(a[2:])
996
1082
argv_copy.append(a)
1085
if bzrlib.global_state is None:
1086
# FIXME: Workaround for users that imported bzrlib but didn't call
1087
# bzrlib.initialize -- vila 2012-01-19
1088
cmdline_overrides = config.CommandLineStore()
1090
cmdline_overrides = bzrlib.global_state.cmdline_overrides
1091
cmdline_overrides._from_cmdline(override_config)
999
1093
debug.set_debug_flags_from_config()
1095
if not opt_no_plugins:
1001
1100
argv = argv_copy
1003
from bzrlib.builtins import cmd_help
1004
cmd_help().run_argv_aliases([])
1102
get_cmd_object('help').run_argv_aliases([])
1007
1105
if argv[0] == '--version':
1008
from bzrlib.builtins import cmd_version
1009
cmd_version().run_argv_aliases([])
1106
get_cmd_object('version').run_argv_aliases([])
1012
if not opt_no_plugins:
1013
from bzrlib.plugin import load_plugins
1016
from bzrlib.plugin import disable_plugins
1019
1109
alias_argv = None
1021
1111
if not opt_no_aliases:
1022
1112
alias_argv = get_alias(argv[0])
1024
user_encoding = osutils.get_user_encoding()
1025
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1026
1114
argv[0] = alias_argv.pop(0)
1028
1116
cmd = argv.pop(0)
1029
# We want only 'ascii' command names, but the user may have typed
1030
# in a Unicode name. In that case, they should just get a
1031
# 'command not found' error later.
1033
1117
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1034
1120
run = cmd_obj.run_argv_aliases
1035
1121
run_argv = [argv, alias_argv]
1095
1183
"bzr plugin commands")
1096
1184
Command.hooks.install_named_hook("get_command", _get_external_command,
1097
1185
"bzr external command lookup")
1098
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1099
"bzr plugin-provider-db check")
1102
def main(argv=None):
1103
"""Main entry point of command-line interface.
1105
:param argv: list of unicode command-line arguments similar to sys.argv.
1106
argv[0] is script name usually, it will be ignored.
1107
Don't pass here sys.argv because this list contains plain strings
1108
and not unicode; pass None instead.
1110
:return: exit code of bzr command.
1113
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1114
sys.stdin, sys.stdout, sys.stderr)
1116
# Is this a final release version? If so, we should suppress warnings
1117
if bzrlib.version_info[3] == 'final':
1118
suppress_deprecation_warnings(override=True)
1186
Command.hooks.install_named_hook("get_missing_command",
1187
_try_plugin_provider,
1188
"bzr plugin-provider-db check")
1192
def _specified_or_unicode_argv(argv):
1193
# For internal or testing use, argv can be passed. Otherwise, get it from
1194
# the process arguments in a unicode-safe way.
1119
1195
if argv is None:
1120
argv = osutils.get_unicode_argv()
1196
return osutils.get_unicode_argv()
1124
1200
# ensure all arguments are unicode strings
1126
1202
if isinstance(a, unicode):
1127
1203
new_argv.append(a)
1129
1205
new_argv.append(a.decode('ascii'))
1130
1206
except UnicodeDecodeError:
1131
1207
raise errors.BzrError("argv should be list of unicode strings.")
1211
def main(argv=None):
1212
"""Main entry point of command-line interface.
1214
Typically `bzrlib.initialize` should be called first.
1216
:param argv: list of unicode command-line arguments similar to sys.argv.
1217
argv[0] is script name usually, it will be ignored.
1218
Don't pass here sys.argv because this list contains plain strings
1219
and not unicode; pass None instead.
1221
:return: exit code of bzr command.
1223
if argv is not None:
1225
_register_builtin_commands()
1133
1226
ret = run_bzr_catch_errors(argv)
1134
bzrlib.ui.ui_factory.log_transport_activity(
1135
display=('bytes' in debug.debug_flags))
1136
1227
trace.mutter("return code %d", ret)
1137
osutils.report_extension_load_failures()
1192
1284
class Provider(object):
1193
'''Generic class to be overriden by plugins'''
1285
"""Generic class to be overriden by plugins"""
1195
1287
def plugin_for_command(self, cmd_name):
1196
'''Takes a command and returns the information for that plugin
1288
"""Takes a command and returns the information for that plugin
1198
1290
:return: A dictionary with all the available information
1199
for the requested plugin
1291
for the requested plugin
1201
1293
raise NotImplementedError
1204
1296
class ProvidersRegistry(registry.Registry):
1205
'''This registry exists to allow other providers to exist'''
1297
"""This registry exists to allow other providers to exist"""
1207
1299
def __iter__(self):
1208
1300
for key, provider in self.iteritems():
1211
1303
command_providers_registry = ProvidersRegistry()
1214
if __name__ == '__main__':
1215
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
