summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTommy Beadle <tbeadle@gmail.com>2016-06-03 14:33:19 -0400
committerTim Graham <timograham@gmail.com>2016-06-07 14:53:19 -0400
commit729b9452b19b031d3817821128a115d5b2d5caed (patch)
tree0df01cf87b77461a406c72456833367f71237051 /docs
parentbe729b6120a50fff28195c28896c83a9b1e0c355 (diff)
Fixed #26704 -- Documented DjangoJSONEncoder.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/request-response.txt2
-rw-r--r--docs/topics/serialization.txt28
2 files changed, 26 insertions, 4 deletions
diff --git a/docs/ref/request-response.txt b/docs/ref/request-response.txt
index e58e7b6d22..3ed4e98a35 100644
--- a/docs/ref/request-response.txt
+++ b/docs/ref/request-response.txt
@@ -946,7 +946,7 @@ types of HTTP responses. Like ``HttpResponse``, these subclasses live in
JSON-serializable object.
The ``encoder``, which defaults to
- ``django.core.serializers.json.DjangoJSONEncoder``, will be used to
+ :class:`django.core.serializers.json.DjangoJSONEncoder`, will be used to
serialize the data. See :ref:`JSON serialization
<serialization-formats-json>` for more details about this serializer.
diff --git a/docs/topics/serialization.txt b/docs/topics/serialization.txt
index 220abcd095..fa5b6b33ea 100644
--- a/docs/topics/serialization.txt
+++ b/docs/topics/serialization.txt
@@ -251,9 +251,6 @@ Foreign keys just have the PK of the linked object as property value.
ManyToMany-relations are serialized for the model that defines them and are
represented as a list of PKs.
-Date and datetime related types are treated in a special way by the JSON
-serializer to make the format compatible with `ECMA-262`_.
-
Be aware that not all Django output can be passed unmodified to :mod:`json`.
For example, if you have some custom type in an object to be serialized, you'll
have to write a custom :mod:`json` encoder for it. Something like this will
@@ -271,6 +268,31 @@ work::
Also note that GeoDjango provides a :doc:`customized GeoJSON serializer
</ref/contrib/gis/serializers>`.
+``DjangoJSONEncoder``
+~~~~~~~~~~~~~~~~~~~~~
+
+.. class:: django.core.serializers.json.DjangoJSONEncoder
+
+The JSON serializer uses ``DjangoJSONEncoder`` for encoding. A subclass of
+:class:`~json.JSONEncoder`, it handles these additional types:
+
+:class:`~datetime.datetime`
+ A string of the form ``YYYY-MM-DDTHH:mm:ss.sssZ`` or
+ ``YYYY-MM-DDTHH:mm:ss.sss+HH:MM`` as defined in `ECMA-262`_.
+
+:class:`~datetime.date`
+ A string of the form ``YYYY-MM-DD`` as defined in `ECMA-262`_.
+
+:class:`~datetime.time`
+ A string of the form ``HH:MM:ss.sss`` as defined in `ECMA-262`_.
+
+:class:`~decimal.Decimal`, ``Promise`` (``django.utils.functional.lazy()`` objects), :class:`~uuid.UUID`
+ A string representation of the object.
+
+.. versionchanged:: 1.10
+
+ Support for ``Promise`` was added.
+
.. _ecma-262: http://www.ecma-international.org/ecma-262/5.1/#sec-15.9.1.15
YAML