/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commands.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
27
27
 
28
28
from bzrlib.lazy_import import lazy_import
29
29
lazy_import(globals(), """
 
30
import codecs
30
31
import errno
31
32
import threading
 
33
from warnings import warn
32
34
 
33
35
import bzrlib
34
36
from bzrlib import (
36
38
    cmdline,
37
39
    debug,
38
40
    errors,
39
 
    i18n,
40
41
    option,
41
42
    osutils,
42
43
    trace,
43
44
    ui,
 
45
    win32utils,
44
46
    )
45
47
""")
46
48
 
47
 
from bzrlib.hooks import Hooks
48
 
from bzrlib.i18n import gettext
 
49
from bzrlib.hooks import HookPoint, Hooks
49
50
# Compatibility - Option used to be in commands.
50
51
from bzrlib.option import Option
51
52
from bzrlib.plugin import disable_plugins, load_plugins
164
165
    return cmd[4:].replace('_','-')
165
166
 
166
167
 
 
168
@deprecated_function(deprecated_in((2, 2, 0)))
 
169
def _builtin_commands():
 
170
    """Return a dict of {name: cmd_class} for builtin commands.
 
171
 
 
172
    :deprecated: Use the builtin_command_registry registry instead
 
173
    """
 
174
    # return dict(name: cmd_class)
 
175
    return dict(builtin_command_registry.items())
 
176
 
 
177
 
167
178
def _register_builtin_commands():
168
179
    if builtin_command_registry.keys():
169
180
        # only load once
211
222
    Use of all_command_names() is encouraged rather than builtin_command_names
212
223
    and/or plugin_command_names.
213
224
    """
214
 
    _register_builtin_commands()
215
225
    return builtin_command_registry.keys()
216
226
 
217
227
 
229
239
    try:
230
240
        return _get_cmd_object(cmd_name, plugins_override)
231
241
    except KeyError:
232
 
        raise errors.BzrCommandError(gettext('unknown command "%s"') % cmd_name)
 
242
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
233
243
 
234
244
 
235
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
265
275
    # Allow plugins to extend commands
266
276
    for hook in Command.hooks['extend_command']:
267
277
        hook(cmd)
268
 
    if getattr(cmd, 'invoked_as', None) is None:
269
 
        cmd.invoked_as = cmd_name
270
278
    return cmd
271
279
 
272
280
 
349
357
    summary, then a complete description of the command.  A grammar
350
358
    description will be inserted.
351
359
 
352
 
    :cvar aliases: Other accepted names for this command.
353
 
 
354
 
    :cvar takes_args: List of argument forms, marked with whether they are
355
 
        optional, repeated, etc.  Examples::
356
 
 
357
 
            ['to_location', 'from_branch?', 'file*']
358
 
 
359
 
        * 'to_location' is required
360
 
        * 'from_branch' is optional
361
 
        * 'file' can be specified 0 or more times
362
 
 
363
 
    :cvar takes_options: List of options that may be given for this command.
364
 
        These can be either strings, referring to globally-defined options, or
365
 
        option objects.  Retrieve through options().
366
 
 
367
 
    :cvar hidden: If true, this command isn't advertised.  This is typically
 
360
    aliases
 
361
        Other accepted names for this command.
 
362
 
 
363
    takes_args
 
364
        List of argument forms, marked with whether they are optional,
 
365
        repeated, etc.
 
366
 
 
367
                Examples:
 
368
 
 
369
                ['to_location', 'from_branch?', 'file*']
 
370
 
 
371
                'to_location' is required
 
372
                'from_branch' is optional
 
373
                'file' can be specified 0 or more times
 
374
 
 
375
    takes_options
 
376
        List of options that may be given for this command.  These can
 
377
        be either strings, referring to globally-defined options,
 
378
        or option objects.  Retrieve through options().
 
379
 
 
380
    hidden
 
381
        If true, this command isn't advertised.  This is typically
368
382
        for commands intended for expert users.
369
383
 
370
 
    :cvar encoding_type: Command objects will get a 'outf' attribute, which has
371
 
        been setup to properly handle encoding of unicode strings.
372
 
        encoding_type determines what will happen when characters cannot be
373
 
        encoded:
374
 
 
375
 
        * strict - abort if we cannot decode
376
 
        * replace - put in a bogus character (typically '?')
377
 
        * exact - do not encode sys.stdout
378
 
 
379
 
        NOTE: by default on Windows, sys.stdout is opened as a text stream,
380
 
        therefore LF line-endings are converted to CRLF.  When a command uses
381
 
        encoding_type = 'exact', then sys.stdout is forced to be a binary
382
 
        stream, and line-endings will not mangled.
383
 
 
384
 
    :cvar invoked_as:
385
 
        A string indicating the real name under which this command was
386
 
        invoked, before expansion of aliases.
387
 
        (This may be None if the command was constructed and run in-process.)
 
384
    encoding_type
 
385
        Command objects will get a 'outf' attribute, which has been
 
386
        setup to properly handle encoding of unicode strings.
 
387
        encoding_type determines what will happen when characters cannot
 
388
        be encoded
 
389
            strict - abort if we cannot decode
 
390
            replace - put in a bogus character (typically '?')
 
391
            exact - do not encode sys.stdout
 
392
 
 
393
            NOTE: by default on Windows, sys.stdout is opened as a text
 
394
            stream, therefore LF line-endings are converted to CRLF.
 
395
            When a command uses encoding_type = 'exact', then
 
396
            sys.stdout is forced to be a binary stream, and line-endings
 
397
            will not mangled.
388
398
 
389
399
    :cvar hooks: An instance of CommandHooks.
390
 
 
391
 
    :cvar __doc__: The help shown by 'bzr help command' for this command.
392
 
        This is set by assigning explicitly to __doc__ so that -OO can
393
 
        be used::
394
 
 
395
 
            class Foo(Command):
396
 
                __doc__ = "My help goes here"
397
400
    """
398
401
    aliases = []
399
402
    takes_args = []
400
403
    takes_options = []
401
404
    encoding_type = 'strict'
402
 
    invoked_as = None
403
 
    l10n = True
404
405
 
405
406
    hidden = False
406
407
 
407
408
    def __init__(self):
408
409
        """Construct an instance of this command."""
 
410
        if self.__doc__ == Command.__doc__:
 
411
            warn("No help message set for %r" % self)
409
412
        # List of standard options directly supported
410
413
        self.supported_std_options = []
411
414
        self._setup_run()
432
435
        """
433
436
        self._operation.cleanup_now()
434
437
 
 
438
    @deprecated_method(deprecated_in((2, 1, 0)))
 
439
    def _maybe_expand_globs(self, file_list):
 
440
        """Glob expand file_list if the platform does not do that itself.
 
441
 
 
442
        Not used anymore, now that the bzr command-line parser globs on
 
443
        Windows.
 
444
 
 
445
        :return: A possibly empty list of unicode paths.
 
446
 
 
447
        Introduced in bzrlib 0.18.
 
448
        """
 
449
        return file_list
 
450
 
435
451
    def _usage(self):
436
452
        """Return single-line grammar for this command.
437
453
 
465
481
            usage help (e.g. Purpose, Usage, Options) with a
466
482
            message explaining how to obtain full help.
467
483
        """
468
 
        if self.l10n:
469
 
            i18n.install()  # Install i18n only for get_help_text for now.
470
484
        doc = self.help()
471
 
        if doc:
472
 
            # Note: If self.gettext() translates ':Usage:\n', the section will
473
 
            # be shown after "Description" section and we don't want to
474
 
            # translate the usage string.
475
 
            # Though, bzr export-pot don't exports :Usage: section and it must
476
 
            # not be translated.
477
 
            doc = self.gettext(doc)
478
 
        else:
479
 
            doc = gettext("No help for this command.")
 
485
        if doc is None:
 
486
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
480
487
 
481
488
        # Extract the summary (purpose) and sections out from the text
482
489
        purpose,sections,order = self._get_help_parts(doc)
489
496
 
490
497
        # The header is the purpose and usage
491
498
        result = ""
492
 
        result += gettext(':Purpose: %s\n') % (purpose,)
 
499
        result += ':Purpose: %s\n' % purpose
493
500
        if usage.find('\n') >= 0:
494
 
            result += gettext(':Usage:\n%s\n') % (usage,)
 
501
            result += ':Usage:\n%s\n' % usage
495
502
        else:
496
 
            result += gettext(':Usage:   %s\n') % (usage,)
 
503
            result += ':Usage:   %s\n' % usage
497
504
        result += '\n'
498
505
 
499
506
        # Add the options
501
508
        # XXX: optparse implicitly rewraps the help, and not always perfectly,
502
509
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
503
510
        # 20090319
504
 
        parser = option.get_optparser(self.options())
505
 
        options = parser.format_option_help()
506
 
        # FIXME: According to the spec, ReST option lists actually don't
507
 
        # support options like --1.14 so that causes syntax errors (in Sphinx
508
 
        # at least).  As that pattern always appears in the commands that
509
 
        # break, we trap on that and then format that block of 'format' options
510
 
        # as a literal block. We use the most recent format still listed so we
511
 
        # don't have to do that too often -- vila 20110514
512
 
        if not plain and options.find('  --1.14  ') != -1:
 
511
        options = option.get_optparser(self.options()).format_option_help()
 
512
        # XXX: According to the spec, ReST option lists actually don't support 
 
513
        # options like --1.9 so that causes syntax errors (in Sphinx at least).
 
514
        # As that pattern always appears in the commands that break, we trap
 
515
        # on that and then format that block of 'format' options as a literal
 
516
        # block.
 
517
        if not plain and options.find('  --1.9  ') != -1:
513
518
            options = options.replace(' format:\n', ' format::\n\n', 1)
514
519
        if options.startswith('Options:'):
515
 
            result += gettext(':Options:%s') % (options[len('options:'):],)
 
520
            result += ':' + options
 
521
        elif options.startswith('options:'):
 
522
            # Python 2.4 version of optparse
 
523
            result += ':Options:' + options[len('options:'):]
516
524
        else:
517
525
            result += options
518
526
        result += '\n'
523
531
            if sections.has_key(None):
524
532
                text = sections.pop(None)
525
533
                text = '\n  '.join(text.splitlines())
526
 
                result += gettext(':Description:\n  %s\n\n') % (text,)
 
534
                result += ':%s:\n  %s\n\n' % ('Description',text)
527
535
 
528
536
            # Add the custom sections (e.g. Examples). Note that there's no need
529
537
            # to indent these as they must be indented already in the source.
530
538
            if sections:
531
539
                for label in order:
532
 
                    if label in sections:
533
 
                        result += ':%s:\n%s\n' % (label, sections[label])
 
540
                    if sections.has_key(label):
 
541
                        result += ':%s:\n%s\n' % (label,sections[label])
534
542
                result += '\n'
535
543
        else:
536
 
            result += (gettext("See bzr help %s for more details and examples.\n\n")
 
544
            result += ("See bzr help %s for more details and examples.\n\n"
537
545
                % self.name())
538
546
 
539
547
        # Add the aliases, source (plug-in) and see also links, if any
540
548
        if self.aliases:
541
 
            result += gettext(':Aliases:  ')
 
549
            result += ':Aliases:  '
542
550
            result += ', '.join(self.aliases) + '\n'
543
551
        plugin_name = self.plugin_name()
544
552
        if plugin_name is not None:
545
 
            result += gettext(':From:     plugin "%s"\n') % plugin_name
 
553
            result += ':From:     plugin "%s"\n' % plugin_name
546
554
        see_also = self.get_see_also(additional_see_also)
547
555
        if see_also:
548
556
            if not plain and see_also_as_links:
554
562
                        see_also_links.append(item)
555
563
                    else:
556
564
                        # Use a Sphinx link for this entry
557
 
                        link_text = gettext(":doc:`{0} <{1}-help>`").format(
558
 
                                                                    item, item)
 
565
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
559
566
                        see_also_links.append(link_text)
560
567
                see_also = see_also_links
561
 
            result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
 
568
            result += ':See also: '
 
569
            result += ', '.join(see_also) + '\n'
562
570
 
563
571
        # If this will be rendered as plain text, convert it
564
572
        if plain:
645
653
    def run_argv_aliases(self, argv, alias_argv=None):
646
654
        """Parse the command line and run with extra aliases in alias_argv."""
647
655
        args, opts = parse_args(self, argv, alias_argv)
648
 
        self._setup_outf()
649
656
 
650
657
        # Process the standard options
651
658
        if 'help' in opts:  # e.g. bzr add --help
652
 
            self.outf.write(self.get_help_text())
 
659
            sys.stdout.write(self.get_help_text())
653
660
            return 0
654
661
        if 'usage' in opts:  # e.g. bzr add --usage
655
 
            self.outf.write(self.get_help_text(verbose=False))
 
662
            sys.stdout.write(self.get_help_text(verbose=False))
656
663
            return 0
657
664
        trace.set_verbosity_level(option._verbosity_level)
658
665
        if 'verbose' in self.supported_std_options:
673
680
        all_cmd_args = cmdargs.copy()
674
681
        all_cmd_args.update(cmdopts)
675
682
 
676
 
        try:
677
 
            return self.run(**all_cmd_args)
678
 
        finally:
679
 
            # reset it, so that other commands run in the same process won't
680
 
            # inherit state. Before we reset it, log any activity, so that it
681
 
            # gets properly tracked.
682
 
            ui.ui_factory.log_transport_activity(
683
 
                display=('bytes' in debug.debug_flags))
684
 
            trace.set_verbosity_level(0)
 
683
        self._setup_outf()
 
684
 
 
685
        return self.run(**all_cmd_args)
685
686
 
686
687
    def _setup_run(self):
687
688
        """Wrap the defined run method on self with a cleanup.
701
702
                del self._operation
702
703
        self.run = run
703
704
 
 
705
    @deprecated_method(deprecated_in((2, 2, 0)))
 
706
    def run_direct(self, *args, **kwargs):
 
707
        """Deprecated thunk from bzrlib 2.1."""
 
708
        return self.run(*args, **kwargs)
 
709
 
704
710
    def run(self):
705
711
        """Actually run the command.
706
712
 
732
738
            return None
733
739
        return getdoc(self)
734
740
 
735
 
    def gettext(self, message):
736
 
        """Returns the gettext function used to translate this command's help.
737
 
 
738
 
        Commands provided by plugins should override this to use their
739
 
        own i18n system.
740
 
        """
741
 
        return i18n.gettext_per_paragraph(message)
742
 
 
743
741
    def name(self):
744
 
        """Return the canonical name for this command.
745
 
 
746
 
        The name under which it was actually invoked is available in invoked_as.
747
 
        """
748
742
        return _unsquish_command_name(self.__class__.__name__)
749
743
 
750
744
    def plugin_name(self):
768
762
        These are all empty initially, because by default nothing should get
769
763
        notified.
770
764
        """
771
 
        Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
772
 
        self.add_hook('extend_command',
 
765
        Hooks.__init__(self)
 
766
        self.create_hook(HookPoint('extend_command',
773
767
            "Called after creating a command object to allow modifications "
774
768
            "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',
 
769
            "new bzrlib.commands.Command object.", (1, 13), None))
 
770
        self.create_hook(HookPoint('get_command',
777
771
            "Called when creating a single command. Called with "
778
772
            "(cmd_or_None, command_name). get_command should either return "
779
773
            "the cmd_or_None parameter, or a replacement Command object that "
780
774
            "should be used for the command. Note that the Command.hooks "
781
775
            "hooks are core infrastructure. Many users will prefer to use "
782
776
            "bzrlib.commands.register_command or plugin_cmds.register_lazy.",
783
 
            (1, 17))
784
 
        self.add_hook('get_missing_command',
 
777
            (1, 17), None))
 
778
        self.create_hook(HookPoint('get_missing_command',
785
779
            "Called when creating a single command if no command could be "
786
780
            "found. Called with (command_name). get_missing_command should "
787
781
            "either return None, or a Command object to be used for the "
788
 
            "command.", (1, 17))
789
 
        self.add_hook('list_commands',
 
782
            "command.", (1, 17), None))
 
783
        self.create_hook(HookPoint('list_commands',
790
784
            "Called when enumerating commands. Called with a set of "
791
785
            "cmd_name strings for all the commands found so far. This set "
792
786
            " is safe to mutate - e.g. to remove a command. "
793
787
            "list_commands should return the updated set of command names.",
794
 
            (1, 17))
 
788
            (1, 17), None))
795
789
 
796
790
Command.hooks = CommandHooks()
797
791
 
811
805
    else:
812
806
        args = argv
813
807
 
814
 
    # for python 2.5 and later, optparse raises this exception if a non-ascii
815
 
    # option name is given.  See http://bugs.python.org/issue2931
816
 
    try:
817
 
        options, args = parser.parse_args(args)
818
 
    except UnicodeEncodeError,e:
819
 
        raise errors.BzrCommandError(gettext('Only ASCII permitted in option names'))
820
 
 
 
808
    options, args = parser.parse_args(args)
821
809
    opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
822
810
                 v is not option.OptionParser.DEFAULT_VALUE])
823
811
    return args, opts
840
828
                argdict[argname + '_list'] = None
841
829
        elif ap[-1] == '+':
842
830
            if not args:
843
 
                raise errors.BzrCommandError(gettext(
844
 
                      "command {0!r} needs one or more {1}").format(
845
 
                      cmd, argname.upper()))
 
831
                raise errors.BzrCommandError("command %r needs one or more %s"
 
832
                                             % (cmd, argname.upper()))
846
833
            else:
847
834
                argdict[argname + '_list'] = args[:]
848
835
                args = []
849
836
        elif ap[-1] == '$': # all but one
850
837
            if len(args) < 2:
851
 
                raise errors.BzrCommandError(
852
 
                      gettext("command {0!r} needs one or more {1}").format(
853
 
                                             cmd, argname.upper()))
 
838
                raise errors.BzrCommandError("command %r needs one or more %s"
 
839
                                             % (cmd, argname.upper()))
854
840
            argdict[argname + '_list'] = args[:-1]
855
841
            args[:-1] = []
856
842
        else:
857
843
            # just a plain arg
858
844
            argname = ap
859
845
            if not args:
860
 
                raise errors.BzrCommandError(
861
 
                     gettext("command {0!r} requires argument {1}").format(
862
 
                               cmd, argname.upper()))
 
846
                raise errors.BzrCommandError("command %r requires argument %s"
 
847
                               % (cmd, argname.upper()))
863
848
            else:
864
849
                argdict[argname] = args.pop(0)
865
850
 
866
851
    if args:
867
 
        raise errors.BzrCommandError( gettext(
868
 
                              "extra argument to command {0}: {1}").format(
869
 
                                       cmd, args[0]) )
 
852
        raise errors.BzrCommandError("extra argument to command %s: %s"
 
853
                                     % (cmd, args[0]))
870
854
 
871
855
    return argdict
872
856
 
955
939
 
956
940
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
957
941
    from bzrlib.lsprof import profile
958
 
    ret, stats = profile(exception_to_return_code, the_callable,
959
 
                         *args, **kwargs)
 
942
    ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
960
943
    stats.sort()
961
944
    if filename is None:
962
945
        stats.pprint()
963
946
    else:
964
947
        stats.save(filename)
965
 
        trace.note(gettext('Profile data written to "%s".'), filename)
 
948
        trace.note('Profile data written to "%s".', filename)
966
949
    return ret
967
950
 
968
951
 
 
952
@deprecated_function(deprecated_in((2, 2, 0)))
 
953
def shlex_split_unicode(unsplit):
 
954
    return cmdline.split(unsplit)
 
955
 
 
956
 
969
957
def get_alias(cmd, config=None):
970
958
    """Return an expanded alias, or None if no alias exists.
971
959
 
1027
1015
        Specify the number of processes that can be run concurrently (selftest).
1028
1016
    """
1029
1017
    trace.mutter("bazaar version: " + bzrlib.__version__)
1030
 
    argv = _specified_or_unicode_argv(argv)
 
1018
    argv = list(argv)
1031
1019
    trace.mutter("bzr arguments: %r", argv)
1032
1020
 
1033
 
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1034
 
            opt_no_l10n = opt_no_aliases = False
 
1021
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
 
1022
                opt_no_aliases = False
1035
1023
    opt_lsprof_file = opt_coverage_dir = None
1036
1024
 
1037
1025
    # --no-plugins is handled specially at a very early stage. We need
1054
1042
            opt_no_plugins = True
1055
1043
        elif a == '--no-aliases':
1056
1044
            opt_no_aliases = True
1057
 
        elif a == '--no-l10n':
1058
 
            opt_no_l10n = True
1059
1045
        elif a == '--builtin':
1060
1046
            opt_builtin = True
1061
1047
        elif a == '--concurrency':
1064
1050
        elif a == '--coverage':
1065
1051
            opt_coverage_dir = argv[i + 1]
1066
1052
            i += 1
1067
 
        elif a == '--profile-imports':
1068
 
            pass # already handled in startup script Bug #588277
1069
1053
        elif a.startswith('-D'):
1070
1054
            debug.debug_flags.add(a[2:])
1071
1055
        else:
1093
1077
    if not opt_no_aliases:
1094
1078
        alias_argv = get_alias(argv[0])
1095
1079
        if alias_argv:
 
1080
            user_encoding = osutils.get_user_encoding()
 
1081
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
1096
1082
            argv[0] = alias_argv.pop(0)
1097
1083
 
1098
1084
    cmd = argv.pop(0)
 
1085
    # We want only 'ascii' command names, but the user may have typed
 
1086
    # in a Unicode name. In that case, they should just get a
 
1087
    # 'command not found' error later.
 
1088
 
1099
1089
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1100
 
    if opt_no_l10n:
1101
 
        cmd.l10n = False
1102
1090
    run = cmd_obj.run_argv_aliases
1103
1091
    run_argv = [argv, alias_argv]
1104
1092
 
1177
1165
        new_argv = []
1178
1166
        try:
1179
1167
            # ensure all arguments are unicode strings
1180
 
            for a in argv:
 
1168
            for a in argv[1:]:
1181
1169
                if isinstance(a, unicode):
1182
1170
                    new_argv.append(a)
1183
1171
                else:
1199
1187
 
1200
1188
    :return: exit code of bzr command.
1201
1189
    """
1202
 
    if argv is not None:
1203
 
        argv = argv[1:]
 
1190
    argv = _specified_or_unicode_argv(argv)
1204
1191
    _register_builtin_commands()
1205
1192
    ret = run_bzr_catch_errors(argv)
 
1193
    bzrlib.ui.ui_factory.log_transport_activity(
 
1194
        display=('bytes' in debug.debug_flags))
1206
1195
    trace.mutter("return code %d", ret)
1207
1196
    return ret
1208
1197
 
1261
1250
 
1262
1251
 
1263
1252
class Provider(object):
1264
 
    """Generic class to be overriden by plugins"""
 
1253
    '''Generic class to be overriden by plugins'''
1265
1254
 
1266
1255
    def plugin_for_command(self, cmd_name):
1267
 
        """Takes a command and returns the information for that plugin
 
1256
        '''Takes a command and returns the information for that plugin
1268
1257
 
1269
1258
        :return: A dictionary with all the available information
1270
 
            for the requested plugin
1271
 
        """
 
1259
        for the requested plugin
 
1260
        '''
1272
1261
        raise NotImplementedError
1273
1262
 
1274
1263
 
1275
1264
class ProvidersRegistry(registry.Registry):
1276
 
    """This registry exists to allow other providers to exist"""
 
1265
    '''This registry exists to allow other providers to exist'''
1277
1266
 
1278
1267
    def __iter__(self):
1279
1268
        for key, provider in self.iteritems():