django-orchestra/orchestra/utils/plugins.py

from .functional import cached


class Plugin(object):
    verbose_name = None
    # Used on select plugin view
    class_verbose_name = None
    icon = None
    
    @classmethod
    def get_plugin_name(cls):
        return cls.__name__
    
    @classmethod
    def get_plugins(cls):
        return cls.plugins
    
    @classmethod
    @cached
    def get_plugin(cls, name):
        for plugin in cls.get_plugins():
            if plugin.get_plugin_name() == name:
                return plugin
        raise KeyError('This plugin is not registered')
    
    @classmethod
    def get_verbose_name(cls):
        # don't evaluate p.verbose_name ugettext_lazy
        verbose = getattr(cls.verbose_name, '_proxy____args', [cls.verbose_name])
        if verbose[0]:
            return cls.verbose_name
        else:
            return cls.get_plugin_name()
    
    @classmethod
    def get_plugin_choices(cls):
        choices = []
        for plugin in cls.get_plugins():
            verbose = plugin.get_verbose_name()
            choices.append((plugin.get_plugin_name(), verbose))
        return sorted(choices, key=lambda e: e[1])


class PluginMount(type):
    def __init__(cls, name, bases, attrs):
        if not attrs.get('abstract', False):
            if not hasattr(cls, 'plugins'):
                # This branch only executes when processing the mount point itself.
                # So, since this is a new plugin type, not an implementation, this
                # class shouldn't be registered as a plugin. Instead, it sets up a
                # list where plugins can be registered later.
                cls.plugins = []
            else:
                # This must be a plugin implementation, which should be registered.
                # Simply appending it to the list is all that's needed to keep
                # track of it later.
                cls.plugins.append(cls)