mirror of
https://github.com/openai/codex.git
synced 2026-05-16 09:12:54 +00:00
b4bc02439f
## Why The SDK package root should be the ergonomic public client API, not a dump of every generated app-server schema type. Generated models still need a supported import path, but callers should be able to tell which names are high-level SDK entrypoints and which names are protocol value models. ## What - Define a curated root `__all__` for clients, handles, input helpers, retry helpers, config, and public errors. - Add a `types` module as the supported home for generated app-server response, event, enum, and helper models. - Update docs and examples to import protocol/value models from the type module. - Add tests that lock root exports, type-module exports, star-import behavior, and example import hygiene. ## Stack 1. #21891 `[1/8]` Pin Python SDK runtime dependency 2. #21893 `[2/8]` Generate Python SDK types from pinned runtime 3. #21895 `[3/8]` Run Python SDK tests in CI 4. This PR `[4/8]` Define Python SDK public API surface 5. #21905 `[5/8]` Rename Python SDK package to `openai-codex` 6. #21910 `[6/8]` Add high-level Python SDK approval mode 7. #22014 `[7/8]` Add Python SDK app-server integration harness 8. #22021 `[8/8]` Add Python SDK Ruff formatting ## Verification - Added public API signature tests for root exports, `types` exports, and example imports. --------- Co-authored-by: Codex <noreply@openai.com>
81 lines
2.3 KiB
Python
81 lines
2.3 KiB
Python
import json
|
|
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 (
|
|
assistant_text_from_turn,
|
|
ensure_local_sdk_src,
|
|
find_turn_by_id,
|
|
runtime_config,
|
|
)
|
|
|
|
ensure_local_sdk_src()
|
|
|
|
from codex_app_server import (
|
|
Codex,
|
|
TextInput,
|
|
)
|
|
from codex_app_server.types import (
|
|
AskForApproval,
|
|
Personality,
|
|
ReasoningSummary,
|
|
)
|
|
|
|
OUTPUT_SCHEMA = {
|
|
"type": "object",
|
|
"properties": {
|
|
"summary": {"type": "string"},
|
|
"actions": {
|
|
"type": "array",
|
|
"items": {"type": "string"},
|
|
},
|
|
},
|
|
"required": ["summary", "actions"],
|
|
"additionalProperties": False,
|
|
}
|
|
|
|
SUMMARY = ReasoningSummary.model_validate("concise")
|
|
|
|
PROMPT = (
|
|
"Analyze a safe rollout plan for enabling a feature flag in production. "
|
|
"Return JSON matching the requested schema."
|
|
)
|
|
APPROVAL_POLICY = AskForApproval.model_validate("never")
|
|
|
|
with Codex(config=runtime_config()) as codex:
|
|
thread = codex.thread_start(model="gpt-5.4", config={"model_reasoning_effort": "high"})
|
|
|
|
turn = thread.turn(
|
|
TextInput(PROMPT),
|
|
approval_policy=APPROVAL_POLICY,
|
|
output_schema=OUTPUT_SCHEMA,
|
|
personality=Personality.pragmatic,
|
|
summary=SUMMARY,
|
|
)
|
|
result = turn.run()
|
|
persisted = thread.read(include_turns=True)
|
|
persisted_turn = find_turn_by_id(persisted.thread.turns, result.id)
|
|
structured_text = assistant_text_from_turn(persisted_turn).strip()
|
|
try:
|
|
structured = json.loads(structured_text)
|
|
except json.JSONDecodeError as exc:
|
|
raise RuntimeError(f"Expected JSON matching OUTPUT_SCHEMA, got: {structured_text!r}") from exc
|
|
|
|
summary = structured.get("summary")
|
|
actions = structured.get("actions")
|
|
if not isinstance(summary, str) or not isinstance(actions, list) or not all(
|
|
isinstance(action, str) for action in actions
|
|
):
|
|
raise RuntimeError(f"Expected structured output with string summary/actions, got: {structured!r}")
|
|
|
|
print("Status:", result.status)
|
|
print("summary:", summary)
|
|
print("actions:")
|
|
for action in actions:
|
|
print("-", action)
|
|
print("Items:", 0 if persisted_turn is None else len(persisted_turn.items or []))
|