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
|
# (C) Copyright 2005-2025 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
""" These tests were originally for the the state function functionality of the
now deleted apptools.sweet_pickle framework. They have been modified here to
use apptools.persistence instead.
"""
# Standard library imports.
import io
import pickle
import unittest
import logging
# Enthought library imports
from apptools.persistence.tests.state_function_classes import Foo, Bar, Baz
from apptools.persistence.versioned_unpickler import VersionedUnpickler
from apptools.persistence.updater import Updater
logger = logging.getLogger(__name__)
class TestUpdater(Updater):
def __init__(self):
self.refactorings = {
(Foo.__module__, Foo.__name__):
(Bar.__module__, Bar.__name__),
(Bar.__module__, Bar.__name__):
(Baz.__module__, Baz.__name__),
}
self.setstates = {}
##############################################################################
# class 'StateFunctionTestCase'
##############################################################################
class StateFunctionTestCase(unittest.TestCase):
"""Originally tests for the state function functionality of the now deleted
apptools.sweet_pickle framework, converted to use apptools.persistence.
"""
##########################################################################
# 'TestCase' interface
##########################################################################
### public interface #####################################################
def setUp(self):
"""Creates the test fixture.
Overridden here to ensure each test starts with an empty global
registry.
"""
self.updater = TestUpdater()
##########################################################################
# 'StateFunctionTestCase' interface
##########################################################################
### public interface #####################################################
def test_normal_setstate(self):
"""Validates that only existing setstate methods are called when
there are no registered state functions in the class chain.
"""
# Validate that unpickling the first class gives us an instance of
# the second class with the appropriate attribute values. It will have
# the default Foo values (because there is no state function to move
# them) and also the default Bar values (since they inherit the
# trait defaults because nothing overwrote the values.)
start = Foo()
test_file = io.BytesIO(pickle.dumps(start, 2))
end = VersionedUnpickler(test_file, updater=TestUpdater()).load()
self.assertIsInstance(end, Bar)
self._assertAttributes(end, 1, (False, 1, 1, "foo"))
self._assertAttributes(end, 2, (True, 2, 2, "bar"))
self._assertAttributes(end, 3, None)
# Validate that unpickling the second class gives us an instance of
# the third class with the appropriate attribute values. It will have
# only the Baz attributes with the Bar values (since the __setstate__
# on Baz converted the Bar attributes to Baz attributes.)
start = Bar()
test_file = io.BytesIO(pickle.dumps(start, 2))
end = VersionedUnpickler(test_file, updater=TestUpdater()).load()
self.assertIsInstance(end, Baz)
self._assertAttributes(end, 2, None)
self._assertAttributes(end, 3, (True, 2, 2, "bar"))
### protected interface ##################################################
def _assertAttributes(self, obj, suffix, values):
"""Ensures that the specified object's attributes with the specified
suffix have the expected values. If values is None, then the
attributes shouldn't exist.
"""
attributeNames = ["b", "f", "i", "s"]
for i in range(len(attributeNames)):
name = attributeNames[i] + str(suffix)
if values is None:
self.assertEqual(
False,
hasattr(obj, name),
"Obj [%s] has attribute [%s]" % (obj, name),
)
else:
self.assertEqual(
values[i],
getattr(obj, name),
"Obj [%s] attribute [%s] has [%s] instead of [%s]"
% (obj, name, values[i], getattr(obj, name)),
)
|
