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 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839
|
from __future__ import annotations
import asyncio
import gc
import math
import sys
import time
from asyncio import CancelledError
from collections.abc import AsyncGenerator, Coroutine, Generator
from typing import Any, NoReturn, cast
from unittest import mock
import pytest
from exceptiongroup import catch
from pytest import FixtureRequest, MonkeyPatch
import anyio
from anyio import (
TASK_STATUS_IGNORED,
CancelScope,
create_task_group,
current_effective_deadline,
current_time,
fail_after,
get_cancelled_exc_class,
get_current_task,
move_on_after,
sleep,
sleep_forever,
wait_all_tasks_blocked,
)
from anyio.abc import TaskGroup, TaskStatus
from anyio.lowlevel import checkpoint
from .conftest import asyncio_params
if sys.version_info < (3, 11):
from exceptiongroup import BaseExceptionGroup, ExceptionGroup
pytestmark = pytest.mark.anyio
async def async_error(text: str, delay: float = 0.1) -> NoReturn:
try:
if delay:
await sleep(delay)
finally:
raise Exception(text)
async def test_already_closed() -> None:
async with create_task_group() as tg:
pass
with pytest.raises(RuntimeError) as exc:
tg.start_soon(async_error, "fail")
exc.match("This task group is not active; no new tasks can be started")
async def test_success() -> None:
async def async_add(value: str) -> None:
results.add(value)
results: set[str] = set()
async with create_task_group() as tg:
tg.start_soon(async_add, "a")
tg.start_soon(async_add, "b")
assert results == {"a", "b"}
@pytest.mark.parametrize(
"module",
[
pytest.param(asyncio, id="asyncio"),
pytest.param(pytest.importorskip("trio"), id="trio"),
],
)
def test_run_natively(module: Any) -> None:
async def testfunc() -> None:
async with create_task_group() as tg:
tg.start_soon(sleep, 0)
if module is asyncio:
asyncio.run(testfunc())
else:
module.run(testfunc)
async def test_start_soon_while_running() -> None:
async def task_func() -> None:
tg.start_soon(sleep, 0)
async with create_task_group() as tg:
tg.start_soon(task_func)
async def test_start_soon_after_error() -> None:
with pytest.raises(ExceptionGroup):
async with create_task_group() as tg:
a = 1 / 0 # noqa: F841
with pytest.raises(RuntimeError) as exc:
tg.start_soon(sleep, 0)
exc.match("This task group is not active; no new tasks can be started")
async def test_start_no_value() -> None:
async def taskfunc(*, task_status: TaskStatus) -> None:
task_status.started()
async with create_task_group() as tg:
value = await tg.start(taskfunc)
assert value is None
async def test_start_called_twice() -> None:
async def taskfunc(*, task_status: TaskStatus) -> None:
task_status.started()
with pytest.raises(
RuntimeError, match="called 'started' twice on the same task status"
):
task_status.started()
async with create_task_group() as tg:
value = await tg.start(taskfunc)
assert value is None
async def test_no_called_started_twice() -> None:
async def taskfunc(*, task_status: TaskStatus) -> None:
task_status.started()
async with create_task_group() as tg:
coro = tg.start(taskfunc)
tg.cancel_scope.cancel()
await coro
async def test_start_with_value() -> None:
async def taskfunc(*, task_status: TaskStatus) -> None:
task_status.started("foo")
async with create_task_group() as tg:
value = await tg.start(taskfunc)
assert value == "foo"
async def test_start_crash_before_started_call() -> None:
async def taskfunc(*, task_status: TaskStatus) -> NoReturn:
raise Exception("foo")
async with create_task_group() as tg:
with pytest.raises(Exception) as exc:
await tg.start(taskfunc)
exc.match("foo")
async def test_start_crash_after_started_call() -> None:
async def taskfunc(*, task_status: TaskStatus) -> NoReturn:
task_status.started(2)
raise Exception("foo")
with pytest.raises(ExceptionGroup) as exc:
async with create_task_group() as tg:
value = await tg.start(taskfunc)
assert len(exc.value.exceptions) == 1
assert str(exc.value.exceptions[0]) == "foo"
assert value == 2
async def test_start_no_started_call() -> None:
async def taskfunc(*, task_status: TaskStatus) -> None:
pass
async with create_task_group() as tg:
with pytest.raises(RuntimeError) as exc:
await tg.start(taskfunc)
exc.match("hild exited")
async def test_start_cancelled() -> None:
started = finished = False
async def taskfunc(*, task_status: TaskStatus) -> None:
nonlocal started, finished
started = True
await sleep(2)
finished = True
async with create_task_group() as tg:
tg.cancel_scope.cancel()
await tg.start(taskfunc)
assert started
assert not finished
@pytest.mark.parametrize("anyio_backend", asyncio_params)
async def test_start_native_host_cancelled() -> None:
started = finished = False
async def taskfunc(*, task_status: TaskStatus) -> None:
nonlocal started, finished
started = True
await sleep(2)
finished = True
async def start_another() -> None:
async with create_task_group() as tg:
await tg.start(taskfunc)
task = asyncio.get_running_loop().create_task(start_another())
await wait_all_tasks_blocked()
task.cancel()
with pytest.raises(asyncio.CancelledError):
await task
assert started
assert not finished
@pytest.mark.parametrize("anyio_backend", asyncio_params)
async def test_start_native_child_cancelled() -> None:
task = None
finished = False
async def taskfunc(*, task_status: TaskStatus) -> None:
nonlocal task, finished
task = asyncio.current_task()
await sleep(2)
finished = True
async def start_another() -> None:
async with create_task_group() as tg2:
await tg2.start(taskfunc)
async with create_task_group() as tg:
tg.start_soon(start_another)
await wait_all_tasks_blocked()
assert task is not None
task.cancel()
assert not finished
@pytest.mark.parametrize("anyio_backend", asyncio_params)
async def test_propagate_native_cancellation_from_taskgroup() -> None:
async def taskfunc() -> None:
async with create_task_group() as tg:
tg.start_soon(asyncio.sleep, 2)
task = asyncio.create_task(taskfunc())
await wait_all_tasks_blocked()
task.cancel()
with pytest.raises(asyncio.CancelledError):
await task
@pytest.mark.parametrize("anyio_backend", asyncio_params)
async def test_cancel_with_nested_task_groups() -> None:
"""Regression test for #695."""
async def shield_task() -> None:
with CancelScope(shield=True) as scope:
with mock.patch.object(
scope,
"_deliver_cancellation",
wraps=getattr(scope, "_deliver_cancellation"),
) as shielded_cancel_spy:
await sleep(0.5)
assert len(outer_cancel_spy.call_args_list) < 10
shielded_cancel_spy.assert_not_called()
async def middle_task() -> None:
try:
async with create_task_group() as tg:
with mock.patch.object(
tg.cancel_scope,
"_deliver_cancellation",
wraps=getattr(tg.cancel_scope, "_deliver_cancellation"),
) as middle_cancel_spy:
tg.start_soon(shield_task, name="shield task")
finally:
assert len(middle_cancel_spy.call_args_list) < 10
assert len(outer_cancel_spy.call_args_list) < 10
async with create_task_group() as tg:
with mock.patch.object(
tg.cancel_scope,
"_deliver_cancellation",
wraps=getattr(tg.cancel_scope, "_deliver_cancellation"),
) as outer_cancel_spy:
tg.start_soon(middle_task, name="middle task")
await wait_all_tasks_blocked()
tg.cancel_scope.cancel()
assert len(outer_cancel_spy.call_args_list) < 10
async def test_start_exception_delivery(anyio_backend_name: str) -> None:
def task_fn(*, task_status: TaskStatus = TASK_STATUS_IGNORED) -> None:
task_status.started("hello")
if anyio_backend_name == "trio":
pattern = "appears to be synchronous"
else:
pattern = "is not a coroutine object"
async with anyio.create_task_group() as tg:
with pytest.raises(TypeError, match=pattern):
await tg.start(task_fn) # type: ignore[arg-type]
async def test_start_cancel_after_error() -> None:
"""Regression test for #517."""
sleep_completed = False
async def sleep_and_raise() -> None:
await wait_all_tasks_blocked()
raise RuntimeError("This should cancel the second start() call")
async def sleep_only(task_status: TaskStatus[None]) -> None:
nonlocal sleep_completed
await sleep(1)
sleep_completed = True
task_status.started()
with pytest.raises(ExceptionGroup) as exc:
async with anyio.create_task_group() as outer_tg:
async with anyio.create_task_group() as inner_tg:
inner_tg.start_soon(sleep_and_raise)
await outer_tg.start(sleep_only)
assert isinstance(exc.value.exceptions[0], ExceptionGroup)
assert isinstance(exc.value.exceptions[0].exceptions[0], RuntimeError)
assert not sleep_completed
async def test_host_exception() -> None:
result = None
async def set_result(value: str) -> None:
nonlocal result
await sleep(3)
result = value
with pytest.raises(ExceptionGroup) as exc:
async with create_task_group() as tg:
tg.start_soon(set_result, "a")
raise Exception("dummy error")
assert len(exc.value.exceptions) == 1
assert str(exc.value.exceptions[0]) == "dummy error"
assert result is None
async def test_level_cancellation() -> None:
marker = None
async def dummy() -> None:
nonlocal marker
marker = 1
# At this point the task has been cancelled so sleep() will raise an exception
await checkpoint()
# Execution should never get this far
marker = 2
async with create_task_group() as tg:
tg.start_soon(dummy)
assert marker is None
tg.cancel_scope.cancel()
assert marker == 1
async def test_failing_child_task_cancels_host() -> None:
async def child() -> NoReturn:
await wait_all_tasks_blocked()
raise Exception("foo")
sleep_completed = False
with pytest.raises(ExceptionGroup) as exc:
async with create_task_group() as tg:
tg.start_soon(child)
await sleep(0.5)
sleep_completed = True
assert len(exc.value.exceptions) == 1
assert str(exc.value.exceptions[0]) == "foo"
assert not sleep_completed
async def test_failing_host_task_cancels_children() -> None:
sleep_completed = False
async def child() -> None:
nonlocal sleep_completed
await sleep(1)
sleep_completed = True
with pytest.raises(ExceptionGroup) as exc:
async with create_task_group() as tg:
tg.start_soon(child)
await wait_all_tasks_blocked()
raise Exception("foo")
assert len(exc.value.exceptions) == 1
assert str(exc.value.exceptions[0]) == "foo"
assert not sleep_completed
async def test_cancel_scope_in_another_task() -> None:
local_scope = None
result = False
async def child() -> None:
nonlocal result, local_scope
with CancelScope() as local_scope:
await sleep(2)
result = True
async with create_task_group() as tg:
tg.start_soon(child)
while local_scope is None:
await checkpoint()
local_scope.cancel()
assert not result
async def test_cancel_propagation() -> None:
async def g() -> NoReturn:
async with create_task_group():
await sleep(1)
pytest.fail("Execution should not reach this point")
async with create_task_group() as tg:
tg.start_soon(g)
await checkpoint()
tg.cancel_scope.cancel()
async def test_cancel_twice() -> None:
"""Test that the same task can receive two cancellations."""
async def cancel_group() -> None:
await wait_all_tasks_blocked()
tg.cancel_scope.cancel()
for _ in range(2):
async with create_task_group() as tg:
tg.start_soon(cancel_group)
await sleep(1)
pytest.fail("Execution should not reach this point")
async def test_cancel_exiting_task_group() -> None:
"""
Test that if a task group is waiting for subtasks to finish and it receives a
cancellation, the subtasks are also cancelled and the waiting continues.
"""
cancel_received = False
async def waiter() -> None:
nonlocal cancel_received
try:
await sleep(5)
finally:
cancel_received = True
async def subgroup() -> None:
async with create_task_group() as tg2:
tg2.start_soon(waiter)
async with create_task_group() as tg:
tg.start_soon(subgroup)
await wait_all_tasks_blocked()
tg.cancel_scope.cancel()
assert cancel_received
async def test_cancel_before_entering_scope() -> None:
"""
Test that CancelScope.cancel() is honored even if called before entering the scope.
"""
cancel_scope = anyio.CancelScope()
cancel_scope.cancel()
with cancel_scope:
await anyio.sleep(1) # Checkpoint to allow anyio to check for cancellation
pytest.fail("execution should not reach this point")
async def test_exception_group_children() -> None:
with pytest.raises(BaseExceptionGroup) as exc:
async with create_task_group() as tg:
tg.start_soon(async_error, "task1")
tg.start_soon(async_error, "task2", 0.15)
assert len(exc.value.exceptions) == 2
assert sorted(str(e) for e in exc.value.exceptions) == ["task1", "task2"]
async def test_exception_group_host() -> None:
with pytest.raises(BaseExceptionGroup) as exc:
async with create_task_group() as tg:
tg.start_soon(async_error, "child", 2)
await wait_all_tasks_blocked()
raise Exception("host")
assert len(exc.value.exceptions) == 2
assert sorted(str(e) for e in exc.value.exceptions) == ["child", "host"]
async def test_escaping_cancelled_exception() -> None:
async with create_task_group() as tg:
tg.cancel_scope.cancel()
await checkpoint()
async def test_cancel_scope_cleared() -> None:
with move_on_after(0.1):
await sleep(1)
await checkpoint()
@pytest.mark.parametrize("delay", [0, 0.1], ids=["instant", "delayed"])
async def test_fail_after(delay: float) -> None:
with pytest.raises(TimeoutError):
with fail_after(delay) as scope:
await sleep(1)
assert scope.cancel_called
assert scope.cancelled_caught
async def test_fail_after_no_timeout() -> None:
with fail_after(None) as scope:
assert scope.deadline == float("inf")
await sleep(0.1)
assert not scope.cancel_called
assert not scope.cancelled_caught
async def test_fail_after_after_cancellation() -> None:
event = anyio.Event()
async with anyio.create_task_group() as tg:
tg.cancel_scope.cancel()
await event.wait()
block_complete = False
with pytest.raises(TimeoutError):
with fail_after(0.1):
await anyio.sleep(0.5)
block_complete = True
assert not block_complete
async def test_fail_after_cancelled_before_deadline() -> None:
"""
Test that fail_after() won't raise TimeoutError if its scope is cancelled before the
deadline.
"""
with fail_after(1) as scope:
scope.cancel()
await checkpoint()
@pytest.mark.xfail(
reason="There is currently no way to tell if cancellation happened due to timeout "
"explicitly if the deadline has been exceeded"
)
async def test_fail_after_scope_cancelled_before_timeout() -> None:
with fail_after(0.1) as scope:
scope.cancel()
time.sleep(0.11) # noqa: ASYNC251
await checkpoint()
@pytest.mark.parametrize("delay", [0, 0.1], ids=["instant", "delayed"])
async def test_move_on_after(delay: float) -> None:
result = False
with move_on_after(delay) as scope:
await sleep(1)
result = True
assert not result
assert scope.cancel_called
assert scope.cancelled_caught
async def test_move_on_after_no_timeout() -> None:
result = False
with move_on_after(None) as scope:
assert scope.deadline == float("inf")
await sleep(0.1)
result = True
assert result
assert not scope.cancel_called
async def test_nested_move_on_after() -> None:
sleep_completed = inner_scope_completed = False
with move_on_after(0.1) as outer_scope:
assert current_effective_deadline() == outer_scope.deadline
with move_on_after(1) as inner_scope:
assert current_effective_deadline() == outer_scope.deadline
await sleep(2)
sleep_completed = True
inner_scope_completed = True
assert not sleep_completed
assert not inner_scope_completed
assert outer_scope.cancel_called
assert outer_scope.cancelled_caught
assert not inner_scope.cancel_called
assert not inner_scope.cancelled_caught
async def test_shielding() -> None:
async def cancel_when_ready() -> None:
await wait_all_tasks_blocked()
tg.cancel_scope.cancel()
inner_sleep_completed = outer_sleep_completed = False
async with create_task_group() as tg:
tg.start_soon(cancel_when_ready)
with move_on_after(10, shield=True) as inner_scope:
assert inner_scope.shield
await sleep(0.1)
inner_sleep_completed = True
await sleep(1)
outer_sleep_completed = True
assert inner_sleep_completed
assert not outer_sleep_completed
assert tg.cancel_scope.cancel_called
assert not inner_scope.cancel_called
async def test_cancel_from_shielded_scope() -> None:
async with create_task_group() as tg:
with CancelScope(shield=True) as inner_scope:
assert inner_scope.shield
tg.cancel_scope.cancel()
assert current_effective_deadline() == math.inf
assert not get_current_task().has_pending_cancellation()
await checkpoint()
assert current_effective_deadline() == -math.inf
assert get_current_task().has_pending_cancellation()
with pytest.raises(get_cancelled_exc_class()):
await sleep(0.01)
with pytest.raises(get_cancelled_exc_class()):
await sleep(0.01)
async def test_cancel_shielded_scope() -> None:
with CancelScope(shield=True) as cancel_scope:
assert cancel_scope.shield
cancel_scope.cancel()
assert current_effective_deadline() == -math.inf
assert get_current_task().has_pending_cancellation()
with pytest.raises(get_cancelled_exc_class()):
await checkpoint()
async def test_shielded_cleanup_after_cancel() -> None:
"""Regression test for #832."""
with CancelScope() as outer_scope:
outer_scope.cancel()
try:
await checkpoint()
finally:
assert current_effective_deadline() == -math.inf
assert get_current_task().has_pending_cancellation()
with CancelScope(shield=True): # noqa: ASYNC100
assert current_effective_deadline() == math.inf
assert not get_current_task().has_pending_cancellation()
assert current_effective_deadline() == -math.inf
assert get_current_task().has_pending_cancellation()
@pytest.mark.parametrize("anyio_backend", asyncio_params)
async def test_cleanup_after_native_cancel() -> None:
"""Regression test for #832."""
# See also https://github.com/python/cpython/pull/102815.
task = asyncio.current_task()
assert task
task.cancel()
with pytest.raises(asyncio.CancelledError):
try:
await checkpoint()
finally:
assert not get_current_task().has_pending_cancellation()
async def test_cancelled_not_caught() -> None:
with CancelScope() as scope: # noqa: ASYNC100
scope.cancel()
assert scope.cancel_called
assert not scope.cancelled_caught
async def test_cancelled_scope_based_checkpoint() -> None:
"""Regression test closely related to #698."""
with CancelScope() as outer_scope:
outer_scope.cancel()
# The following three lines are a way to implement a checkpoint function.
# See also https://github.com/python-trio/trio/issues/860.
with CancelScope() as inner_scope:
inner_scope.cancel()
await sleep_forever()
pytest.fail("checkpoint should have raised")
assert not inner_scope.cancelled_caught
assert outer_scope.cancelled_caught
async def test_cancelled_raises_beyond_origin_unshielded() -> None:
with CancelScope() as outer_scope:
with CancelScope() as inner_scope:
inner_scope.cancel()
try:
await checkpoint()
finally:
outer_scope.cancel()
pytest.fail("checkpoint should have raised")
pytest.fail("exiting the inner scope should've raised a cancellation error")
# Here, the outer scope is responsible for the cancellation, so the inner scope
# won't catch the cancellation exception, but the outer scope will
assert not inner_scope.cancelled_caught
assert outer_scope.cancelled_caught
async def test_cancelled_raises_beyond_origin_shielded() -> None:
code_between_scopes_was_run = False
with CancelScope() as outer_scope:
with CancelScope(shield=True) as inner_scope:
inner_scope.cancel()
try:
await checkpoint()
finally:
outer_scope.cancel()
pytest.fail("checkpoint should have raised")
code_between_scopes_was_run = True
# Here, the inner scope is the one responsible for cancellation, and given that the
# outer scope was also cancelled, it is not considered to have "caught" the
# cancellation, even though it swallows it, because the inner scope triggered it
assert code_between_scopes_was_run
assert inner_scope.cancelled_caught
assert not outer_scope.cancelled_caught
async def test_empty_taskgroup_contains_yield_point() -> None:
"""
Test that a task group yields at exit at least once, even with no child tasks to
wait on.
"""
outer_task_ran = False
async def outer_task() -> None:
nonlocal outer_task_ran
outer_task_ran = True
async with create_task_group() as tg_outer:
for _ in range(2): # this is to make sure Trio actually schedules outer_task()
async with create_task_group():
tg_outer.start_soon(outer_task)
assert outer_task_ran
@pytest.mark.parametrize("anyio_backend", asyncio_params)
async def test_cancel_host_asyncgen() -> None:
done = False
async def host_task() -> None:
nonlocal done
with CancelScope() as inner_scope:
inner_scope.cancel()
with pytest.raises(get_cancelled_exc_class()):
await checkpoint()
with pytest.raises(get_cancelled_exc_class()):
await checkpoint()
done = True
async def host_agen_fn() -> AsyncGenerator[None, None]:
await host_task()
yield
pytest.fail("host_agen_fn should only be __anext__ed once")
host_agen = host_agen_fn()
try:
loop = asyncio.get_running_loop()
await loop.create_task(host_agen.__anext__())
finally:
await host_agen.aclose()
assert done
async def test_shielding_immediate_scope_cancelled() -> None:
async def cancel_when_ready() -> None:
await wait_all_tasks_blocked()
scope.cancel()
sleep_completed = False
async with create_task_group() as tg:
with CancelScope(shield=True) as scope:
tg.start_soon(cancel_when_ready)
await sleep(0.5)
sleep_completed = True
assert not sleep_completed
async def test_shielding_mutate() -> None:
completed = False
async def task(task_status: TaskStatus) -> NoReturn:
nonlocal completed
with CancelScope() as scope:
# Enable the shield a little after the scope starts to make this test
# general, even though it has no bearing on the current implementation.
await sleep(0.1)
scope.shield = True
task_status.started()
await sleep(0.1)
completed = True
scope.shield = False
await sleep(1)
pytest.fail("Execution should not reach this point")
async with create_task_group() as tg:
await tg.start(task)
tg.cancel_scope.cancel()
assert completed
async def test_cancel_scope_in_child_task() -> None:
child_scope = None
async def child() -> None:
nonlocal child_scope
with CancelScope() as child_scope:
await sleep(2)
host_done = False
async with create_task_group() as tg:
tg.start_soon(child)
await wait_all_tasks_blocked()
assert child_scope is not None
child_scope.cancel()
await sleep(0.1)
host_done = True
assert host_done
assert not tg.cancel_scope.cancel_called
async def test_exception_cancels_siblings() -> None:
sleep_completed = False
async def child(fail: bool) -> None:
if fail:
raise Exception("foo")
else:
nonlocal sleep_completed
await sleep(1)
sleep_completed = True
with pytest.raises(ExceptionGroup) as exc:
async with create_task_group() as tg:
tg.start_soon(child, False)
await wait_all_tasks_blocked()
tg.start_soon(child, True)
assert len(exc.value.exceptions) == 1
assert str(exc.value.exceptions[0]) == "foo"
assert not sleep_completed
async def test_cancel_cascade() -> None:
async def do_something() -> NoReturn:
async with create_task_group() as tg2:
tg2.start_soon(sleep, 1, name="sleep")
pytest.fail("Execution should not reach this point")
async with create_task_group() as tg:
tg.start_soon(do_something, name="do_something")
await wait_all_tasks_blocked()
tg.cancel_scope.cancel()
async def test_cancelled_parent() -> None:
async def child() -> NoReturn:
with CancelScope():
await sleep(1)
raise Exception("foo")
async def parent(tg: TaskGroup) -> None:
await wait_all_tasks_blocked()
tg.start_soon(child)
async with create_task_group() as tg:
tg.start_soon(parent, tg)
tg.cancel_scope.cancel()
async def test_shielded_deadline() -> None:
with move_on_after(10):
with CancelScope(shield=True):
with move_on_after(1000):
assert current_effective_deadline() - current_time() > 900
await checkpoint()
async def test_deadline_reached_on_start() -> None:
with move_on_after(0):
await checkpoint()
pytest.fail("Execution should not reach this point")
async def test_deadline_moved() -> None:
with fail_after(0.1) as scope:
scope.deadline += 0.3
await sleep(0.2)
async def test_timeout_error_with_multiple_cancellations() -> None:
with pytest.raises(TimeoutError):
with fail_after(0.1):
async with create_task_group() as tg:
tg.start_soon(sleep, 2)
await sleep(2)
async def test_nested_fail_after() -> None:
async def killer(scope: CancelScope) -> None:
await wait_all_tasks_blocked()
scope.cancel()
async with create_task_group() as tg:
with CancelScope() as scope:
with CancelScope():
tg.start_soon(killer, scope)
with fail_after(1):
await sleep(2)
pytest.fail("Execution should not reach this point")
pytest.fail("Execution should not reach this point either")
pytest.fail("Execution should also not reach this point")
assert scope.cancel_called
async def test_nested_shield() -> None:
async def killer(scope: CancelScope) -> None:
await wait_all_tasks_blocked()
scope.cancel()
with pytest.raises(ExceptionGroup) as exc:
async with create_task_group() as tg:
with CancelScope() as scope:
with CancelScope(shield=True):
tg.start_soon(killer, scope)
with fail_after(0.2):
await sleep(2)
assert len(exc.value.exceptions) == 1
assert isinstance(exc.value.exceptions[0], TimeoutError)
async def test_triple_nested_shield_checkpoint_in_outer() -> None:
"""Regression test for #370."""
got_past_checkpoint = False
async def taskfunc() -> None:
nonlocal got_past_checkpoint
with CancelScope() as scope1:
with CancelScope() as scope2:
with CancelScope(shield=True):
scope1.cancel()
scope2.cancel()
await checkpoint()
await checkpoint()
got_past_checkpoint = True
async with create_task_group() as tg:
tg.start_soon(taskfunc)
assert not got_past_checkpoint
async def test_triple_nested_shield_checkpoint_in_middle() -> None:
got_past_checkpoint = False
async def taskfunc() -> None:
nonlocal got_past_checkpoint
with CancelScope() as scope1:
with CancelScope():
with CancelScope(shield=True):
scope1.cancel()
await checkpoint()
await checkpoint()
got_past_checkpoint = True
async with create_task_group() as tg:
tg.start_soon(taskfunc)
assert not got_past_checkpoint
def test_task_group_in_generator(
anyio_backend_name: str, anyio_backend_options: dict[str, Any]
) -> None:
async def task_group_generator() -> AsyncGenerator[None, None]:
async with create_task_group():
yield
gen = task_group_generator()
anyio.run(
gen.__anext__,
backend=anyio_backend_name,
backend_options=anyio_backend_options,
)
pytest.raises(
StopAsyncIteration,
anyio.run,
gen.__anext__,
backend=anyio_backend_name,
backend_options=anyio_backend_options,
)
async def test_exception_group_filtering() -> None:
"""Test that CancelledErrors are filtered out of nested exception groups."""
async def fail(name: str) -> NoReturn:
try:
await anyio.sleep(0.1)
finally:
raise Exception(f"{name} task failed")
async def fn() -> None:
async with anyio.create_task_group() as tg:
tg.start_soon(fail, "parent")
async with anyio.create_task_group() as tg2:
tg2.start_soon(fail, "child")
await anyio.sleep(1)
with pytest.raises(BaseExceptionGroup) as exc:
await fn()
assert len(exc.value.exceptions) == 2
assert str(exc.value.exceptions[0]) == "parent task failed"
assert isinstance(exc.value.exceptions[1], ExceptionGroup)
assert len(exc.value.exceptions[1].exceptions) == 1
assert str(exc.value.exceptions[1].exceptions[0]) == "child task failed"
async def test_cancel_propagation_with_inner_spawn() -> None:
async def g() -> NoReturn:
async with anyio.create_task_group() as tg2:
tg2.start_soon(anyio.sleep, 10)
await anyio.sleep(1)
pytest.fail("Execution should not have reached this line")
async with anyio.create_task_group() as tg:
tg.start_soon(g)
await wait_all_tasks_blocked()
tg.cancel_scope.cancel()
async def test_escaping_cancelled_error_from_cancelled_task() -> None:
"""
Regression test for issue #88. No CancelledError should escape the outer scope.
"""
with CancelScope() as scope:
with move_on_after(0.1):
await sleep(1)
scope.cancel()
@pytest.mark.skipif(
sys.version_info >= (3, 11),
reason="Generator based coroutines have been removed in Python 3.11",
)
@pytest.mark.filterwarnings(
'ignore:"@coroutine" decorator is deprecated:DeprecationWarning'
)
def test_cancel_generator_based_task() -> None:
async def native_coro_part() -> None:
with CancelScope() as scope:
asyncio.get_running_loop().call_soon(scope.cancel)
await asyncio.sleep(1)
pytest.fail("Execution should not have reached this line")
@asyncio.coroutine # type: ignore[attr-defined]
def generator_part() -> Generator[object, BaseException, None]:
yield from native_coro_part() # type: ignore[misc]
anyio.run(generator_part, backend="asyncio")
@pytest.mark.skipif(
sys.version_info >= (3, 11),
reason="Generator based coroutines have been removed in Python 3.11",
)
@pytest.mark.filterwarnings(
'ignore:"@coroutine" decorator is deprecated:DeprecationWarning'
)
@pytest.mark.parametrize("anyio_backend", asyncio_params)
async def test_schedule_old_style_coroutine_func() -> None:
"""
Test that we give a sensible error when a user tries to spawn a task from a
generator-style coroutine function.
"""
@asyncio.coroutine # type: ignore[attr-defined]
def corofunc() -> Generator[Any, Any, None]:
yield from asyncio.sleep(1) # type: ignore[misc]
async with create_task_group() as tg:
funcname = (
f"{__name__}.test_schedule_old_style_coroutine_func.<locals>.corofunc"
)
with pytest.raises(
TypeError,
match=f"Expected {funcname}\\(\\) to return a coroutine, but the return "
f"value \\(<generator .+>\\) is not a coroutine object",
):
tg.start_soon(corofunc)
@pytest.mark.parametrize("anyio_backend", asyncio_params)
async def test_cancel_native_future_tasks() -> None:
async def wait_native_future() -> None:
loop = asyncio.get_running_loop()
await loop.create_future()
async with anyio.create_task_group() as tg:
tg.start_soon(wait_native_future)
tg.cancel_scope.cancel()
@pytest.mark.parametrize("anyio_backend", asyncio_params)
async def test_cancel_native_future_tasks_cancel_scope() -> None:
async def wait_native_future() -> None:
with anyio.CancelScope():
loop = asyncio.get_running_loop()
await loop.create_future()
async with anyio.create_task_group() as tg:
tg.start_soon(wait_native_future)
tg.cancel_scope.cancel()
@pytest.mark.parametrize("anyio_backend", asyncio_params)
async def test_cancel_completed_task() -> None:
loop = asyncio.get_running_loop()
old_exception_handler = loop.get_exception_handler()
exceptions = []
def exception_handler(*args: object, **kwargs: object) -> None:
exceptions.append((args, kwargs))
loop.set_exception_handler(exception_handler)
try:
async def noop() -> None:
pass
async with anyio.create_task_group() as tg:
tg.start_soon(noop)
tg.cancel_scope.cancel()
assert exceptions == []
finally:
loop.set_exception_handler(old_exception_handler)
async def test_task_in_sync_spawn_callback() -> None:
outer_task_id = anyio.get_current_task().id
inner_task_id = None
def task_wrap() -> Coroutine[object, object, None]:
assert anyio.get_current_task().id == outer_task_id
async def corofn() -> None:
nonlocal inner_task_id
inner_task_id = anyio.get_current_task().id
return corofn()
async with create_task_group() as tg:
tg.start_soon(task_wrap)
assert inner_task_id is not None
assert inner_task_id != outer_task_id
async def test_shielded_cancel_sleep_time() -> None:
"""
Test that cancelling a shielded tasks spends more time sleeping than cancelling.
"""
event = anyio.Event()
hang_time = 0.2
async def set_event() -> None:
await sleep(hang_time)
event.set()
async def never_cancel_task() -> None:
with CancelScope(shield=True):
await sleep(0.2)
await event.wait()
async with create_task_group() as tg:
tg.start_soon(set_event)
async with create_task_group() as tg:
tg.start_soon(never_cancel_task)
tg.cancel_scope.cancel()
process_time = time.process_time()
assert (time.process_time() - process_time) < hang_time
async def test_cancelscope_wrong_exit_order() -> None:
"""
Test that a RuntimeError is raised if the task tries to exit cancel scopes in the
wrong order.
"""
scope1 = CancelScope()
scope2 = CancelScope()
scope1.__enter__()
scope2.__enter__()
pytest.raises(RuntimeError, scope1.__exit__, None, None, None)
async def test_cancelscope_exit_before_enter() -> None:
"""
Test that a RuntimeError is raised if one tries to exit a cancel scope before
entering.
"""
scope = CancelScope()
pytest.raises(RuntimeError, scope.__exit__, None, None, None)
@pytest.mark.parametrize(
"anyio_backend", asyncio_params
) # trio does not check for this yet
async def test_cancelscope_exit_in_wrong_task() -> None:
async def enter_scope(scope: CancelScope) -> None:
scope.__enter__()
async def exit_scope(scope: CancelScope) -> None:
scope.__exit__(None, None, None)
scope = CancelScope()
async with create_task_group() as tg:
tg.start_soon(enter_scope, scope)
with pytest.raises(ExceptionGroup) as exc:
async with create_task_group() as tg:
tg.start_soon(exit_scope, scope)
assert len(exc.value.exceptions) == 1
assert str(exc.value.exceptions[0]) == (
"Attempted to exit cancel scope in a different task than it was entered in"
)
def test_unhandled_exception_group(caplog: pytest.LogCaptureFixture) -> None:
def crash() -> NoReturn:
raise KeyboardInterrupt
async def nested() -> None:
async with anyio.create_task_group() as tg:
tg.start_soon(anyio.sleep, 5)
await anyio.sleep(5)
async def main() -> NoReturn:
async with anyio.create_task_group() as tg:
tg.start_soon(nested)
await wait_all_tasks_blocked()
asyncio.get_running_loop().call_soon(crash)
await anyio.sleep(5)
pytest.fail("Execution should never reach this point")
with pytest.raises(KeyboardInterrupt):
anyio.run(main, backend="asyncio")
assert not caplog.messages
async def test_single_cancellation_exc() -> None:
"""
Test that only a single cancellation exception bubbles out of the task group when
case it was cancelled via an outer scope and no actual errors were raised.
"""
with CancelScope() as outer:
try:
async with create_task_group() as tg:
tg.start_soon(sleep, 5)
await wait_all_tasks_blocked()
outer.cancel()
await sleep(5)
except BaseException as exc:
if isinstance(exc, get_cancelled_exc_class()):
raise
pytest.fail(f"Raised the wrong type of exception: {exc}")
else:
pytest.fail("Did not raise a cancellation exception")
async def test_start_soon_parent_id() -> None:
root_task_id = get_current_task().id
parent_id: int | None = None
async def subtask() -> None:
nonlocal parent_id
parent_id = get_current_task().parent_id
async def starter_task() -> None:
tg.start_soon(subtask)
async with anyio.create_task_group() as tg:
tg.start_soon(starter_task)
assert parent_id == root_task_id
async def test_start_parent_id() -> None:
root_task_id = get_current_task().id
starter_task_id: int | None = None
initial_parent_id: int | None = None
permanent_parent_id: int | None = None
async def subtask(*, task_status: TaskStatus) -> None:
nonlocal initial_parent_id, permanent_parent_id
initial_parent_id = get_current_task().parent_id
task_status.started()
permanent_parent_id = get_current_task().parent_id
async def starter_task() -> None:
nonlocal starter_task_id
starter_task_id = get_current_task().id
await tg.start(subtask)
async with anyio.create_task_group() as tg:
tg.start_soon(starter_task)
assert initial_parent_id != permanent_parent_id
assert initial_parent_id == starter_task_id
assert permanent_parent_id == root_task_id
@pytest.mark.skipif(
sys.version_info < (3, 11),
reason="Task uncancelling is only supported on Python 3.11",
)
@pytest.mark.parametrize("anyio_backend", asyncio_params)
class TestUncancel:
async def test_uncancel_after_native_cancel(self) -> None:
task = cast(asyncio.Task, asyncio.current_task())
with pytest.raises(asyncio.CancelledError), CancelScope():
task.cancel()
await checkpoint()
assert task.cancelling() == 1
task.uncancel()
async def test_uncancel_after_scope_cancel(self) -> None:
task = cast(asyncio.Task, asyncio.current_task())
with CancelScope() as scope:
scope.cancel()
await checkpoint()
assert task.cancelling() == 0
async def test_uncancel_after_scope_and_native_cancel(self) -> None:
task = cast(asyncio.Task, asyncio.current_task())
with pytest.raises(asyncio.CancelledError), CancelScope() as scope:
scope.cancel()
task.cancel()
await checkpoint()
assert task.cancelling() == 1
task.uncancel()
async def test_cancel_message_replaced(self) -> None:
task = asyncio.current_task()
assert task
try:
task.cancel()
await checkpoint()
except asyncio.CancelledError:
try:
with CancelScope() as scope:
scope.cancel()
try:
await checkpoint()
except asyncio.CancelledError:
raise asyncio.CancelledError
except asyncio.CancelledError:
pytest.fail("Should have swallowed the CancelledError")
async def test_cancel_counter_nested_scopes(self) -> None:
with CancelScope() as root_scope:
with CancelScope():
root_scope.cancel()
await checkpoint()
assert not cast(asyncio.Task, asyncio.current_task()).cancelling()
async def test_uncancel_after_taskgroup_cancelled(self) -> None:
"""
Test that a cancel scope only uncancels the host task as many times as it has
cancelled that specific task, and won't count child task cancellations towards
that amount.
"""
async def child_task(task_status: TaskStatus[None]) -> None:
async with create_task_group() as tg:
tg.start_soon(sleep, 3)
await wait_all_tasks_blocked()
task_status.started()
task = asyncio.current_task()
assert task
with pytest.raises(CancelledError):
async with create_task_group() as tg:
await tg.start(child_task)
task.cancel()
assert task.cancelling() == 1
async def test_uncancel_after_group_aexit_native_cancel(self) -> None:
"""Closely related to #695."""
done = anyio.Event()
async def shield_task() -> None:
with CancelScope(shield=True):
await done.wait()
async def middle_task() -> None:
async with create_task_group() as tg:
tg.start_soon(shield_task)
task = asyncio.get_running_loop().create_task(middle_task())
try:
await wait_all_tasks_blocked()
task.cancel("native 1")
await sleep(0.1)
task.cancel("native 2")
finally:
done.set()
with pytest.raises(asyncio.CancelledError) as exc:
await task
# Neither native cancellation should have been uncancelled, and the latest
# cancellation message should be the one coming out of the task group.
assert task.cancelling() == 2
assert str(exc.value) == "native 2"
async def test_uncancel_after_child_task_failed(self) -> None:
async def taskfunc() -> None:
raise Exception("dummy error")
with pytest.raises(ExceptionGroup) as exc_info:
async with create_task_group() as tg:
tg.start_soon(taskfunc)
assert len(exc_info.value.exceptions) == 1
assert str(exc_info.value.exceptions[0]) == "dummy error"
assert not cast(asyncio.Task, asyncio.current_task()).cancelling()
async def test_uncancel_cancelled_scope_based_checkpoint(self) -> None:
"""See also test_cancelled_scope_based_checkpoint."""
task = asyncio.current_task()
assert task
with CancelScope() as outer_scope:
outer_scope.cancel()
try:
# The following three lines are a way to implement a checkpoint
# function. See also https://github.com/python-trio/trio/issues/860.
with CancelScope() as inner_scope:
inner_scope.cancel()
await sleep_forever()
finally:
assert isinstance(sys.exc_info()[1], asyncio.CancelledError)
assert task.cancelling()
assert not task.cancelling()
async def test_cancel_before_entering_task_group() -> None:
with CancelScope() as scope:
scope.cancel()
try:
async with create_task_group():
pass
except get_cancelled_exc_class():
pytest.fail("This should not raise a cancellation exception")
async def test_reraise_cancelled_in_excgroup() -> None:
def handler(excgrp: BaseExceptionGroup) -> None:
raise
with CancelScope() as scope:
scope.cancel()
with catch({get_cancelled_exc_class(): handler}):
await anyio.sleep_forever()
async def test_cancel_child_task_when_host_is_shielded() -> None:
# Regression test for #642
# Tests that cancellation propagates to a child task even if the host task is within
# a shielded cancel scope.
cancelled = anyio.Event()
async def wait_cancel() -> None:
try:
await anyio.sleep_forever()
except anyio.get_cancelled_exc_class():
cancelled.set()
raise
with CancelScope() as parent_scope:
async with anyio.create_task_group() as task_group:
task_group.start_soon(wait_cancel)
await wait_all_tasks_blocked()
with CancelScope(shield=True), fail_after(1):
parent_scope.cancel()
await cancelled.wait()
async def test_start_cancels_parent_scope() -> None:
"""Regression test for #685 / #710."""
started: bool = False
async def in_task_group(task_status: TaskStatus[None]) -> None:
nonlocal started
started = True
await sleep_forever()
async with create_task_group() as tg:
with CancelScope() as inner_scope:
inner_scope.cancel()
await tg.start(in_task_group)
assert started
assert not tg.cancel_scope.cancel_called
if sys.version_info >= (3, 14):
async def no_other_refs() -> list[object]:
frame = sys._getframe(1)
coro = get_current_task().coro
async def get_coro_for_frame(*, task_status: TaskStatus[object]) -> None:
my_coro = coro
while my_coro.cr_frame is not frame:
my_coro = my_coro.cr_await
task_status.started(my_coro)
async with create_task_group() as tg:
return [await tg.start(get_coro_for_frame)]
elif sys.version_info >= (3, 11):
async def no_other_refs() -> list[object]:
return []
else:
async def no_other_refs() -> list[object]:
return [sys._getframe(1)]
@pytest.mark.skipif(
sys.implementation.name == "pypy",
reason=(
"gc.get_referrers is broken on PyPy see "
"https://github.com/pypy/pypy/issues/5075"
),
)
class TestRefcycles:
async def test_exception_refcycles_direct(self) -> None:
"""
Test that TaskGroup doesn't keep a reference to the raised ExceptionGroup
Note: This test never failed on anyio, but keeping this test to align
with the tests from cpython.
"""
tg = create_task_group()
exc = None
class _Done(Exception):
pass
try:
async with tg:
raise _Done
except ExceptionGroup as e:
exc = e
assert exc is not None
assert gc.get_referrers(exc) == await no_other_refs()
async def test_exception_refcycles_errors(self) -> None:
"""Test that TaskGroup deletes self._exceptions, and __aexit__ args"""
tg = create_task_group()
exc = None
class _Done(Exception):
pass
try:
async with tg:
raise _Done
except ExceptionGroup as excs:
exc = excs.exceptions[0]
assert isinstance(exc, _Done)
assert gc.get_referrers(exc) == await no_other_refs()
async def test_exception_refcycles_parent_task(self) -> None:
"""Test that TaskGroup's cancel_scope deletes self._host_task"""
tg = create_task_group()
exc = None
class _Done(Exception):
pass
async def coro_fn() -> None:
async with tg:
raise _Done
try:
async with anyio.create_task_group() as tg2:
tg2.start_soon(coro_fn)
except ExceptionGroup as excs:
exc = excs.exceptions[0].exceptions[0]
assert isinstance(exc, _Done)
assert gc.get_referrers(exc) == await no_other_refs()
async def test_exception_refcycles_propagate_cancellation_error(self) -> None:
"""Test that TaskGroup deletes cancelled_exc"""
tg = anyio.create_task_group()
exc = None
with CancelScope() as cs:
cs.cancel()
try:
async with tg:
await checkpoint()
except get_cancelled_exc_class() as e:
exc = e
raise
assert isinstance(exc, get_cancelled_exc_class())
assert gc.get_referrers(exc) == await no_other_refs()
async def test_exception_refcycles_base_error(self) -> None:
"""
Test for BaseExceptions.
anyio doesn't treat these differently so this test is redundant
but copied from CPython's asyncio.TaskGroup tests for completion.
"""
class MyKeyboardInterrupt(KeyboardInterrupt):
pass
tg = create_task_group()
exc = None
try:
async with tg:
raise MyKeyboardInterrupt
except BaseExceptionGroup as excs:
exc = excs.exceptions[0]
assert isinstance(exc, MyKeyboardInterrupt)
assert gc.get_referrers(exc) == await no_other_refs()
class TestTaskStatusTyping:
"""
These tests do not do anything at run time, but since the test suite is also checked
with a static type checker, it ensures that the `TaskStatus` typing works as
intended.
"""
async def typetest_None(*, task_status: TaskStatus[None]) -> None:
task_status.started()
task_status.started(None)
async def typetest_None_Union(*, task_status: TaskStatus[int | None]) -> None:
task_status.started()
task_status.started(None)
async def typetest_non_None(*, task_status: TaskStatus[int]) -> None:
# We use `type: ignore` and `--warn-unused-ignores` to get type checking errors
# if these ever stop failing.
task_status.started() # type: ignore[call-arg]
task_status.started(None) # type: ignore[arg-type]
async def typetest_variance_good(*, task_status: TaskStatus[float]) -> None:
task_status2: TaskStatus[int] = task_status
task_status2.started(0)
async def typetest_variance_bad(*, task_status: TaskStatus[int]) -> None:
# We use `type: ignore` and `--warn-unused-ignores` to get type checking errors
# if these ever stop failing.
task_status2: TaskStatus[float] = task_status # type: ignore[assignment]
task_status2.started(0.0)
async def typetest_optional_status(
*,
task_status: TaskStatus[int] = TASK_STATUS_IGNORED,
) -> None:
task_status.started(1)
@pytest.mark.skipif(
sys.version_info < (3, 12),
reason="Eager task factories require Python 3.12",
)
@pytest.mark.parametrize("anyio_backend", ["asyncio"])
@pytest.mark.parametrize("use_custom_eager_factory", [False, True])
async def test_eager_task_factory(
request: FixtureRequest, use_custom_eager_factory: bool
) -> None:
ran = False
async def sync_coro() -> None:
nonlocal ran
ran = True
# This should trigger fetching the task state
with CancelScope(): # noqa: ASYNC100
pass
def create_custom_task(
coro: Coroutine[Any, Any, Any], /, **kwargs: Any
) -> asyncio.Task[Any]:
return asyncio.Task(coro, **kwargs)
loop = asyncio.get_running_loop()
old_task_factory = loop.get_task_factory()
if use_custom_eager_factory:
loop.set_task_factory(asyncio.create_eager_task_factory(create_custom_task))
else:
loop.set_task_factory(asyncio.eager_task_factory)
request.addfinalizer(lambda: loop.set_task_factory(old_task_factory))
async with create_task_group() as tg:
tg.start_soon(sync_coro)
assert not ran
tg.cancel_scope.cancel()
@pytest.mark.parametrize("anyio_backend", asyncio_params)
async def test_patched_asyncio_task(monkeypatch: MonkeyPatch) -> None:
monkeypatch.setattr(
asyncio,
"Task",
asyncio.tasks._PyTask, # type: ignore[attr-defined]
)
async with create_task_group() as tg:
tg.start_soon(sleep, 0)
|