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
|
import time
import unittest
from threading import Lock, Thread
from freezegun import freeze_time
import cached_property
def CheckFactory(cached_property_decorator, threadsafe=False):
"""
Create dynamically a Check class whose add_cached method is decorated by
the cached_property_decorator.
"""
class Check:
def __init__(self):
self.control_total = 0
self.cached_total = 0
self.lock = Lock()
@property
def add_control(self):
self.control_total += 1
return self.control_total
@cached_property_decorator
def add_cached(self):
if threadsafe:
time.sleep(1)
# Need to guard this since += isn't atomic.
with self.lock:
self.cached_total += 1
else:
self.cached_total += 1
return self.cached_total
def run_threads(self, num_threads):
threads = []
for _ in range(num_threads):
thread = Thread(target=self.add_cached)
thread.start()
threads.append(thread)
for thread in threads:
thread.join()
return Check
class TestCachedProperty(unittest.TestCase):
"""Tests for cached_property"""
cached_property_factory = cached_property.cached_property
def assert_control(self, check, expected):
"""
Assert that both `add_control` and 'control_total` equal `expected`
"""
self.assertEqual(expected, check.add_control)
self.assertEqual(expected, check.control_total)
def assert_cached(self, check, expected):
"""
Assert that both `add_cached` and 'cached_total` equal `expected`
"""
self.assertEqual(expected, check.add_cached)
self.assertEqual(expected, check.cached_total)
def test_cached_property(self):
Check = CheckFactory(self.cached_property_factory)
check = Check()
# The control shows that we can continue to add 1
self.assert_control(check, 1)
self.assert_control(check, 2)
# The cached version demonstrates how nothing is added after the first
self.assert_cached(check, 1)
self.assert_cached(check, 1)
# The cache does not expire
with freeze_time("9999-01-01"):
self.assert_cached(check, 1)
# Typically descriptors return themselves if accessed though the class
# rather than through an instance.
self.assertTrue(isinstance(Check.add_cached, self.cached_property_factory))
def test_reset_cached_property(self):
Check = CheckFactory(self.cached_property_factory)
check = Check()
# Run standard cache assertion
self.assert_cached(check, 1)
self.assert_cached(check, 1)
# Clear the cache
del check.add_cached
# Value is cached again after the next access
self.assert_cached(check, 2)
self.assert_cached(check, 2)
def test_none_cached_property(self):
class Check:
def __init__(self):
self.cached_total = None
@self.cached_property_factory
def add_cached(self):
return self.cached_total
self.assert_cached(Check(), None)
def test_set_cached_property(self):
Check = CheckFactory(self.cached_property_factory)
check = Check()
check.add_cached = "foo"
self.assertEqual("foo", check.add_cached)
self.assertEqual(0, check.cached_total)
class TestThreadedCachedProperty(TestCachedProperty):
"""Tests for threaded_cached_property"""
cached_property_factory = cached_property.threaded_cached_property
def test_threads(self):
Check = CheckFactory(self.cached_property_factory, threadsafe=True)
check = Check()
num_threads = 5
# threaded_cached_property_with_ttl is thread-safe
check.run_threads(num_threads)
self.assert_cached(check, 1)
self.assert_cached(check, 1)
# The cache does not expire
with freeze_time("9999-01-01"):
check.run_threads(num_threads)
self.assert_cached(check, 1)
self.assert_cached(check, 1)
class TestCachedPropertyWithTTL(TestCachedProperty):
"""Tests for cached_property_with_ttl"""
cached_property_factory = cached_property.cached_property_with_ttl
def test_ttl_expiry(self):
Check = CheckFactory(self.cached_property_factory(ttl=100000))
check = Check()
# Run standard cache assertion
self.assert_cached(check, 1)
self.assert_cached(check, 1)
# The cache expires in the future
with freeze_time("9999-01-01"):
self.assert_cached(check, 2)
self.assert_cached(check, 2)
# Things are not reverted when we are back to the present
self.assert_cached(check, 2)
self.assert_cached(check, 2)
class TestThreadedCachedPropertyWithTTL(
TestThreadedCachedProperty, TestCachedPropertyWithTTL
):
"""Tests for threaded_cached_property_with_ttl"""
cached_property_factory = cached_property.threaded_cached_property_with_ttl
def test_threads_ttl_expiry(self):
Check = CheckFactory(self.cached_property_factory(ttl=100000), threadsafe=True)
check = Check()
num_threads = 5
# Same as in test_threads
check.run_threads(num_threads)
self.assert_cached(check, 1)
self.assert_cached(check, 1)
# The cache expires in the future
with freeze_time("9999-01-01"):
check.run_threads(num_threads)
self.assert_cached(check, 2)
self.assert_cached(check, 2)
# Things are not reverted when we are back to the present
self.assert_cached(check, 2)
self.assert_cached(check, 2)
|
