24
26
# 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?
29
34
from bzrlib.lazy_import import lazy_import
30
35
lazy_import(globals(), """
39
from warnings import warn
35
42
from bzrlib import (
49
from bzrlib.hooks import Hooks
50
from bzrlib.i18n import gettext
54
from bzrlib.hooks import HookPoint, Hooks
51
55
# Compatibility - Option used to be in commands.
52
56
from bzrlib.option import Option
53
from bzrlib.plugin import disable_plugins, load_plugins
54
57
from bzrlib import registry
58
from bzrlib.symbol_versioning import (
62
suppress_deprecation_warnings,
57
66
class CommandInfo(object):
70
79
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)
89
82
def _get_name(command_name):
135
121
key = self._get_name(command_name)
136
122
registry.Registry.register_lazy(self, key, module_name, command_name,
137
123
info=CommandInfo(aliases))
139
self._alias_dict[a] = key
142
126
plugin_cmds = CommandRegistry()
143
builtin_command_registry = CommandRegistry()
144
plugin_cmds.overridden_registry = builtin_command_registry
147
129
def register_command(cmd, decorate=False):
148
"""Register a plugin command.
150
Should generally be avoided in favor of lazy registration.
152
130
global plugin_cmds
153
131
return plugin_cmds.register(cmd, decorate)
217
186
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():
220
206
def get_cmd_object(cmd_name, plugins_override=True):
221
207
"""Return the command object for a command.
227
213
return _get_cmd_object(cmd_name, plugins_override)
229
raise errors.BzrCommandError(gettext('unknown command "%s"') % cmd_name)
232
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
215
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
218
def _get_cmd_object(cmd_name, plugins_override=True):
233
219
"""Get a command object.
235
221
:param cmd_name: The name of the command.
236
222
: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.
239
223
:return: A Command object instance
240
224
:raises KeyError: If no command is found.
346
331
summary, then a complete description of the command. A grammar
347
332
description will be inserted.
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
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
365
356
for commands intended for expert users.
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.)
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
386
373
: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"
397
377
takes_options = []
398
378
encoding_type = 'strict'
404
382
def __init__(self):
405
383
"""Construct an instance of this command."""
384
if self.__doc__ == Command.__doc__:
385
warn("No help message set for %r" % self)
406
386
# List of standard options directly supported
407
387
self.supported_std_options = []
388
self._operation = cleanup.OperationWithCleanups(self.run)
410
390
def add_cleanup(self, cleanup_func, *args, **kwargs):
411
391
"""Register a function to call after self.run returns or raises.
424
404
This is useful for releasing expensive or contentious resources (such
425
405
as write locks) before doing further work that does not require those
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.
406
resources (such as writing results to self.outf).
430
408
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.
432
423
def _usage(self):
433
424
"""Return single-line grammar for this command.
462
453
usage help (e.g. Purpose, Usage, Options) with a
463
454
message explaining how to obtain full help.
466
i18n.install() # Install i18n only for get_help_text for now.
467
456
doc = self.help()
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.")
458
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
478
460
# Extract the summary (purpose) and sections out from the text
479
461
purpose,sections,order = self._get_help_parts(doc)
498
480
# XXX: optparse implicitly rewraps the help, and not always perfectly,
499
481
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
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:
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:
510
490
options = options.replace(' format:\n', ' format::\n\n', 1)
511
491
if options.startswith('Options:'):
512
result += gettext(':Options:%s') % (options[len('options:'):],)
492
result += ':' + options
493
elif options.startswith('options:'):
494
# Python 2.4 version of optparse
495
result += ':Options:' + options[len('options:'):]
514
497
result += options
520
503
if sections.has_key(None):
521
504
text = sections.pop(None)
522
505
text = '\n '.join(text.splitlines())
523
result += gettext(':Description:\n %s\n\n') % (text,)
506
result += ':%s:\n %s\n\n' % ('Description',text)
525
508
# Add the custom sections (e.g. Examples). Note that there's no need
526
509
# to indent these as they must be indented already in the source.
528
511
for label in order:
529
if label in sections:
530
result += ':%s:\n%s\n' % (label, sections[label])
512
if sections.has_key(label):
513
result += ':%s:\n%s\n' % (label,sections[label])
533
result += (gettext("See bzr help %s for more details and examples.\n\n")
516
result += ("See bzr help %s for more details and examples.\n\n"
536
519
# Add the aliases, source (plug-in) and see also links, if any
538
result += gettext(':Aliases: ')
521
result += ':Aliases: '
539
522
result += ', '.join(self.aliases) + '\n'
540
523
plugin_name = self.plugin_name()
541
524
if plugin_name is not None:
542
result += gettext(':From: plugin "%s"\n') % plugin_name
525
result += ':From: plugin "%s"\n' % plugin_name
543
526
see_also = self.get_see_also(additional_see_also)
545
528
if not plain and see_also_as_links:
642
625
def run_argv_aliases(self, argv, alias_argv=None):
643
626
"""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)
644
631
args, opts = parse_args(self, argv, alias_argv)
647
633
# Process the standard options
648
634
if 'help' in opts: # e.g. bzr add --help
649
self.outf.write(self.get_help_text())
635
sys.stdout.write(self.get_help_text())
651
637
if 'usage' in opts: # e.g. bzr add --usage
652
self.outf.write(self.get_help_text(verbose=False))
638
sys.stdout.write(self.get_help_text(verbose=False))
654
640
trace.set_verbosity_level(option._verbosity_level)
655
641
if 'verbose' in self.supported_std_options:
669
656
all_cmd_args = cmdargs.copy()
670
657
all_cmd_args.update(cmdopts)
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']:
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)
705
668
"""Actually run the command.
710
673
Return 0 or None if the command was successful, or a non-zero
711
674
shell error code if not. It's OK for this method to allow
712
675
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):
725
677
raise NotImplementedError('no implementation of command %r'
768
708
These are all empty initially, because by default nothing should get
771
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
772
self.add_hook('extend_command',
712
self.create_hook(HookPoint('extend_command',
773
713
"Called after creating a command object to allow modifications "
774
714
"such as adding or removing options, docs etc. Called with the "
775
"new bzrlib.commands.Command object.", (1, 13))
776
self.add_hook('get_command',
715
"new bzrlib.commands.Command object.", (1, 13), None))
716
self.create_hook(HookPoint('get_command',
777
717
"Called when creating a single command. Called with "
778
718
"(cmd_or_None, command_name). get_command should either return "
779
719
"the cmd_or_None parameter, or a replacement Command object that "
780
720
"should be used for the command. Note that the Command.hooks "
781
721
"hooks are core infrastructure. Many users will prefer to use "
782
722
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
784
self.add_hook('get_missing_command',
724
self.create_hook(HookPoint('get_missing_command',
785
725
"Called when creating a single command if no command could be "
786
726
"found. Called with (command_name). get_missing_command should "
787
727
"either return None, or a Command object to be used for the "
789
self.add_hook('list_commands',
728
"command.", (1, 17), None))
729
self.create_hook(HookPoint('list_commands',
790
730
"Called when enumerating commands. Called with a set of "
791
731
"cmd_name strings for all the commands found so far. This set "
792
732
" is safe to mutate - e.g. to remove a command. "
793
733
"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 "
802
736
Command.hooks = CommandHooks()
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'))
754
options, args = parser.parse_args(args)
828
755
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
829
756
v is not option.OptionParser.DEFAULT_VALUE])
830
757
return args, opts
847
774
argdict[argname + '_list'] = None
848
775
elif ap[-1] == '+':
850
raise errors.BzrCommandError(gettext(
851
"command {0!r} needs one or more {1}").format(
852
cmd, argname.upper()))
777
raise errors.BzrCommandError("command %r needs one or more %s"
778
% (cmd, argname.upper()))
854
780
argdict[argname + '_list'] = args[:]
856
782
elif ap[-1] == '$': # all but one
857
783
if len(args) < 2:
858
raise errors.BzrCommandError(
859
gettext("command {0!r} needs one or more {1}").format(
860
cmd, argname.upper()))
784
raise errors.BzrCommandError("command %r needs one or more %s"
785
% (cmd, argname.upper()))
861
786
argdict[argname + '_list'] = args[:-1]
864
789
# just a plain arg
867
raise errors.BzrCommandError(
868
gettext("command {0!r} requires argument {1}").format(
869
cmd, argname.upper()))
792
raise errors.BzrCommandError("command %r requires argument %s"
793
% (cmd, argname.upper()))
871
795
argdict[argname] = args.pop(0)
874
raise errors.BzrCommandError( gettext(
875
"extra argument to command {0}: {1}").format(
798
raise errors.BzrCommandError("extra argument to command %s: %s"
963
886
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
964
887
from bzrlib.lsprof import profile
965
ret, stats = profile(exception_to_return_code, the_callable,
888
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
968
890
if filename is None:
971
893
stats.save(filename)
972
trace.note(gettext('Profile data written to "%s".'), filename)
894
trace.note('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'))]
976
903
def get_alias(cmd, config=None):
977
904
"""Return an expanded alias, or None if no alias exists.
988
915
config = bzrlib.config.GlobalConfig()
989
916
alias = config.get_alias(cmd)
991
return cmdline.split(alias)
918
return shlex_split_unicode(alias)
995
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
996
923
"""Execute a command.
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.
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.
1011
932
Special master options: these must come before the command because
1012
933
they control how the command is interpreted.
1072
990
elif a == '--coverage':
1073
991
opt_coverage_dir = argv[i + 1]
1075
elif a == '--profile-imports':
1076
pass # already handled in startup script Bug #588277
1077
993
elif a.startswith('-D'):
1078
994
debug.debug_flags.add(a[2:])
1079
elif a.startswith('-O'):
1080
override_config.append(a[2:])
1082
996
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)
1093
999
debug.set_debug_flags_from_config()
1003
from bzrlib.builtins import cmd_help
1004
cmd_help().run_argv_aliases([])
1007
if argv[0] == '--version':
1008
from bzrlib.builtins import cmd_version
1009
cmd_version().run_argv_aliases([])
1095
1012
if not opt_no_plugins:
1013
from bzrlib.plugin import load_plugins
1016
from bzrlib.plugin import disable_plugins
1098
1017
disable_plugins()
1102
get_cmd_object('help').run_argv_aliases([])
1105
if argv[0] == '--version':
1106
get_cmd_object('version').run_argv_aliases([])
1109
1019
alias_argv = None
1111
1021
if not opt_no_aliases:
1112
1022
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]
1114
1026
argv[0] = alias_argv.pop(0)
1116
1028
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.
1117
1033
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1120
1034
run = cmd_obj.run_argv_aliases
1121
1035
run_argv = [argv, alias_argv]
1183
1095
"bzr plugin commands")
1184
1096
Command.hooks.install_named_hook("get_command", _get_external_command,
1185
1097
"bzr external command lookup")
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.
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)
1195
1119
if argv is None:
1196
return osutils.get_unicode_argv()
1120
argv = osutils.get_unicode_argv()
1200
1124
# ensure all arguments are unicode strings
1202
1126
if isinstance(a, unicode):
1203
1127
new_argv.append(a)
1205
1129
new_argv.append(a.decode('ascii'))
1206
1130
except UnicodeDecodeError:
1207
1131
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()
1226
1133
ret = run_bzr_catch_errors(argv)
1134
bzrlib.ui.ui_factory.log_transport_activity(
1135
display=('bytes' in debug.debug_flags))
1227
1136
trace.mutter("return code %d", ret)
1137
osutils.report_extension_load_failures()
1284
1192
class Provider(object):
1285
"""Generic class to be overriden by plugins"""
1193
'''Generic class to be overriden by plugins'''
1287
1195
def plugin_for_command(self, cmd_name):
1288
"""Takes a command and returns the information for that plugin
1196
'''Takes a command and returns the information for that plugin
1290
1198
:return: A dictionary with all the available information
1291
for the requested plugin
1199
for the requested plugin
1293
1201
raise NotImplementedError
1296
1204
class ProvidersRegistry(registry.Registry):
1297
"""This registry exists to allow other providers to exist"""
1205
'''This registry exists to allow other providers to exist'''
1299
1207
def __iter__(self):
1300
1208
for key, provider in self.iteritems():
1303
1211
command_providers_registry = ProvidersRegistry()
1214
if __name__ == '__main__':
1215
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
