Commit a4262dd

authored

Added missing error message when no resource name is configured on serializer (#1020)

1 parent 3db6bce commit a4262ddCopy full SHA for a4262dd

File tree

+22

-1

lines changed

+22

-1

lines changed

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ Jamie Bliss <astronouth7303@gmail.com>`
`15`	`15`	`Jason Housley <housleyjk@gmail.com>`
`16`	`16`	`Jeppe Fihl-Pearson <jeppe@tenzer.dk>`
`17`	`17`	`Jerel Unruh <mail@unruhdesigns.com>`
	`18`	`+Jonas Kiefer <https://github.com/jokiefer>`
`18`	`19`	`Jonas Metzener <jonas.metzener@adfinis.com>`
`19`	`20`	`Jonathan Senecal <contact@jonathansenecal.com>`
`20`	`21`	`Joseba Mendivil <git@jma.email>`

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ any parts of the framework not mentioned in the documentation should generally b`
`22`	`22`	* Raise comprehensible error when reserved field names `meta` and `results` are used.
`23`	`23`	* Use `relationships` in the error object `pointer` when the field is actually a relationship.
`24`	`24`	`* Added missing inflection to the generated OpenAPI schema.`
	`25`	+* Added missing error message when `resource_name` is not properly configured.
`25`	`26`
`26`	`27`	`### Changed`
`27`	`28`

Lines changed: 4 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -320,7 +320,10 @@ def get_resource_type_from_serializer(serializer):`
`320`	`320`	`return meta.resource_name`
`321`	`321`	`elif hasattr(meta, "model"):`
`322`	`322`	`return get_resource_type_from_model(meta.model)`
`323`		`- raise AttributeError()`
	`323`	`+ raise AttributeError(`
	`324`	`+ f"can not detect 'resource_name' on serializer '{serializer.__class__.__name__}'"`
	`325`	`+ f" in module '{serializer.__class__.__module__}'"`
	`326`	`+ )`
`324`	`327`
`325`	`328`
`326`	`329`	`def get_included_resources(request, serializer=None):`

Lines changed: 16 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`import pytest`
`2`	`2`	`from django.db import models`
`3`	`3`	`from rest_framework import status`
	`4`	`+from rest_framework.fields import Field`
`4`	`5`	`from rest_framework.generics import GenericAPIView`
`5`	`6`	`from rest_framework.response import Response`
`6`	`7`	`from rest_framework.views import APIView`
`@@ -15,6 +16,7 @@`
`15`	`16`	`get_included_serializers,`
`16`	`17`	`get_related_resource_type,`
`17`	`18`	`get_resource_name,`
	`19`	`+ get_resource_type_from_serializer,`
`18`	`20`	`undo_format_field_name,`
`19`	`21`	`undo_format_field_names,`
`20`	`22`	`undo_format_link_segment,`
`@@ -377,3 +379,17 @@ class Meta:`
`377`	`379`	`}`
`378`	`380`
`379`	`381`	`assert included_serializers == expected_included_serializers`
	`382`	`+`
	`383`	`+`
	`384`	`+def test_get_resource_type_from_serializer_without_resource_name_raises_error():`
	`385`	`+ class SerializerWithoutResourceName(serializers.Serializer):`
	`386`	`+ something = Field()`
	`387`	`+`
	`388`	`+ serializer = SerializerWithoutResourceName()`
	`389`	`+`
	`390`	`+ with pytest.raises(AttributeError) as excinfo:`
	`391`	`+ get_resource_type_from_serializer(serializer=serializer)`
	`392`	`+ assert str(excinfo.value) == (`
	`393`	`+ "can not detect 'resource_name' on serializer "`
	`394`	`+ "'SerializerWithoutResourceName' in module 'tests.test_utils'"`
	`395`	`+ )`

Comments

(0)