summaryrefslogtreecommitdiff
path: root/docs/ref/models
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2012-09-08 14:52:17 -0400
committerTim Graham <timograham@gmail.com>2012-09-08 14:52:17 -0400
commit6e2bb344e40dafdf462f6fb660837fa061faf549 (patch)
tree12be053b8c122e622622fad3fbeee89407ec42cb /docs/ref/models
parent20ee727ac9e0a374401473d90f055393944f197e (diff)
Fixed #18478 - Documented how to use a mutable default in a model field.
Diffstat (limited to 'docs/ref/models')
-rw-r--r--docs/ref/models/fields.txt8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt
index 190c0037ca..8b3c31f029 100644
--- a/docs/ref/models/fields.txt
+++ b/docs/ref/models/fields.txt
@@ -195,6 +195,14 @@ support tablespaces for indexes, this option is ignored.
The default value for the field. This can be a value or a callable object. If
callable it will be called every time a new object is created.
+The default cannot be a mutable object (model instance, list, set, etc.), as a
+reference to the same instance of that object would be used as the default
+value in all new model instances. Instead, wrap the desired default in a
+callable. For example, if you had a custom ``JSONField`` and wanted to specify
+a dictionary as the default, use a ``lambda`` as follows::
+
+ contact_info = JSONField("ContactInfo", default=lambda:{"email": "to1@example.com"})
+
``editable``
------------