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
|
from __future__ import annotations
import gc
import sys
from typing import NoReturn
import pytest
from anyio import (
BrokenResourceError,
CancelScope,
ClosedResourceError,
EndOfStream,
WouldBlock,
create_memory_object_stream,
create_task_group,
fail_after,
wait_all_tasks_blocked,
)
from anyio.abc import ObjectReceiveStream, ObjectSendStream, TaskStatus
from anyio.streams.memory import (
MemoryObjectItemReceiver,
MemoryObjectReceiveStream,
MemoryObjectSendStream,
)
from ..conftest import asyncio_params
if sys.version_info < (3, 11):
from exceptiongroup import ExceptionGroup
def test_invalid_max_buffer() -> None:
pytest.raises(ValueError, create_memory_object_stream, 1.0).match(
"max_buffer_size must be either an integer or math.inf"
)
def test_negative_max_buffer() -> None:
pytest.raises(ValueError, create_memory_object_stream, -1).match(
"max_buffer_size cannot be negative"
)
async def test_receive_then_send() -> None:
async def receiver() -> None:
received_objects.append(await receive.receive())
received_objects.append(await receive.receive())
send, receive = create_memory_object_stream[str](0)
received_objects: list[str] = []
async with create_task_group() as tg:
tg.start_soon(receiver)
await wait_all_tasks_blocked()
await send.send("hello")
await send.send("anyio")
assert received_objects == ["hello", "anyio"]
send.close()
receive.close()
async def test_receive_then_send_nowait() -> None:
async def receiver() -> None:
received_objects.append(await receive.receive())
send, receive = create_memory_object_stream[str](0)
received_objects: list[str] = []
async with create_task_group() as tg:
tg.start_soon(receiver)
tg.start_soon(receiver)
await wait_all_tasks_blocked()
send.send_nowait("hello")
send.send_nowait("anyio")
assert sorted(received_objects, reverse=True) == ["hello", "anyio"]
send.close()
receive.close()
async def test_send_then_receive_nowait() -> None:
send, receive = create_memory_object_stream[str](0)
async with create_task_group() as tg:
tg.start_soon(send.send, "hello")
await wait_all_tasks_blocked()
assert receive.receive_nowait() == "hello"
send.close()
receive.close()
async def test_send_is_unblocked_after_receive_nowait() -> None:
send, receive = create_memory_object_stream[str](1)
send.send_nowait("hello")
with fail_after(1):
async with create_task_group() as tg:
tg.start_soon(send.send, "anyio")
await wait_all_tasks_blocked()
assert receive.receive_nowait() == "hello"
assert receive.receive_nowait() == "anyio"
send.close()
receive.close()
async def test_send_nowait_then_receive_nowait() -> None:
send, receive = create_memory_object_stream[str](2)
send.send_nowait("hello")
send.send_nowait("anyio")
assert receive.receive_nowait() == "hello"
assert receive.receive_nowait() == "anyio"
send.close()
receive.close()
async def test_iterate() -> None:
async def receiver() -> None:
received_objects.extend([item async for item in receive])
send, receive = create_memory_object_stream[str]()
received_objects: list[str] = []
async with create_task_group() as tg:
tg.start_soon(receiver)
await send.send("hello")
await send.send("anyio")
await send.aclose()
assert received_objects == ["hello", "anyio"]
send.close()
receive.close()
async def test_receive_send_closed_send_stream() -> None:
send, receive = create_memory_object_stream[None]()
await send.aclose()
with pytest.raises(EndOfStream):
receive.receive_nowait()
with pytest.raises(ClosedResourceError):
await send.send(None)
receive.close()
async def test_receive_send_closed_receive_stream() -> None:
send, receive = create_memory_object_stream[None]()
await receive.aclose()
with pytest.raises(ClosedResourceError):
receive.receive_nowait()
with pytest.raises(BrokenResourceError):
await send.send(None)
send.close()
async def test_cancel_receive() -> None:
send, receive = create_memory_object_stream[str]()
async with create_task_group() as tg:
tg.start_soon(receive.receive)
await wait_all_tasks_blocked()
tg.cancel_scope.cancel()
with pytest.raises(WouldBlock):
send.send_nowait("hello")
send.close()
receive.close()
async def test_cancel_send() -> None:
send, receive = create_memory_object_stream[str]()
async with create_task_group() as tg:
tg.start_soon(send.send, "hello")
await wait_all_tasks_blocked()
tg.cancel_scope.cancel()
with pytest.raises(WouldBlock):
receive.receive_nowait()
send.close()
receive.close()
async def test_clone() -> None:
send1, receive1 = create_memory_object_stream[str](1)
send2 = send1.clone()
receive2 = receive1.clone()
await send1.aclose()
await receive1.aclose()
send2.send_nowait("hello")
assert receive2.receive_nowait() == "hello"
send1.close()
receive1.close()
send2.close()
receive2.close()
async def test_clone_closed() -> None:
send, receive = create_memory_object_stream[NoReturn](1)
await send.aclose()
await receive.aclose()
pytest.raises(ClosedResourceError, send.clone)
pytest.raises(ClosedResourceError, receive.clone)
async def test_close_send_while_receiving() -> None:
send, receive = create_memory_object_stream[NoReturn](1)
with pytest.raises(ExceptionGroup) as exc:
async with create_task_group() as tg:
tg.start_soon(receive.receive)
await wait_all_tasks_blocked()
await send.aclose()
assert len(exc.value.exceptions) == 1
assert isinstance(exc.value.exceptions[0], EndOfStream)
send.close()
receive.close()
async def test_close_receive_while_sending() -> None:
# We send None here as a regression test for #731
send, receive = create_memory_object_stream[None](0)
with pytest.raises(ExceptionGroup) as exc:
async with create_task_group() as tg:
tg.start_soon(send.send, None)
await wait_all_tasks_blocked()
await receive.aclose()
assert len(exc.value.exceptions) == 1
assert isinstance(exc.value.exceptions[0], BrokenResourceError)
send.close()
receive.close()
async def test_receive_after_send_closed() -> None:
send, receive = create_memory_object_stream[str](1)
await send.send("hello")
await send.aclose()
assert await receive.receive() == "hello"
send.close()
receive.close()
async def test_receive_when_cancelled() -> None:
"""
Test that calling receive() in a cancelled scope prevents it from going through with
the operation.
"""
send, receive = create_memory_object_stream[str]()
async with create_task_group() as tg:
tg.start_soon(send.send, "hello")
await wait_all_tasks_blocked()
tg.start_soon(send.send, "world")
await wait_all_tasks_blocked()
with CancelScope() as scope:
scope.cancel()
await receive.receive()
assert await receive.receive() == "hello"
assert await receive.receive() == "world"
send.close()
receive.close()
async def test_send_when_cancelled() -> None:
"""
Test that calling send() in a cancelled scope prevents it from going through with
the operation.
"""
async def receiver() -> None:
received.append(await receive.receive())
received: list[str] = []
send, receive = create_memory_object_stream[str]()
async with create_task_group() as tg:
tg.start_soon(receiver)
with CancelScope() as scope:
scope.cancel()
await send.send("hello")
await send.send("world")
assert received == ["world"]
send.close()
receive.close()
async def test_cancel_during_receive() -> None:
"""
Test that cancelling a pending receive() operation does not cause an item in the
stream to be lost.
"""
async def scoped_receiver(task_status: TaskStatus[CancelScope]) -> None:
with CancelScope() as cancel_scope:
task_status.started(cancel_scope)
received.append(await receive.receive())
assert cancel_scope.cancel_called
received: list[str] = []
send, receive = create_memory_object_stream[str]()
with send, receive:
async with create_task_group() as tg:
receiver_scope = await tg.start(scoped_receiver)
await wait_all_tasks_blocked()
send.send_nowait("hello")
receiver_scope.cancel()
assert received == ["hello"]
async def test_cancel_during_receive_buffered() -> None:
"""
Test that sending an item to a memory object stream when the receiver that is next
in line has been cancelled will not result in the item being lost.
"""
async def scoped_receiver(
receive: MemoryObjectReceiveStream[str], task_status: TaskStatus[CancelScope]
) -> None:
with CancelScope() as cancel_scope:
task_status.started(cancel_scope)
await receive.receive()
send, receive = create_memory_object_stream[str](1)
with send, receive:
async with create_task_group() as tg:
cancel_scope = await tg.start(scoped_receiver, receive)
await wait_all_tasks_blocked()
cancel_scope.cancel()
send.send_nowait("item")
# Since the item was not sent to the cancelled task, it should be available here
assert receive.receive_nowait() == "item"
async def test_close_receive_after_send() -> None:
async def send() -> None:
async with send_stream:
await send_stream.send("test")
async def receive() -> None:
async with receive_stream:
assert await receive_stream.receive() == "test"
send_stream, receive_stream = create_memory_object_stream[str]()
async with create_task_group() as tg:
tg.start_soon(send)
tg.start_soon(receive)
send_stream.close()
receive_stream.close()
async def test_statistics() -> None:
send_stream, receive_stream = create_memory_object_stream[None](1)
streams: list[MemoryObjectReceiveStream[None] | MemoryObjectSendStream[None]] = [
send_stream,
receive_stream,
]
for stream in streams:
statistics = stream.statistics()
assert statistics.max_buffer_size == 1
assert statistics.current_buffer_used == 0
assert statistics.open_send_streams == 1
assert statistics.open_receive_streams == 1
assert statistics.tasks_waiting_send == 0
assert statistics.tasks_waiting_receive == 0
for stream in streams:
async with create_task_group() as tg:
# Test tasks_waiting_send
send_stream.send_nowait(None)
assert stream.statistics().current_buffer_used == 1
tg.start_soon(send_stream.send, None)
await wait_all_tasks_blocked()
assert stream.statistics().current_buffer_used == 1
assert stream.statistics().tasks_waiting_send == 1
receive_stream.receive_nowait()
assert stream.statistics().current_buffer_used == 1
assert stream.statistics().tasks_waiting_send == 0
receive_stream.receive_nowait()
assert stream.statistics().current_buffer_used == 0
# Test tasks_waiting_receive
tg.start_soon(receive_stream.receive)
await wait_all_tasks_blocked()
assert stream.statistics().tasks_waiting_receive == 1
send_stream.send_nowait(None)
assert stream.statistics().tasks_waiting_receive == 0
async with create_task_group() as tg:
# Test tasks_waiting_send
send_stream.send_nowait(None)
assert stream.statistics().tasks_waiting_send == 0
for _ in range(3):
tg.start_soon(send_stream.send, None)
await wait_all_tasks_blocked()
assert stream.statistics().tasks_waiting_send == 3
for i in range(2, -1, -1):
receive_stream.receive_nowait()
assert stream.statistics().tasks_waiting_send == i
receive_stream.receive_nowait()
assert stream.statistics().current_buffer_used == 0
assert stream.statistics().tasks_waiting_send == 0
assert stream.statistics().tasks_waiting_receive == 0
send_stream.close()
receive_stream.close()
async def test_sync_close() -> None:
send_stream, receive_stream = create_memory_object_stream[None](1)
with send_stream, receive_stream:
pass
with pytest.raises(ClosedResourceError):
send_stream.send_nowait(None)
with pytest.raises(ClosedResourceError):
receive_stream.receive_nowait()
async def test_type_variance() -> None:
"""
This test does not do anything at run time, but since the test suite is also checked
with a static type checker, it ensures that the memory object stream
co/contravariance works as intended. If it doesn't, one or both of the following
reassignments will trip the type checker.
"""
send, receive = create_memory_object_stream[float]()
receive1: MemoryObjectReceiveStream[complex] = receive # noqa: F841
receive2: ObjectReceiveStream[complex] = receive # noqa: F841
send1: MemoryObjectSendStream[int] = send # noqa: F841
send2: ObjectSendStream[int] = send # noqa: F841
send.close()
receive.close()
async def test_deprecated_item_type_parameter() -> None:
with pytest.warns(DeprecationWarning, match="item_type argument has been "):
send, receive = create_memory_object_stream(item_type=int)
send.close()
receive.close()
async def test_not_closed_warning() -> None:
send, receive = create_memory_object_stream[int]()
with pytest.warns(
ResourceWarning, match="Unclosed <MemoryObjectSendStream at [0-9a-f]+>"
):
del send
gc.collect()
with pytest.warns(
ResourceWarning, match="Unclosed <MemoryObjectReceiveStream at [0-9a-f]+>"
):
del receive
gc.collect()
@pytest.mark.parametrize("anyio_backend", asyncio_params)
async def test_send_to_natively_cancelled_receiver() -> None:
"""
Test that if a task waiting on receive.receive() is cancelled and then another
task sends an item, said item is not delivered to the task with a pending
cancellation, but rather to the next one in line.
"""
from asyncio import CancelledError, create_task
send, receive = create_memory_object_stream[str](1)
with send, receive:
receive_task = create_task(receive.receive())
await wait_all_tasks_blocked() # ensure that the task is waiting to receive
receive_task.cancel()
send.send_nowait("hello")
with pytest.raises(CancelledError):
await receive_task
assert receive.receive_nowait() == "hello"
async def test_memory_object_item_receiver_repr() -> None:
"""
Test the repr of `MemoryObjectItemReceiver`.
Since when `item` is not set, the default dataclass repr raises an AttributeError.
"""
receiver = MemoryObjectItemReceiver[str]()
assert str(receiver) is not None
receiver_repr = repr(receiver)
assert "item=None" in receiver_repr
assert str(receiver) is not None
receiver.item = "test_item"
receiver_repr = repr(receiver)
assert "item='test_item'" in receiver_repr
|