|
| 1 | +"""Tests for ReasoningDeltaEvent stream event (issue #825).""" |
| 2 | + |
| 3 | +from __future__ import annotations |
| 4 | + |
| 5 | +import pytest |
| 6 | + |
| 7 | +from agents import Agent, Runner |
| 8 | +from agents.stream_events import ReasoningDeltaEvent, RawResponsesStreamEvent |
| 9 | + |
| 10 | +from openai.types.responses.response_reasoning_item import ResponseReasoningItem, Summary |
| 11 | + |
| 12 | +from .fake_model import FakeModel |
| 13 | +from .test_responses import get_text_message |
| 14 | + |
| 15 | + |
| 16 | +def _make_reasoning_item(text: str) -> ResponseReasoningItem: |
| 17 | + return ResponseReasoningItem( |
| 18 | + id="rs_test", |
| 19 | + type="reasoning", |
| 20 | + summary=[Summary(text=text, type="summary_text")], |
| 21 | + ) |
| 22 | + |
| 23 | + |
| 24 | +@pytest.mark.asyncio |
| 25 | +async def test_reasoning_delta_event_emitted_during_streaming() -> None: |
| 26 | + """ReasoningDeltaEvent is emitted when the model streams a reasoning summary delta.""" |
| 27 | + model = FakeModel() |
| 28 | + model.set_next_output([ |
| 29 | + _make_reasoning_item("Let me think..."), |
| 30 | + get_text_message("Answer"), |
| 31 | + ]) |
| 32 | + |
| 33 | + agent = Agent(name="A", model=model) |
| 34 | + result = Runner.run_streamed(agent, input="hi") |
| 35 | + |
| 36 | + reasoning_deltas: list[ReasoningDeltaEvent] = [] |
| 37 | + async for event in result.stream_events(): |
| 38 | + if isinstance(event, ReasoningDeltaEvent): |
| 39 | + reasoning_deltas.append(event) |
| 40 | + |
| 41 | + assert len(reasoning_deltas) >= 1 |
| 42 | + assert all(isinstance(e.delta, str) for e in reasoning_deltas) |
| 43 | + assert all(isinstance(e.snapshot, str) for e in reasoning_deltas) |
| 44 | + assert all(e.type == "reasoning_delta" for e in reasoning_deltas) |
| 45 | + |
| 46 | + |
| 47 | +@pytest.mark.asyncio |
| 48 | +async def test_reasoning_delta_snapshot_accumulates() -> None: |
| 49 | + """The snapshot field grows monotonically across delta events.""" |
| 50 | + model = FakeModel() |
| 51 | + model.set_next_output([ |
| 52 | + _make_reasoning_item("Hello world"), |
| 53 | + get_text_message("done"), |
| 54 | + ]) |
| 55 | + |
| 56 | + agent = Agent(name="A", model=model) |
| 57 | + result = Runner.run_streamed(agent, input="hi") |
| 58 | + |
| 59 | + snapshots: list[str] = [] |
| 60 | + async for event in result.stream_events(): |
| 61 | + if isinstance(event, ReasoningDeltaEvent): |
| 62 | + snapshots.append(event.snapshot) |
| 63 | + |
| 64 | + # Each snapshot must be at least as long as the previous one |
| 65 | + for i in range(1, len(snapshots)): |
| 66 | + assert len(snapshots[i]) >= len(snapshots[i - 1]) |
| 67 | + |
| 68 | + # Last snapshot must contain the full reasoning text |
| 69 | + if snapshots: |
| 70 | + assert "Hello world" in snapshots[-1] |
| 71 | + |
| 72 | + |
| 73 | +@pytest.mark.asyncio |
| 74 | +async def test_no_reasoning_delta_event_without_reasoning() -> None: |
| 75 | + """ReasoningDeltaEvent is not emitted when there is no reasoning in the response.""" |
| 76 | + model = FakeModel() |
| 77 | + model.set_next_output([get_text_message("plain text answer")]) |
| 78 | + |
| 79 | + agent = Agent(name="A", model=model) |
| 80 | + result = Runner.run_streamed(agent, input="hi") |
| 81 | + |
| 82 | + async for event in result.stream_events(): |
| 83 | + assert not isinstance(event, ReasoningDeltaEvent), ( |
| 84 | + "Got unexpected ReasoningDeltaEvent for a plain text response" |
| 85 | + ) |
| 86 | + |
| 87 | + |
| 88 | +@pytest.mark.asyncio |
| 89 | +async def test_reasoning_delta_event_type_field() -> None: |
| 90 | + """ReasoningDeltaEvent.type is always 'reasoning_delta'.""" |
| 91 | + model = FakeModel() |
| 92 | + model.set_next_output([ |
| 93 | + _make_reasoning_item("some reasoning"), |
| 94 | + get_text_message("answer"), |
| 95 | + ]) |
| 96 | + |
| 97 | + agent = Agent(name="A", model=model) |
| 98 | + result = Runner.run_streamed(agent, input="hi") |
| 99 | + |
| 100 | + async for event in result.stream_events(): |
| 101 | + if isinstance(event, ReasoningDeltaEvent): |
| 102 | + assert event.type == "reasoning_delta" |
| 103 | + break |
| 104 | + |
| 105 | + |
| 106 | +@pytest.mark.asyncio |
| 107 | +async def test_raw_response_events_still_emitted_alongside_reasoning_delta() -> None: |
| 108 | + """RawResponsesStreamEvent is still emitted even when ReasoningDeltaEvent is also emitted.""" |
| 109 | + model = FakeModel() |
| 110 | + model.set_next_output([ |
| 111 | + _make_reasoning_item("thinking"), |
| 112 | + get_text_message("result"), |
| 113 | + ]) |
| 114 | + |
| 115 | + agent = Agent(name="A", model=model) |
| 116 | + result = Runner.run_streamed(agent, input="hi") |
| 117 | + |
| 118 | + raw_events: list[RawResponsesStreamEvent] = [] |
| 119 | + reasoning_events: list[ReasoningDeltaEvent] = [] |
| 120 | + |
| 121 | + async for event in result.stream_events(): |
| 122 | + if isinstance(event, RawResponsesStreamEvent): |
| 123 | + raw_events.append(event) |
| 124 | + elif isinstance(event, ReasoningDeltaEvent): |
| 125 | + reasoning_events.append(event) |
| 126 | + |
| 127 | + # Both types should be present |
| 128 | + assert len(raw_events) > 0 |
| 129 | + assert len(reasoning_events) > 0 |
| 130 | + |
| 131 | + |
| 132 | +@pytest.mark.asyncio |
| 133 | +async def test_reasoning_delta_event_importable_from_agents() -> None: |
| 134 | + """ReasoningDeltaEvent can be imported directly from the agents package.""" |
| 135 | + from agents import ReasoningDeltaEvent as RDE |
| 136 | + assert RDE is ReasoningDeltaEvent |
| 137 | + |
| 138 | + |
| 139 | +def test_reasoning_delta_event_dataclass() -> None: |
| 140 | + """ReasoningDeltaEvent is a proper dataclass with expected fields.""" |
| 141 | + event = ReasoningDeltaEvent(delta="chunk", snapshot="full chunk") |
| 142 | + assert event.delta == "chunk" |
| 143 | + assert event.snapshot == "full chunk" |
| 144 | + assert event.type == "reasoning_delta" |
0 commit comments