c18277043e
## What changed Replace the selectable personality templates in the bundled `gpt-5.4` and `gpt-5.5` definitions with fixed friendly instructions. Personality selection becomes unavailable for these models in the TUI, and submitted turns omit the personality override. Remove personality overrides from Python SDK examples and the walkthrough notebook. ## Testing Update core and TUI tests to cover fixed friendly instructions, ignored pragmatic updates, unavailable personality selection, and omitted turn overrides. Preserve coverage for selectable personalities in legacy catalogs, and add coverage for resumed legacy sessions and explicit empty instruction overrides. GitOrigin-RevId: 869a71445584272405fcbd1325efc31c224808c8
Python SDK Examples
Each example folder contains runnable versions:
sync.py(public sync surface:Codex)async.py(public async surface:AsyncCodex)
All examples intentionally use only public SDK exports from openai_codex
and openai_codex.types.
Examples use plain strings for text-only turns and typed input objects for multimodal or structured input lists.
Use ExternalMessage for untrusted content from another agent, tool, or
application. It retains tool-level authority and does not grant user
authorization or approval; example 16 establishes the user's task first.
Prerequisites
- Python
>=3.10 - Install the SDK for the same Python interpreter you will use to run examples
Install the published SDK:
python -m pip install openai-codex
The SDK installs its pinned openai-codex-cli-bin runtime dependency.
The pinned runtime version comes from the SDK package dependency.
Run From A Checkout
Contributors using these checked-in scripts should install development
dependencies from sdk/python:
uv sync --group dev
source .venv/bin/activate
The examples bootstrap local SDK imports from sdk/python/src. If the pinned
runtime is not already installed, the bootstrap installs the matching runtime
package for the active interpreter and cleans up temporary files afterward.
Run examples
From sdk/python:
python examples/<example-folder>/sync.py
python examples/<example-folder>/async.py
The checked-in examples use the local SDK source tree automatically.
Recommended first run
python examples/01_quickstart_constructor/sync.py
python examples/01_quickstart_constructor/async.py
Index
01_quickstart_constructor/- first run / sanity check
02_turn_run/- inspect full turn output fields
03_turn_stream_events/- stream a turn with a small curated event view
04_models_and_metadata/- discover visible models for the connected runtime
05_existing_thread/- resume a real existing thread (created in-script)
06_thread_lifecycle_and_controls/- thread lifecycle + control calls
07_image_and_text/- image data URL + text multimodal turn
08_local_image_and_text/- local image + text multimodal turn using a generated temporary sample image
09_async_parity/- parity-style sync flow (see async parity in other examples)
10_error_handling_and_retry/- overload retry pattern + typed error handling structure
11_cli_mini_app/- interactive chat loop
12_turn_params_kitchen_sink/- structured output with a curated advanced
turn(...)configuration
- structured output with a curated advanced
13_model_select_and_turn_params/- list models, pick highest model + highest supported reasoning effort, run turns, print message and usage
14_turn_controls/- separate
steer()andinterrupt()demos with concise summaries
- separate
15_login_and_account/- browser-login handle lifecycle, cancellation, and account inspection
16_external_message/- process an untrusted external notification within a user-authorized task