mirror of
https://github.com/encode/django-rest-framework.git
synced 2024-11-25 19:14:01 +03:00
Added ListField
This commit is contained in:
parent
8b8623c5f8
commit
2e87de0143
|
@ -881,6 +881,44 @@ class ImageField(Field):
|
||||||
|
|
||||||
# Advanced field types...
|
# Advanced field types...
|
||||||
|
|
||||||
|
class ListField(Field):
|
||||||
|
child = None
|
||||||
|
initial = []
|
||||||
|
default_error_messages = {
|
||||||
|
'not_a_list': _('Expected a list of items but got type `{input_type}`')
|
||||||
|
}
|
||||||
|
|
||||||
|
def __init__(self, *args, **kwargs):
|
||||||
|
self.child = kwargs.pop('child', copy.deepcopy(self.child))
|
||||||
|
assert self.child is not None, '`child` is a required argument.'
|
||||||
|
assert not inspect.isclass(self.child), '`child` has not been instantiated.'
|
||||||
|
super(ListField, self).__init__(*args, **kwargs)
|
||||||
|
self.child.bind(field_name='', parent=self)
|
||||||
|
|
||||||
|
def get_value(self, dictionary):
|
||||||
|
# We override the default field access in order to support
|
||||||
|
# lists in HTML forms.
|
||||||
|
if html.is_html_input(dictionary):
|
||||||
|
return html.parse_html_list(dictionary, prefix=self.field_name)
|
||||||
|
return dictionary.get(self.field_name, empty)
|
||||||
|
|
||||||
|
def to_internal_value(self, data):
|
||||||
|
"""
|
||||||
|
List of dicts of native values <- List of dicts of primitive datatypes.
|
||||||
|
"""
|
||||||
|
if html.is_html_input(data):
|
||||||
|
data = html.parse_html_list(data)
|
||||||
|
if isinstance(data, type('')) or not hasattr(data, '__iter__'):
|
||||||
|
self.fail('not_a_list', input_type=type(data).__name__)
|
||||||
|
return [self.child.run_validation(item) for item in data]
|
||||||
|
|
||||||
|
def to_representation(self, data):
|
||||||
|
"""
|
||||||
|
List of object instances -> List of dicts of primitive datatypes.
|
||||||
|
"""
|
||||||
|
return [self.child.to_representation(item) for item in data]
|
||||||
|
|
||||||
|
|
||||||
class ReadOnlyField(Field):
|
class ReadOnlyField(Field):
|
||||||
"""
|
"""
|
||||||
A read-only field that simply returns the field value.
|
A read-only field that simply returns the field value.
|
||||||
|
|
|
@ -287,6 +287,9 @@ class Serializer(BaseSerializer):
|
||||||
return representation.serializer_repr(self, indent=1)
|
return representation.serializer_repr(self, indent=1)
|
||||||
|
|
||||||
|
|
||||||
|
# There's some replication of `ListField` here,
|
||||||
|
# but that's probably better than obfuscating the call hierarchy.
|
||||||
|
|
||||||
class ListSerializer(BaseSerializer):
|
class ListSerializer(BaseSerializer):
|
||||||
child = None
|
child = None
|
||||||
initial = []
|
initial = []
|
||||||
|
@ -301,7 +304,7 @@ class ListSerializer(BaseSerializer):
|
||||||
def get_value(self, dictionary):
|
def get_value(self, dictionary):
|
||||||
# We override the default field access in order to support
|
# We override the default field access in order to support
|
||||||
# lists in HTML forms.
|
# lists in HTML forms.
|
||||||
if is_html_input(dictionary):
|
if html.is_html_input(dictionary):
|
||||||
return html.parse_html_list(dictionary, prefix=self.field_name)
|
return html.parse_html_list(dictionary, prefix=self.field_name)
|
||||||
return dictionary.get(self.field_name, empty)
|
return dictionary.get(self.field_name, empty)
|
||||||
|
|
||||||
|
@ -311,7 +314,6 @@ class ListSerializer(BaseSerializer):
|
||||||
"""
|
"""
|
||||||
if html.is_html_input(data):
|
if html.is_html_input(data):
|
||||||
data = html.parse_html_list(data)
|
data = html.parse_html_list(data)
|
||||||
|
|
||||||
return [self.child.run_validation(item) for item in data]
|
return [self.child.run_validation(item) for item in data]
|
||||||
|
|
||||||
def to_representation(self, data):
|
def to_representation(self, data):
|
||||||
|
|
|
@ -849,6 +849,25 @@ class TestMultipleChoiceField(FieldValues):
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class TestListField(FieldValues):
|
||||||
|
"""
|
||||||
|
Values for `ListField`.
|
||||||
|
"""
|
||||||
|
valid_inputs = [
|
||||||
|
([1, 2, 3], [1, 2, 3]),
|
||||||
|
(['1', '2', '3'], [1, 2, 3])
|
||||||
|
]
|
||||||
|
invalid_inputs = [
|
||||||
|
('not a list', ['Expected a list of items but got type `str`']),
|
||||||
|
([1, 2, 'error'], ['A valid integer is required.'])
|
||||||
|
]
|
||||||
|
outputs = [
|
||||||
|
([1, 2, 3], [1, 2, 3]),
|
||||||
|
(['1', '2', '3'], [1, 2, 3])
|
||||||
|
]
|
||||||
|
field = fields.ListField(child=fields.IntegerField())
|
||||||
|
|
||||||
|
|
||||||
# Tests for SerializerMethodField.
|
# Tests for SerializerMethodField.
|
||||||
# --------------------------------
|
# --------------------------------
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user