mirror of
https://github.com/encode/django-rest-framework.git
synced 2025-02-16 19:41:06 +03:00
Add max_length and min_length arguments for ListField (#4877)
This commit is contained in:
parent
79f431c44a
commit
cbad236f6d
|
@ -434,9 +434,11 @@ Requires either the `Pillow` package or `PIL` package. The `Pillow` package is
|
||||||
|
|
||||||
A field class that validates a list of objects.
|
A field class that validates a list of objects.
|
||||||
|
|
||||||
**Signature**: `ListField(child)`
|
**Signature**: `ListField(child, min_length=None, max_length=None)`
|
||||||
|
|
||||||
- `child` - A field instance that should be used for validating the objects in the list. If this argument is not provided then objects in the list will not be validated.
|
- `child` - A field instance that should be used for validating the objects in the list. If this argument is not provided then objects in the list will not be validated.
|
||||||
|
- `min_length` - Validates that the list contains no fewer than this number of elements.
|
||||||
|
- `max_length` - Validates that the list contains no more than this number of elements.
|
||||||
|
|
||||||
For example, to validate a list of integers you might use something like the following:
|
For example, to validate a list of integers you might use something like the following:
|
||||||
|
|
||||||
|
|
|
@ -1505,12 +1505,16 @@ class ListField(Field):
|
||||||
initial = []
|
initial = []
|
||||||
default_error_messages = {
|
default_error_messages = {
|
||||||
'not_a_list': _('Expected a list of items but got type "{input_type}".'),
|
'not_a_list': _('Expected a list of items but got type "{input_type}".'),
|
||||||
'empty': _('This list may not be empty.')
|
'empty': _('This list may not be empty.'),
|
||||||
|
'min_length': _('Ensure this field has at least {min_length} elements.'),
|
||||||
|
'max_length': _('Ensure this field has no more than {max_length} elements.')
|
||||||
}
|
}
|
||||||
|
|
||||||
def __init__(self, *args, **kwargs):
|
def __init__(self, *args, **kwargs):
|
||||||
self.child = kwargs.pop('child', copy.deepcopy(self.child))
|
self.child = kwargs.pop('child', copy.deepcopy(self.child))
|
||||||
self.allow_empty = kwargs.pop('allow_empty', True)
|
self.allow_empty = kwargs.pop('allow_empty', True)
|
||||||
|
self.max_length = kwargs.pop('max_length', None)
|
||||||
|
self.min_length = kwargs.pop('min_length', None)
|
||||||
|
|
||||||
assert not inspect.isclass(self.child), '`child` has not been instantiated.'
|
assert not inspect.isclass(self.child), '`child` has not been instantiated.'
|
||||||
assert self.child.source is None, (
|
assert self.child.source is None, (
|
||||||
|
@ -1520,6 +1524,12 @@ class ListField(Field):
|
||||||
|
|
||||||
super(ListField, self).__init__(*args, **kwargs)
|
super(ListField, self).__init__(*args, **kwargs)
|
||||||
self.child.bind(field_name='', parent=self)
|
self.child.bind(field_name='', parent=self)
|
||||||
|
if self.max_length is not None:
|
||||||
|
message = self.error_messages['max_length'].format(max_length=self.max_length)
|
||||||
|
self.validators.append(MaxLengthValidator(self.max_length, message=message))
|
||||||
|
if self.min_length is not None:
|
||||||
|
message = self.error_messages['min_length'].format(min_length=self.min_length)
|
||||||
|
self.validators.append(MinLengthValidator(self.min_length, message=message))
|
||||||
|
|
||||||
def get_value(self, dictionary):
|
def get_value(self, dictionary):
|
||||||
if self.field_name not in dictionary:
|
if self.field_name not in dictionary:
|
||||||
|
|
|
@ -1668,6 +1668,16 @@ class TestEmptyListField(FieldValues):
|
||||||
field = serializers.ListField(child=serializers.IntegerField(), allow_empty=False)
|
field = serializers.ListField(child=serializers.IntegerField(), allow_empty=False)
|
||||||
|
|
||||||
|
|
||||||
|
class TestListFieldLengthLimit(FieldValues):
|
||||||
|
valid_inputs = ()
|
||||||
|
invalid_inputs = [
|
||||||
|
((0, 1), ['Ensure this field has at least 3 elements.']),
|
||||||
|
((0, 1, 2, 3, 4, 5), ['Ensure this field has no more than 4 elements.']),
|
||||||
|
]
|
||||||
|
outputs = ()
|
||||||
|
field = serializers.ListField(child=serializers.IntegerField(), min_length=3, max_length=4)
|
||||||
|
|
||||||
|
|
||||||
class TestUnvalidatedListField(FieldValues):
|
class TestUnvalidatedListField(FieldValues):
|
||||||
"""
|
"""
|
||||||
Values for `ListField` with no `child` argument.
|
Values for `ListField` with no `child` argument.
|
||||||
|
|
Loading…
Reference in New Issue
Block a user