-
-
Notifications
You must be signed in to change notification settings - Fork 7k
Raise error if fields
on serializer is not a list of strings.
#2213
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
from django.test import TestCase | ||
from rest_framework import serializers | ||
from .models import BasicModel | ||
|
||
|
||
class TestSerializerMetaClass(TestCase): | ||
def setUp(self): | ||
class FieldsSerializer(serializers.ModelSerializer): | ||
text = serializers.CharField() | ||
|
||
class Meta: | ||
model = BasicModel | ||
fields = ('text') | ||
|
||
class ExcludeSerializer(serializers.ModelSerializer): | ||
text = serializers.CharField() | ||
|
||
class Meta: | ||
model = BasicModel | ||
exclude = ('text') | ||
|
||
class FieldsAndExcludeSerializer(serializers.ModelSerializer): | ||
text = serializers.CharField() | ||
|
||
class Meta: | ||
model = BasicModel | ||
fields = ('text',) | ||
exclude = ('text',) | ||
|
||
self.fields_serializer = FieldsSerializer | ||
self.exclude_serializer = ExcludeSerializer | ||
self.faeSerializer = FieldsAndExcludeSerializer | ||
|
||
def test_meta_class_fields(self): | ||
object = BasicModel(text="Hello World.") | ||
serializer = self.fields_serializer(instance=object) | ||
|
||
with self.assertRaises(TypeError) as result: | ||
serializer.data | ||
|
||
exception = result.exception | ||
self.assertEqual(str(exception), "`fields` must be a list or tuple") | ||
|
||
def test_meta_class_exclude(self): | ||
object = BasicModel(text="Hello World.") | ||
serializer = self.exclude_serializer(instance=object) | ||
|
||
with self.assertRaises(TypeError) as result: | ||
serializer.data | ||
|
||
exception = result.exception | ||
self.assertEqual(str(exception), "`exclude` must be a list or tuple") | ||
|
||
def test_meta_class_fields_and_exclude(self): | ||
object = BasicModel(text="Hello World.") | ||
serializer = self.faeSerializer(instance=object) | ||
|
||
with self.assertRaises(AssertionError) as result: | ||
serializer.data | ||
|
||
exception = result.exception | ||
self.assertEqual(str(exception), "Cannot set both 'fields' and 'exclude'.") | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think I'd rather just see these in |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could do:
But I don't mind too much - will accept the pull request either way.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, sorry, I've not seen the message during the weekend.
should I create another pull request to adjust the error message?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@BrickXu If it's yet not fixed on master, I think it's safe to open another PR with those tweaks and also maybe this one as well https://github.com/tomchristie/django-rest-framework/pull/2213/files#r21361897