<filename>src/ralph/util/plugin.py
#!/usr/bin/env python
# -*- coding: utf-8 -*-

from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals


BY_NAME = {}
BY_REQUIREMENTS = {}
PRIORITIES = {}


class PluginFailed(Exception):
    """Raised when a scan plugin is unsuccessful."""


class Restart(Exception):
    """Raised when the plugin should be re-run."""


def register(func=None, chain="default", requires=None, priority=None):
    """
    A decorator that registers a function as plugin.
    """
    if func is None:
        def wrapper(f):
            return register(func=f, chain=chain,
                            requires=requires, priority=priority)
        return wrapper
    if not requires:
        requires = set()
    BY_NAME.setdefault(chain, {})[func.func_name] = func
    BY_REQUIREMENTS.setdefault(
        chain,
        {},
    ).setdefault(
        frozenset(requires),
        [],
    ).append(func.func_name)
    PRIORITIES.setdefault(chain, {})[func.func_name] = priority or 100
    return func


def next(chain, done_reqs):
    """
    Return a list of plugins that can be run given the list of plugins
    that has already been ran.
    """
    ret = set()
    if chain not in BY_REQUIREMENTS:
        return ret
    done_reqs = set(done_reqs)
    for needed_reqs, plugins in BY_REQUIREMENTS[chain].iteritems():
        if needed_reqs <= done_reqs:
            ret |= set(plugins)
    return ret


def highest_priority(chain, plugins):
    """
    Selects a plugin from given `plugins` on a specified `chain` with the
    highest priority.
    """
    ret = max(plugins, key=lambda p: PRIORITIES.get(chain, {}).get(p, 100))
    return ret


def prioritize(chain, plugins):
    """
    Returns the `plugins` sequence sorted in descending priority.
    """
    return sorted(
        plugins,
        key=lambda p: -PRIORITIES.get(chain, {}).get(p, 100),
    )


def run(chain, func_name, **kwargs):
    """
    Run a single plugin by a name.
    """
    return BY_NAME[chain][func_name](**kwargs)


def purge(plugin_set):
    """Remove all plugins from the plugin subsystem which are not related by
    means of requirements to the given `plugin_set`."""
    for ck, cv in BY_REQUIREMENTS.iteritems():
        for pk, pv in cv.iteritems():
            for p in pv:
                if p in plugin_set:
                    plugin_set |= pk
    for ck, cv in BY_REQUIREMENTS.iteritems():
        for pk, pv in cv.iteritems():
            to_delete = set()
            for p in pv:
                if p not in plugin_set:
                    to_delete.add(p)
            for p in to_delete:
                pv.remove(p)

<filename>src/ralph/util/plugin.py
#!/usr/bin/env python
# -*- coding: utf-8 -*-

from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals


BY_NAME = {}
BY_REQUIREMENTS = {}
PRIORITIES = {}


class PluginFailed(Exception):
    """Raised when a scan plugin is unsuccessful."""


class Restart(Exception):
    """Raised when the plugin should be re-run."""


def register(func=None, chain="default", requires=None, priority=None):
    """
    A decorator that registers a function as plugin.
    """
    if func is None:
        def wrapper(f):
            return register(func=f, chain=chain,
                            requires=requires, priority=priority)
        return wrapper
    if not requires:
        requires = set()
    BY_NAME.setdefault(chain, {})[func.func_name] = func
    BY_REQUIREMENTS.setdefault(
        chain,
        {},
    ).setdefault(
        frozenset(requires),
        [],
    ).append(func.func_name)
    PRIORITIES.setdefault(chain, {})[func.func_name] = priority or 100
    return func


def next(chain, done_reqs):
    """
    Return a list of plugins that can be run given the list of plugins
    that has already been ran.
    """
    ret = set()
    if chain not in BY_REQUIREMENTS:
        return ret
    done_reqs = set(done_reqs)
    for needed_reqs, plugins in BY_REQUIREMENTS[chain].iteritems():
        if needed_reqs <= done_reqs:
            ret |= set(plugins)
    return ret


def highest_priority(chain, plugins):
    """
    Selects a plugin from given `plugins` on a specified `chain` with the
    highest priority.
    """
    ret = max(plugins, key=lambda p: PRIORITIES.get(chain, {}).get(p, 100))
    return ret


def prioritize(chain, plugins):
    """
    Returns the `plugins` sequence sorted in descending priority.
    """
    return sorted(
        plugins,
        key=lambda p: -PRIORITIES.get(chain, {}).get(p, 100),
    )


def run(chain, func_name, **kwargs):
    """
    Run a single plugin by a name.
    """
    return BY_NAME[chain][func_name](**kwargs)


def purge(plugin_set):
    """Remove all plugins from the plugin subsystem which are not related by
    means of requirements to the given `plugin_set`."""
    for ck, cv in BY_REQUIREMENTS.iteritems():
        for pk, pv in cv.iteritems():
            for p in pv:
                if p in plugin_set:
                    plugin_set |= pk
    for ck, cv in BY_REQUIREMENTS.iteritems():
        for pk, pv in cv.iteritems():
            to_delete = set()
            for p in pv:
                if p not in plugin_set:
                    to_delete.add(p)
            for p in to_delete:
                pv.remove(p)

#!/usr/bin/env python # -*- coding: utf-8 -*- Raised when a scan plugin is unsuccessful. Raised when the plugin should be re-run. A decorator that registers a function as plugin. Return a list of plugins that can be run given the list of plugins     that has already been ran. Selects a plugin from given `plugins` on a specified `chain` with the     highest priority. Returns the `plugins` sequence sorted in descending priority. Run a single plugin by a name. Remove all plugins from the plugin subsystem which are not related by     means of requirements to the given `plugin_set`.