openstack/zaqar
Code Issues Proposed changes

Use the oslo.serialization instead of openstack/common/jsonutils

Browse Source 
oslo.serialization already graduated from oslo-incubator. So we should
use that one.

Change-Id: I983dda5b987550f540c0e4d79ace485493f57fa1
This commit is contained in:
Jeffrey Zhang 2014-11-18 15:48:34 +08:00
parent 2e9ee875a0
commit 06cee67a7c
24 changed files with 20 additions and 219 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/api/autoindex.rst
View File

@ -32,7 +32,6 @@
zaqar.openstack.common.fileutils.rst
zaqar.openstack.common.gettextutils.rst
zaqar.openstack.common.importutils.rst
zaqar.openstack.common.jsonutils.rst
zaqar.openstack.common.local.rst
zaqar.openstack.common.lockutils.rst
zaqar.openstack.common.log.rst

7
doc/source/api/zaqar.openstack.common.jsonutils.rst
View File

@ -1,7 +0,0 @@
The :mod:`zaqar.openstack.common.jsonutils` module
===================================================
.. automodule:: zaqar.openstack.common.jsonutils
:members:
:undoc-members:
:show-inheritance:

1
openstack-common.conf
View File

@ -6,7 +6,6 @@ module=excutils
module=fileutils
module=gettextutils
module=importutils
module=jsonutils
module=local
module=lockutils
module=log

1
requirements.txt
View File

@ -17,6 +17,7 @@ stevedore>=1.1.0 # Apache-2.0
six>=1.7.0
oslo.config>=1.4.0 # Apache-2.0
oslo.i18n>=1.0.0 # Apache-2.0
oslo.serialization>=1.0.0 # Apache-2.0
oslo.utils>=1.1.0 # Apache-2.0
SQLAlchemy>=0.9.7,<=0.9.99
enum34

2
tests/unit/transport/wsgi/test_v1_1.py
View File

@ -15,8 +15,8 @@ import uuid
import ddt
import falcon
from oslo.serialization import jsonutils
from zaqar.openstack.common import jsonutils
from zaqar.tests.unit.transport.wsgi import base
from zaqar.tests.unit.transport.wsgi import v1_1

190
zaqar/openstack/common/jsonutils.py
View File

@ -1,190 +0,0 @@
# Copyright 2010 United States Government as represented by the
# Administrator of the National Aeronautics and Space Administration.
# Copyright 2011 Justin Santa Barbara
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
'''
JSON related utilities.
This module provides a few things:
1) A handy function for getting an object down to something that can be
JSON serialized. See to_primitive().
2) Wrappers around loads() and dumps(). The dumps() wrapper will
automatically use to_primitive() for you if needed.
3) This sets up anyjson to use the loads() and dumps() wrappers if anyjson
is available.
'''
import codecs
import datetime
import functools
import inspect
import itertools
import sys
if sys.version_info < (2, 7):
# On Python <= 2.6, json module is not C boosted, so try to use
# simplejson module if available
try:
import simplejson as json
except ImportError:
import json
else:
import json
import six
import six.moves.xmlrpc_client as xmlrpclib
from zaqar.openstack.common import gettextutils
from zaqar.openstack.common import importutils
from zaqar.openstack.common import strutils
from zaqar.openstack.common import timeutils
netaddr = importutils.try_import("netaddr")
_nasty_type_tests = [inspect.ismodule, inspect.isclass, inspect.ismethod,
inspect.isfunction, inspect.isgeneratorfunction,
inspect.isgenerator, inspect.istraceback, inspect.isframe,
inspect.iscode, inspect.isbuiltin, inspect.isroutine,
inspect.isabstract]
_simple_types = (six.string_types + six.integer_types
+ (type(None), bool, float))
def to_primitive(value, convert_instances=False, convert_datetime=True,
level=0, max_depth=3):
"""Convert a complex object into primitives.
Handy for JSON serialization. We can optionally handle instances,
but since this is a recursive function, we could have cyclical
data structures.
To handle cyclical data structures we could track the actual objects
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.
Therefore, convert_instances=True is lossy ... be aware.
"""
# handle obvious types first - order of basic types determined by running
# full tests on nova project, resulting in the following counts:
# 572754 <type 'NoneType'>
# 460353 <type 'int'>
# 379632 <type 'unicode'>
# 274610 <type 'str'>
# 199918 <type 'dict'>
# 114200 <type 'datetime.datetime'>
# 51817 <type 'bool'>
# 26164 <type 'list'>
# 6491 <type 'float'>
# 283 <type 'tuple'>
# 19 <type 'long'>
if isinstance(value, _simple_types):
return value
if isinstance(value, datetime.datetime):
if convert_datetime:
return timeutils.strtime(value)
else:
return value
# value of itertools.count doesn't get caught by nasty_type_tests
# and results in infinite loop when list(value) is called.
if type(value) == itertools.count:
return six.text_type(value)
# FIXME(vish): Workaround for LP bug 852095. Without this workaround,
# tests that raise an exception in a mocked method that
# has a @wrap_exception with a notifier will fail. If
# we up the dependency to 0.5.4 (when it is released) we
# can remove this workaround.
if getattr(value, '__module__', None) == 'mox':
return 'mock'
if level > max_depth:
return '?'
# The try block may not be necessary after the class check above,
# but just in case ...
try:
recursive = functools.partial(to_primitive,
convert_instances=convert_instances,
convert_datetime=convert_datetime,
level=level,
max_depth=max_depth)
if isinstance(value, dict):
return dict((k, recursive(v)) for k, v in six.iteritems(value))
elif isinstance(value, (list, tuple)):
return [recursive(lv) for lv in value]
# It's not clear why xmlrpclib created their own DateTime type, but
# for our purposes, make it a datetime type which is explicitly
# handled
if isinstance(value, xmlrpclib.DateTime):
value = datetime.datetime(*tuple(value.timetuple())[:6])
if convert_datetime and isinstance(value, datetime.datetime):
return timeutils.strtime(value)
elif isinstance(value, gettextutils.Message):
return value.data
elif hasattr(value, 'iteritems'):
return recursive(dict(value.iteritems()), level=level + 1)
elif hasattr(value, '__iter__'):
return recursive(list(value))
elif convert_instances and hasattr(value, '__dict__'):
# Likely an instance of something. Watch for cycles.
# Ignore class member vars.
return recursive(value.__dict__, level=level + 1)
elif netaddr and isinstance(value, netaddr.IPAddress):
return six.text_type(value)
else:
if any(test(value) for test in _nasty_type_tests):
return six.text_type(value)
return value
except TypeError:
# Class objects are tricky since they may define something like
# __iter__ defined but it isn't callable as list().
return six.text_type(value)
def dumps(value, default=to_primitive, **kwargs):
return json.dumps(value, default=default, **kwargs)
def dump(obj, fp, *args, **kwargs):
return json.dump(obj, fp, *args, **kwargs)
def loads(s, encoding='utf-8', **kwargs):
return json.loads(strutils.safe_decode(s, encoding), **kwargs)
def load(fp, encoding='utf-8', **kwargs):
return json.load(codecs.getreader(encoding)(fp), **kwargs)
try:
import anyjson
except ImportError:
pass
else:
anyjson._modules.append((__name__, 'dumps', TypeError,
'loads', ValueError, 'load'))
anyjson.force_implementation(__name__)

2
zaqar/openstack/common/log.py
View File

@ -37,6 +37,7 @@ import sys
import traceback
from oslo.config import cfg
from oslo.serialization import jsonutils
import six
from six import moves
@ -44,7 +45,6 @@ _PY26 = sys.version_info[0:2] == (2, 6)
from zaqar.openstack.common.gettextutils import _
from zaqar.openstack.common import importutils
from zaqar.openstack.common import jsonutils
from zaqar.openstack.common import local
# NOTE(flaper87): Pls, remove when graduating this module
# from the incubator.

2
zaqar/storage/sqlalchemy/utils.py
View File

@ -15,12 +15,12 @@
import functools
from oslo.serialization import jsonutils
from oslo.utils import encodeutils
import sqlalchemy as sa
from sqlalchemy import exc
from sqlalchemy.sql import func as sfunc
from zaqar.openstack.common import jsonutils
from zaqar.openstack.common import log as logging
from zaqar.storage import errors
from zaqar.storage.sqlalchemy import tables

3
zaqar/tests/functional/http.py
View File

@ -17,11 +17,10 @@ import functools
import json
from falcon import testing as ftest
from oslo.serialization import jsonutils
import requests
import six
from zaqar.openstack.common import jsonutils
def _build_url(method):

2
zaqar/tests/unit/transport/wsgi/base.py
View File

@ -15,9 +15,9 @@
import uuid
from falcon import testing as ftest
from oslo.serialization import jsonutils
from zaqar import bootstrap
from zaqar.openstack.common import jsonutils
from zaqar import tests as testing
from zaqar.transport import validation
from zaqar.transport.wsgi import driver

2
zaqar/tests/unit/transport/wsgi/v1/test_claims.py
View File

@ -19,10 +19,10 @@ import uuid
import ddt
import falcon
import mock
from oslo.serialization import jsonutils
from oslo.utils import timeutils
from testtools import matchers
from zaqar.openstack.common import jsonutils
from zaqar import tests as testing
from zaqar.tests.unit.transport.wsgi import base

2
zaqar/tests/unit/transport/wsgi/v1/test_default_limits.py
View File

@ -17,8 +17,8 @@ import contextlib
import uuid
import falcon
from oslo.serialization import jsonutils
from zaqar.openstack.common import jsonutils
from zaqar import storage
from zaqar.tests.unit.transport.wsgi import base

2
zaqar/tests/unit/transport/wsgi/v1/test_home.py
View File

@ -13,9 +13,9 @@
# the License.
import falcon
from oslo.serialization import jsonutils
import six.moves.urllib.parse as urlparse
from zaqar.openstack.common import jsonutils
from zaqar.tests.unit.transport.wsgi import base

2
zaqar/tests/unit/transport/wsgi/v1/test_messages.py
View File

@ -19,11 +19,11 @@ import uuid
import ddt
import falcon
import mock
from oslo.serialization import jsonutils
from oslo.utils import timeutils
import six
from testtools import matchers
from zaqar.openstack.common import jsonutils
from zaqar import tests as testing
from zaqar.tests.unit.transport.wsgi import base
from zaqar.transport import validation

2
zaqar/tests/unit/transport/wsgi/v1/test_pools.py
View File

@ -17,8 +17,8 @@ import uuid
import ddt
import falcon
from oslo.serialization import jsonutils
from zaqar.openstack.common import jsonutils
from zaqar import tests as testing
from zaqar.tests.unit.transport.wsgi import base

2
zaqar/tests/unit/transport/wsgi/v1/test_queue_lifecycle.py
View File

@ -14,9 +14,9 @@
import ddt
import falcon
from oslo.serialization import jsonutils
import six
from zaqar.openstack.common import jsonutils
from zaqar import tests as testing
from zaqar.tests.unit.transport.wsgi import base

2
zaqar/tests/unit/transport/wsgi/v1_1/test_claims.py
View File

@ -20,10 +20,10 @@ import uuid
import ddt
import falcon
import mock
from oslo.serialization import jsonutils
from oslo.utils import timeutils
from testtools import matchers
from zaqar.openstack.common import jsonutils
from zaqar import tests as testing
from zaqar.tests.unit.transport.wsgi import base

2
zaqar/tests/unit/transport/wsgi/v1_1/test_default_limits.py
View File

@ -17,8 +17,8 @@ import contextlib
import uuid
import falcon
from oslo.serialization import jsonutils
from zaqar.openstack.common import jsonutils
from zaqar import storage
from zaqar.tests.unit.transport.wsgi import base

2
zaqar/tests/unit/transport/wsgi/v1_1/test_flavors.py
View File

@ -17,8 +17,8 @@ import uuid
import ddt
import falcon
from oslo.serialization import jsonutils
from zaqar.openstack.common import jsonutils
from zaqar import tests as testing
from zaqar.tests.unit.transport.wsgi import base

2
zaqar/tests/unit/transport/wsgi/v1_1/test_health.py
View File

@ -17,8 +17,8 @@
import ddt
import falcon
import mock
from oslo.serialization import jsonutils
from zaqar.openstack.common import jsonutils
from zaqar.storage import errors
import zaqar.storage.mongodb as mongo
from zaqar import tests as testing

2
zaqar/tests/unit/transport/wsgi/v1_1/test_home.py
View File

@ -15,9 +15,9 @@
import uuid
import falcon
from oslo.serialization import jsonutils
import six.moves.urllib.parse as urlparse
from zaqar.openstack.common import jsonutils
from zaqar.tests.unit.transport.wsgi import base

2
zaqar/tests/unit/transport/wsgi/v1_1/test_messages.py
View File

@ -19,11 +19,11 @@ import uuid
import ddt
import falcon
import mock
from oslo.serialization import jsonutils
from oslo.utils import timeutils
import six
from testtools import matchers
from zaqar.openstack.common import jsonutils
from zaqar import tests as testing
from zaqar.tests.unit.transport.wsgi import base
from zaqar.transport import validation

2
zaqar/tests/unit/transport/wsgi/v1_1/test_pools.py
View File

@ -17,8 +17,8 @@ import uuid
import ddt
import falcon
from oslo.serialization import jsonutils
from zaqar.openstack.common import jsonutils
from zaqar import tests as testing
from zaqar.tests.unit.transport.wsgi import base

2
zaqar/tests/unit/transport/wsgi/v1_1/test_queue_lifecycle.py
View File

@ -16,9 +16,9 @@ import uuid
import ddt
import falcon
from oslo.serialization import jsonutils
import six
from zaqar.openstack.common import jsonutils
from zaqar import tests as testing
from zaqar.tests.unit.transport.wsgi import base