p15693087
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fixed #14537 -- Added documentation on where validators can be imported from to Validators Reference docs, and improved Sphinx formatting and metadata. Thanks to rfugger for the report. 

git-svn-id: http://code.djangoproject.com/svn/django/trunk@14331 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Gabriel Hurley 2010-10-23 22:06:01 +00:00
parent e18f8b1d22
commit d371142001
2 changed files with 64 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

110
docs/ref/validators.txt
View File

@ -10,8 +10,9 @@ Writing validators
================== ==================
A validator is a callable that takes a value and raises a A validator is a callable that takes a value and raises a
``ValidationError`` if it doesn't meet some criteria. Validators can be useful :exc:`~django.core.exceptions.ValidationError` if it doesn't meet some
for re-using validation logic between different types of fields. criteria. Validators can be useful for re-using validation logic between
different types of fields.
For example, here's a validator that only allows even numbers:: For example, here's a validator that only allows even numbers::
@ -21,7 +22,7 @@ For example, here's a validator that only allows even numbers::
if value % 2 != 0: if value % 2 != 0:
raise ValidationError(u'%s is not an even number' % value) raise ValidationError(u'%s is not an even number' % value)
You can add this to a model field via the field's ``validators`` You can add this to a model field via the field's :attr:`~django.db.models.Field.validators`
argument:: argument::
from django.db import models from django.db import models
@ -44,109 +45,114 @@ See the :doc:`form validation </ref/forms/validation>` for more information on
how validators are run in forms, and :ref:`Validating objects how validators are run in forms, and :ref:`Validating objects
<validating-objects>` for how they're run in models. Note that validators will <validating-objects>` for how they're run in models. Note that validators will
not be run automatically when you save a model, but if you are using a not be run automatically when you save a model, but if you are using a
``ModelForm``, it will run your validators on any fields that are included in :class:`~django.forms.ModelForm`, it will run your validators on any fields
your form. See the :doc:`ModelForm documentation </topics/forms/modelforms>` that are included in your form. See the
for information on how model validation interacts with forms. :doc:`ModelForm documentation </topics/forms/modelforms>` for information on
how model validation interacts with forms.
Built-in validators Built-in validators
=================== ===================
Django has a collection of callable validators for use with model and form The :mod:`django.core.validators` module contains a collection of callable
fields. They're used internally but are available for use with your own fields, validators for use with model and form fields. They're used internally but
too. They can be used in addition to, or in lieu of custom ``field.clean()`` are available for use with your own fields, too. They can be used in addition
methods. to, or in lieu of custom ``field.clean()`` methods.
``RegexValidator`` ``RegexValidator``
------------------ ------------------
.. class:: RegexValidator(regex, [message=None, code=None])
.. class:: RegexValidator(regex, message=None, code=None) .. attribute:: regex
.. attribute:: regex The regular expression pattern to search for the provided ``value``,
or a pre-compiled regular expression. Raises a
:exc:`~django.core.exceptions.ValidationError` with :attr:`.message`
and :attr:`.code` if no match is found.
The regular expression pattern to search for the provided ``value``, .. attribute:: message
or a pre-compiled regular expression. Raises a ``ValidationError``
with ``message`` and ``code`` if no match is found.
.. attribute:: message=None The error message used by :exc:`~django.core.exceptions.ValidationError`
if validation fails. If no :attr:`.message` is specified, a generic
``"Enter a valid value"`` message is used. Default value: ``None``.
The error message used by ``ValidationError`` if validation fails. If no .. attribute:: code
``message`` is specified, a generic ``"Enter a valid value"`` message is used.
.. attribute:: code=None The error code used by :exc:`~django.core.exceptions.ValidationError`
if validation fails. If :attr:`.code` is not specified, ``"invalid"``
The error code used by ``ValidationError`` if validation fails. If ``code`` is used. Default value: ``None``.
is not specified, ``"invalid"`` is used.
``URLValidator`` ``URLValidator``
---------------- ----------------
.. class:: URLValidator([verify_exists=False, validator_user_agent=URL_VALIDATOR_USER_AGENT])
.. class:: URLValidator(verify_exists=False, validator_user_agent=URL_VALIDATOR_USER_AGENT) A :class:`RegexValidator` that ensures a value looks like a URL and
optionally verifies that the URL actually exists (i.e., doesn't return a
404 status code). Raises an error code of ``'invalid'`` if it doesn't look
like a URL, and a code of ``'invalid_link'`` if it doesn't exist.
A ``RegexValidator`` that ensures a value looks like a URL and optionally .. attribute:: verify_exists
verifies that the URL actually exists (i.e., doesn't return a 404 status code).
Raises an error code of ``'invalid'`` if it doesn't look like a URL, and a code
of ``'invalid_link'`` if it doesn't exist.
.. attribute:: verify_exists=False Default value: ``False``. If set to ``True``, this validator checks
that the URL actually exists.
If ``verify_exists`` is ``True``, this validator checks that the URL actually .. attribute:: validator_user_agent
exists.
.. attribute:: validator_user_agent=URL_VALIDATOR_USER_AGENT If :attr:`.verify_exists` is ``True``, Django uses the value of
:attr:`.validator_user_agent` as the "User-agent" for the request. This
If ``verify_exists`` is ``True``, it uses ``validator_user_agent`` as the "User-agent" defaults to :setting:`settings.URL_VALIDATOR_USER_AGENT <URL_VALIDATOR_USER_AGENT>`.
for the request. This defaults to ``settings.URL_VALIDATOR_USER_AGENT``.
``validate_email`` ``validate_email``
------------------ ------------------
.. data:: validate_email
A ``RegexValidator`` instance that ensures a value looks like an e-mail address. A :class:`RegexValidator` instance that ensures a value looks like an
e-mail address.
``validate_slug`` ``validate_slug``
----------------- -----------------
.. data:: validate_slug
A ``RegexValidator`` instance that ensures a value consists of only letters, A :class:`RegexValidator` instance that ensures a value consists of only
numbers, underscores or hyphens. letters, numbers, underscores or hyphens.
``validate_ipv4_address`` ``validate_ipv4_address``
------------------------- -------------------------
.. data:: validate_ipv4_address
A ``RegexValidator`` instance that ensures a value looks like an IPv4 address. A :class:`RegexValidator` instance that ensures a value looks like an IPv4
address.
``validate_comma_separated_integer_list`` ``validate_comma_separated_integer_list``
----------------------------------------- -----------------------------------------
.. data:: validate_comma_separated_integer_list
A ``RegexValidator`` instance that ensures a value is a comma-separated list A :class:`RegexValidator` instance that ensures a value is a
of integers. comma-separated list of integers.
``MaxValueValidator`` ``MaxValueValidator``
--------------------- ---------------------
.. class:: MaxValueValidator(max_value) .. class:: MaxValueValidator(max_value)
Raises a ``ValidationError`` with a code of ``'max_value'`` if ``value`` is Raises a :exc:`~django.core.exceptions.ValidationError` with a code of
greater than ``max_value``. ``'max_value'`` if ``value`` is greater than ``max_value``.
``MinValueValidator`` ``MinValueValidator``
--------------------- ---------------------
.. class:: MinValueValidator(min_value) .. class:: MinValueValidator(min_value)
Raises a ``ValidationError`` with a code of ``'min_value'`` if ``value`` is Raises a :exc:`~django.core.exceptions.ValidationError` with a code of
less than ``min_value``. ``'min_value'`` if ``value`` is less than ``min_value``.
``MaxLengthValidator`` ``MaxLengthValidator``
---------------------- ----------------------
.. class:: MaxLengthValidator(max_length) .. class:: MaxLengthValidator(max_length)
Raises a ``ValidationError`` with a code of ``'max_length'`` if the length of Raises a :exc:`~django.core.exceptions.ValidationError` with a code of
``value`` is greater than ``max_length``. ``'max_length'`` if the length of ``value`` is greater than ``max_length``.
``MinLengthValidator`` ``MinLengthValidator``
---------------------- ----------------------
.. class:: MinLengthValidator(min_length) .. class:: MinLengthValidator(min_length)
Raises a ``ValidationError`` with a code of ``'min_length'`` if the length of Raises a :exc:`~django.core.exceptions.ValidationError` with a code of
``value`` is less than ``min_length``. ``'min_length'`` if the length of ``value`` is less than ``min_length``.

6
docs/topics/forms/modelforms.txt
View File

@ -2,8 +2,14 @@
Creating forms from models Creating forms from models
========================== ==========================
.. module:: django.forms.models
:synopsis: ModelForm and ModelFormset.
.. currentmodule:: django.forms
``ModelForm`` ``ModelForm``
============= =============
.. class:: ModelForm
If you're building a database-driven app, chances are you'll have forms that If you're building a database-driven app, chances are you'll have forms that
map closely to Django models. For instance, you might have a ``BlogComment`` map closely to Django models. For instance, you might have a ``BlogComment``