1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
|
# 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.
"""
Helper functions for deconstructing classes, functions, and user-defined
objects into serializable types.
"""
from __future__ import print_function, division, absolute_import
from types import FunctionType, BuiltinFunctionType
import simplejson as json
from six import string_types, PY2, PY3
from .primitive_types import return_primitive
def init_arg_names(obj):
"""
Names of arguments to __init__ method of this object's class.
"""
# doing something wildly hacky by pulling out the arguments to
# __init__ or __new__ and hoping that they match fields defined on the
# object
try:
init_code = obj.__init__.__func__.__code__
except AttributeError:
try:
init_code = obj.__new__.__func__.__code__
except AttributeError:
# if object is a namedtuple then we can return its fields
# as the required initial args
if hasattr(obj, "_fields"):
return obj._fields
else:
raise ValueError("Cannot determine args to %s.__init__" % (obj,))
arg_names = init_code.co_varnames[:init_code.co_argcount]
# drop self argument
nonself_arg_names = arg_names[1:]
return nonself_arg_names
def simple_object_to_dict(self):
return {name: getattr(self, name) for name in init_arg_names(self)}
def _lookup_value(module_string, name, _cache={}):
key = (module_string, name)
if key in _cache:
value = _cache[key]
else:
module_parts = module_string.split(".")
# assuming that only JSON serialization from old Python2 runs
# of serialization would generate __builtin__ as a module
# name
if PY3 and module_parts[0] == "__builtin__":
module_parts = ["six", "moves", "builtins"] + module_parts[1:]
value = None
for i in range(1, len(module_parts) + 1):
try:
# try importing successively longer chains of
# sub-modules but break when we hit something that's
# not a module but actually data
qualified_name = ".".join(module_parts[:i])
value = __import__(
qualified_name,
fromlist=module_parts[:i - 1])
except ImportError:
break
if value is None:
raise ImportError(module_parts[0])
# once we've imported as much as we can, continue with getattr
# lookups
for attribute_name in module_parts[i:] + name.split("."):
value = getattr(value, attribute_name)
_cache[key] = value
return value
def class_from_serializable_representation(class_repr):
"""
Given the name of a module and a class it contains, imports that module
and gets the class object from it.
"""
return _lookup_value(class_repr["__module__"], class_repr["__name__"])
def get_module_name(obj):
module_name = obj.__module__
if PY2 and module_name == "__builtin__":
return "six.moves.builtins"
else:
return module_name
def class_to_serializable_representation(cls):
"""
Given a class, return two strings:
- fully qualified import path for its module
- name of the class
The class can be reconstructed from these two strings by calling
class_from_serializable_representation.
"""
return {"__module__": get_module_name(cls), "__name__": cls.__name__}
def function_from_serializable_representation(fn_repr):
"""
Given the name of a module and a function it contains, imports that module
and gets the class object from it.
"""
return _lookup_value(fn_repr["__module__"], fn_repr["__name__"])
def function_to_serializable_representation(fn):
"""
Converts a Python function into a serializable representation. Does not
currently work for methods or functions with closure data.
"""
if type(fn) not in (FunctionType, BuiltinFunctionType):
raise ValueError(
"Can't serialize %s : %s, must be globally defined function" % (
fn, type(fn),))
if hasattr(fn, "__closure__") and fn.__closure__ is not None:
raise ValueError("No serializable representation for closure %s" % (fn,))
return {"__module__": get_module_name(fn), "__name__": fn.__name__}
SERIALIZED_DICTIONARY_KEYS_FIELD = "__serialized_keys__"
SERIALIZED_DICTIONARY_KEYS_ELEMENT_PREFIX = (
SERIALIZED_DICTIONARY_KEYS_FIELD + "element_")
def index_to_serialized_key_name(index):
return "%s%d" % (SERIALIZED_DICTIONARY_KEYS_ELEMENT_PREFIX, index)
def parse_serialized_keys_index(name):
"""
Given a field name such as __serialized_keys__element_10 returns the integer 10
but returns None for other strings.
"""
if name.startswith(SERIALIZED_DICTIONARY_KEYS_ELEMENT_PREFIX):
try:
return int(name[len(SERIALIZED_DICTIONARY_KEYS_ELEMENT_PREFIX):])
except:
pass
return None
def dict_to_serializable_repr(x):
"""
Recursively convert values of dictionary to serializable representations.
Convert non-string keys to JSON representations and replace them in the
dictionary with indices of unique JSON strings (e.g. __1, __2, etc..).
"""
# list of JSON representations of hashable objects which were
# used as keys in this dictionary
serialized_key_list = []
serialized_keys_to_names = {}
# use the class of x rather just dict since we might want to convert
# derived classes such as OrderedDict
result = type(x)()
for (k, v) in x.items():
if not isinstance(k, string_types):
# JSON does not support using complex types such as tuples
# or user-defined objects with implementations of __hash__ as
# keys in a dictionary so we must keep the serialized
# representations of such values in a list and refer to indices
# in that list
serialized_key_repr = to_json(k)
if serialized_key_repr in serialized_keys_to_names:
k = serialized_keys_to_names[serialized_key_repr]
else:
k = index_to_serialized_key_name(len(serialized_key_list))
serialized_keys_to_names[serialized_key_repr] = k
serialized_key_list.append(serialized_key_repr)
result[k] = to_serializable_repr(v)
if len(serialized_key_list) > 0:
# only include this list of serialized keys if we had any non-string
# keys
result[SERIALIZED_DICTIONARY_KEYS_FIELD] = serialized_key_list
return result
def from_serializable_dict(x):
"""
Reconstruct a dictionary by recursively reconstructing all its keys and
values.
This is the most hackish part since we rely on key names such as
__name__, __class__, __module__ as metadata about how to reconstruct
an object.
TODO:
It would be cleaner to always wrap each object in a layer of type
metadata and then have an inner dictionary which represents the
flattened result of to_dict() for user-defined objects.
"""
if "__name__" in x:
return _lookup_value(x.pop("__module__"), x.pop("__name__"))
non_string_key_objects = [
from_json(serialized_key)
for serialized_key
in x.pop(SERIALIZED_DICTIONARY_KEYS_FIELD, [])
]
converted_dict = type(x)()
for k, v in x.items():
serialized_key_index = parse_serialized_keys_index(k)
if serialized_key_index is not None:
k = non_string_key_objects[serialized_key_index]
converted_dict[k] = from_serializable_repr(v)
if "__class__" in converted_dict:
class_object = converted_dict.pop("__class__")
if "__value__" in converted_dict:
return class_object(converted_dict["__value__"])
elif hasattr(class_object, "from_dict"):
return class_object.from_dict(converted_dict)
else:
return class_object(**converted_dict)
return converted_dict
def list_to_serializable_repr(x):
return [to_serializable_repr(element) for element in x]
def to_dict(obj):
"""
If value wasn't isn't a primitive scalar or collection then it needs to
either implement to_dict (instances of Serializable) or has member
data matching each required arg of __init__.
"""
if isinstance(obj, dict):
return obj
elif hasattr(obj, "to_dict"):
return obj.to_dict()
try:
return simple_object_to_dict(obj)
except:
raise ValueError(
"Cannot convert %s : %s to dictionary" % (
obj, type(obj)))
@return_primitive
def to_serializable_repr(x):
"""
Convert an instance of Serializable or a primitive collection containing
such instances into serializable types.
"""
t = type(x)
if isinstance(x, list):
return list_to_serializable_repr(x)
elif t in (set, tuple):
return {
"__class__": class_to_serializable_representation(t),
"__value__": list_to_serializable_repr(x)
}
elif isinstance(x, dict):
return dict_to_serializable_repr(x)
elif isinstance(x, (FunctionType, BuiltinFunctionType)):
return function_to_serializable_representation(x)
elif type(x) is type:
return class_to_serializable_representation(x)
else:
state_dictionary = to_serializable_repr(to_dict(x))
state_dictionary["__class__"] = class_to_serializable_representation(
x.__class__)
return state_dictionary
@return_primitive
def from_serializable_repr(x):
t = type(x)
if isinstance(x, list):
return t([from_serializable_repr(element) for element in x])
elif isinstance(x, dict):
return from_serializable_dict(x)
else:
raise TypeError(
"Cannot convert %s : %s from serializable representation to object" % (
x, type(x)))
def to_json(x):
"""
Returns JSON representation of a given Serializable instance or
other primitive object.
"""
return json.dumps(to_serializable_repr(x))
def from_json(json_string):
return from_serializable_repr(json.loads(json_string))
|