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 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
|
# -*- coding: utf-8 -*-
#
# Copyright (C) 2008 John Paulett (john -at- paulett.org)
# All rights reserved.
#
# This software is licensed as described in the file COPYING, which
# you should have received as part of this distribution.
import os
import sys
import doctest
import unittest
import datetime
import time
import jsonpickle
from jsonpickle import handlers
from jsonpickle import tags
from samples import Thing, ThingWithSlots, ThingWithProps, BrokenReprThing, DictSubclass, ListSubclass, SetSubclass
class PicklingTestCase(unittest.TestCase):
def setUp(self):
self.pickler = jsonpickle.pickler.Pickler()
self.unpickler = jsonpickle.unpickler.Unpickler()
def test_string(self):
self.assertEqual('a string', self.pickler.flatten('a string'))
self.assertEqual('a string', self.unpickler.restore('a string'))
def test_unicode(self):
self.assertEqual(u'a string', self.pickler.flatten(u'a string'))
self.assertEqual(u'a string', self.unpickler.restore(u'a string'))
def test_int(self):
self.assertEqual(3, self.pickler.flatten(3))
self.assertEqual(3, self.unpickler.restore(3))
def test_float(self):
self.assertEqual(3.5, self.pickler.flatten(3.5))
self.assertEqual(3.5, self.unpickler.restore(3.5))
def test_boolean(self):
self.assertTrue(self.pickler.flatten(True))
self.assertFalse(self.pickler.flatten(False))
self.assertTrue(self.unpickler.restore(True))
self.assertFalse(self.unpickler.restore(False))
def test_none(self):
self.assertTrue(self.pickler.flatten(None) is None)
self.assertTrue(self.unpickler.restore(None) is None)
def test_list(self):
# multiple types of values
listA = [1, 35.0, 'value']
self.assertEqual(listA, self.pickler.flatten(listA))
self.assertEqual(listA, self.unpickler.restore(listA))
# nested list
listB = [40, 40, listA, 6]
self.assertEqual(listB, self.pickler.flatten(listB))
self.assertEqual(listB, self.unpickler.restore(listB))
# 2D list
listC = [[1, 2], [3, 4]]
self.assertEqual(listC, self.pickler.flatten(listC))
self.assertEqual(listC, self.unpickler.restore(listC))
# empty list
listD = []
self.assertEqual(listD, self.pickler.flatten(listD))
self.assertEqual(listD, self.unpickler.restore(listD))
def test_list_subclass(self):
obj = ListSubclass()
obj.extend([1, 2, 3])
flattened = self.pickler.flatten(obj)
self.assertTrue(tags.OBJECT in flattened)
self.assertTrue(tags.SEQ in flattened)
self.assertEqual(len(flattened[tags.SEQ]), 3)
for v in obj:
self.assertTrue(v in flattened[tags.SEQ])
restored = self.unpickler.restore(flattened)
self.assertEqual(type(restored), ListSubclass)
self.assertEqual(restored, obj)
def test_list_subclass_with_data(self):
obj = ListSubclass()
obj.extend([1, 2, 3])
data = SetSubclass([1, 2, 3])
obj.data = data
flattened = self.pickler.flatten(obj)
restored = self.unpickler.restore(flattened)
self.assertEqual(restored, obj)
self.assertEqual(type(restored.data), SetSubclass)
self.assertEqual(restored.data, data)
def test_set(self):
setlist = ['orange', 'apple', 'grape']
setA = set(setlist)
flattened = self.pickler.flatten(setA)
for s in setlist:
self.assertTrue(s in flattened[tags.SET])
setA_pickled = {tags.SET: setlist}
self.assertEqual(setA, self.unpickler.restore(setA_pickled))
def test_set_subclass(self):
obj = SetSubclass([1, 2, 3])
flattened = self.pickler.flatten(obj)
self.assertTrue(tags.OBJECT in flattened)
self.assertTrue(tags.SEQ in flattened)
self.assertEqual(len(flattened[tags.SEQ]), 3)
for v in obj:
self.assertTrue(v in flattened[tags.SEQ])
restored = self.unpickler.restore(flattened)
self.assertEqual(type(restored), SetSubclass)
self.assertEqual(restored, obj)
def test_set_subclass_with_data(self):
obj = SetSubclass([1, 2, 3])
data = ListSubclass()
data.extend([1, 2, 3])
obj.data = data
flattened = self.pickler.flatten(obj)
restored = self.unpickler.restore(flattened)
self.assertEqual(type(restored.data), ListSubclass)
self.assertEqual(restored.data, data)
def test_dict(self):
dictA = {'key1': 1.0, 'key2': 20, 'key3': 'thirty'}
self.assertEqual(dictA, self.pickler.flatten(dictA))
self.assertEqual(dictA, self.unpickler.restore(dictA))
dictB = {}
self.assertEqual(dictB, self.pickler.flatten(dictB))
self.assertEqual(dictB, self.unpickler.restore(dictB))
def test_tuple(self):
# currently all collections are converted to lists
tupleA = (4, 16, 32)
tupleA_pickled = {tags.TUPLE: [4, 16, 32]}
self.assertEqual(tupleA_pickled, self.pickler.flatten(tupleA))
self.assertEqual(tupleA, self.unpickler.restore(tupleA_pickled))
tupleB = (4,)
tupleB_pickled = {tags.TUPLE: [4]}
self.assertEqual(tupleB_pickled, self.pickler.flatten(tupleB))
self.assertEqual(tupleB, self.unpickler.restore(tupleB_pickled))
def test_tuple_roundtrip(self):
data = (1,2,3)
newdata = jsonpickle.decode(jsonpickle.encode(data))
self.assertEqual(data, newdata)
def test_set_roundtrip(self):
data = set([1,2,3])
newdata = jsonpickle.decode(jsonpickle.encode(data))
self.assertEqual(data, newdata)
def test_list_roundtrip(self):
data = [1,2,3]
newdata = jsonpickle.decode(jsonpickle.encode(data))
self.assertEqual(data, newdata)
def test_class(self):
inst = Thing('test name')
inst.child = Thing('child name')
flattened = self.pickler.flatten(inst)
self.assertEqual('test name', flattened['name'])
child = flattened['child']
self.assertEqual('child name', child['name'])
inflated = self.unpickler.restore(flattened)
self.assertEqual('test name', inflated.name)
self.assertTrue(type(inflated) is Thing)
self.assertEqual('child name', inflated.child.name)
self.assertTrue(type(inflated.child) is Thing)
def test_classlist(self):
array = [Thing('one'), Thing('two'), 'a string']
flattened = self.pickler.flatten(array)
self.assertEqual('one', flattened[0]['name'])
self.assertEqual('two', flattened[1]['name'])
self.assertEqual('a string', flattened[2])
inflated = self.unpickler.restore(flattened)
self.assertEqual('one', inflated[0].name)
self.assertTrue(type(inflated[0]) is Thing)
self.assertEqual('two', inflated[1].name)
self.assertTrue(type(inflated[1]) is Thing)
self.assertEqual('a string', inflated[2])
def test_classdict(self):
dict = {'k1':Thing('one'), 'k2':Thing('two'), 'k3':3}
flattened = self.pickler.flatten(dict)
self.assertEqual('one', flattened['k1']['name'])
self.assertEqual('two', flattened['k2']['name'])
self.assertEqual(3, flattened['k3'])
inflated = self.unpickler.restore(flattened)
self.assertEqual('one', inflated['k1'].name)
self.assertTrue(type(inflated['k1']) is Thing)
self.assertEqual('two', inflated['k2'].name)
self.assertTrue(type(inflated['k2']) is Thing)
self.assertEqual(3, inflated['k3'])
#TODO show that non string keys fail
def test_recursive(self):
"""create a recursive structure and test that we can handle it
"""
parent = Thing('parent')
child = Thing('child')
child.sibling = Thing('sibling')
parent.self = parent
parent.child = child
parent.child.twin = child
parent.child.parent = parent
parent.child.sibling.parent = parent
cloned = jsonpickle.decode(jsonpickle.encode(parent))
self.assertEqual(parent.name,
cloned.name)
self.assertEqual(parent.child.name,
cloned.child.name)
self.assertEqual(parent.child.sibling.name,
cloned.child.sibling.name)
self.assertEqual(cloned,
cloned.child.parent)
self.assertEqual(cloned,
cloned.child.sibling.parent)
self.assertEqual(cloned,
cloned.child.twin.parent)
self.assertEqual(cloned.child,
cloned.child.twin)
def test_newstyleslots(self):
obj = ThingWithSlots(True, False)
jsonstr = jsonpickle.encode(obj)
newobj = jsonpickle.decode(jsonstr)
self.assertTrue(newobj.a)
self.assertFalse(newobj.b)
def test_newstyleslots_with_children(self):
obj = ThingWithSlots(Thing('a'), Thing('b'))
jsonstr = jsonpickle.encode(obj)
newobj = jsonpickle.decode(jsonstr)
self.assertEqual(newobj.a.name, 'a')
self.assertEqual(newobj.b.name, 'b')
def test_oldstyleclass(self):
from pickle import _EmptyClass
obj = _EmptyClass()
obj.value = 1234
flattened = self.pickler.flatten(obj)
self.assertEqual(1234, flattened['value'])
inflated = self.unpickler.restore(flattened)
self.assertEqual(1234, inflated.value)
def test_struct_time(self):
t = time.struct_time('123456789')
flattened = self.pickler.flatten(t)
self.assertEqual(['1', '2', '3', '4', '5', '6', '7', '8', '9'], flattened)
def test_dictsubclass(self):
obj = DictSubclass()
obj['key1'] = 1
flattened = self.pickler.flatten(obj)
self.assertEqual({'key1': 1,
tags.OBJECT: 'samples.DictSubclass'
},
flattened)
self.assertEqual(flattened[tags.OBJECT],
'samples.DictSubclass')
inflated = self.unpickler.restore(flattened)
self.assertEqual(1, inflated['key1'])
self.assertEqual(inflated.name, 'Test')
def test_dictsubclass_notunpickable(self):
self.pickler.unpicklable = False
obj = DictSubclass()
obj['key1'] = 1
flattened = self.pickler.flatten(obj)
self.assertEqual(1, flattened['key1'])
self.assertFalse(tags.OBJECT in flattened)
inflated = self.unpickler.restore(flattened)
self.assertEqual(1, inflated['key1'])
def test_datetime(self):
obj = datetime.datetime.now()
flattened = self.pickler.flatten(obj)
self.assertTrue(repr(obj) in flattened[tags.REPR])
self.assertTrue('datetime' in flattened[tags.REPR])
inflated = self.unpickler.restore(flattened)
self.assertEqual(obj, inflated)
def test_broken_repr_dict_key(self):
"""Tests that we can pickle dictionaries with keys that have
broken __repr__ implementations.
"""
br = BrokenReprThing('test')
obj = { br: True }
pickler = jsonpickle.pickler.Pickler()
flattened = pickler.flatten(obj)
self.assertTrue('<BrokenReprThing "test">' in flattened)
self.assertTrue(flattened['<BrokenReprThing "test">'])
def test_repr_not_unpickable(self):
obj = datetime.datetime.now()
pickler = jsonpickle.pickler.Pickler(unpicklable=False)
flattened = pickler.flatten(obj)
self.assertFalse(tags.REPR in flattened)
self.assertFalse(tags.OBJECT in flattened)
self.assertEqual(str(obj), flattened)
def test_thing_with_module(self):
obj = Thing('with-module')
obj.themodule = os
flattened = self.pickler.flatten(obj)
inflated = self.unpickler.restore(flattened)
self.assertEqual(inflated.themodule, os)
def test_thing_with_submodule(self):
from distutils import sysconfig
obj = Thing('with-submodule')
obj.submodule = sysconfig
flattened = self.pickler.flatten(obj)
inflated = self.unpickler.restore(flattened)
self.assertEqual(inflated.submodule, sysconfig)
def test_datetime_date(self):
obj = datetime.datetime.now().date()
flattened = self.pickler.flatten(obj)
self.assertTrue(repr(obj) in flattened[tags.REPR])
self.assertTrue('datetime' in flattened[tags.REPR])
inflated = self.unpickler.restore(flattened)
self.assertEqual(obj, inflated)
def test_datetime_time(self):
obj = datetime.datetime.now().time()
flattened = self.pickler.flatten(obj)
self.assertTrue(repr(obj) in flattened[tags.REPR])
self.assertTrue('datetime' in flattened[tags.REPR])
inflated = self.unpickler.restore(flattened)
self.assertEqual(obj, inflated)
def test_datetime_timedelta(self):
obj = datetime.timedelta(5)
flattened = self.pickler.flatten(obj)
self.assertTrue(repr(obj) in flattened[tags.REPR])
self.assertTrue('datetime' in flattened[tags.REPR])
inflated = self.unpickler.restore(flattened)
self.assertEqual(obj, inflated)
def test_type_reference(self):
"""This test ensures that users can store references to types.
"""
obj = Thing('object-with-type-reference')
# reference the built-in 'object' type
obj.typeref = object
flattened = self.pickler.flatten(obj)
self.assertEqual(flattened['typeref'], {
tags.TYPE: '__builtin__.object',
})
inflated = self.unpickler.restore(flattened)
self.assertEqual(inflated.typeref, object)
def test_class_reference(self):
"""This test ensures that users can store references to classes.
"""
obj = Thing('object-with-class-reference')
# reference the 'Thing' class (not an instance of the class)
obj.classref = Thing
flattened = self.pickler.flatten(obj)
self.assertEqual(flattened['classref'], {
tags.TYPE: 'samples.Thing',
})
inflated = self.unpickler.restore(flattened)
self.assertEqual(inflated.classref, Thing)
def test_supports_getstate_setstate(self):
obj = ThingWithProps('object-which-defines-getstate-setstate')
print dir(obj)
flattened = self.pickler.flatten(obj)
self.assertTrue(flattened[tags.STATE].get('__identity__'))
self.assertTrue(flattened[tags.STATE].get('nom'))
inflated = self.unpickler.restore(flattened)
self.assertEqual(obj, inflated)
class JSONPickleTestCase(unittest.TestCase):
def setUp(self):
self.obj = Thing('A name')
self.expected_json = ('{"'+tags.OBJECT+'": "samples.Thing",'
' "name": "A name", "child": null}')
def test_encode(self):
pickled = jsonpickle.encode(self.obj)
self.assertEqual(self.expected_json, pickled)
def test_encode_notunpicklable(self):
pickled = jsonpickle.encode(self.obj, unpicklable=False)
self.assertEqual('{"name": "A name", "child": null}', pickled)
def test_decode(self):
unpickled = jsonpickle.decode(self.expected_json)
self.assertEqual(self.obj.name, unpickled.name)
self.assertEqual(type(self.obj), type(unpickled))
def test_json(self):
pickled = jsonpickle.encode(self.obj)
self.assertEqual(self.expected_json, pickled)
unpickled = jsonpickle.decode(self.expected_json)
self.assertEqual(self.obj.name, unpickled.name)
self.assertEqual(type(self.obj), type(unpickled))
def test_unicode_dict_keys(self):
pickled = jsonpickle.encode({'é'.decode('utf-8'): 'é'.decode('utf-8')})
unpickled = jsonpickle.decode(pickled)
self.assertEqual(unpickled['é'.decode('utf-8')], 'é'.decode('utf-8'))
self.assertTrue('é'.decode('utf-8') in unpickled)
def test_tuple_dict_keys(self):
"""Test that we handle dictionaries with tuples as keys.
We do not model this presently, so ensure that we at
least convert those tuples to repr strings.
TODO: handle dictionaries with non-stringy keys.
"""
pickled = jsonpickle.encode({(1, 2): 3,
(4, 5): { (7, 8): 9 }})
unpickled = jsonpickle.decode(pickled)
subdict = unpickled['(4, 5)']
self.assertEqual(unpickled['(1, 2)'], 3)
self.assertEqual(subdict['(7, 8)'], 9)
def test_datetime_dict_keys(self):
"""Test that we handle datetime objects as keys.
We do not model this presently, so ensure that we at
least convert those tuples into repr strings.
"""
pickled = jsonpickle.encode({datetime.datetime(2008, 12, 31): True})
unpickled = jsonpickle.decode(pickled)
self.assertTrue(unpickled['datetime.datetime(2008, 12, 31, 0, 0)'])
def test_object_dict_keys(self):
"""Test that we handle random objects as keys.
"""
pickled = jsonpickle.encode({Thing('random'): True})
unpickled = jsonpickle.decode(pickled)
self.assertEqual(unpickled,
{u'samples.Thing("random")': True})
def test_load_backend(self):
"""Test that we can call jsonpickle.load_backend()
"""
jsonpickle.load_backend('simplejson', 'dumps', 'loads', ValueError)
def test_set_preferred_backend_allows_magic(self):
"""Tests that we can use the pluggable backends magically
"""
backend = 'os.path'
jsonpickle.load_backend(backend, 'split', 'join', AttributeError)
jsonpickle.set_preferred_backend(backend)
slash_hello, world = jsonpickle.encode('/hello/world')
jsonpickle.remove_backend(backend)
self.assertEqual(slash_hello, '/hello')
self.assertEqual(world, 'world')
def test_load_backend_submodule(self):
"""Test that we can load a submodule as a backend
"""
jsonpickle.load_backend('os.path', 'split', 'join', AttributeError)
self.assertTrue('os.path' in jsonpickle.json._backend_names and
'os.path' in jsonpickle.json._encoders and
'os.path' in jsonpickle.json._decoders and
'os.path' in jsonpickle.json._encoder_options and
'os.path' in jsonpickle.json._decoder_exceptions)
def _backend_is_partially_loaded(self, backend):
"""Return True if the specified backend is incomplete"""
return (backend in jsonpickle.json._backend_names or
backend in jsonpickle.json._encoders or
backend in jsonpickle.json._decoders or
backend in jsonpickle.json._encoder_options or
backend in jsonpickle.json._decoder_exceptions)
def test_load_backend_skips_bad_inputs(self):
"""Test that we ignore bad encoders"""
jsonpickle.load_backend('os.path', 'bad!', 'split', AttributeError)
self.failIf(self._backend_is_partially_loaded('os.path'))
def test_load_backend_skips_bad_inputs(self):
"""Test that we ignore bad decoders"""
jsonpickle.load_backend('os.path', 'join', 'bad!', AttributeError)
self.failIf(self._backend_is_partially_loaded('os.path'))
def test_load_backend_skips_bad_decoder_exceptions(self):
"""Test that we ignore bad decoder exceptions"""
jsonpickle.load_backend('os.path', 'join', 'split', 'bad!')
self.failIf(self._backend_is_partially_loaded('os.path'))
# Test classes for ExternalHandlerTestCase
class Mixin(object):
def ok(self):
return True
class UnicodeMixin(unicode, Mixin):
def __add__(self, rhs):
obj = super(UnicodeMixin, self).__add__(rhs)
return UnicodeMixin(obj)
class UnicodeMixinHandler(handlers.BaseHandler):
def flatten(self, obj, data):
data['value'] = obj
return data
def restore(self, obj):
return UnicodeMixin(obj['value'])
class ExternalHandlerTestCase(unittest.TestCase):
def setUp(self):
handlers.registry.register(UnicodeMixin, UnicodeMixinHandler)
def tearDown(self):
handlers.registry.unregister(UnicodeMixin)
def test_unicode_mixin(self):
obj = UnicodeMixin('test')
self.assertEqual(unicode(obj), u'test')
# Encode into JSON
content = jsonpickle.encode(obj)
# Resurrect from JSON
new_obj = jsonpickle.decode(content)
new_obj += ' passed'
self.assertEqual(unicode(new_obj), u'test passed')
self.assertEqual(type(new_obj), UnicodeMixin)
self.assertTrue(new_obj.ok())
def suite():
suite = unittest.TestSuite()
suite.addTest(unittest.makeSuite(PicklingTestCase))
suite.addTest(unittest.makeSuite(JSONPickleTestCase))
suite.addTest(unittest.makeSuite(ExternalHandlerTestCase))
suite.addTest(doctest.DocTestSuite(jsonpickle.pickler))
suite.addTest(doctest.DocTestSuite(jsonpickle.unpickler))
suite.addTest(doctest.DocTestSuite(jsonpickle))
return suite
if __name__ == '__main__':
unittest.main(defaultTest='suite')
|