mirror of
https://github.com/openai/codex.git
synced 2026-05-21 03:33:41 +00:00
f0166cadbb
## 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`.
57 lines
1.8 KiB
Python
57 lines
1.8 KiB
Python
import sys
|
|
from pathlib import Path
|
|
|
|
_EXAMPLES_ROOT = Path(__file__).resolve().parents[1]
|
|
if str(_EXAMPLES_ROOT) not in sys.path:
|
|
sys.path.insert(0, str(_EXAMPLES_ROOT))
|
|
|
|
from _bootstrap import ensure_local_sdk_src, runtime_config
|
|
|
|
ensure_local_sdk_src()
|
|
|
|
from openai_codex import Codex, TextInput
|
|
|
|
with Codex(config=runtime_config()) as codex:
|
|
thread = codex.thread_start(model="gpt-5.4", config={"model_reasoning_effort": "high"})
|
|
turn = thread.turn(TextInput("Explain SIMD in 3 short bullets."))
|
|
|
|
event_count = 0
|
|
saw_started = False
|
|
saw_delta = False
|
|
completed_status = None
|
|
completed_texts = []
|
|
|
|
for event in turn.stream():
|
|
event_count += 1
|
|
if event.method == "turn/started":
|
|
saw_started = True
|
|
print("stream.started")
|
|
continue
|
|
if event.method == "item/agentMessage/delta":
|
|
delta = event.payload.delta
|
|
if delta:
|
|
if not saw_delta:
|
|
print("assistant> ", end="", flush=True)
|
|
print(delta, end="", flush=True)
|
|
saw_delta = True
|
|
continue
|
|
if event.method == "item/completed":
|
|
root = event.payload.item.root
|
|
if root.type == "agentMessage":
|
|
completed_texts.append(root.text)
|
|
continue
|
|
if event.method == "turn/completed":
|
|
completed_status = event.payload.turn.status.value
|
|
|
|
if completed_status is None:
|
|
raise RuntimeError("stream ended without turn/completed")
|
|
if saw_delta:
|
|
print()
|
|
else:
|
|
final_text = "".join(completed_texts).strip()
|
|
print("assistant>", final_text)
|
|
|
|
print("stream.started.seen:", saw_started)
|
|
print("stream.completed:", completed_status)
|
|
print("events.count:", event_count)
|