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
48
from bzrlib.hooks import Hooks
49
from bzrlib.i18n import gettext
55
50
# Compatibility - Option used to be in commands.
56
51
from bzrlib.option import Option
52
from bzrlib.plugin import disable_plugins, load_plugins
57
53
from bzrlib import registry
58
from bzrlib.symbol_versioning import (
65
56
class CommandInfo(object):
78
69
class CommandRegistry(registry.Registry):
70
"""Special registry mapping command names to command classes.
72
:ivar overridden_registry: Look in this registry for commands being
73
overridden by this registry. This can be used to tell plugin commands
74
about the builtin they're decorating.
78
registry.Registry.__init__(self)
79
self.overridden_registry = None
80
# map from aliases to the real command that implements the name
83
def get(self, command_name):
84
real_name = self._alias_dict.get(command_name, command_name)
85
return registry.Registry.get(self, real_name)
81
88
def _get_name(command_name):
120
134
key = self._get_name(command_name)
121
135
registry.Registry.register_lazy(self, key, module_name, command_name,
122
136
info=CommandInfo(aliases))
138
self._alias_dict[a] = key
125
141
plugin_cmds = CommandRegistry()
142
builtin_command_registry = CommandRegistry()
143
plugin_cmds.overridden_registry = builtin_command_registry
128
146
def register_command(cmd, decorate=False):
147
"""Register a plugin command.
149
Should generally be avoided in favor of lazy registration.
129
151
global plugin_cmds
130
152
return plugin_cmds.register(cmd, decorate)
195
226
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):
228
raise errors.BzrCommandError(gettext('unknown command "%s"') % cmd_name)
231
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
201
232
"""Get a command object.
203
234
:param cmd_name: The name of the command.
204
235
:param plugins_override: Allow plugins to override builtins.
236
:param check_missing: Look up commands not found in the regular index via
237
the get_missing_command hook.
205
238
:return: A Command object instance
206
239
:raises KeyError: If no command is found.
313
345
summary, then a complete description of the command. A grammar
314
346
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
348
:cvar aliases: Other accepted names for this command.
350
:cvar takes_args: List of argument forms, marked with whether they are
351
optional, repeated, etc. Examples::
353
['to_location', 'from_branch?', 'file*']
355
* 'to_location' is required
356
* 'from_branch' is optional
357
* 'file' can be specified 0 or more times
359
:cvar takes_options: List of options that may be given for this command.
360
These can be either strings, referring to globally-defined options, or
361
option objects. Retrieve through options().
363
:cvar hidden: If true, this command isn't advertised. This is typically
338
364
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
366
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
367
been setup to properly handle encoding of unicode strings.
368
encoding_type determines what will happen when characters cannot be
371
* strict - abort if we cannot decode
372
* replace - put in a bogus character (typically '?')
373
* exact - do not encode sys.stdout
375
NOTE: by default on Windows, sys.stdout is opened as a text stream,
376
therefore LF line-endings are converted to CRLF. When a command uses
377
encoding_type = 'exact', then sys.stdout is forced to be a binary
378
stream, and line-endings will not mangled.
381
A string indicating the real name under which this command was
382
invoked, before expansion of aliases.
383
(This may be None if the command was constructed and run in-process.)
355
385
:cvar hooks: An instance of CommandHooks.
387
:cvar __doc__: The help shown by 'bzr help command' for this command.
388
This is set by assigning explicitly to __doc__ so that -OO can
392
__doc__ = "My help goes here"
359
396
takes_options = []
360
397
encoding_type = 'strict'
364
403
def __init__(self):
365
404
"""Construct an instance of this command."""
366
if self.__doc__ == Command.__doc__:
367
warn("No help message set for %r" % self)
368
405
# List of standard options directly supported
369
406
self.supported_std_options = []
370
self._operation = cleanup.OperationWithCleanups(self.run)
372
409
def add_cleanup(self, cleanup_func, *args, **kwargs):
373
410
"""Register a function to call after self.run returns or raises.
386
423
This is useful for releasing expensive or contentious resources (such
387
424
as write locks) before doing further work that does not require those
388
resources (such as writing results to self.outf).
425
resources (such as writing results to self.outf). Note though, that
426
as it releases all resources, this may release locks that the command
427
wants to hold, so use should be done with care.
390
429
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
431
def _usage(self):
406
432
"""Return single-line grammar for this command.
435
461
usage help (e.g. Purpose, Usage, Options) with a
436
462
message explaining how to obtain full help.
465
i18n.install() # Install i18n only for get_help_text for now.
438
466
doc = self.help()
440
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
468
# Note: If self.gettext() translates ':Usage:\n', the section will
469
# be shown after "Description" section and we don't want to
470
# translate the usage string.
471
# Though, bzr export-pot don't exports :Usage: section and it must
473
doc = self.gettext(doc)
475
doc = gettext("No help for this command.")
442
477
# Extract the summary (purpose) and sections out from the text
443
478
purpose,sections,order = self._get_help_parts(doc)
462
497
# XXX: optparse implicitly rewraps the help, and not always perfectly,
463
498
# 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:
500
parser = option.get_optparser(self.options())
501
options = parser.format_option_help()
502
# FIXME: According to the spec, ReST option lists actually don't
503
# support options like --1.14 so that causes syntax errors (in Sphinx
504
# at least). As that pattern always appears in the commands that
505
# break, we trap on that and then format that block of 'format' options
506
# as a literal block. We use the most recent format still listed so we
507
# don't have to do that too often -- vila 20110514
508
if not plain and options.find(' --1.14 ') != -1:
472
509
options = options.replace(' format:\n', ' format::\n\n', 1)
473
510
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:'):]
511
result += gettext(':Options:%s') % (options[len('options:'):],)
479
513
result += options
485
519
if sections.has_key(None):
486
520
text = sections.pop(None)
487
521
text = '\n '.join(text.splitlines())
488
result += ':%s:\n %s\n\n' % ('Description',text)
522
result += gettext(':Description:\n %s\n\n') % (text,)
490
524
# Add the custom sections (e.g. Examples). Note that there's no need
491
525
# to indent these as they must be indented already in the source.
493
527
for label in order:
494
if sections.has_key(label):
495
result += ':%s:\n%s\n' % (label,sections[label])
528
if label in sections:
529
result += ':%s:\n%s\n' % (label, sections[label])
498
result += ("See bzr help %s for more details and examples.\n\n"
532
result += (gettext("See bzr help %s for more details and examples.\n\n")
501
535
# Add the aliases, source (plug-in) and see also links, if any
503
result += ':Aliases: '
537
result += gettext(':Aliases: ')
504
538
result += ', '.join(self.aliases) + '\n'
505
539
plugin_name = self.plugin_name()
506
540
if plugin_name is not None:
507
result += ':From: plugin "%s"\n' % plugin_name
541
result += gettext(':From: plugin "%s"\n') % plugin_name
508
542
see_also = self.get_see_also(additional_see_also)
510
544
if not plain and see_also_as_links:
607
641
def run_argv_aliases(self, argv, alias_argv=None):
608
642
"""Parse the command line and run with extra aliases in alias_argv."""
609
643
args, opts = parse_args(self, argv, alias_argv)
611
646
# Process the standard options
612
647
if 'help' in opts: # e.g. bzr add --help
613
sys.stdout.write(self.get_help_text())
648
self.outf.write(self.get_help_text())
615
650
if 'usage' in opts: # e.g. bzr add --usage
616
sys.stdout.write(self.get_help_text(verbose=False))
651
self.outf.write(self.get_help_text(verbose=False))
618
653
trace.set_verbosity_level(option._verbosity_level)
619
654
if 'verbose' in self.supported_std_options:
634
668
all_cmd_args = cmdargs.copy()
635
669
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)
672
return self.run(**all_cmd_args)
674
# reset it, so that other commands run in the same process won't
675
# inherit state. Before we reset it, log any activity, so that it
676
# gets properly tracked.
677
ui.ui_factory.log_transport_activity(
678
display=('bytes' in debug.debug_flags))
679
trace.set_verbosity_level(0)
681
def _setup_run(self):
682
"""Wrap the defined run method on self with a cleanup.
684
This is called by __init__ to make the Command be able to be run
685
by just calling run(), as it could be before cleanups were added.
687
If a different form of cleanups are in use by your Command subclass,
688
you can override this method.
691
def run(*args, **kwargs):
692
self._operation = cleanup.OperationWithCleanups(class_run)
694
return self._operation.run_simple(*args, **kwargs)
646
700
"""Actually run the command.
651
705
Return 0 or None if the command was successful, or a non-zero
652
706
shell error code if not. It's OK for this method to allow
653
707
an exception to raise up.
709
This method is automatically wrapped by Command.__init__ with a
710
cleanup operation, stored as self._operation. This can be used
711
via self.add_cleanup to perform automatic cleanups at the end of
714
The argument for run are assembled by introspection. So for instance,
715
if your command takes an argument files, you would declare::
717
def run(self, files=None):
655
720
raise NotImplementedError('no implementation of command %r'
686
763
These are all empty initially, because by default nothing should get
690
self.create_hook(HookPoint('extend_command',
766
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
767
self.add_hook('extend_command',
691
768
"Called after creating a command object to allow modifications "
692
769
"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',
770
"new bzrlib.commands.Command object.", (1, 13))
771
self.add_hook('get_command',
695
772
"Called when creating a single command. Called with "
696
773
"(cmd_or_None, command_name). get_command should either return "
697
774
"the cmd_or_None parameter, or a replacement Command object that "
698
775
"should be used for the command. Note that the Command.hooks "
699
776
"hooks are core infrastructure. Many users will prefer to use "
700
777
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
702
self.create_hook(HookPoint('get_missing_command',
779
self.add_hook('get_missing_command',
703
780
"Called when creating a single command if no command could be "
704
781
"found. Called with (command_name). get_missing_command should "
705
782
"either return None, or a Command object to be used for the "
706
"command.", (1, 17), None))
707
self.create_hook(HookPoint('list_commands',
784
self.add_hook('list_commands',
708
785
"Called when enumerating commands. Called with a set of "
709
786
"cmd_name strings for all the commands found so far. This set "
710
787
" is safe to mutate - e.g. to remove a command. "
711
788
"list_commands should return the updated set of command names.",
714
791
Command.hooks = CommandHooks()
732
options, args = parser.parse_args(args)
809
# for python 2.5 and later, optparse raises this exception if a non-ascii
810
# option name is given. See http://bugs.python.org/issue2931
812
options, args = parser.parse_args(args)
813
except UnicodeEncodeError,e:
814
raise errors.BzrCommandError(
815
gettext('Only ASCII permitted in option names'))
733
817
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
734
818
v is not option.OptionParser.DEFAULT_VALUE])
735
819
return args, opts
752
836
argdict[argname + '_list'] = None
753
837
elif ap[-1] == '+':
755
raise errors.BzrCommandError("command %r needs one or more %s"
756
% (cmd, argname.upper()))
839
raise errors.BzrCommandError(gettext(
840
"command {0!r} needs one or more {1}").format(
841
cmd, argname.upper()))
758
843
argdict[argname + '_list'] = args[:]
760
845
elif ap[-1] == '$': # all but one
761
846
if len(args) < 2:
762
raise errors.BzrCommandError("command %r needs one or more %s"
763
% (cmd, argname.upper()))
847
raise errors.BzrCommandError(
848
gettext("command {0!r} needs one or more {1}").format(
849
cmd, argname.upper()))
764
850
argdict[argname + '_list'] = args[:-1]
767
853
# just a plain arg
770
raise errors.BzrCommandError("command %r requires argument %s"
771
% (cmd, argname.upper()))
856
raise errors.BzrCommandError(
857
gettext("command {0!r} requires argument {1}").format(
858
cmd, argname.upper()))
773
860
argdict[argname] = args.pop(0)
776
raise errors.BzrCommandError("extra argument to command %s: %s"
863
raise errors.BzrCommandError( gettext(
864
"extra argument to command {0}: {1}").format(
864
952
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
865
953
from bzrlib.lsprof import profile
866
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
954
ret, stats = profile(exception_to_return_code, the_callable,
868
957
if filename is None:
871
960
stats.save(filename)
872
trace.note('Profile data written to "%s".', filename)
961
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
965
def get_alias(cmd, config=None):
882
966
"""Return an expanded alias, or None if no alias exists.
893
977
config = bzrlib.config.GlobalConfig()
894
978
alias = config.get_alias(cmd)
896
return shlex_split_unicode(alias)
980
return cmdline.split(alias)
984
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
901
985
"""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.
987
:param argv: The command-line arguments, without the program name from
988
argv[0] These should already be decoded. All library/test code calling
989
run_bzr should be passing valid strings (don't need decoding).
990
:param load_plugins: What function to call when triggering plugin loading.
991
This function should take no arguments and cause all plugins to be
993
:param disable_plugins: What function to call when disabling plugin
994
loading. This function should take no arguments and cause all plugin
995
loading to be prohibited (so that code paths in your application that
996
know about some plugins possibly being present will fail to import
997
those plugins even if they are installed.)
998
:return: Returns a command exit code or raises an exception.
910
1000
Special master options: these must come before the command because
911
1001
they control how the command is interpreted.
968
1061
elif a == '--coverage':
969
1062
opt_coverage_dir = argv[i + 1]
1064
elif a == '--profile-imports':
1065
pass # already handled in startup script Bug #588277
971
1066
elif a.startswith('-D'):
972
1067
debug.debug_flags.add(a[2:])
1068
elif a.startswith('-O'):
1069
override_config.append(a[2:])
974
1071
argv_copy.append(a)
1074
bzrlib.global_state.cmdline_overrides._from_cmdline(override_config)
977
1076
debug.set_debug_flags_from_config()
1078
if not opt_no_plugins:
979
1083
argv = argv_copy
981
from bzrlib.builtins import cmd_help
982
cmd_help().run_argv_aliases([])
1085
get_cmd_object('help').run_argv_aliases([])
985
1088
if argv[0] == '--version':
986
from bzrlib.builtins import cmd_version
987
cmd_version().run_argv_aliases([])
1089
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
1092
alias_argv = None
999
1094
if not opt_no_aliases:
1000
1095
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
1097
argv[0] = alias_argv.pop(0)
1006
1099
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
1100
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1012
1103
run = cmd_obj.run_argv_aliases
1013
1104
run_argv = [argv, alias_argv]
1173
1267
class Provider(object):
1174
'''Generic class to be overriden by plugins'''
1268
"""Generic class to be overriden by plugins"""
1176
1270
def plugin_for_command(self, cmd_name):
1177
'''Takes a command and returns the information for that plugin
1271
"""Takes a command and returns the information for that plugin
1179
1273
:return: A dictionary with all the available information
1180
for the requested plugin
1274
for the requested plugin
1182
1276
raise NotImplementedError
1185
1279
class ProvidersRegistry(registry.Registry):
1186
'''This registry exists to allow other providers to exist'''
1280
"""This registry exists to allow other providers to exist"""
1188
1282
def __iter__(self):
1189
1283
for key, provider in self.iteritems():
added
removed
bzrlib/commands.py
