def describe(self, **kwargs):
        """
        Describe this field instance for purpose of self-documentation.

        Args:
            kwargs (dict): dictionary of additional description items for
                extending default description

        Returns:
            dict: dictionary of description items

        Suggested way for overriding description fields or extending it with
        additional items is calling super class method with new/overriden
        fields passed as keyword arguments like following:

        .. code-block:: python

            class DummyField(BaseField):
               def description(self, **kwargs):
                   super().describe(is_dummy=True, **kwargs)

        """
        description = {
            'label': self.label,
            'details': inspect.cleandoc(self.details),
            'type': "list of {}".format(self.type) if self.many else self.type,
            'spec': self.spec,
            'read_only': self.read_only,
            'write_only': self.write_only,
            'allow_null': self.allow_null,
        }
        description.update(kwargs)
        return description
def describe ( self , ** kwargs ) : description = { 'label' : self . label , 'details' : inspect . cleandoc ( self . details ) , 'type' : "list of {}" . format ( self . type ) if self . many else self . type , 'spec' : self . spec , 'read_only' : self . read_only , 'write_only' : self . write_only , 'allow_null' : self . allow_null , } description . update ( kwargs ) return description
Describe this field instance for purpose of self-documentation.

        Args:
            kwargs (dict): dictionary of additional description items for
                extending default description

        Returns:
            dict: dictionary of description items

        Suggested way for overriding description fields or extending it with
        additional items is calling super class method with new/overriden
        fields passed as keyword arguments like following:

        .. code-block:: python

            class DummyField(BaseField):
               def description(self, **kwargs):
                   super().describe(is_dummy=True, **kwargs)