openstack
/
oslo.serialization
Code Issues Proposed changes

Merge "More docstring cleanups/tweaks"

This commit is contained in:
Jenkins 2015-04-17 19:10:54 +00:00 committed by Gerrit Code Review
parent 2df5edaa9b 4ada51b09d
commit e52fdfaf18
2 changed files with 21 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
oslo_serialization/jsonutils.py
View File

@ -20,14 +20,12 @@ JSON related utilities.
This module provides a few things: This module provides a few things:
1) A handy function for getting an object down to something that can be #. A handy function for getting an object down to something that can be
JSON serialized. See to_primitive(). JSON serialized. See :func:`.to_primitive`.
#. Wrappers around :func:`.loads` and :func:`.dumps`. The :func:`.dumps`
2) Wrappers around loads() and dumps(). The dumps() wrapper will wrapper will automatically use :func:`.to_primitive` for you if needed.
automatically use to_primitive() for you if needed. #. This sets up ``anyjson`` to use the :func:`.loads` and :func:`.dumps`
wrappers if ``anyjson`` is available.
3) This sets up anyjson to use the loads() and dumps() wrappers if anyjson
is available.
''' '''
@ -87,7 +85,7 @@ def to_primitive(value, convert_instances=False, convert_datetime=True,
visited in a set, but not all objects are hashable. Instead we just visited in a set, but not all objects are hashable. Instead we just
track the depth of the object inspections and don't go too deep. track the depth of the object inspections and don't go too deep.
Therefore, convert_instances=True is lossy ... be aware. Therefore, ``convert_instances=True`` is lossy ... be aware.
""" """
# handle obvious types first - order of basic types determined by running # handle obvious types first - order of basic types determined by running
# full tests on nova project, resulting in the following counts: # full tests on nova project, resulting in the following counts:

14
oslo_serialization/msgpackutils.py
View File

@ -12,6 +12,20 @@
# License for the specific language governing permissions and limitations # License for the specific language governing permissions and limitations
# under the License. # under the License.
'''
Msgpack related utilities.
This module provides a few things:
#. A handy registry for getting an object down to something that can be
msgpack serialized. See :class:`.HandlerRegistry`.
#. Wrappers around :func:`.loads` and :func:`.dumps`. The :func:`.dumps`
wrapper will automatically use
the :py:attr:`~oslo_serialization.msgpackutils.default_registry` for
you if needed.
'''
import datetime import datetime
import functools import functools
import itertools import itertools