mirror of
https://github.com/openai/codex.git
synced 2026-05-20 03:05:02 +00:00
## Why
`TurnHandle.run()` returned the raw app-server `Turn`, whose live
start/completed payloads do not include loaded `items`, so users saw
empty `items` after starting a turn. That made the handle-based path
behave differently from `Thread.run(...)`, and pushed examples toward
persisted-thread reads plus helper extraction.
This PR makes the run APIs standalone: starting a turn and running it
returns collected turn data directly, or fails visibly when required
stream events are missing.
## What Changed
- Replaces the public `RunResult` export with `TurnResult`.
- Adds turn metadata to `TurnResult`: `id`, `status`, `error`,
`started_at`, `completed_at`, and `duration_ms`, alongside
`final_response`, `items`, and `usage`.
- Changes `TurnHandle.run()` and `AsyncTurnHandle.run()` to consume
stream events with the same collector used by `Thread.run(...)`.
- Exports `TurnError` from `openai_codex.types` for the new result
shape.
- Updates tests, examples, docs, and the walkthrough notebook to use
`result.final_response` and `result.items` directly.
- Removes persisted-thread helper paths and placeholder/skipped control
flows from the public examples and notebook.
## Verification
- `python3 -m py_compile ...` over changed SDK, example, and test Python
files.
- `python3 -c "import json;
json.load(open('sdk/python/notebooks/sdk_walkthrough.ipynb'))"`
- `git diff --check`
- `PYTHONPATH=sdk/python/src python3 -c ...` import/signature smoke for
`TurnResult`, `TurnHandle.run`, and `AsyncTurnHandle.run`.
170 lines
3.9 KiB
Python
170 lines
3.9 KiB
Python
from __future__ import annotations
|
|
|
|
from collections.abc import AsyncIterator, Iterable, Iterator
|
|
from typing import Any
|
|
|
|
from app_server_harness import (
|
|
ev_assistant_message,
|
|
ev_completed,
|
|
ev_message_item_added,
|
|
ev_output_text_delta,
|
|
ev_response_created,
|
|
sse,
|
|
)
|
|
|
|
from openai_codex.generated.v2_all import (
|
|
AgentMessageDeltaNotification,
|
|
ItemCompletedNotification,
|
|
MessagePhase,
|
|
)
|
|
from openai_codex.models import Notification
|
|
|
|
TINY_PNG_BYTES = bytes(
|
|
[
|
|
137,
|
|
80,
|
|
78,
|
|
71,
|
|
13,
|
|
10,
|
|
26,
|
|
10,
|
|
0,
|
|
0,
|
|
0,
|
|
13,
|
|
73,
|
|
72,
|
|
68,
|
|
82,
|
|
0,
|
|
0,
|
|
0,
|
|
1,
|
|
0,
|
|
0,
|
|
0,
|
|
1,
|
|
8,
|
|
6,
|
|
0,
|
|
0,
|
|
0,
|
|
31,
|
|
21,
|
|
196,
|
|
137,
|
|
0,
|
|
0,
|
|
0,
|
|
11,
|
|
73,
|
|
68,
|
|
65,
|
|
84,
|
|
120,
|
|
156,
|
|
99,
|
|
96,
|
|
0,
|
|
2,
|
|
0,
|
|
0,
|
|
5,
|
|
0,
|
|
1,
|
|
122,
|
|
94,
|
|
171,
|
|
63,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
73,
|
|
69,
|
|
78,
|
|
68,
|
|
174,
|
|
66,
|
|
96,
|
|
130,
|
|
]
|
|
)
|
|
|
|
|
|
def response_approval_policy(response: Any) -> str:
|
|
"""Return serialized approvalPolicy from a generated thread response."""
|
|
return response.model_dump(by_alias=True, mode="json")["approvalPolicy"]
|
|
|
|
|
|
def agent_message_texts(events: list[Notification]) -> list[str]:
|
|
"""Extract completed agent-message text from SDK notifications."""
|
|
texts: list[str] = []
|
|
for event in events:
|
|
if not isinstance(event.payload, ItemCompletedNotification):
|
|
continue
|
|
item = event.payload.item.root
|
|
if item.type == "agentMessage":
|
|
texts.append(item.text)
|
|
return texts
|
|
|
|
|
|
def agent_message_texts_from_items(items: Iterable[Any]) -> list[str]:
|
|
"""Extract agent-message text from completed turn result items."""
|
|
texts: list[str] = []
|
|
for item in items:
|
|
root = item.root
|
|
if root.type == "agentMessage":
|
|
texts.append(root.text)
|
|
return texts
|
|
|
|
|
|
def next_sync_delta(stream: Iterator[Notification]) -> str:
|
|
"""Advance a sync turn stream until the next agent-message text delta."""
|
|
for event in stream:
|
|
if isinstance(event.payload, AgentMessageDeltaNotification):
|
|
return event.payload.delta
|
|
raise AssertionError("stream completed before an agent-message delta")
|
|
|
|
|
|
async def next_async_delta(stream: AsyncIterator[Notification]) -> str:
|
|
"""Advance an async turn stream until the next agent-message text delta."""
|
|
async for event in stream:
|
|
if isinstance(event.payload, AgentMessageDeltaNotification):
|
|
return event.payload.delta
|
|
raise AssertionError("stream completed before an agent-message delta")
|
|
|
|
|
|
def streaming_response(response_id: str, item_id: str, parts: list[str]) -> str:
|
|
"""Build an SSE stream with text deltas and a final assistant message."""
|
|
return sse(
|
|
[
|
|
ev_response_created(response_id),
|
|
ev_message_item_added(item_id),
|
|
*[ev_output_text_delta(part) for part in parts],
|
|
ev_assistant_message(item_id, "".join(parts)),
|
|
ev_completed(response_id),
|
|
]
|
|
)
|
|
|
|
|
|
def assistant_message_with_phase(
|
|
item_id: str,
|
|
text: str,
|
|
phase: MessagePhase,
|
|
) -> dict[str, Any]:
|
|
"""Build an assistant message event carrying app-server phase metadata."""
|
|
event = ev_assistant_message(item_id, text)
|
|
event["item"] = {**event["item"], "phase": phase.value}
|
|
return event
|
|
|
|
|
|
def request_kind(request_path: str) -> str:
|
|
"""Classify captured mock-server request paths for compact assertions."""
|
|
if request_path.endswith("/responses/compact"):
|
|
return "compact"
|
|
if request_path.endswith("/responses"):
|
|
return "responses"
|
|
return request_path
|