73
80
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
83
def _get_name(command_name):
138
122
key = self._get_name(command_name)
139
123
registry.Registry.register_lazy(self, key, module_name, command_name,
140
124
info=CommandInfo(aliases))
142
self._alias_dict[a] = key
145
127
plugin_cmds = CommandRegistry()
146
builtin_command_registry = CommandRegistry()
147
plugin_cmds.overridden_registry = builtin_command_registry
150
130
def register_command(cmd, decorate=False):
151
"""Register a plugin command.
153
Should generally be avoided in favor of lazy registration.
155
131
global plugin_cmds
156
132
return plugin_cmds.register(cmd, decorate)
164
140
return cmd[4:].replace('_','-')
167
@deprecated_function(deprecated_in((2, 2, 0)))
168
143
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
144
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()
145
return _scan_module_for_commands(bzrlib.builtins)
187
148
def _scan_module_for_commands(module):
359
317
summary, then a complete description of the command. A grammar
360
318
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
321
Other accepted names for this command.
324
List of argument forms, marked with whether they are optional,
329
['to_location', 'from_branch?', 'file*']
331
'to_location' is required
332
'from_branch' is optional
333
'file' can be specified 0 or more times
336
List of options that may be given for this command. These can
337
be either strings, referring to globally-defined options,
338
or option objects. Retrieve through options().
341
If true, this command isn't advertised. This is typically
378
342
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.)
345
Command objects will get a 'outf' attribute, which has been
346
setup to properly handle encoding of unicode strings.
347
encoding_type determines what will happen when characters cannot
349
strict - abort if we cannot decode
350
replace - put in a bogus character (typically '?')
351
exact - do not encode sys.stdout
353
NOTE: by default on Windows, sys.stdout is opened as a text
354
stream, therefore LF line-endings are converted to CRLF.
355
When a command uses encoding_type = 'exact', then
356
sys.stdout is forced to be a binary stream, and line-endings
399
359
: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
363
takes_options = []
411
364
encoding_type = 'strict'
417
368
def __init__(self):
418
369
"""Construct an instance of this command."""
370
if self.__doc__ == Command.__doc__:
371
warn("No help message set for %r" % self)
419
372
# List of standard options directly supported
420
373
self.supported_std_options = []
374
self._operation = cleanup.OperationWithCleanups(self.run)
423
376
def add_cleanup(self, cleanup_func, *args, **kwargs):
424
377
"""Register a function to call after self.run returns or raises.
488
439
usage help (e.g. Purpose, Usage, Options) with a
489
440
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
442
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.")
444
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
504
446
# Extract the summary (purpose) and sections out from the text
505
447
purpose,sections,order = self._get_help_parts(doc)
524
466
# XXX: optparse implicitly rewraps the help, and not always perfectly,
525
467
# 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:
469
options = option.get_optparser(self.options()).format_option_help()
470
# XXX: According to the spec, ReST option lists actually don't support
471
# options like --1.9 so that causes syntax errors (in Sphinx at least).
472
# As that pattern always appears in the commands that break, we trap
473
# on that and then format that block of 'format' options as a literal
475
if not plain and options.find(' --1.9 ') != -1:
536
476
options = options.replace(' format:\n', ' format::\n\n', 1)
537
477
if options.startswith('Options:'):
538
result += gettext(':Options:%s') % (options[len('options:'):],)
478
result += ':' + options
479
elif options.startswith('options:'):
480
# Python 2.4 version of optparse
481
result += ':Options:' + options[len('options:'):]
540
483
result += options
546
489
if sections.has_key(None):
547
490
text = sections.pop(None)
548
491
text = '\n '.join(text.splitlines())
549
result += gettext(':Description:\n %s\n\n') % (text,)
492
result += ':%s:\n %s\n\n' % ('Description',text)
551
494
# Add the custom sections (e.g. Examples). Note that there's no need
552
495
# to indent these as they must be indented already in the source.
554
497
for label in order:
555
if label in sections:
556
result += ':%s:\n%s\n' % (label, sections[label])
498
if sections.has_key(label):
499
result += ':%s:\n%s\n' % (label,sections[label])
559
result += (gettext("See bzr help %s for more details and examples.\n\n")
502
result += ("See bzr help %s for more details and examples.\n\n"
562
505
# Add the aliases, source (plug-in) and see also links, if any
564
result += gettext(':Aliases: ')
507
result += ':Aliases: '
565
508
result += ', '.join(self.aliases) + '\n'
566
509
plugin_name = self.plugin_name()
567
510
if plugin_name is not None:
568
result += gettext(':From: plugin "%s"\n') % plugin_name
511
result += ':From: plugin "%s"\n' % plugin_name
569
512
see_also = self.get_see_also(additional_see_also)
571
514
if not plain and see_also_as_links:
667
611
def run_argv_aliases(self, argv, alias_argv=None):
668
612
"""Parse the command line and run with extra aliases in alias_argv."""
669
613
args, opts = parse_args(self, argv, alias_argv)
672
615
# Process the standard options
673
616
if 'help' in opts: # e.g. bzr add --help
674
self.outf.write(self.get_help_text())
617
sys.stdout.write(self.get_help_text())
676
619
if 'usage' in opts: # e.g. bzr add --usage
677
self.outf.write(self.get_help_text(verbose=False))
620
sys.stdout.write(self.get_help_text(verbose=False))
679
622
trace.set_verbosity_level(option._verbosity_level)
680
623
if 'verbose' in self.supported_std_options:
695
638
all_cmd_args = cmdargs.copy()
696
639
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)))
643
return self.run_direct(**all_cmd_args)
727
645
def run_direct(self, *args, **kwargs):
728
"""Deprecated thunk from bzrlib 2.1."""
729
return self.run(*args, **kwargs)
646
"""Call run directly with objects (without parsing an argv list)."""
647
return self._operation.run_simple(*args, **kwargs)
732
650
"""Actually run the command.
737
655
Return 0 or None if the command was successful, or a non-zero
738
656
shell error code if not. It's OK for this method to allow
739
657
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
659
raise NotImplementedError('no implementation of command %r'
795
690
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',
694
self.create_hook(HookPoint('extend_command',
800
695
"Called after creating a command object to allow modifications "
801
696
"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',
697
"new bzrlib.commands.Command object.", (1, 13), None))
698
self.create_hook(HookPoint('get_command',
804
699
"Called when creating a single command. Called with "
805
700
"(cmd_or_None, command_name). get_command should either return "
806
701
"the cmd_or_None parameter, or a replacement Command object that "
807
702
"should be used for the command. Note that the Command.hooks "
808
703
"hooks are core infrastructure. Many users will prefer to use "
809
704
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
811
self.add_hook('get_missing_command',
706
self.create_hook(HookPoint('get_missing_command',
812
707
"Called when creating a single command if no command could be "
813
708
"found. Called with (command_name). get_missing_command should "
814
709
"either return None, or a Command object to be used for the "
816
self.add_hook('list_commands',
710
"command.", (1, 17), None))
711
self.create_hook(HookPoint('list_commands',
817
712
"Called when enumerating commands. Called with a set of "
818
713
"cmd_name strings for all the commands found so far. This set "
819
714
" is safe to mutate - e.g. to remove a command. "
820
715
"list_commands should return the updated set of command names.",
823
718
Command.hooks = CommandHooks()
1120
1005
if not opt_no_aliases:
1121
1006
alias_argv = get_alias(argv[0])
1008
user_encoding = osutils.get_user_encoding()
1009
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1123
1010
argv[0] = alias_argv.pop(0)
1125
1012
cmd = argv.pop(0)
1013
# We want only 'ascii' command names, but the user may have typed
1014
# in a Unicode name. In that case, they should just get a
1015
# 'command not found' error later.
1126
1017
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1129
1018
run = cmd_obj.run_argv_aliases
1130
1019
run_argv = [argv, alias_argv]
1290
1179
class Provider(object):
1291
"""Generic class to be overriden by plugins"""
1180
'''Generic class to be overriden by plugins'''
1293
1182
def plugin_for_command(self, cmd_name):
1294
"""Takes a command and returns the information for that plugin
1183
'''Takes a command and returns the information for that plugin
1296
1185
:return: A dictionary with all the available information
1297
for the requested plugin
1186
for the requested plugin
1299
1188
raise NotImplementedError
1302
1191
class ProvidersRegistry(registry.Registry):
1303
"""This registry exists to allow other providers to exist"""
1192
'''This registry exists to allow other providers to exist'''
1305
1194
def __iter__(self):
1306
1195
for key, provider in self.iteritems():