Commit b72d45c9 authored by Arkadiusz Hiler's avatar Arkadiusz Hiler

PatchworkModelSerializer: Fix expanding related models

Newer versions of DRF no longer use get_related_field(), so the code
became dead and the breakage went unnoticed.

Let's fix that by simply overwriting the fields with appropriate
serializers when expanding is requested.

Also add a test that checks whether things actually get expanded.
Signed-off-by: Arkadiusz Hiler's avatarArkadiusz Hiler <>
parent e3d974a4
......@@ -25,13 +25,6 @@ from patchwork.models import (Project, Series, SeriesRevision, Patch, Person,
from rest_framework import serializers
from rest_framework import fields
from enum import Enum
class RelatedMode(Enum):
"""Select how to show related fields in the JSON responses."""
primary_key = 1
expand = 2
class Iso8601DateTimeField(fields.DateTimeField):
......@@ -60,38 +53,16 @@ class PatchworkModelSerializer(serializers.ModelSerializer):
def __init__(self, *args, **kwargs):
super(PatchworkModelSerializer, self).__init__(*args, **kwargs)
self._pw_related = RelatedMode.primary_key
related = None
if 'request' in self.context:
related = self.context['request'].query_params.get('related')
if not related:
self._pw_related = RelatedMode[related]
except KeyError:
def _pw_get_nested_field(self, model_field, related_model, to_many):
class NestedModelSerializer(serializers.ModelSerializer):
class Meta:
model = related_model
if in self.opts.expand_serializers:
serializer_class = self.opts.expand_serializers[]
return serializer_class(context=self.context, many=to_many)
return NestedModelSerializer(many=to_many)
def get_related_field(self, model_field, related_model, to_many):
if self._pw_related == RelatedMode.expand:
return self._pw_get_nested_field(model_field, related_model,
return super(PatchworkModelSerializer, self). \
get_related_field(model_field, related_model, to_many)
self._expand_related = (related == 'expand')
# See
if self._expand_related and self.Meta and self.Meta.expand_serializers:
# replace the default serialized with the expanding ones
for (field, serializer) in self.Meta.expand_serializers.items():
self.fields[field] = serializer()
class JSONField(serializers.Field):
......@@ -211,7 +182,7 @@ class RevisionSerializer(PatchworkModelSerializer):
def get_patches(self, revision):
queryset = revision.ordered_patches()
if self._pw_related == RelatedMode.expand:
if self._expand_related:
serializer = PatchSerializer(instance=queryset, many=True,
......@@ -343,6 +343,16 @@ class APITest(APITestBase):
params={'related': 'expand'})
def testRelatedExpand(self):
# using the related=expand parameter should expand submmitters
json = self.get_json('/projects/%(project_id)s/series/',
params={'related': 'expand'})
for result in json['results']:
submitter = result['submitter']
self.assertTrue('id' in submitter.keys())
self.assertTrue('name' in submitter.keys())
def testSeriesFilters(self):
filters = [
('submitted_since', '2015-06-01', self.n_series - 1),
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment