Kaydet (Commit) 2e4200b5 authored tarafından Loic Bistuer's avatar Loic Bistuer Kaydeden (comit) Tim Graham

Fixed #21654 -- Documented a use-case for Form.errors.as_data().

Thanks selwin for the suggestion.
üst 007c5cd3
...@@ -128,6 +128,20 @@ instances. ...@@ -128,6 +128,20 @@ instances.
{'sender': [ValidationError(['Enter a valid email address.'])], {'sender': [ValidationError(['Enter a valid email address.'])],
'subject': [ValidationError(['This field is required.'])]} 'subject': [ValidationError(['This field is required.'])]}
Use this method anytime you need to identify an error by its ``code``. This
enables things like rewriting the error's message or writing custom logic in a
view when a given error is present. It can also be used to serialize the errors
in a custom format (e.g. XML); for instance, :meth:`~Form.errors.as_json()`
relies on ``as_data()``.
The need for the ``as_data()`` method is due to backwards compatibility.
Previously ``ValidationError`` instances were lost as soon as their
**rendered** error messages were added to the ``Form.errors`` dictionary.
Ideally ``Form.errors`` would have stored ``ValidationError`` instances
and methods with an ``as_`` prefix could render them, but it had to be done
the other way around in order not to break code that expects rendered error
messages in ``Form.errors``.
.. method:: Form.errors.as_json() .. method:: Form.errors.as_json()
.. versionadded:: 1.7 .. versionadded:: 1.7
......
...@@ -179,6 +179,13 @@ to override your error message you can still opt for the less verbose:: ...@@ -179,6 +179,13 @@ to override your error message you can still opt for the less verbose::
ValidationError(_('Invalid value: %s') % value) ValidationError(_('Invalid value: %s') % value)
.. versionadded:: 1.7
The :meth:`Form.errors.as_data() <django.forms.Form.errors.as_data()>` and
:meth:`Form.errors.as_json() <django.forms.Form.errors.as_json()>` methods
greatly benefit from fully featured ``ValidationError``\s (with a ``code`` name
and a ``params`` dictionary).
Raising multiple errors Raising multiple errors
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment