Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 9d11e8a

Browse files
authored
Fix related resource on inherited polymorphic model (#767)
Fixes #621 When adding a ResourceRelatedField to a serializer that is included in the polymorphic_serializers list of a polymorphic serializer, the parent_model is not correctly resolved in get_related_resource_type: instead of resolving to the inherited type, the base type is resolved. This can cause an AttributeError if the field in question is not present on the base model. We ran into this, and then found the closed and seemingly abandoned issue referenced above. This PR implements the fix suggested by the original author, who deserves all the credit. The example code has been expanded to trigger the error when running the test-suite. Thanks in advance for your time and please let us know if you have any suggestions for improvement.
1 parent c8c5cf1 commit 9d11e8a

File tree

6 files changed

+47
-1
lines changed

6 files changed

+47
-1
lines changed

‎AUTHORS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,4 @@ Stas S. <stas@nerd.ro>
2727
Nathanael Gordon <nathanael.l.gordon@gmail.com>
2828
Charlie Allatson <charles.allatson@gmail.com>
2929
Joseba Mendivil <git@jma.email>
30+
Felix Viernickel <felix@gedankenspieler.org>

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ any parts of the framework not mentioned in the documentation should generally b
2121
* Ensure that `409 Conflict` is returned when processing a `PATCH` request in which the resource object’s type and id do not match the server’s endpoint properly as outlined in [JSON:API](https://jsonapi.org/format/#crud-updating-responses-409) spec.
2222
* Properly return parser error when primary data is of invalid type
2323
* Pass instance to child serializer when `PolymorphicModelSerializer` inits it in `to_internal_value`
24+
* Handle serialization of related resources on inherited polymorphic models that are absent on the base model
2425

2526
## [3.0.0] - 2019年10月14日
2627

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Generated by Django 3.0.3 on 2020年02月06日 10:24
2+
3+
from django.db import migrations, models
4+
import django.db.models.deletion
5+
6+
7+
class Migration(migrations.Migration):
8+
9+
dependencies = [
10+
('example', '0007_artproject_description'),
11+
]
12+
13+
operations = [
14+
migrations.CreateModel(
15+
name='LabResults',
16+
fields=[
17+
('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
18+
('date', models.DateField()),
19+
('measurements', models.TextField()),
20+
('research_project', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='lab_results', to='example.ResearchProject')),
21+
],
22+
),
23+
]

‎example/models.py‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,13 @@ class ResearchProject(Project):
151151
supervisor = models.CharField(max_length=30)
152152

153153

154+
class LabResults(models.Model):
155+
research_project = models.ForeignKey(
156+
ResearchProject, related_name='lab_results', on_delete=models.CASCADE)
157+
date = models.DateField()
158+
measurements = models.TextField()
159+
160+
154161
class Company(models.Model):
155162
name = models.CharField(max_length=100)
156163
current_project = models.ForeignKey(

‎example/serializers.py‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
Comment,
1616
Company,
1717
Entry,
18+
LabResults,
1819
Project,
1920
ProjectType,
2021
ResearchProject,
@@ -303,11 +304,20 @@ class Meta:
303304

304305

305306
class ResearchProjectSerializer(BaseProjectSerializer):
307+
# testing exclusive related field on inherited polymorphic model
308+
lab_results = relations.ResourceRelatedField(many=True, read_only=True)
309+
306310
class Meta:
307311
model = ResearchProject
308312
exclude = ('polymorphic_ctype',)
309313

310314

315+
class LabResultsSerializer(serializers.ModelSerializer):
316+
class Meta:
317+
model = LabResults
318+
fields = ('date', 'measurements')
319+
320+
311321
class ProjectSerializer(serializers.PolymorphicModelSerializer):
312322
included_serializers = {
313323
'project_type': ProjectTypeSerializer,

‎rest_framework_json_api/utils.py‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,7 @@ def format_resource_type(value, format_type=None, pluralize=None):
143143

144144

145145
def get_related_resource_type(relation):
146+
from rest_framework_json_api.serializers import PolymorphicModelSerializer
146147
try:
147148
return get_resource_type_from_serializer(relation)
148149
except AttributeError:
@@ -165,7 +166,10 @@ def get_related_resource_type(relation):
165166
else:
166167
parent_serializer = relation.parent
167168
parent_model = None
168-
if hasattr(parent_serializer, 'Meta'):
169+
if isinstance(parent_serializer, PolymorphicModelSerializer):
170+
parent_model = parent_serializer.get_polymorphic_serializer_for_instance(
171+
parent_serializer.instance).Meta.model
172+
elif hasattr(parent_serializer, 'Meta'):
169173
parent_model = getattr(parent_serializer.Meta, 'model', None)
170174
elif hasattr(parent_serializer, 'parent') and hasattr(parent_serializer.parent, 'Meta'):
171175
parent_model = getattr(parent_serializer.parent.Meta, 'model', None)

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /