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 (
65
57
class CommandInfo(object):
78
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)
81
89
def _get_name(command_name):
120
135
key = self._get_name(command_name)
121
136
registry.Registry.register_lazy(self, key, module_name, command_name,
122
137
info=CommandInfo(aliases))
139
self._alias_dict[a] = key
125
142
plugin_cmds = CommandRegistry()
143
builtin_command_registry = CommandRegistry()
144
plugin_cmds.overridden_registry = builtin_command_registry
128
147
def register_command(cmd, decorate=False):
148
"""Register a plugin command.
150
Should generally be avoided in favor of lazy registration.
129
152
global plugin_cmds
130
153
return plugin_cmds.register(cmd, decorate)
195
227
return _get_cmd_object(cmd_name, plugins_override)
197
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
200
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):
201
233
"""Get a command object.
203
235
:param cmd_name: The name of the command.
204
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.
205
239
:return: A Command object instance
206
240
:raises KeyError: If no command is found.
313
346
summary, then a complete description of the command. A grammar
314
347
description will be inserted.
317
Other accepted names for this command.
320
List of argument forms, marked with whether they are optional,
325
['to_location', 'from_branch?', 'file*']
327
'to_location' is required
328
'from_branch' is optional
329
'file' can be specified 0 or more times
332
List of options that may be given for this command. These can
333
be either strings, referring to globally-defined options,
334
or option objects. Retrieve through options().
337
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
338
365
for commands intended for expert users.
341
Command objects will get a 'outf' attribute, which has been
342
setup to properly handle encoding of unicode strings.
343
encoding_type determines what will happen when characters cannot
345
strict - abort if we cannot decode
346
replace - put in a bogus character (typically '?')
347
exact - do not encode sys.stdout
349
NOTE: by default on Windows, sys.stdout is opened as a text
350
stream, therefore LF line-endings are converted to CRLF.
351
When a command uses encoding_type = 'exact', then
352
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.)
355
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"
359
397
takes_options = []
360
398
encoding_type = 'strict'
364
404
def __init__(self):
365
405
"""Construct an instance of this command."""
366
if self.__doc__ == Command.__doc__:
367
warn("No help message set for %r" % self)
368
406
# List of standard options directly supported
369
407
self.supported_std_options = []
370
self._operation = cleanup.OperationWithCleanups(self.run)
372
410
def add_cleanup(self, cleanup_func, *args, **kwargs):
373
411
"""Register a function to call after self.run returns or raises.
386
424
This is useful for releasing expensive or contentious resources (such
387
425
as write locks) before doing further work that does not require those
388
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.
390
430
self._operation.cleanup_now()
392
@deprecated_method(deprecated_in((2, 1, 0)))
393
def _maybe_expand_globs(self, file_list):
394
"""Glob expand file_list if the platform does not do that itself.
396
Not used anymore, now that the bzr command-line parser globs on
399
:return: A possibly empty list of unicode paths.
401
Introduced in bzrlib 0.18.
405
432
def _usage(self):
406
433
"""Return single-line grammar for this command.
435
462
usage help (e.g. Purpose, Usage, Options) with a
436
463
message explaining how to obtain full help.
466
i18n.install() # Install i18n only for get_help_text for now.
438
467
doc = self.help()
440
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.")
442
478
# Extract the summary (purpose) and sections out from the text
443
479
purpose,sections,order = self._get_help_parts(doc)
462
498
# XXX: optparse implicitly rewraps the help, and not always perfectly,
463
499
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
465
options = option.get_optparser(self.options()).format_option_help()
466
# XXX: According to the spec, ReST option lists actually don't support
467
# options like --1.9 so that causes syntax errors (in Sphinx at least).
468
# As that pattern always appears in the commands that break, we trap
469
# on that and then format that block of 'format' options as a literal
471
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:
472
510
options = options.replace(' format:\n', ' format::\n\n', 1)
473
511
if options.startswith('Options:'):
474
result += ':' + options
475
elif options.startswith('options:'):
476
# Python 2.4 version of optparse
477
result += ':Options:' + options[len('options:'):]
512
result += gettext(':Options:%s') % (options[len('options:'):],)
479
514
result += options
485
520
if sections.has_key(None):
486
521
text = sections.pop(None)
487
522
text = '\n '.join(text.splitlines())
488
result += ':%s:\n %s\n\n' % ('Description',text)
523
result += gettext(':Description:\n %s\n\n') % (text,)
490
525
# Add the custom sections (e.g. Examples). Note that there's no need
491
526
# to indent these as they must be indented already in the source.
493
528
for label in order:
494
if sections.has_key(label):
495
result += ':%s:\n%s\n' % (label,sections[label])
529
if label in sections:
530
result += ':%s:\n%s\n' % (label, sections[label])
498
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")
501
536
# Add the aliases, source (plug-in) and see also links, if any
503
result += ':Aliases: '
538
result += gettext(':Aliases: ')
504
539
result += ', '.join(self.aliases) + '\n'
505
540
plugin_name = self.plugin_name()
506
541
if plugin_name is not None:
507
result += ':From: plugin "%s"\n' % plugin_name
542
result += gettext(':From: plugin "%s"\n') % plugin_name
508
543
see_also = self.get_see_also(additional_see_also)
510
545
if not plain and see_also_as_links:
607
642
def run_argv_aliases(self, argv, alias_argv=None):
608
643
"""Parse the command line and run with extra aliases in alias_argv."""
609
644
args, opts = parse_args(self, argv, alias_argv)
611
647
# Process the standard options
612
648
if 'help' in opts: # e.g. bzr add --help
613
sys.stdout.write(self.get_help_text())
649
self.outf.write(self.get_help_text())
615
651
if 'usage' in opts: # e.g. bzr add --usage
616
sys.stdout.write(self.get_help_text(verbose=False))
652
self.outf.write(self.get_help_text(verbose=False))
618
654
trace.set_verbosity_level(option._verbosity_level)
619
655
if 'verbose' in self.supported_std_options:
634
669
all_cmd_args = cmdargs.copy()
635
670
all_cmd_args.update(cmdopts)
639
return self.run_direct(**all_cmd_args)
641
def run_direct(self, *args, **kwargs):
642
"""Call run directly with objects (without parsing an argv list)."""
643
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
self._operation = cleanup.OperationWithCleanups(class_run)
695
return self._operation.run_simple(*args, **kwargs)
646
701
"""Actually run the command.
651
706
Return 0 or None if the command was successful, or a non-zero
652
707
shell error code if not. It's OK for this method to allow
653
708
an exception to raise up.
710
This method is automatically wrapped by Command.__init__ with a
711
cleanup operation, stored as self._operation. This can be used
712
via self.add_cleanup to perform automatic cleanups at the end of
715
The argument for run are assembled by introspection. So for instance,
716
if your command takes an argument files, you would declare::
718
def run(self, files=None):
655
721
raise NotImplementedError('no implementation of command %r'
686
764
These are all empty initially, because by default nothing should get
690
self.create_hook(HookPoint('extend_command',
767
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
768
self.add_hook('extend_command',
691
769
"Called after creating a command object to allow modifications "
692
770
"such as adding or removing options, docs etc. Called with the "
693
"new bzrlib.commands.Command object.", (1, 13), None))
694
self.create_hook(HookPoint('get_command',
771
"new bzrlib.commands.Command object.", (1, 13))
772
self.add_hook('get_command',
695
773
"Called when creating a single command. Called with "
696
774
"(cmd_or_None, command_name). get_command should either return "
697
775
"the cmd_or_None parameter, or a replacement Command object that "
698
776
"should be used for the command. Note that the Command.hooks "
699
777
"hooks are core infrastructure. Many users will prefer to use "
700
778
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
702
self.create_hook(HookPoint('get_missing_command',
780
self.add_hook('get_missing_command',
703
781
"Called when creating a single command if no command could be "
704
782
"found. Called with (command_name). get_missing_command should "
705
783
"either return None, or a Command object to be used for the "
706
"command.", (1, 17), None))
707
self.create_hook(HookPoint('list_commands',
785
self.add_hook('list_commands',
708
786
"Called when enumerating commands. Called with a set of "
709
787
"cmd_name strings for all the commands found so far. This set "
710
788
" is safe to mutate - e.g. to remove a command. "
711
789
"list_commands should return the updated set of command names.",
714
792
Command.hooks = CommandHooks()
732
options, args = parser.parse_args(args)
810
# for python 2.5 and later, optparse raises this exception if a non-ascii
811
# option name is given. See http://bugs.python.org/issue2931
813
options, args = parser.parse_args(args)
814
except UnicodeEncodeError,e:
815
raise errors.BzrCommandError(
816
gettext('Only ASCII permitted in option names'))
733
818
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
734
819
v is not option.OptionParser.DEFAULT_VALUE])
735
820
return args, opts
752
837
argdict[argname + '_list'] = None
753
838
elif ap[-1] == '+':
755
raise errors.BzrCommandError("command %r needs one or more %s"
756
% (cmd, argname.upper()))
840
raise errors.BzrCommandError(gettext(
841
"command {0!r} needs one or more {1}").format(
842
cmd, argname.upper()))
758
844
argdict[argname + '_list'] = args[:]
760
846
elif ap[-1] == '$': # all but one
761
847
if len(args) < 2:
762
raise errors.BzrCommandError("command %r needs one or more %s"
763
% (cmd, argname.upper()))
848
raise errors.BzrCommandError(
849
gettext("command {0!r} needs one or more {1}").format(
850
cmd, argname.upper()))
764
851
argdict[argname + '_list'] = args[:-1]
767
854
# just a plain arg
770
raise errors.BzrCommandError("command %r requires argument %s"
771
% (cmd, argname.upper()))
857
raise errors.BzrCommandError(
858
gettext("command {0!r} requires argument {1}").format(
859
cmd, argname.upper()))
773
861
argdict[argname] = args.pop(0)
776
raise errors.BzrCommandError("extra argument to command %s: %s"
864
raise errors.BzrCommandError( gettext(
865
"extra argument to command {0}: {1}").format(
864
953
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
865
954
from bzrlib.lsprof import profile
866
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
955
ret, stats = profile(exception_to_return_code, the_callable,
868
958
if filename is None:
871
961
stats.save(filename)
872
trace.note('Profile data written to "%s".', filename)
962
trace.note(gettext('Profile data written to "%s".'), filename)
876
def shlex_split_unicode(unsplit):
878
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
881
966
def get_alias(cmd, config=None):
882
967
"""Return an expanded alias, or None if no alias exists.
893
978
config = bzrlib.config.GlobalConfig()
894
979
alias = config.get_alias(cmd)
896
return shlex_split_unicode(alias)
981
return cmdline.split(alias)
985
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
901
986
"""Execute a command.
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.
988
:param argv: The command-line arguments, without the program name from
989
argv[0] These should already be decoded. All library/test code calling
990
run_bzr should be passing valid strings (don't need decoding).
991
:param load_plugins: What function to call when triggering plugin loading.
992
This function should take no arguments and cause all plugins to be
994
:param disable_plugins: What function to call when disabling plugin
995
loading. This function should take no arguments and cause all plugin
996
loading to be prohibited (so that code paths in your application that
997
know about some plugins possibly being present will fail to import
998
those plugins even if they are installed.)
999
:return: Returns a command exit code or raises an exception.
910
1001
Special master options: these must come before the command because
911
1002
they control how the command is interpreted.
968
1062
elif a == '--coverage':
969
1063
opt_coverage_dir = argv[i + 1]
1065
elif a == '--profile-imports':
1066
pass # already handled in startup script Bug #588277
971
1067
elif a.startswith('-D'):
972
1068
debug.debug_flags.add(a[2:])
1069
elif a.startswith('-O'):
1070
override_config.append(a[2:])
974
1072
argv_copy.append(a)
1075
if bzrlib.global_state is None:
1076
# FIXME: Workaround for users that imported bzrlib but didn't call
1077
# bzrlib.initialize -- vila 2012-01-19
1078
cmdline_overrides = config.CommandLineStore()
1080
cmdline_overrides = bzrlib.global_state.cmdline_overrides
1081
cmdline_overrides._from_cmdline(override_config)
977
1083
debug.set_debug_flags_from_config()
1085
if not opt_no_plugins:
979
1090
argv = argv_copy
981
from bzrlib.builtins import cmd_help
982
cmd_help().run_argv_aliases([])
1092
get_cmd_object('help').run_argv_aliases([])
985
1095
if argv[0] == '--version':
986
from bzrlib.builtins import cmd_version
987
cmd_version().run_argv_aliases([])
1096
get_cmd_object('version').run_argv_aliases([])
990
if not opt_no_plugins:
991
from bzrlib.plugin import load_plugins
994
from bzrlib.plugin import disable_plugins
997
1099
alias_argv = None
999
1101
if not opt_no_aliases:
1000
1102
alias_argv = get_alias(argv[0])
1002
user_encoding = osutils.get_user_encoding()
1003
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1004
1104
argv[0] = alias_argv.pop(0)
1006
1106
cmd = argv.pop(0)
1007
# We want only 'ascii' command names, but the user may have typed
1008
# in a Unicode name. In that case, they should just get a
1009
# 'command not found' error later.
1011
1107
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1012
1110
run = cmd_obj.run_argv_aliases
1013
1111
run_argv = [argv, alias_argv]
1173
1274
class Provider(object):
1174
'''Generic class to be overriden by plugins'''
1275
"""Generic class to be overriden by plugins"""
1176
1277
def plugin_for_command(self, cmd_name):
1177
'''Takes a command and returns the information for that plugin
1278
"""Takes a command and returns the information for that plugin
1179
1280
:return: A dictionary with all the available information
1180
for the requested plugin
1281
for the requested plugin
1182
1283
raise NotImplementedError
1185
1286
class ProvidersRegistry(registry.Registry):
1186
'''This registry exists to allow other providers to exist'''
1287
"""This registry exists to allow other providers to exist"""
1188
1289
def __iter__(self):
1189
1290
for key, provider in self.iteritems():
added
removed
bzrlib/commands.py
