mirror of
https://github.com/openai/codex.git
synced 2026-05-20 19:23:21 +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`.
81 lines
2.4 KiB
Python
81 lines
2.4 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,
|
|
)
|
|
from openai_codex.types import (
|
|
ThreadTokenUsageUpdatedNotification,
|
|
TurnCompletedNotification,
|
|
)
|
|
|
|
print("Codex mini CLI. Type /exit to quit.")
|
|
|
|
|
|
def _format_usage(usage: object) -> str:
|
|
last = usage.last
|
|
total = usage.total
|
|
return (
|
|
"usage>\n"
|
|
f" last: input={last.input_tokens} output={last.output_tokens} reasoning={last.reasoning_output_tokens} total={last.total_tokens} cached={last.cached_input_tokens}\n"
|
|
f" total: input={total.input_tokens} output={total.output_tokens} reasoning={total.reasoning_output_tokens} total={total.total_tokens} cached={total.cached_input_tokens}"
|
|
)
|
|
|
|
|
|
with Codex(config=runtime_config()) as codex:
|
|
thread = codex.thread_start(model="gpt-5.4", config={"model_reasoning_effort": "high"})
|
|
print("Thread:", thread.id)
|
|
|
|
while True:
|
|
try:
|
|
user_input = input("you> ").strip()
|
|
except EOFError:
|
|
break
|
|
|
|
if not user_input:
|
|
continue
|
|
if user_input in {"/exit", "/quit"}:
|
|
break
|
|
|
|
turn = thread.turn(TextInput(user_input))
|
|
usage = None
|
|
status = None
|
|
error = None
|
|
|
|
print("assistant> ", end="", flush=True)
|
|
for event in turn.stream():
|
|
payload = event.payload
|
|
if event.method == "item/agentMessage/delta":
|
|
delta = payload.delta
|
|
if delta:
|
|
print(delta, end="", flush=True)
|
|
continue
|
|
if isinstance(payload, ThreadTokenUsageUpdatedNotification):
|
|
usage = payload.token_usage
|
|
continue
|
|
if isinstance(payload, TurnCompletedNotification):
|
|
status = payload.turn.status
|
|
error = payload.turn.error
|
|
|
|
print()
|
|
if status is None:
|
|
raise RuntimeError("stream ended without turn/completed")
|
|
if usage is None:
|
|
raise RuntimeError("stream ended without token usage")
|
|
|
|
status_text = status.value
|
|
print(f"assistant.status> {status_text}")
|
|
if status_text == "failed":
|
|
print("assistant.error>", error)
|
|
|
|
print(_format_usage(usage))
|