mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-23 09:36:06 +00:00
Code Issues 25 Releases Wiki Activity

Fixed #29423 -- Documented Field.value_from_object().

Browse Source
This commit is contained in:
Srinivas Reddy Thatiparthy 2018-05-25 20:53:13 +05:30 committed by Tim Graham
parent 738a0a4dc2
commit 4c35a173e8
2 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/howto/custom-model-fields.txt
View File

@ -679,8 +679,8 @@ Converting field data for serialization
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To customize how the values are serialized by a serializer, you can override
:meth:`~Field.value_to_string`. Using ``value_from_object()`` is the best way
to get the field's value prior to serialization. For example, since our
:meth:`~Field.value_to_string`. Using :meth:`~Field.value_from_object` is the
best way to get the field's value prior to serialization. For example, since
``HandField`` uses strings for its data storage anyway, we can reuse some
existing conversion code::

6
docs/ref/models/fields.txt
View File

@ -1857,6 +1857,12 @@ Field API reference
Besides saving to the database, the field also needs to know how to
serialize its value:
.. method:: value_from_object(obj)
Returns the field's value for the given model instance.
This method is often used by :meth:`value_to_string`.
.. method:: value_to_string(obj)
Converts ``obj`` to a string. Used to serialize the value of the field.