summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorJon Dufresne <jon.dufresne@gmail.com>2019-07-23 05:04:06 -0700
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2019-07-25 08:15:20 +0200
commit5ed20b3aa3536539b9bc1cb5b40e84e3147a2228 (patch)
tree559c955e75e0e30c992eb5836b9eb9aea4b8fed8 /docs/ref
parent93ffa81bc59ff13c1a5c07f5bd22d003756e1da5 (diff)
Fixed #30657 -- Allowed customizing Field's descriptors with a descriptor_class attribute.
Allows model fields to override the descriptor class used on the model instance attribute.
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/models/fields.txt10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt
index 758c21c7bc..ead39f0572 100644
--- a/docs/ref/models/fields.txt
+++ b/docs/ref/models/fields.txt
@@ -1793,6 +1793,16 @@ Field API reference
where the arguments are interpolated from the field's ``__dict__``.
+ .. attribute:: descriptor_class
+
+ .. versionadded:: 3.0
+
+ A class implementing the :py:ref:`descriptor protocol <descriptors>`
+ that is instantiated and assigned to the model instance attribute. The
+ constructor must accept a single argument, the ``Field`` instance.
+ Overriding this class attribute allows for customizing the get and set
+ behavior.
+
To map a ``Field`` to a database-specific type, Django exposes several
methods: