Source code for djburger.validators.bases

'''Base classes for validators

Use this classes as base class for your own validators.
'''

# built-in
import abc

# external
from six import with_metaclass

# project
from ..datastructures import MultiDict
from ..utils import is_django_active, is_django_installed, safe_model_to_dict


__all__ = [
    'IValidator',
    'Form', 'ModelForm',
    'Marshmallow', 'WTForms', 'RESTFramework',
]


# Django
if is_django_installed:
    from django.forms import Form as _Form, ModelForm as _ModelForm
    from django.http.request import QueryDict
else:
    from djburger.mocks import DjangoFormBase as _Form
    _ModelForm = _Form
    QueryDict = None


# marshmallow
try:
    from marshmallow import Schema as _MarshmallowSchema
except ImportError:
    from djburger.mocks import MarshmallowBase as _MarshmallowSchema


# WTForms
try:
    from wtforms.form import Form as _WTForms
except ImportError:
    from djburger.mocks import WTFormsBase as _WTForms


# Django REST Framework
if is_django_active:
    try:
        from rest_framework.serializers import Serializer as _RESTFrameworkSerializer
    except ImportError:
        from djburger.mocks import RESTFrameworkBase as _RESTFrameworkSerializer
else:
    from djburger.mocks import RESTFrameworkBase as _RESTFrameworkSerializer


class IValidator(with_metaclass(abc.ABCMeta)):
    """Abstract base class for validators.
    """

    @abc.abstractmethod
    def __init__(self):
        """
        Args:
            request - Request object
            **kwargs - all kwargs of Django Forms.
        """
        pass

    @abc.abstractmethod
    def is_valid(self):
        """Validate and clean data.

        1. Set `cleaned_data` and return True if data is valid
        2. Set `errors` and return False otherwise.

        Returns:
            True: data is valid
            False: data is invalid
        """
        pass

    @abc.abstractproperty
    def errors(self):
        """Errors dict. Set by `is_valid` method.

        key: name of invalid field or `__all__`.
        value: list of errors strings.
        """
        pass

    @abc.abstractproperty
    def cleaned_data(self):
        """Cleaned data dict (or other type). Set by `is_valid` method.
        """
        pass


# Don't use IValidator here. It's raise conflict of metaclasses
class Form(_Form):
    """Validator based on Django Forms.
    """

    def __init__(self, data, request=None, **kwargs):
        self.request = request
        data = safe_model_to_dict(data)
        super(Form, self).__init__(data=data, **kwargs)


class ModelForm(_ModelForm):
    """Validator based on Django Model Forms.
    """

    def __init__(self, data, request=None, **kwargs):
        self.request = request
        data = safe_model_to_dict(data)
        super(ModelForm, self).__init__(data=data, **kwargs)

    def save(self, *args, **kwargs):
        """All operations into validators must be idempotency.
        """
        raise NotImplementedError('Saving object from validator not allowed')


class Marshmallow(_MarshmallowSchema):
    """Validator based on marshmallow schema.
    """

    def __init__(self, data, request=None, **kwargs):
        self.request = request
        self.data = safe_model_to_dict(data)
        super(Marshmallow, self).__init__(**kwargs)

    def is_valid(self):
        self.cleaned_data, self.errors = self.load(self.data)
        return not self.errors


class WTForms(_WTForms):
    """Validator based on WTForms form.
    """

    def __init__(self, data, request=None, **kwargs):
        self.request = request
        # prevalidation uses MultiDict
        if hasattr(data, 'getlist'):
            super(WTForms, self).__init__(data, **kwargs)
        # if prevalidation try convert to MultiDict
        elif request:
            data = {k: (v if isinstance(v, (list, tuple)) else [v]) for k, v in data.items()}
            data = MultiDict(data)
            super(WTForms, self).__init__(data, **kwargs)
        # postvalidation
        else:
            data = safe_model_to_dict(data)
            super(WTForms, self).__init__(data=data, **kwargs)

    def is_valid(self):
        return self.validate()

    @property
    def cleaned_data(self):
        return self.data


class RESTFramework(_RESTFrameworkSerializer):
    """Validator based on Django REST Framework serializers.
    """

    def __init__(self, data, request=None, **kwargs):
        self.request = request
        data = safe_model_to_dict(data)
        super(RESTFramework, self).__init__(data=data, **kwargs)

    @property
    def cleaned_data(self):
        return self.validated_data