Source code for pynami.schemas.default

# -*- coding: utf-8 -*-
"""
Schema for default values
"""
from marshmallow import fields

from .base import BaseSearchSchema, BaseSearchModel


class Baseadmin(BaseSearchModel):
    """
    Base data class for all default values and their id mapping.

    This class is intended to be instantiated by calling the
    :meth:`~marshmallow.Schema.load` method on a corresponding data dictionary.
    """
    _tabkeys = ['type', 'descriptor', 'id']

    def __str__(self):
        return f'{self.type}: {self.descriptor} ({self.id})'


class BaseadminSchema(BaseSearchSchema):
    """
    Schema class for the :class:`Baseadmin` class

    All the default values only consist of the same four attributes
    """
    __model__ = Baseadmin

    name = fields.String()
    """str: Name of this value. This will be empty in many cases."""