summaryrefslogtreecommitdiff
path: root/docs/ref/validators.txt
diff options
context:
space:
mode:
authorBerker Peksag <berker.peksag@gmail.com>2016-03-26 22:09:08 +0200
committerTim Graham <timograham@gmail.com>2016-06-30 09:08:50 -0400
commit12b4280444b58c94197255655e284e4103fe00a9 (patch)
tree26640543f44e65800ae0fbb59004e9e7907bdf73 /docs/ref/validators.txt
parentc9d0a0f7f47c8496a9d8b0cfda94e2ef118d9ab3 (diff)
Fixed #21548 -- Added FileExtensionValidator and validate_image_file_extension.
Diffstat (limited to 'docs/ref/validators.txt')
-rw-r--r--docs/ref/validators.txt27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/ref/validators.txt b/docs/ref/validators.txt
index 7c82f21605..417df517a4 100644
--- a/docs/ref/validators.txt
+++ b/docs/ref/validators.txt
@@ -279,3 +279,30 @@ to, or in lieu of custom ``field.clean()`` methods.
``decimal_places``.
- ``'max_whole_digits'`` if the number of whole digits is larger than
the difference between ``max_digits`` and ``decimal_places``.
+
+``FileExtensionValidator``
+--------------------------
+
+.. class:: FileExtensionValidator(allowed_extensions, message, code)
+
+ .. versionadded:: 1.11
+
+ Raises a :exc:`~django.core.exceptions.ValidationError` with a code of
+ ``'invalid_extension'`` if the ``value`` cannot be found in
+ ``allowed_extensions``.
+
+ .. warning::
+
+ Don't rely on validation of the file extension to determine a file's
+ type. Files can be renamed to have any extension no matter what data
+ they contain.
+
+``validate_image_file_extension``
+---------------------------------
+
+.. data:: validate_image_file_extension
+
+ .. versionadded:: 1.11
+
+ Uses Pillow to ensure that the ``value`` is `a valid image extension
+ <https://pillow.readthedocs.org/en/latest/handbook/image-file-formats.html>`_.