codex - 💡(How to fix) Fix openai-codex-sdk: FileChangeItem.status Literal rejects 'in_progress' from streaming patch updates [1 participants]

TL;DR

Update the PatchApplyStatus type in openai_codex_sdk/types.py to include the "in_progress" state to fix the ValidationError.

Guidance

• Verify that the error occurs due to the PatchApplyStatus type not allowing the "in_progress" state by checking the error message and the openai_codex_sdk/types.py file.
• Update the PatchApplyStatus type to include the "in_progress" state, as suggested in the issue: PatchApplyStatus = Literal["in_progress", "completed", "failed"].
• Alternatively, apply the provided workaround by monkey-patching the PatchApplyStatus type and rebuilding the FileChangeItem model before opening a thread.
• Test the fix by running the agent-mode call that previously caused the error and verify that the ValidationError is no longer raised.

Example

The suggested fix can be applied by modifying the openai_codex_sdk/types.py file:

PatchApplyStatus = Literal["in_progress", "completed", "failed"]

Or by using the provided workaround:

from typing import Literal
from openai_codex_sdk import types as _t
_t.PatchApplyStatus = Literal["in_progress", "completed", "failed"]
_t.FileChangeItem.model_fields["status"].annotation = _t.PatchApplyStatus
_t.FileChangeItem.model_rebuild(force=True)

Notes

The fix assumes that the "in_progress" state is a valid state for the PatchApplyStatus type. If this is not the case, further investigation may be required to determine the correct set of states.

Recommendation

Apply the workaround by monkey-patching the PatchApplyStatus type and rebuilding the FileChangeItem model, as this provides a temporary solution until the openai_codex_sdk library is updated to include the correct set of states for the PatchApplyStatus type.