Validator documentation and tweaks

docs/api-guide/validators.md

@@ -0,0 +1,183 @@
+<a class="github" href="validators.py"></a>
+
+# Validators
+
+> Validators can be useful for re-using validation logic between different types of fields.
+>
+> &mdash; [Django documentation][cite]
+
+Most of the time you're dealing with validation in REST framework you'll simply be relying on the default field validation, or writing explicit validation methods on serializer or field classes.
+
+Sometimes you'll want to place your validation logic into reusable components, so that it can easily be reused throughout your codebase. This can be achieved by using validator functions and validator classes.
+
+## Validation in REST framework
+
+Validation in Django REST framework serializers is handled a little differently to how validation works in Django's `ModelForm` class.
+
+With `ModelForm` the validation is performed partially on the form, and partially on the model instance. With REST framework the validation is performed entirely on the serializer class. This is advantageous for the following reasons:
+
+* It introduces a proper separation of concerns, making your code behaviour more obvious.
+* It is easy to switch between using shortcut `ModelSerializer` classes and using  explicit `Serializer` classes. Any validation behaviour being used for `ModelSerializer` is simple to replicate.
+* Printing the `repr` of a serializer instance will show you exactly what validation rules it applies. There's no extra hidden validation behaviour being called on the model instance.
+
+When you're using `ModelSerializer` all of this is handled automatically for you. If you want to drop down to using a `Serializer` classes instead, then you need to define the validation rules explicitly.
+
+#### Example
+
+As an example of how REST framework uses explicit validation, we'll take a simple model class that has a field with a uniqueness constraint.
+
+    class CustomerReportRecord(models.Model):
+        time_raised = models.DateTimeField(default=timezone.now, editable=False) 
+        reference = models.CharField(unique=True, max_length=20)
+        description = models.TextField()
+
+Here's a basic `ModelSerializer` that we can use for creating or updating instances of `CustomerReportRecord`:
+
+    class CustomerReportSerializer(serializers.ModelSerializer):
+        class Meta:
+            model = CustomerReportRecord
+
+If we open up the Django shell using `manage.py shell` we can now 
+
+    >>> from project.example.serializers import CustomerReportSerializer
+    >>> serializer = CustomerReportSerializer()
+    >>> print(repr(serializer))
+    CustomerReportSerializer():
+        id = IntegerField(label='ID', read_only=True)
+        time_raised = DateTimeField(read_only=True)
+        reference = CharField(max_length=20, validators=[<UniqueValidator(queryset=CustomerReportRecord.objects.all())>])
+        description = CharField(style={'type': 'textarea'})
+
+The interesting bit here is the `reference` field. We can see that the uniqueness constraint is being explicitly enforced by a validator on the serializer field.
+
+Because of this more explicit style REST framework includes a few validator classes that are not available in core Django. These classes are detailed below.
+
+---
+
+## UniqueValidator
+
+This validator can be used to enforce the `unique=True` constraint on model fields.
+It takes a single required argument, and an optional `messages` argument:
+
+* `queryset` *required* - This is the queryset against which uniqueness should be enforced.
+* `message` - The error message that should be used when validation fails.
+
+This validator should be applied to *serializer fields*, like so:
+
+    slug = SlugField(
+        max_length=100,
+        validators=[UniqueValidator(queryset=BlogPost.objects.all())]
+    )
+
+## UniqueTogetherValidator
+
+This validator can be used to enforce `unique_together` constraints on model instances.
+It has two required arguments, and a single optional `messages` argument:
+
+* `queryset` *required* - This is the queryset against which uniqueness should be enforced.
+* `fields` *required* - A list or tuple of field names which should make a unique set. These must exist as fields on the serializer class.
+* `message` - The error message that should be used when validation fails.
+
+The validator should be applied to *serializer classes*, like so:
+
+    class ExampleSerializer(serializers.Serializer):
+        # ...
+        class Meta:
+            # ToDo items belong to a parent list, and have an ordering defined
+            # by the 'position' field. No two items in a given list may share
+            # the same position.
+            validators = [
+                UniqueTogetherValidator(
+                    queryset=ToDoItem.objects.all(),
+                    fields=('list', 'position')
+                )
+            ]
+
+## UniqueForDateValidator
+
+## UniqueForMonthValidator
+
+## UniqueForYearValidator
+
+These validators can be used to enforce the `unique_for_date`, `unique_for_month` and `unique_for_year` constraints on model instances. They take the following arguments:
+
+* `queryset` *required* - This is the queryset against which uniqueness should be enforced.
+* `field` *required* - A field name against which uniqueness in the given date range will be validated. This must exist as a field on the serializer class.
+* `date_field` *required* - A field name which will be used to determine date range for the uniqueness constrain. This must exist as a field on the serializer class.
+* `message` - The error message that should be used when validation fails.
+
+The validator should be applied to *serializer classes*, like so:
+
+    class ExampleSerializer(serializers.Serializer):
+        # ...
+        class Meta:
+            # Blog posts should have a slug that is unique for the current year.
+            validators = [
+                UniqueForYearValidator(
+                    queryset=BlogPostItem.objects.all(),
+                    field='slug',
+                    date_field='published'
+                )
+            ]
+
+The date field that is used for the validation is always required to be present on the serializer class. You can't simply rely on a model class `default=...`, because the value being used for the default wouldn't be generated until after the validation has run.
+
+There are a couple of styles you may want to use for this depending on how you want your API to behave. If you're using `ModelSerializer` you'll probably simply rely on the defaults that REST framework generates for you, but if you are using `Serializer` or simply want more explicit control, use on of the styles demonstrated below.
+
+#### Using with a writable date field.
+
+If you want the date field to be writable the only thing worth noting is that you should ensure that it is always available in the input data, either by setting a `default` argument, or by setting `required=True`.
+
+    published = serializers.DateTimeField(required=True)
+
+#### Using with a read-only date field.
+
+If you want the date field to be visible, but not editable by the user, then set `read_only=True` and additionally set a `default=...` argument.
+
+    published = serializers.DateTimeField(read_only=True, default=timezone.now)
+
+The field will not be writable to the user, but the default value will still be passed through to the `validated_data`.
+
+#### Using with a hidden date field.
+
+If you want the date field to be entirely hidden from the user, then use `HiddenField`. This field type does not accept user input, but instead always returns it's default value to the `validated_data` in the serializer.
+
+    published = serializers.HiddenField(default=timezone.now)
+
+---
+
+# Writing custom validators
+
+You can use any of Django's existing validators, or write your own custom validators.
+
+## Function based
+
+A validator may be any callable that raises a `serializers.ValidationError` on failure.
+
+    def even_number(value):
+        if value % 2 != 0:
+            raise serializers.ValidationError('This field must be an even number.') 
+
+## Class based
+
+To write a class based validator, use the `__call__` method. Class based validators are useful as they allow you to parameterize and reuse behavior.
+
+    class MultipleOf:
+        def __init__(self, base):
+            self.base = base
+
+        def __call__(self, value):
+            if value % self.base != 0
+                message = 'This field must be a multiple of %d.' % self.base
+                raise serializers.ValidationError(message)
+
+#### Using `set_context()`
+
+In some advanced cases you might want a validator to be passed the serializer field it is being used with as additional context. You can do so by declaring a `set_context` method on a class based validator.
+
+    def set_context(self, serializer_field):
+        # Determine if this is an update or a create operation.
+        # In `__call__` we can then use that information to modify the validation behavior.
+        self.is_update = serializer_field.parent.instance is not None
+
+[cite]: https://docs.djangoproject.com/en/dev/ref/validators/

docs/index.md

@@ -173,6 +173,7 @@ The API guide is your complete reference manual to all the functionality provide
 * [Serializers][serializers]
 * [Serializer fields][fields]
 * [Serializer relations][relations]
+* [Validation][validation]
 * [Authentication][authentication]
 * [Permissions][permissions]
 * [Throttling][throttling]
@@ -294,6 +295,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 [serializers]: api-guide/serializers.md
 [fields]: api-guide/fields.md
 [relations]: api-guide/relations.md
+[validation]: api-guide/validation.md
 [authentication]: api-guide/authentication.md
 [permissions]: api-guide/permissions.md
 [throttling]: api-guide/throttling.md

docs/template.html

@@ -95,6 +95,7 @@
                   <li><a href="{{ base_url }}/api-guide/serializers{{ suffix }}">Serializers</a></li>
                   <li><a href="{{ base_url }}/api-guide/fields{{ suffix }}">Serializer fields</a></li>
                   <li><a href="{{ base_url }}/api-guide/relations{{ suffix }}">Serializer relations</a></li>
+                  <li><a href="{{ base_url }}/api-guide/validation{{ suffix }}">Validation</a></li>
                   <li><a href="{{ base_url }}/api-guide/authentication{{ suffix }}">Authentication</a></li>
                   <li><a href="{{ base_url }}/api-guide/permissions{{ suffix }}">Permissions</a></li>
                   <li><a href="{{ base_url }}/api-guide/throttling{{ suffix }}">Throttling</a></li>

mkdocs.py

@@ -59,6 +59,7 @@
     'api-guide/serializers.md',
     'api-guide/fields.md',
     'api-guide/relations.md',
+    'api-guide/validation.md',
     'api-guide/authentication.md',
     'api-guide/permissions.md',
     'api-guide/throttling.md',

rest_framework/serializers.py

@@ -292,6 +292,8 @@ def __init__(self, *args, **kwargs):
         for key, value in self._get_base_fields().items():
             self.fields[key] = value
 
+        self.validators = getattr(getattr(self, 'Meta', None), 'validators', [])
+
     def _get_base_fields(self):
         return copy.deepcopy(self._declared_fields)
 

rest_framework/validators.py

@@ -19,9 +19,10 @@ class UniqueValidator:
     """
     message = _('This field must be unique.')
 
-    def __init__(self, queryset):
+    def __init__(self, queryset, message=None):
         self.queryset = queryset
         self.serializer_field = None
+        self.message = message or self.message
 
     def set_context(self, serializer_field):
         # Determine the underlying model field name. This may not be the
@@ -54,10 +55,11 @@ class UniqueTogetherValidator:
     """
     message = _('The fields {field_names} must make a unique set.')
 
-    def __init__(self, queryset, fields):
+    def __init__(self, queryset, fields, message=None):
         self.queryset = queryset
         self.fields = fields
         self.serializer_field = None
+        self.message = message or self.message
 
     def set_context(self, serializer):
         # Determine the existing instance, if this is an update operation.
@@ -86,10 +88,11 @@ def __repr__(self):
 class BaseUniqueForValidator:
     message = None
 
-    def __init__(self, queryset, field, date_field):
+    def __init__(self, queryset, field, date_field, message=None):
         self.queryset = queryset
         self.field = field
         self.date_field = date_field
+        self.message = message or self.message
 
     def set_context(self, serializer):
         # Determine the underlying model field names. These may not be the