Source code for transmute_core.contenttype_serializers.interface

[docs]class ContentTypeSerializer(object): """ A ContentTypeSerializer handles the conversion from a python data structure to a bytes object representing the content in a particular content type. """
[docs] def content_type(self): """ return back what a list of content types this serializer should support. """ raise NotImplementedError() # noqa
[docs] def main_type(self): """ return back a single content type that represents this serializer. """ raise NotImplementedError() # noqa
[docs] def dump(data): """ should return back a bytes (or string in python 2), representation of your object, to be used in e.g. response bodies. a ValueError should be returned in the case where the object cannote be serialized. """ raise NotImplementedError() # noqa
[docs] def load(raw_bytes): """ given a bytes object, should return a base python data structure that represents the object. a ValueError should be returned in the case where the object cannot be serialized. """ raise NotImplementedError() # noqa
[docs] def can_handle(content_type_name): """ given a content type, returns true if this serializer can convert bodies of the given type. """ raise NotImplementedError() # noqa