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
|
from __future__ import annotations
import asyncio
import concurrent.futures
import socket
import sys
import typing
import unittest
import urwid
if typing.TYPE_CHECKING:
from concurrent.futures import Future
from types import TracebackType
try:
import gi.repository
except ImportError:
GLIB_AVAILABLE = False
else:
GLIB_AVAILABLE = True
try:
import tornado
except ImportError:
TORNADO_AVAILABLE = False
else:
TORNADO_AVAILABLE = True
try:
import twisted
except ImportError:
TWISTED_AVAILABLE = False
else:
TWISTED_AVAILABLE = True
try:
import trio
except ImportError:
TRIO_AVAILABLE = False
else:
TRIO_AVAILABLE = True
try:
import zmq
except ImportError:
ZMQ_AVAILABLE = False
else:
ZMQ_AVAILABLE = True
IS_WINDOWS = sys.platform == "win32"
class ClosingSocketPair(typing.ContextManager[tuple[socket.socket, socket.socket]]):
__slots__ = ("rd_s", "wr_s")
def __init__(self) -> None:
self.rd_s: socket.socket | None = None
self.wr_s: socket.socket | None = None
def __enter__(self) -> tuple[socket.socket, socket.socket]:
self.rd_s, self.wr_s = socket.socketpair()
return self.rd_s, self.wr_s
def __exit__(
self,
exc_type: type[BaseException] | None,
exc_val: BaseException | None,
exc_tb: TracebackType | None,
) -> None:
if self.rd_s is not None:
self.rd_s.close()
if self.wr_s is not None:
self.wr_s.close()
class EventLoopTestMixin:
evl: urwid.EventLoop
def test_event_loop(self):
evl: urwid.EventLoop = self.evl
out = []
rd: socket.socket
wr: socket.socket
def step1():
out.append("writing")
wr.send(b"hi")
def step2():
out.append(rd.recv(2).decode("ascii"))
raise urwid.ExitMainLoop
with ClosingSocketPair() as (rd, wr):
_handle = evl.alarm(0, step1)
_handle = evl.watch_file(rd.fileno(), step2)
evl.run()
self.assertEqual(out, ["writing", "hi"])
def test_remove_alarm(self):
evl: urwid.EventLoop = self.evl
handle = evl.alarm(50, lambda: None)
def step1():
self.assertTrue(evl.remove_alarm(handle))
self.assertFalse(evl.remove_alarm(handle))
raise urwid.ExitMainLoop
evl.alarm(0, step1)
evl.run()
def test_remove_watch_file(self):
evl: urwid.EventLoop = self.evl
with ClosingSocketPair() as (rd, _wr):
handle = evl.watch_file(rd.fileno(), lambda: None)
def step1():
self.assertTrue(evl.remove_watch_file(handle))
self.assertFalse(evl.remove_watch_file(handle))
raise urwid.ExitMainLoop
evl.alarm(0, step1)
evl.run()
_expected_idle_handle = 1
def test_run(self):
evl: urwid.EventLoop = self.evl
out = []
wr: socket.socket
rd: socket.socket
def say_hello():
out.append("hello")
def say_waiting():
out.append("waiting")
def exit_clean() -> typing.NoReturn:
out.append("clean exit")
raise urwid.ExitMainLoop
def exit_error() -> typing.NoReturn:
1 / 0
with ClosingSocketPair() as (rd, wr):
self.assertEqual(wr.send(b"data"), 4)
_handle = evl.alarm(0.01, exit_clean)
_handle = evl.alarm(0.005, say_hello)
idle_handle = evl.enter_idle(say_waiting)
if self._expected_idle_handle is not None:
self.assertEqual(idle_handle, 1)
evl.run()
self.assertTrue("waiting" in out, out)
self.assertTrue("hello" in out, out)
self.assertTrue("clean exit" in out, out)
handle = evl.watch_file(rd.fileno(), exit_clean)
del out[:]
evl.run()
self.assertEqual(["clean exit"], out)
self.assertTrue(evl.remove_watch_file(handle))
_handle = evl.alarm(0, exit_error)
self.assertRaises(ZeroDivisionError, evl.run)
_handle = evl.watch_file(rd.fileno(), exit_error)
self.assertRaises(ZeroDivisionError, evl.run)
def test_run_in_executor(self):
out: list[str] = []
with concurrent.futures.ThreadPoolExecutor(max_workers=1) as executor:
def start():
out.append("started")
self.evl.run_in_executor(executor, func).add_done_callback(callback)
def func() -> bool:
out.append("future called")
return True
def callback(fut: Future) -> None:
out.append(f"callback called with future outcome: {fut.result()}")
def exit_clean() -> typing.NoReturn:
out.append("clean exit")
raise urwid.ExitMainLoop
_handle = self.evl.alarm(0.1, exit_clean)
_handle = self.evl.alarm(0.005, start)
self.evl.run()
self.assertEqual(
[
"started",
"future called",
"callback called with future outcome: True",
"clean exit",
],
out,
)
class SelectEventLoopTest(unittest.TestCase, EventLoopTestMixin):
def setUp(self):
self.evl = urwid.SelectEventLoop()
@unittest.skipIf(IS_WINDOWS, "Windows is temporary not supported by AsyncioEventLoop.")
class AsyncioEventLoopTest(unittest.TestCase, EventLoopTestMixin):
def setUp(self):
if sys.version_info[:2] < (3, 11):
self.loop = asyncio.get_event_loop_policy().get_event_loop()
self.evl_runner = None
else:
self.evl_runner = asyncio.Runner(loop_factory=asyncio.SelectorEventLoop)
self.loop = self.evl_runner.get_loop()
self.evl = urwid.AsyncioEventLoop(loop=self.loop)
def tearDown(self):
if self.evl_runner is not None:
self.evl_runner.close()
_expected_idle_handle = None
def test_error(self):
evl = self.evl
evl.alarm(0, lambda: 1 / 0) # Simulate error in event loop
self.assertRaises(ZeroDivisionError, evl.run)
@unittest.skipIf(
sys.implementation.name == "pypy",
"Well known dead wait (lock?) on pypy.",
)
def test_coroutine_error(self):
evl = self.evl
async def error_coro():
result = 1 / 0 # Simulate error in coroutine
return result
asyncio.ensure_future(error_coro(), loop=self.loop)
self.assertRaises(ZeroDivisionError, evl.run)
@unittest.skipUnless(GLIB_AVAILABLE, "GLIB unavailable")
class GLibEventLoopTest(unittest.TestCase, EventLoopTestMixin):
def setUp(self):
self.evl = urwid.GLibEventLoop()
def test_error(self):
evl = self.evl
evl.alarm(0, lambda: 1 / 0) # Simulate error in event loop
self.assertRaises(ZeroDivisionError, evl.run)
@unittest.skipUnless(TORNADO_AVAILABLE, "Tornado not available")
@unittest.skipIf(
IS_WINDOWS,
"Windows is temporary not supported by TornadoEventLoop due to race conditions.",
)
class TornadoEventLoopTest(unittest.TestCase, EventLoopTestMixin):
def setUp(self):
from tornado.ioloop import IOLoop
self.evl = urwid.TornadoEventLoop(IOLoop())
_expected_idle_handle = None
@unittest.skipUnless(TWISTED_AVAILABLE, "Twisted is not available")
@unittest.skipIf(
IS_WINDOWS,
"Windows is temporary not supported by TwistedEventLoop due to race conditions.",
)
class TwistedEventLoopTest(unittest.TestCase, EventLoopTestMixin):
def setUp(self):
self.evl = urwid.TwistedEventLoop()
# can't restart twisted reactor, so use shortened tests
def test_event_loop(self):
pass
def test_remove_alarm(self):
pass
def test_remove_watch_file(self):
pass
def test_run(self):
from twisted.internet import threads
evl = self.evl
out = []
wr: socket.socket
rd: socket.socket
def step2():
out.append(rd.recv(2).decode("ascii"))
def say_hello():
out.append("hello")
def say_waiting():
out.append("waiting")
def test_remove_alarm():
handle = evl.alarm(50, lambda: None)
self.assertTrue(evl.remove_alarm(handle))
self.assertFalse(evl.remove_alarm(handle))
out.append("remove_alarm ok")
def test_remove_watch_file():
with ClosingSocketPair() as (rd_, _wr):
handle = evl.watch_file(rd_.fileno(), lambda: None)
self.assertTrue(evl.remove_watch_file(handle))
self.assertFalse(evl.remove_watch_file(handle))
out.append("remove_watch_file ok")
def test_threaded():
out.append("schedule to thread")
threads.deferToThread(func).addCallback(callback)
def func() -> bool:
out.append("future called")
return True
def callback(result: bool) -> None:
out.append(f"callback called with future outcome: {result}")
def exit_clean() -> typing.NoReturn:
out.append("clean exit")
raise urwid.ExitMainLoop
def exit_error() -> typing.NoReturn:
1 / 0
with ClosingSocketPair() as (rd, wr):
self.assertEqual(wr.send(b"data"), 4)
_handle = evl.watch_file(rd.fileno(), step2)
_handle = evl.alarm(0.1, exit_clean)
_handle = evl.alarm(0.05, say_hello)
_handle = evl.alarm(0.06, test_remove_alarm)
_handle = evl.alarm(0.07, test_remove_watch_file)
_handle = evl.alarm(0.08, test_threaded)
self.assertEqual(evl.enter_idle(say_waiting), 1)
evl.run()
self.assertIn("da", out)
self.assertIn("ta", out)
self.assertIn("hello", out)
self.assertIn("remove_alarm ok", out)
self.assertIn("clean exit", out)
self.assertIn("schedule to thread", out)
self.assertIn("future called", out)
self.assertIn("callback called with future outcome: True", out)
def test_error(self):
evl = self.evl
evl.alarm(0, lambda: 1 / 0) # Simulate error in event loop
self.assertRaises(ZeroDivisionError, evl.run)
@unittest.skip("not implemented for twisted event loop")
def test_run_in_executor(self):
"""Not implemented for twisted event loop."""
@unittest.skipUnless(TRIO_AVAILABLE, "Trio not available")
@unittest.skipIf(
IS_WINDOWS,
"Windows is temporary not supported by TrioEventLoop due to race conditions.",
)
class TrioEventLoopTest(unittest.TestCase, EventLoopTestMixin):
def setUp(self):
self.evl = urwid.TrioEventLoop()
_expected_idle_handle = None
def test_error(self):
evl = self.evl
evl.alarm(0, lambda: 1 / 0) # Simulate error in event loop
self.assertRaises(ZeroDivisionError, evl.run)
@unittest.skip("not implemented for trio event loop")
def test_run_in_executor(self):
"""Not implemented for trio event loop."""
@unittest.skipUnless(ZMQ_AVAILABLE, "ZMQ is not available")
@unittest.skipIf(IS_WINDOWS, "ZMQEventLoop is not supported under windows")
class ZMQEventLoopTest(unittest.TestCase, EventLoopTestMixin):
def setUp(self):
self.evl = urwid.ZMQEventLoop()
|
