File: test_async_helpers.py

package info (click to toggle)
ipython 9.8.0-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 8,624 kB
  • sloc: python: 45,268; sh: 317; makefile: 168
file content (448 lines) | stat: -rw-r--r-- 10,709 bytes parent folder | download
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
446
447
448
"""
Test for async helpers.

Should only trigger on python 3.5+ or will have syntax errors.
"""

from itertools import chain, repeat
from textwrap import dedent, indent
from typing import TYPE_CHECKING
from unittest import TestCase

import pytest

from IPython.core.async_helpers import _should_be_async
from IPython.testing.decorators import skip_without

if TYPE_CHECKING:
    from IPython import get_ipython

    ip = get_ipython()


def iprc(x):
    return ip.run_cell(dedent(x)).raise_error()


def iprc_nr(x):
    return ip.run_cell(dedent(x))


class AsyncTest(TestCase):
    def test_should_be_async(self):
        self.assertFalse(_should_be_async("False"))
        self.assertTrue(_should_be_async("await bar()"))
        self.assertTrue(_should_be_async("x = await bar()"))
        self.assertFalse(
            _should_be_async(
                dedent(
                    """
            async def awaitable():
                pass
        """
                )
            )
        )

    def _get_top_level_cases(self):
        # These are test cases that should be valid in a function
        # but invalid outside of a function.
        test_cases = []
        test_cases.append(("basic", "{val}"))

        # Note, in all conditional cases, I use True instead of
        # False so that the peephole optimizer won't optimize away
        # the return, so CPython will see this as a syntax error:
        #
        # while True:
        #    break
        #    return
        #
        # But not this:
        #
        # while False:
        #    return
        #
        # See https://bugs.python.org/issue1875

        test_cases.append(
            (
                "if",
                dedent(
                    """
        if True:
            {val}
        """
                ),
            )
        )

        test_cases.append(
            (
                "while",
                dedent(
                    """
        while True:
            {val}
            break
        """
                ),
            )
        )

        test_cases.append(
            (
                "try",
                dedent(
                    """
        try:
            {val}
        except:
            pass
        """
                ),
            )
        )

        test_cases.append(
            (
                "except",
                dedent(
                    """
        try:
            pass
        except:
            {val}
        """
                ),
            )
        )

        test_cases.append(
            (
                "finally",
                dedent(
                    """
        try:
            pass
        except:
            pass
        finally:
            {val}
        """
                ),
            )
        )

        test_cases.append(
            (
                "for",
                dedent(
                    """
        for _ in range(4):
            {val}
        """
                ),
            )
        )

        test_cases.append(
            (
                "nested",
                dedent(
                    """
        if True:
            while True:
                {val}
                break
        """
                ),
            )
        )

        test_cases.append(
            (
                "deep-nested",
                dedent(
                    """
        if True:
            while True:
                break
                for x in range(3):
                    if True:
                        while True:
                            for x in range(3):
                                {val}
        """
                ),
            )
        )

        return test_cases

    def _get_ry_syntax_errors(self):
        # This is a mix of tests that should be a syntax error if
        # return or yield whether or not they are in a function

        test_cases = []

        test_cases.append(
            (
                "class",
                dedent(
                    """
        class V:
            {val}
        """
                ),
            )
        )

        test_cases.append(
            (
                "nested-class",
                dedent(
                    """
        class V:
            class C:
                {val}
        """
                ),
            )
        )

        return test_cases

    def test_top_level_return_error(self):
        tl_err_test_cases = self._get_top_level_cases()
        tl_err_test_cases.extend(self._get_ry_syntax_errors())

        vals = (
            "return",
            "yield",
            "yield from (_ for _ in range(3))",
            dedent(
                """
                    def f():
                        pass
                    return
                    """
            ),
        )

        for test_name, test_case in tl_err_test_cases:
            # This example should work if 'pass' is used as the value
            with self.subTest((test_name, "pass")):
                iprc(test_case.format(val="pass"))

            # It should fail with all the values
            for val in vals:
                with self.subTest((test_name, val)):
                    msg = "Syntax error not raised for %s, %s" % (test_name, val)
                    with self.assertRaises(SyntaxError, msg=msg):
                        iprc(test_case.format(val=val))

    def test_in_func_no_error(self):
        # Test that the implementation of top-level return/yield
        # detection isn't *too* aggressive, and works inside a function
        func_contexts = []

        func_contexts.append(
            (
                "func",
                False,
                dedent(
                    """
        def f():"""
                ),
            )
        )

        func_contexts.append(
            (
                "method",
                False,
                dedent(
                    """
        class MyClass:
            def __init__(self):
        """
                ),
            )
        )

        func_contexts.append(
            (
                "async-func",
                True,
                dedent(
                    """
        async def f():"""
                ),
            )
        )

        func_contexts.append(
            (
                "async-method",
                True,
                dedent(
                    """
        class MyClass:
            async def f(self):"""
                ),
            )
        )

        func_contexts.append(
            (
                "closure",
                False,
                dedent(
                    """
        def f():
            def g():
        """
                ),
            )
        )

        def nest_case(context, case):
            # Detect indentation
            lines = context.strip().splitlines()
            prefix_len = 0
            for c in lines[-1]:
                if c != " ":
                    break
                prefix_len += 1

            indented_case = indent(case, " " * (prefix_len + 4))
            return context + "\n" + indented_case

        # Gather and run the tests

        # yield is allowed in async functions, starting in Python 3.6,
        # and yield from is not allowed in any version
        vals = ("return", "yield", "yield from (_ for _ in range(3))")

        success_tests = zip(self._get_top_level_cases(), repeat(False))
        failure_tests = zip(self._get_ry_syntax_errors(), repeat(True))

        tests = chain(success_tests, failure_tests)

        for context_name, async_func, context in func_contexts:
            for (test_name, test_case), should_fail in tests:
                nested_case = nest_case(context, test_case)

                for val in vals:
                    test_id = (context_name, test_name, val)
                    cell = nested_case.format(val=val)

                    with self.subTest(test_id):
                        if should_fail:
                            msg = "SyntaxError not raised for %s" % str(test_id)
                            with self.assertRaises(SyntaxError, msg=msg):
                                iprc(cell)

                                print(cell)
                        else:
                            iprc(cell)

    def test_nonlocal(self):
        # fails if outer scope is not a function scope or if var not defined
        with self.assertRaises(SyntaxError):
            iprc("nonlocal x")
            iprc(
                """
            x = 1
            def f():
                nonlocal x
                x = 10000
                yield x
            """
            )
            iprc(
                """
            def f():
                def g():
                    nonlocal x
                    x = 10000
                    yield x
            """
            )

        # works if outer scope is a function scope and var exists
        iprc(
            """
        def f():
            x = 20
            def g():
                nonlocal x
                x = 10000
                yield x
        """
        )

    def test_execute(self):
        iprc(
            """
        import asyncio
        await asyncio.sleep(0.001)
        """
        )

    def test_autoawait(self):
        iprc("%autoawait False")
        iprc("%autoawait True")
        iprc(
            """
        from asyncio import sleep
        await sleep(0.1)
        """
        )

    def test_memory_error(self):
        """
        The pgen parser in 3.8 or before use to raise MemoryError on too many
        nested parens anymore"""

        iprc("(" * 200 + ")" * 200)

    @pytest.mark.xfail(reason="fail on curio 1.6 and before on Python 3.12")
    @pytest.mark.skip(
        reason="skip_without(curio) fails on 3.12 for now even with other skip so must uncond skip"
    )
    # @skip_without("curio")
    def test_autoawait_curio(self):
        iprc("%autoawait curio")

    @skip_without("trio")
    def test_autoawait_trio(self):
        iprc("%autoawait trio")

    @skip_without("trio")
    def test_autoawait_trio_wrong_sleep(self):
        iprc("%autoawait trio")
        res = iprc_nr(
            """
        import asyncio
        await asyncio.sleep(0)
        """
        )
        with self.assertRaises(TypeError):
            res.raise_error()

    @skip_without("trio")
    def test_autoawait_asyncio_wrong_sleep(self):
        iprc("%autoawait asyncio")
        res = iprc_nr(
            """
        import trio
        await trio.sleep(0)
        """
        )
        with self.assertRaises(RuntimeError):
            res.raise_error()

    def tearDown(self):
        ip.loop_runner = "asyncio"