Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Non-Model Serializer #115

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Non-Model Serializer #115

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5fea149
When I separated the methods of the `HalModelSerializer` into a class…
claytondaley Jan 31, 2020
07e6e9e
Update drf_hal_json/serializers.py
ambsw-technology Feb 27, 2020
895a94d
Combine Imports
ambsw-technology Feb 27, 2020
1ebd9e2
Had to fix other references to HalSerialzer[Mixin]
ambsw-technology Feb 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 18 additions & 12 deletions drf_hal_json/serializers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
from drf_hal_json.fields import HalContributeToLinkField, HalHyperlinkedIdentityField, HalIncludeInLinksMixin
from rest_framework.fields import empty
from rest_framework.relations import HyperlinkedRelatedField, ManyRelatedField
from rest_framework.serializers import BaseSerializer, HyperlinkedModelSerializer, ListSerializer
from rest_framework.serializers import BaseSerializer, HyperlinkedModelSerializer, ListSerializer, Serializer
from rest_framework.utils.field_mapping import get_nested_relation_kwargs
from rest_framework.utils.serializer_helpers import ReturnDict

Expand All @@ -30,16 +30,12 @@ def data(self):
)


class HalModelSerializer(HyperlinkedModelSerializer):
"""
Serializer for HAL representation of django models
"""
serializer_related_field = HyperlinkedRelatedField
serializer_url_field = HalHyperlinkedIdentityField
class HalSerializer(Serializer):

default_list_serializer = HalListSerializer

def __init__(self, instance=None, data=empty, **kwargs):
super(HalModelSerializer, self).__init__(instance, data, **kwargs)
super(HalSerializer, self).__init__(instance, data, **kwargs)
self.nested_serializer_class = self.__class__
if data != empty and not LINKS_FIELD_NAME in data:
data[LINKS_FIELD_NAME] = dict() # put links in data, so that field validation does not fail
Expand All @@ -56,7 +52,7 @@ class Meta:
list_serializer_class = getattr(meta, 'list_serializer_class', None)
if list_serializer_class is None:
setattr(meta, 'list_serializer_class', cls.default_list_serializer)
return super(HalModelSerializer, cls).many_init(*args, **kwargs)
return super(HalSerializer, cls).many_init(*args, **kwargs)

def build_link_object(self, val):
if (type([]) == type(val)):
Expand All @@ -72,7 +68,7 @@ def _get_url(self, item):
return None

def to_representation(self, instance):
ret = super(HalModelSerializer, self).to_representation(instance)
ret = super(HalSerializer, self).to_representation(instance)
resp = defaultdict(dict)

for field_name in self.link_field_names:
Expand All @@ -87,6 +83,8 @@ def to_representation(self, instance):
for field_name in self.embedded_field_names:
# if a related resource is embedded, it should still
# get a link in the parent object
if field_name not in ret:
continue
if type(ret[field_name]) == list:
embed_self = list(filter(lambda x: x is not None, [self._get_url(x) for x in ret[field_name] if x]))
else:
Expand All @@ -99,7 +97,7 @@ def to_representation(self, instance):
return resp

def get_fields(self):
fields = super(HalModelSerializer, self).get_fields()
fields = super(HalSerializer, self).get_fields()

self.embedded_field_names = []
self.link_field_names = []
Expand Down Expand Up @@ -133,7 +131,7 @@ def build_nested_field(self, field_name, relation_info, nested_depth):
"""
Create nested fields for forward and reverse relationships.
"""
class NestedSerializer(HalModelSerializer):
class NestedSerializer(HalSerializer):
class Meta:
model = relation_info.related_model
depth = nested_depth - 1
Expand All @@ -143,3 +141,11 @@ class Meta:
field_kwargs = get_nested_relation_kwargs(relation_info)

return field_class, field_kwargs


class HalModelSerializer(HalSerializer, HyperlinkedModelSerializer):
"""
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

undefined name 'HalSerializerMixin'

Serializer for HAL representation of django models
"""
serializer_related_field = HyperlinkedRelatedField
serializer_url_field = HalHyperlinkedIdentityField