From b7ade645290ecf45530fe7211f8f759fc9cf9971 Mon Sep 17 00:00:00 2001 From: Claude Paroz Date: Sat, 26 Sep 2015 20:15:26 +0200 Subject: Fixed #25468 -- Made DjangoJSONEncoder lazy string aware Thanks Stavros Korokithakis for the report and Tim Graham for the review. --- docs/releases/1.10.txt | 6 ++++++ docs/topics/serialization.txt | 7 +++---- 2 files changed, 9 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/releases/1.10.txt b/docs/releases/1.10.txt index bd32f874d9..66d3828087 100644 --- a/docs/releases/1.10.txt +++ b/docs/releases/1.10.txt @@ -162,6 +162,12 @@ Requests and Responses * ... +Serialization +^^^^^^^^^^^^^ + +* The ``django.core.serializers.json.DjangoJSONEncoder`` now knows how to + serialize lazy strings, typically used for translatable content. + Signals ^^^^^^^ diff --git a/docs/topics/serialization.txt b/docs/topics/serialization.txt index e34553699d..2221463210 100644 --- a/docs/topics/serialization.txt +++ b/docs/topics/serialization.txt @@ -256,16 +256,15 @@ 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`. -In particular, :ref:`lazy translation objects ` need a -`special encoder`_ written for them. Something like this will work:: +For example, if you have some custom type in an object to be serialized, you'll +have to write a `special encoder`_ for it. Something like this will work:: - from django.utils.functional import Promise from django.utils.encoding import force_text from django.core.serializers.json import DjangoJSONEncoder class LazyEncoder(DjangoJSONEncoder): def default(self, obj): - if isinstance(obj, Promise): + if isinstance(obj, YourCustomType): return force_text(obj) return super(LazyEncoder, self).default(obj) -- cgit v1.3