23
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?
28
34
from bzrlib.lazy_import import lazy_import
29
35
lazy_import(globals(), """
39
from warnings import warn
34
42
from bzrlib import (
47
from bzrlib.hooks import Hooks
48
from bzrlib.i18n import gettext
54
from bzrlib.hooks import HookPoint, Hooks
49
55
# Compatibility - Option used to be in commands.
50
56
from bzrlib.option import Option
51
from bzrlib.plugin import disable_plugins, load_plugins
52
57
from bzrlib import registry
53
58
from bzrlib.symbol_versioning import (
54
59
deprecated_function,
73
78
class CommandRegistry(registry.Registry):
74
"""Special registry mapping command names to command classes.
76
:ivar overridden_registry: Look in this registry for commands being
77
overridden by this registry. This can be used to tell plugin commands
78
about the builtin they're decorating.
82
registry.Registry.__init__(self)
83
self.overridden_registry = None
84
# map from aliases to the real command that implements the name
87
def get(self, command_name):
88
real_name = self._alias_dict.get(command_name, command_name)
89
return registry.Registry.get(self, real_name)
92
81
def _get_name(command_name):
138
120
key = self._get_name(command_name)
139
121
registry.Registry.register_lazy(self, key, module_name, command_name,
140
122
info=CommandInfo(aliases))
142
self._alias_dict[a] = key
145
125
plugin_cmds = CommandRegistry()
146
builtin_command_registry = CommandRegistry()
147
plugin_cmds.overridden_registry = builtin_command_registry
150
128
def register_command(cmd, decorate=False):
151
"""Register a plugin command.
153
Should generally be avoided in favor of lazy registration.
155
129
global plugin_cmds
156
130
return plugin_cmds.register(cmd, decorate)
164
138
return cmd[4:].replace('_','-')
167
@deprecated_function(deprecated_in((2, 2, 0)))
168
141
def _builtin_commands():
169
"""Return a dict of {name: cmd_class} for builtin commands.
171
:deprecated: Use the builtin_command_registry registry instead
173
# return dict(name: cmd_class)
174
return dict(builtin_command_registry.items())
177
def _register_builtin_commands():
178
if builtin_command_registry.keys():
181
142
import bzrlib.builtins
182
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
183
builtin_command_registry.register(cmd_class)
184
bzrlib.builtins._register_lazy_builtins()
143
return _scan_module_for_commands(bzrlib.builtins)
187
146
def _scan_module_for_commands(module):
359
313
summary, then a complete description of the command. A grammar
360
314
description will be inserted.
362
:cvar aliases: Other accepted names for this command.
364
:cvar takes_args: List of argument forms, marked with whether they are
365
optional, repeated, etc. Examples::
367
['to_location', 'from_branch?', 'file*']
369
* 'to_location' is required
370
* 'from_branch' is optional
371
* 'file' can be specified 0 or more times
373
:cvar takes_options: List of options that may be given for this command.
374
These can be either strings, referring to globally-defined options, or
375
option objects. Retrieve through options().
377
:cvar hidden: If true, this command isn't advertised. This is typically
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
378
338
for commands intended for expert users.
380
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
381
been setup to properly handle encoding of unicode strings.
382
encoding_type determines what will happen when characters cannot be
385
* strict - abort if we cannot decode
386
* replace - put in a bogus character (typically '?')
387
* exact - do not encode sys.stdout
389
NOTE: by default on Windows, sys.stdout is opened as a text stream,
390
therefore LF line-endings are converted to CRLF. When a command uses
391
encoding_type = 'exact', then sys.stdout is forced to be a binary
392
stream, and line-endings will not mangled.
395
A string indicating the real name under which this command was
396
invoked, before expansion of aliases.
397
(This may be None if the command was constructed and run in-process.)
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
399
355
:cvar hooks: An instance of CommandHooks.
401
:cvar __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"
410
359
takes_options = []
411
360
encoding_type = 'strict'
417
364
def __init__(self):
418
365
"""Construct an instance of this command."""
366
if self.__doc__ == Command.__doc__:
367
warn("No help message set for %r" % self)
419
368
# List of standard options directly supported
420
369
self.supported_std_options = []
370
self._operation = cleanup.OperationWithCleanups(self.run)
423
372
def add_cleanup(self, cleanup_func, *args, **kwargs):
424
373
"""Register a function to call after self.run returns or raises.
437
386
This is useful for releasing expensive or contentious resources (such
438
387
as write locks) before doing further work that does not require those
439
resources (such as writing results to self.outf). Note though, that
440
as it releases all resources, this may release locks that the command
441
wants to hold, so use should be done with care.
388
resources (such as writing results to self.outf).
443
390
self._operation.cleanup_now()
445
392
@deprecated_method(deprecated_in((2, 1, 0)))
446
393
def _maybe_expand_globs(self, file_list):
447
394
"""Glob expand file_list if the platform does not do that itself.
488
435
usage help (e.g. Purpose, Usage, Options) with a
489
436
message explaining how to obtain full help.
491
if self.l10n and not i18n.installed():
492
i18n.install() # Install i18n only for get_help_text for now.
493
438
doc = self.help()
495
# Note: If self.gettext() translates ':Usage:\n', the section will
496
# be shown after "Description" section and we don't want to
497
# translate the usage string.
498
# Though, bzr export-pot don't exports :Usage: section and it must
500
doc = self.gettext(doc)
502
doc = gettext("No help for this command.")
440
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
504
442
# Extract the summary (purpose) and sections out from the text
505
443
purpose,sections,order = self._get_help_parts(doc)
524
462
# XXX: optparse implicitly rewraps the help, and not always perfectly,
525
463
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
527
parser = option.get_optparser(self.options())
528
options = parser.format_option_help()
529
# FIXME: According to the spec, ReST option lists actually don't
530
# support options like --1.14 so that causes syntax errors (in Sphinx
531
# at least). As that pattern always appears in the commands that
532
# break, we trap on that and then format that block of 'format' options
533
# as a literal block. We use the most recent format still listed so we
534
# don't have to do that too often -- vila 20110514
535
if not plain and options.find(' --1.14 ') != -1:
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:
536
472
options = options.replace(' format:\n', ' format::\n\n', 1)
537
473
if options.startswith('Options:'):
538
result += gettext(':Options:%s') % (options[len('options:'):],)
474
result += ':' + options
475
elif options.startswith('options:'):
476
# Python 2.4 version of optparse
477
result += ':Options:' + options[len('options:'):]
540
479
result += options
546
485
if sections.has_key(None):
547
486
text = sections.pop(None)
548
487
text = '\n '.join(text.splitlines())
549
result += gettext(':Description:\n %s\n\n') % (text,)
488
result += ':%s:\n %s\n\n' % ('Description',text)
551
490
# Add the custom sections (e.g. Examples). Note that there's no need
552
491
# to indent these as they must be indented already in the source.
554
493
for label in order:
555
if label in sections:
556
result += ':%s:\n%s\n' % (label, sections[label])
494
if sections.has_key(label):
495
result += ':%s:\n%s\n' % (label,sections[label])
559
result += (gettext("See bzr help %s for more details and examples.\n\n")
498
result += ("See bzr help %s for more details and examples.\n\n"
562
501
# Add the aliases, source (plug-in) and see also links, if any
564
result += gettext(':Aliases: ')
503
result += ':Aliases: '
565
504
result += ', '.join(self.aliases) + '\n'
566
505
plugin_name = self.plugin_name()
567
506
if plugin_name is not None:
568
result += gettext(':From: plugin "%s"\n') % plugin_name
507
result += ':From: plugin "%s"\n' % plugin_name
569
508
see_also = self.get_see_also(additional_see_also)
571
510
if not plain and see_also_as_links:
667
607
def run_argv_aliases(self, argv, alias_argv=None):
668
608
"""Parse the command line and run with extra aliases in alias_argv."""
669
609
args, opts = parse_args(self, argv, alias_argv)
672
611
# Process the standard options
673
612
if 'help' in opts: # e.g. bzr add --help
674
self.outf.write(self.get_help_text())
613
sys.stdout.write(self.get_help_text())
676
615
if 'usage' in opts: # e.g. bzr add --usage
677
self.outf.write(self.get_help_text(verbose=False))
616
sys.stdout.write(self.get_help_text(verbose=False))
679
618
trace.set_verbosity_level(option._verbosity_level)
680
619
if 'verbose' in self.supported_std_options:
695
634
all_cmd_args = cmdargs.copy()
696
635
all_cmd_args.update(cmdopts)
699
return self.run(**all_cmd_args)
701
# reset it, so that other commands run in the same process won't
702
# inherit state. Before we reset it, log any activity, so that it
703
# gets properly tracked.
704
ui.ui_factory.log_transport_activity(
705
display=('bytes' in debug.debug_flags))
706
trace.set_verbosity_level(0)
708
def _setup_run(self):
709
"""Wrap the defined run method on self with a cleanup.
711
This is called by __init__ to make the Command be able to be run
712
by just calling run(), as it could be before cleanups were added.
714
If a different form of cleanups are in use by your Command subclass,
715
you can override this method.
718
def run(*args, **kwargs):
719
self._operation = cleanup.OperationWithCleanups(class_run)
721
return self._operation.run_simple(*args, **kwargs)
726
@deprecated_method(deprecated_in((2, 2, 0)))
639
return self.run_direct(**all_cmd_args)
727
641
def run_direct(self, *args, **kwargs):
728
"""Deprecated thunk from bzrlib 2.1."""
729
return self.run(*args, **kwargs)
642
"""Call run directly with objects (without parsing an argv list)."""
643
return self._operation.run_simple(*args, **kwargs)
732
646
"""Actually run the command.
737
651
Return 0 or None if the command was successful, or a non-zero
738
652
shell error code if not. It's OK for this method to allow
739
653
an exception to raise up.
741
This method is automatically wrapped by Command.__init__ with a
742
cleanup operation, stored as self._operation. This can be used
743
via self.add_cleanup to perform automatic cleanups at the end of
746
The argument for run are assembled by introspection. So for instance,
747
if your command takes an argument files, you would declare::
749
def run(self, files=None):
752
655
raise NotImplementedError('no implementation of command %r'
795
686
These are all empty initially, because by default nothing should get
798
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
799
self.add_hook('extend_command',
690
self.create_hook(HookPoint('extend_command',
800
691
"Called after creating a command object to allow modifications "
801
692
"such as adding or removing options, docs etc. Called with the "
802
"new bzrlib.commands.Command object.", (1, 13))
803
self.add_hook('get_command',
693
"new bzrlib.commands.Command object.", (1, 13), None))
694
self.create_hook(HookPoint('get_command',
804
695
"Called when creating a single command. Called with "
805
696
"(cmd_or_None, command_name). get_command should either return "
806
697
"the cmd_or_None parameter, or a replacement Command object that "
807
698
"should be used for the command. Note that the Command.hooks "
808
699
"hooks are core infrastructure. Many users will prefer to use "
809
700
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
811
self.add_hook('get_missing_command',
702
self.create_hook(HookPoint('get_missing_command',
812
703
"Called when creating a single command if no command could be "
813
704
"found. Called with (command_name). get_missing_command should "
814
705
"either return None, or a Command object to be used for the "
816
self.add_hook('list_commands',
706
"command.", (1, 17), None))
707
self.create_hook(HookPoint('list_commands',
817
708
"Called when enumerating commands. Called with a set of "
818
709
"cmd_name strings for all the commands found so far. This set "
819
710
" is safe to mutate - e.g. to remove a command. "
820
711
"list_commands should return the updated set of command names.",
823
714
Command.hooks = CommandHooks()
1008
893
config = bzrlib.config.GlobalConfig()
1009
894
alias = config.get_alias(cmd)
1011
return cmdline.split(alias)
896
return shlex_split_unicode(alias)
1015
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
1016
901
"""Execute a command.
1018
:param argv: The command-line arguments, without the program name from
1019
argv[0] These should already be decoded. All library/test code calling
1020
run_bzr should be passing valid strings (don't need decoding).
1021
:param load_plugins: What function to call when triggering plugin loading.
1022
This function should take no arguments and cause all plugins to be
1024
:param disable_plugins: What function to call when disabling plugin
1025
loading. This function should take no arguments and cause all plugin
1026
loading to be prohibited (so that code paths in your application that
1027
know about some plugins possibly being present will fail to import
1028
those plugins even if they are installed.)
1029
:return: Returns a command exit code or raises an exception.
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.
1031
910
Special master options: these must come before the command because
1032
911
they control how the command is interpreted.
1102
977
debug.set_debug_flags_from_config()
981
from bzrlib.builtins import cmd_help
982
cmd_help().run_argv_aliases([])
985
if argv[0] == '--version':
986
from bzrlib.builtins import cmd_version
987
cmd_version().run_argv_aliases([])
1104
990
if not opt_no_plugins:
991
from bzrlib.plugin import load_plugins
994
from bzrlib.plugin import disable_plugins
1107
995
disable_plugins()
1111
get_cmd_object('help').run_argv_aliases([])
1114
if argv[0] == '--version':
1115
get_cmd_object('version').run_argv_aliases([])
1118
997
alias_argv = None
1120
999
if not opt_no_aliases:
1121
1000
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]
1123
1004
argv[0] = alias_argv.pop(0)
1125
1006
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.
1126
1011
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1129
1012
run = cmd_obj.run_argv_aliases
1130
1013
run_argv = [argv, alias_argv]
1290
1173
class Provider(object):
1291
"""Generic class to be overriden by plugins"""
1174
'''Generic class to be overriden by plugins'''
1293
1176
def plugin_for_command(self, cmd_name):
1294
"""Takes a command and returns the information for that plugin
1177
'''Takes a command and returns the information for that plugin
1296
1179
:return: A dictionary with all the available information
1297
for the requested plugin
1180
for the requested plugin
1299
1182
raise NotImplementedError
1302
1185
class ProvidersRegistry(registry.Registry):
1303
"""This registry exists to allow other providers to exist"""
1186
'''This registry exists to allow other providers to exist'''
1305
1188
def __iter__(self):
1306
1189
for key, provider in self.iteritems():
added
removed
bzrlib/commands.py
