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
|
# -*- Mode: Python -*-
import unittest
from gi.repository import GObject
import sys
import testhelper
class TestGObjectAPI(unittest.TestCase):
def testGObjectModule(self):
obj = GObject.GObject()
self.assertEqual(obj.__module__,
'gi._gobject._gobject')
class TestReferenceCounting(unittest.TestCase):
def testRegularObject(self):
obj = GObject.GObject()
self.assertEqual(obj.__grefcount__, 1)
obj = GObject.new(GObject.GObject)
self.assertEqual(obj.__grefcount__, 1)
def testFloating(self):
obj = testhelper.Floating()
self.assertEqual(obj.__grefcount__, 1)
obj = GObject.new(testhelper.Floating)
self.assertEqual(obj.__grefcount__, 1)
def testOwnedByLibrary(self):
# Upon creation, the refcount of the object should be 2:
# - someone already has a reference on the new object.
# - the python wrapper should hold its own reference.
obj = testhelper.OwnedByLibrary()
self.assertEqual(obj.__grefcount__, 2)
# We ask the library to release its reference, so the only
# remaining ref should be our wrapper's. Once the wrapper
# will run out of scope, the object will get finalized.
obj.release()
self.assertEqual(obj.__grefcount__, 1)
def testOwnedByLibraryOutOfScope(self):
obj = testhelper.OwnedByLibrary()
self.assertEqual(obj.__grefcount__, 2)
# We are manually taking the object out of scope. This means
# that our wrapper has been freed, and its reference dropped. We
# cannot check it but the refcount should now be 1 (the ref held
# by the library is still there, we didn't call release()
obj = None
# When we get the object back from the lib, the wrapper is
# re-created, so our refcount will be 2 once again.
obj = testhelper.owned_by_library_get_instance_list()[0]
self.assertEqual(obj.__grefcount__, 2)
obj.release()
self.assertEqual(obj.__grefcount__, 1)
def testOwnedByLibraryUsingGObjectNew(self):
# Upon creation, the refcount of the object should be 2:
# - someone already has a reference on the new object.
# - the python wrapper should hold its own reference.
obj = GObject.new(testhelper.OwnedByLibrary)
self.assertEqual(obj.__grefcount__, 2)
# We ask the library to release its reference, so the only
# remaining ref should be our wrapper's. Once the wrapper
# will run out of scope, the object will get finalized.
obj.release()
self.assertEqual(obj.__grefcount__, 1)
def testOwnedByLibraryOutOfScopeUsingGobjectNew(self):
obj = GObject.new(testhelper.OwnedByLibrary)
self.assertEqual(obj.__grefcount__, 2)
# We are manually taking the object out of scope. This means
# that our wrapper has been freed, and its reference dropped. We
# cannot check it but the refcount should now be 1 (the ref held
# by the library is still there, we didn't call release()
obj = None
# When we get the object back from the lib, the wrapper is
# re-created, so our refcount will be 2 once again.
obj = testhelper.owned_by_library_get_instance_list()[0]
self.assertEqual(obj.__grefcount__, 2)
obj.release()
self.assertEqual(obj.__grefcount__, 1)
def testFloatingAndSunk(self):
# Upon creation, the refcount of the object should be 2:
# - someone already has a reference on the new object.
# - the python wrapper should hold its own reference.
obj = testhelper.FloatingAndSunk()
self.assertEqual(obj.__grefcount__, 2)
# We ask the library to release its reference, so the only
# remaining ref should be our wrapper's. Once the wrapper
# will run out of scope, the object will get finalized.
obj.release()
self.assertEqual(obj.__grefcount__, 1)
def testFloatingAndSunkOutOfScope(self):
obj = testhelper.FloatingAndSunk()
self.assertEqual(obj.__grefcount__, 2)
# We are manually taking the object out of scope. This means
# that our wrapper has been freed, and its reference dropped. We
# cannot check it but the refcount should now be 1 (the ref held
# by the library is still there, we didn't call release()
obj = None
# When we get the object back from the lib, the wrapper is
# re-created, so our refcount will be 2 once again.
obj = testhelper.floating_and_sunk_get_instance_list()[0]
self.assertEqual(obj.__grefcount__, 2)
obj.release()
self.assertEqual(obj.__grefcount__, 1)
def testFloatingAndSunkUsingGObjectNew(self):
# Upon creation, the refcount of the object should be 2:
# - someone already has a reference on the new object.
# - the python wrapper should hold its own reference.
obj = GObject.new(testhelper.FloatingAndSunk)
self.assertEqual(obj.__grefcount__, 2)
# We ask the library to release its reference, so the only
# remaining ref should be our wrapper's. Once the wrapper
# will run out of scope, the object will get finalized.
obj.release()
self.assertEqual(obj.__grefcount__, 1)
def testFloatingAndSunkOutOfScopeUsingGObjectNew(self):
obj = GObject.new(testhelper.FloatingAndSunk)
self.assertEqual(obj.__grefcount__, 2)
# We are manually taking the object out of scope. This means
# that our wrapper has been freed, and its reference dropped. We
# cannot check it but the refcount should now be 1 (the ref held
# by the library is still there, we didn't call release()
obj = None
# When we get the object back from the lib, the wrapper is
# re-created, so our refcount will be 2 once again.
obj = testhelper.floating_and_sunk_get_instance_list()[0]
self.assertEqual(obj.__grefcount__, 2)
obj.release()
self.assertEqual(obj.__grefcount__, 1)
def testUninitializedObject(self):
class Obj(GObject.GObject):
def __init__(self):
x = self.__grefcount__
super(Obj, self).__init__()
assert x >= 0 # quiesce pyflakes
# Accessing __grefcount__ before the object is initialized is wrong.
# Ensure we get a proper exception instead of a crash.
self.assertRaises(TypeError, Obj)
class A(GObject.GObject):
def __init__(self):
super(A, self).__init__()
class TestPythonReferenceCounting(unittest.TestCase):
# Newly created instances should alwayshave two references: one for
# the GC, and one for the bound variable in the local scope.
def testNewInstanceHasTwoRefs(self):
obj = GObject.GObject()
self.assertEqual(sys.getrefcount(obj), 2)
def testNewInstanceHasTwoRefsUsingGObjectNew(self):
obj = GObject.new(GObject.GObject)
self.assertEqual(sys.getrefcount(obj), 2)
def testNewSubclassInstanceHasTwoRefs(self):
obj = A()
self.assertEqual(sys.getrefcount(obj), 2)
def testNewSubclassInstanceHasTwoRefsUsingGObjectNew(self):
obj = GObject.new(A)
self.assertEqual(sys.getrefcount(obj), 2)
class TestContextManagers(unittest.TestCase):
class ContextTestObject(GObject.GObject):
prop = GObject.Property(default=0, type=int)
def on_prop_set(self, obj, prop):
# Handler which tracks property changed notifications.
self.tracking.append(obj.get_property(prop.name))
def setUp(self):
self.tracking = []
self.obj = self.ContextTestObject()
self.handler = self.obj.connect('notify::prop', self.on_prop_set)
def testFreezeNotifyContext(self):
# Verify prop tracking list
self.assertEqual(self.tracking, [])
self.obj.props.prop = 1
self.assertEqual(self.tracking, [1])
self.obj.props.prop = 2
self.assertEqual(self.tracking, [1, 2])
self.assertEqual(self.obj.__grefcount__, 1)
# Using the context manager the tracking list should not be affected
# and the GObject reference count should go up.
with self.obj.freeze_notify():
self.assertEqual(self.obj.__grefcount__, 2)
self.obj.props.prop = 3
self.assertEqual(self.obj.props.prop, 3)
self.assertEqual(self.tracking, [1, 2])
# After the context manager, the prop should have been modified,
# the tracking list will be modified, and the GObject ref
# count goes back down.
self.assertEqual(self.obj.props.prop, 3)
self.assertEqual(self.tracking, [1, 2, 3])
self.assertEqual(self.obj.__grefcount__, 1)
def testHandlerBlockContext(self):
# Verify prop tracking list
self.assertEqual(self.tracking, [])
self.obj.props.prop = 1
self.assertEqual(self.tracking, [1])
self.obj.props.prop = 2
self.assertEqual(self.tracking, [1, 2])
self.assertEqual(self.obj.__grefcount__, 1)
# Using the context manager the tracking list should not be affected
# and the GObject reference count should go up.
with self.obj.handler_block(self.handler):
self.assertEqual(self.obj.__grefcount__, 2)
self.obj.props.prop = 3
self.assertEqual(self.obj.props.prop, 3)
self.assertEqual(self.tracking, [1, 2])
# After the context manager, the prop should have been modified
# the tracking list should have stayed the same and the GObject ref
# count goes back down.
self.assertEqual(self.obj.props.prop, 3)
self.assertEqual(self.tracking, [1, 2])
self.assertEqual(self.obj.__grefcount__, 1)
def testFreezeNotifyContextNested(self):
self.assertEqual(self.tracking, [])
with self.obj.freeze_notify():
self.obj.props.prop = 1
self.assertEqual(self.tracking, [])
with self.obj.freeze_notify():
self.obj.props.prop = 2
self.assertEqual(self.tracking, [])
with self.obj.freeze_notify():
self.obj.props.prop = 3
self.assertEqual(self.tracking, [])
self.assertEqual(self.tracking, [])
self.assertEqual(self.tracking, [])
# Finally after last context, the notifications should have collapsed
# and the last one sent.
self.assertEqual(self.tracking, [3])
def testHandlerBlockContextNested(self):
self.assertEqual(self.tracking, [])
with self.obj.handler_block(self.handler):
self.obj.props.prop = 1
self.assertEqual(self.tracking, [])
with self.obj.handler_block(self.handler):
self.obj.props.prop = 2
self.assertEqual(self.tracking, [])
with self.obj.handler_block(self.handler):
self.obj.props.prop = 3
self.assertEqual(self.tracking, [])
self.assertEqual(self.tracking, [])
self.assertEqual(self.tracking, [])
# Finally after last context, the notifications should have collapsed
# and the last one sent.
self.assertEqual(self.obj.props.prop, 3)
self.assertEqual(self.tracking, [])
def testFreezeNotifyNormalUsageRefCounts(self):
# Ensure ref counts without using methods as context managers
# maintain the same count.
self.assertEqual(self.obj.__grefcount__, 1)
self.obj.freeze_notify()
self.assertEqual(self.obj.__grefcount__, 1)
self.obj.thaw_notify()
self.assertEqual(self.obj.__grefcount__, 1)
def testHandlerBlockNormalUsageRefCounts(self):
self.assertEqual(self.obj.__grefcount__, 1)
self.obj.handler_block(self.handler)
self.assertEqual(self.obj.__grefcount__, 1)
self.obj.handler_unblock(self.handler)
self.assertEqual(self.obj.__grefcount__, 1)
def testFreezeNotifyContextError(self):
# Test an exception occurring within a freeze context exits the context
try:
with self.obj.freeze_notify():
self.obj.props.prop = 1
self.assertEqual(self.tracking, [])
raise ValueError('Simulation')
except ValueError:
pass
# Verify the property set within the context called notify.
self.assertEqual(self.obj.props.prop, 1)
self.assertEqual(self.tracking, [1])
# Verify we are still not in a frozen context.
self.obj.props.prop = 2
self.assertEqual(self.tracking, [1, 2])
def testHandlerBlockContextError(self):
# Test an exception occurring within a handler block exits the context
try:
with self.obj.handler_block(self.handler):
self.obj.props.prop = 1
self.assertEqual(self.tracking, [])
raise ValueError('Simulation')
except ValueError:
pass
# Verify the property set within the context didn't call notify.
self.assertEqual(self.obj.props.prop, 1)
self.assertEqual(self.tracking, [])
# Verify we are still not in a handler block context.
self.obj.props.prop = 2
self.assertEqual(self.tracking, [2])
if __name__ == '__main__':
unittest.main()
|
