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
|
import asyncio
import io
import unittest
# To prevent a warning "test altered the execution environment"
def tearDownModule():
asyncio.events._set_event_loop_policy(None)
def capture_test_stack(*, fut=None, depth=1):
def walk(s):
ret = [
(f"T<{n}>" if '-' not in (n := s.future.get_name()) else 'T<anon>')
if isinstance(s.future, asyncio.Task) else 'F'
]
ret.append(
[
(
f"s {entry.frame.f_code.co_name}"
if entry.frame.f_generator is None else
(
f"a {entry.frame.f_generator.cr_code.co_name}"
if hasattr(entry.frame.f_generator, 'cr_code') else
f"ag {entry.frame.f_generator.ag_code.co_name}"
)
) for entry in s.call_stack
]
)
ret.append(
sorted([
walk(ab) for ab in s.awaited_by
], key=lambda entry: entry[0])
)
return ret
buf = io.StringIO()
asyncio.print_call_graph(fut, file=buf, depth=depth+1)
stack = asyncio.capture_call_graph(fut, depth=depth)
return walk(stack), buf.getvalue()
class CallStackTestBase:
async def test_stack_tgroup(self):
stack_for_c5 = None
def c5():
nonlocal stack_for_c5
stack_for_c5 = capture_test_stack(depth=2)
async def c4():
await asyncio.sleep(0)
c5()
async def c3():
await c4()
async def c2():
await c3()
async def c1(task):
await task
async def main():
async with asyncio.TaskGroup() as tg:
task = tg.create_task(c2(), name="c2_root")
tg.create_task(c1(task), name="sub_main_1")
tg.create_task(c1(task), name="sub_main_2")
await main()
self.assertEqual(stack_for_c5[0], [
# task name
'T<c2_root>',
# call stack
['s c5', 'a c4', 'a c3', 'a c2'],
# awaited by
[
['T<anon>',
['a _aexit', 'a __aexit__', 'a main', 'a test_stack_tgroup'], []
],
['T<sub_main_1>',
['a c1'],
[
['T<anon>',
['a _aexit', 'a __aexit__', 'a main', 'a test_stack_tgroup'], []
]
]
],
['T<sub_main_2>',
['a c1'],
[
['T<anon>',
['a _aexit', 'a __aexit__', 'a main', 'a test_stack_tgroup'], []
]
]
]
]
])
self.assertIn(
' async CallStackTestBase.test_stack_tgroup()',
stack_for_c5[1])
async def test_stack_async_gen(self):
stack_for_gen_nested_call = None
async def gen_nested_call():
nonlocal stack_for_gen_nested_call
stack_for_gen_nested_call = capture_test_stack()
async def gen():
for num in range(2):
yield num
if num == 1:
await gen_nested_call()
async def main():
async for el in gen():
pass
await main()
self.assertEqual(stack_for_gen_nested_call[0], [
'T<anon>',
[
's capture_test_stack',
'a gen_nested_call',
'ag gen',
'a main',
'a test_stack_async_gen'
],
[]
])
self.assertIn(
'async generator CallStackTestBase.test_stack_async_gen.<locals>.gen()',
stack_for_gen_nested_call[1])
async def test_stack_gather(self):
stack_for_deep = None
async def deep():
await asyncio.sleep(0)
nonlocal stack_for_deep
stack_for_deep = capture_test_stack()
async def c1():
await asyncio.sleep(0)
await deep()
async def c2():
await asyncio.sleep(0)
async def main():
await asyncio.gather(c1(), c2())
await main()
self.assertEqual(stack_for_deep[0], [
'T<anon>',
['s capture_test_stack', 'a deep', 'a c1'],
[
['T<anon>', ['a main', 'a test_stack_gather'], []]
]
])
async def test_stack_shield(self):
stack_for_shield = None
async def deep():
await asyncio.sleep(0)
nonlocal stack_for_shield
stack_for_shield = capture_test_stack()
async def c1():
await asyncio.sleep(0)
await deep()
async def main():
await asyncio.shield(c1())
await main()
self.assertEqual(stack_for_shield[0], [
'T<anon>',
['s capture_test_stack', 'a deep', 'a c1'],
[
['T<anon>', ['a main', 'a test_stack_shield'], []]
]
])
async def test_stack_timeout(self):
stack_for_inner = None
async def inner():
await asyncio.sleep(0)
nonlocal stack_for_inner
stack_for_inner = capture_test_stack()
async def c1():
async with asyncio.timeout(1):
await asyncio.sleep(0)
await inner()
async def main():
await asyncio.shield(c1())
await main()
self.assertEqual(stack_for_inner[0], [
'T<anon>',
['s capture_test_stack', 'a inner', 'a c1'],
[
['T<anon>', ['a main', 'a test_stack_timeout'], []]
]
])
async def test_stack_wait(self):
stack_for_inner = None
async def inner():
await asyncio.sleep(0)
nonlocal stack_for_inner
stack_for_inner = capture_test_stack()
async def c1():
async with asyncio.timeout(1):
await asyncio.sleep(0)
await inner()
async def c2():
for i in range(3):
await asyncio.sleep(0)
async def main(t1, t2):
while True:
_, pending = await asyncio.wait([t1, t2])
if not pending:
break
t1 = asyncio.create_task(c1())
t2 = asyncio.create_task(c2())
try:
await main(t1, t2)
finally:
await t1
await t2
self.assertEqual(stack_for_inner[0], [
'T<anon>',
['s capture_test_stack', 'a inner', 'a c1'],
[
['T<anon>',
['a _wait', 'a wait', 'a main', 'a test_stack_wait'],
[]
]
]
])
async def test_stack_task(self):
stack_for_inner = None
async def inner():
await asyncio.sleep(0)
nonlocal stack_for_inner
stack_for_inner = capture_test_stack()
async def c1():
await inner()
async def c2():
await asyncio.create_task(c1(), name='there there')
async def main():
await c2()
await main()
self.assertEqual(stack_for_inner[0], [
'T<there there>',
['s capture_test_stack', 'a inner', 'a c1'],
[['T<anon>', ['a c2', 'a main', 'a test_stack_task'], []]]
])
async def test_stack_future(self):
stack_for_fut = None
async def a2(fut):
await fut
async def a1(fut):
await a2(fut)
async def b1(fut):
await fut
async def main():
nonlocal stack_for_fut
fut = asyncio.Future()
async with asyncio.TaskGroup() as g:
g.create_task(a1(fut), name="task A")
g.create_task(b1(fut), name='task B')
for _ in range(5):
# Do a few iterations to ensure that both a1 and b1
# await on the future
await asyncio.sleep(0)
stack_for_fut = capture_test_stack(fut=fut)
fut.set_result(None)
await main()
self.assertEqual(stack_for_fut[0],
['F',
[],
[
['T<task A>',
['a a2', 'a a1'],
[['T<anon>', ['a test_stack_future'], []]]
],
['T<task B>',
['a b1'],
[['T<anon>', ['a test_stack_future'], []]]
],
]]
)
self.assertTrue(stack_for_fut[1].startswith('* Future(id='))
@unittest.skipIf(
not hasattr(asyncio.futures, "_c_future_add_to_awaited_by"),
"C-accelerated asyncio call graph backend missing",
)
class TestCallStackC(CallStackTestBase, unittest.IsolatedAsyncioTestCase):
def setUp(self):
futures = asyncio.futures
tasks = asyncio.tasks
self._Future = asyncio.Future
asyncio.Future = futures.Future = futures._CFuture
self._Task = asyncio.Task
asyncio.Task = tasks.Task = tasks._CTask
self._future_add_to_awaited_by = asyncio.future_add_to_awaited_by
futures.future_add_to_awaited_by = futures._c_future_add_to_awaited_by
asyncio.future_add_to_awaited_by = futures.future_add_to_awaited_by
self._future_discard_from_awaited_by = asyncio.future_discard_from_awaited_by
futures.future_discard_from_awaited_by = futures._c_future_discard_from_awaited_by
asyncio.future_discard_from_awaited_by = futures.future_discard_from_awaited_by
self._current_task = asyncio.current_task
asyncio.current_task = asyncio.tasks.current_task = tasks._c_current_task
def tearDown(self):
futures = asyncio.futures
tasks = asyncio.tasks
futures.future_discard_from_awaited_by = self._future_discard_from_awaited_by
asyncio.future_discard_from_awaited_by = self._future_discard_from_awaited_by
del self._future_discard_from_awaited_by
futures.future_add_to_awaited_by = self._future_add_to_awaited_by
asyncio.future_add_to_awaited_by = self._future_add_to_awaited_by
del self._future_add_to_awaited_by
asyncio.Task = self._Task
tasks.Task = self._Task
del self._Task
asyncio.Future = self._Future
futures.Future = self._Future
del self._Future
asyncio.current_task = asyncio.tasks.current_task = self._current_task
@unittest.skipIf(
not hasattr(asyncio.futures, "_py_future_add_to_awaited_by"),
"Pure Python asyncio call graph backend missing",
)
class TestCallStackPy(CallStackTestBase, unittest.IsolatedAsyncioTestCase):
def setUp(self):
futures = asyncio.futures
tasks = asyncio.tasks
self._Future = asyncio.Future
asyncio.Future = futures.Future = futures._PyFuture
self._Task = asyncio.Task
asyncio.Task = tasks.Task = tasks._PyTask
self._future_add_to_awaited_by = asyncio.future_add_to_awaited_by
futures.future_add_to_awaited_by = futures._py_future_add_to_awaited_by
asyncio.future_add_to_awaited_by = futures.future_add_to_awaited_by
self._future_discard_from_awaited_by = asyncio.future_discard_from_awaited_by
futures.future_discard_from_awaited_by = futures._py_future_discard_from_awaited_by
asyncio.future_discard_from_awaited_by = futures.future_discard_from_awaited_by
self._current_task = asyncio.current_task
asyncio.current_task = asyncio.tasks.current_task = tasks._py_current_task
def tearDown(self):
futures = asyncio.futures
tasks = asyncio.tasks
futures.future_discard_from_awaited_by = self._future_discard_from_awaited_by
asyncio.future_discard_from_awaited_by = self._future_discard_from_awaited_by
del self._future_discard_from_awaited_by
futures.future_add_to_awaited_by = self._future_add_to_awaited_by
asyncio.future_add_to_awaited_by = self._future_add_to_awaited_by
del self._future_add_to_awaited_by
asyncio.Task = self._Task
tasks.Task = self._Task
del self._Task
asyncio.Future = self._Future
futures.Future = self._Future
del self._Future
asyncio.current_task = asyncio.tasks.current_task = self._current_task
|
