# -*- coding: utf-8 -*-
"""The cookie plugins manager object."""
# pylint: disable=redundant-returns-doc
[docs]
class CookiePluginsManager(object):
"""Class that implements the cookie plugins manager."""
_plugin_classes = {}
[docs]
@classmethod
def DeregisterPlugin(cls, plugin_class):
"""Deregisters a plugin class.
The plugin classes are identified based on their lower case name.
Args:
plugin_class (type): the class object of the plugin.
Raises:
KeyError: if plugin class is not set for the corresponding name.
"""
plugin_name = plugin_class.NAME.lower()
if plugin_name not in cls._plugin_classes:
raise KeyError('Plugin class not set for name: {0:s}.'.format(
plugin_class.NAME))
del cls._plugin_classes[plugin_name]
[docs]
@classmethod
def GetPlugins(cls):
"""Retrieves the cookie plugins.
Returns:
list[type]: list of all cookie plugin objects.
"""
return [plugin_class() for plugin_class in cls._plugin_classes.values()]
[docs]
@classmethod
def RegisterPlugin(cls, plugin_class):
"""Registers a plugin class.
The plugin classes are identified based on their lower case name.
Args:
plugin_class (type): the class object of the plugin.
Raises:
KeyError: if plugin class is already set for the corresponding name.
"""
plugin_name = plugin_class.NAME.lower()
if plugin_name in cls._plugin_classes:
raise KeyError(('Plugin class already set for name: {0:s}.').format(
plugin_class.NAME))
cls._plugin_classes[plugin_name] = plugin_class
[docs]
@classmethod
def RegisterPlugins(cls, plugin_classes):
"""Registers plugin classes.
The plugin classes are identified based on their lower case name.
Args:
plugin_classes (list[type]): a list of class objects of the plugins.
Raises:
KeyError: if plugin class is already set for the corresponding name.
"""
for plugin_class in plugin_classes:
cls.RegisterPlugin(plugin_class)