platypush/platypush/plugins/__init__.py

import sys
import logging
import traceback

from functools import wraps

from platypush.config import Config
from platypush.message.response import Response
from platypush.utils import get_decorators

def action(f):
    @wraps(f)
    def _execute_action(*args, **kwargs):
        output = None
        errors = []

        output = f(*args, **kwargs)
        if output and isinstance(output, Response):
            errors = output.errors \
                if isinstance(output.errors, list) else [output.errors]
            output = output.output
        elif isinstance(output, tuple) and len(output) == 2:
            errors = output[1] \
                if isinstance(output[1], list) else [output[1]]

            if len(errors) == 1 and errors[0] is None: errors = []
            output = output[0]

        return Response(output=output, errors=errors)

    # Propagate the docstring
    _execute_action.__doc__ = f.__doc__
    return _execute_action


class Plugin(object):
    """ Base plugin class """

    def __init__(self, **kwargs):
        self.logger = logging.getLogger(self.__class__.__name__)
        if 'logging' in kwargs:
            self.logger.setLevel(getattr(logging, kwargs['logging'].upper()))

        self.registered_actions = set(
            get_decorators(self.__class__, climb_class_hierarchy=True)
            .get('action', [])
        )

    def run(self, method, *args, **kwargs):
        if method not in self.registered_actions:
            raise RuntimeError('{} is not a registered action on {}'.format(
                method, self.__class__.__name__))

        return getattr(self, method)(*args, **kwargs)


# vim:sw=4:ts=4:et: