openstack/deb-python-colander
Code Issues Proposed changes

blah blah blah

Browse Source
This commit is contained in:
Chris McDonough
2012-02-17 23:52:21 -05:00
parent cd9c4e107b
commit 511c4740af
1 changed files with 23 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
docs/null.rst
View File

@@ -188,14 +188,15 @@ colander.null <missing> null serialized
colander.null value null serialized colander.null value null serialized
===================== ===================== =========================== ===================== ===================== ===========================
.. note:: ``<missing>`` in the above table represents the circumstance .. note::
in which a key present in a :class:`colander.MappingSchema` is not
present in a mapping passed to its ``<missing>`` in the above table represents the circumstance in which a
:meth:`colander.SchemaNode.serialize` method. In reality, key present in a :class:`colander.MappingSchema` is not present in a
``<missing>`` means exactly the same thing as mapping passed to its :meth:`colander.SchemaNode.serialize` method. In
:attr:`colanderr.null`, because the :class:`colander.Mapping` type reality, ``<missing>`` means exactly the same thing as
does the equivalent of ``mapping.get(keyname, colander.null)`` to :attr:`colanderr.null`, because the :class:`colander.Mapping` type does
find a subvalue during serialization. the equivalent of ``mapping.get(keyname, colander.null)`` to find a
subvalue during serialization.
.. _deserializing_null: .. _deserializing_null:
@@ -229,19 +230,20 @@ a schema, the node will take the following steps:
with an explicit ``missing`` value), a :exc:`colander.Invalid` exception with an explicit ``missing`` value), a :exc:`colander.Invalid` exception
will be raised with a message indicating that the field is required. will be raised with a message indicating that the field is required.
.. note:: There are differences between serialization and .. note::
deserialization involving the :attr:`colander.null` value. During
serialization, if an :attr:`colander.null` value is encountered, There are differences between serialization and deserialization involving
and no valid ``default`` attribute exists on the node related to the :attr:`colander.null` value. During serialization, if an
the value the *null value* for that node is returned. :attr:`colander.null` value is encountered, and no valid ``default``
Deserialization, however, doesn't use the ``default`` attribute of attribute exists on the node related to the value the *null value* for
the node to find a default deserialization value in the same that node is returned. Deserialization, however, doesn't use the
circumstance; instead it uses the ``missing`` attribute instead. ``default`` attribute of the node to find a default deserialization value
Also, if, during deserialization, an :attr:`colander.null` value is in the same circumstance; instead it uses the ``missing`` attribute
encountered as the value passed to the deserialize method, and no instead. Also, if, during deserialization, an :attr:`colander.null` value
explicit ``missing`` value exists for the node, a is encountered as the value passed to the deserialize method, and no
:exc:`colander.Invalid` exception is raised (:attr:`colander.null` explicit ``missing`` value exists for the node, a :exc:`colander.Invalid`
is not returned, as it is during serialization). exception is raised (:attr:`colander.null` is not returned, as it is
during serialization).
Here's an example of a deserialization which uses a ``missing`` value Here's an example of a deserialization which uses a ``missing`` value
in the schema as a deserialization default value: in the schema as a deserialization default value: