codex-backend-sdk 0.5.0__tar.gz → 0.5.2__tar.gz

{codex_backend_sdk-0.5.0 → codex_backend_sdk-0.5.2}/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 ## Unreleased
 
+## [0.5.1] - 2026-08-14
+
+### Fixed
+- Preserve ordered nonopaque remote-compaction output items instead of rejecting
+  any response containing more than the required opaque compaction anchor.
+
 ## [0.5.0] - 2026-08-13
 
 ### Added

{codex_backend_sdk-0.5.0 → codex_backend_sdk-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: codex-backend-sdk
-Version: 0.5.0
+Version: 0.5.2
 Summary: Unofficial Python SDK for the ChatGPT Codex backend API
 License: MIT
 License-File: LICENSE

{codex_backend_sdk-0.5.0 → codex_backend_sdk-0.5.2}/codex_backend_sdk/__init__.py

@@ -17,7 +17,7 @@ Quickstart:
     print(response.output_text)
 """
 
-__version__ = "0.5.0"
+__version__ = "0.5.2"
 
 from .oauth import (
     DeviceCode,
@@ -32,6 +32,7 @@ from .resources.remote_control import (
     RemoteControlClient,
     RemoteControlClientPage,
     RemoteControlConnection,
+    RemoteControlConnectionClosed,
     RemoteControlDesktop,
     RemoteControlEnrollment,
     RemoteControlEnvironment,
@@ -120,6 +121,7 @@ __all__ = [
     "RemoteControlClient",
     "RemoteControlClientPage",
     "RemoteControlConnection",
+    "RemoteControlConnectionClosed",
     "RemoteControlDesktop",
     "RemoteControlEnrollment",
     "RemoteControlEnvironment",

{codex_backend_sdk-0.5.0 → codex_backend_sdk-0.5.2}/codex_backend_sdk/resources/remote_control.py

@@ -19,6 +19,10 @@ if TYPE_CHECKING:
 REMOTE_CONTROL_ROOT = "/wham/remote/control"
 
 
+class RemoteControlConnectionClosed(ConnectionError):
+    """The Remote Control peer closed its WebSocket without an envelope."""
+
+
 class RemoteControlEnrollment(CodexBaseModel):
     server_id: str
     environment_id: str
@@ -117,8 +121,16 @@ class RemoteControlConnection:
             raise TypeError("Expected `envelope` to serialize to a JSON object.")
         self._socket.send(json.dumps(payload, separators=(",", ":")))
 
+    def ping(self, payload: bytes = b"") -> None:
+        """Send a WebSocket ping frame to keep the remote path alive."""
+        self._socket.ping(payload)
+
     def receive(self) -> dict[str, Any]:
         message = self._socket.recv()
+        if message in {"", b""}:
+            raise RemoteControlConnectionClosed(
+                "Remote Control WebSocket closed without a final envelope."
+            )
         if isinstance(message, bytes):
             message = message.decode("utf-8")
         payload = json.loads(message)

{codex_backend_sdk-0.5.0 → codex_backend_sdk-0.5.2}/codex_backend_sdk/resources/responses.py

@@ -353,13 +353,13 @@ class Responses:
                 raise RuntimeError("Remote compaction v2 failed")
 
         compaction_items = [item for item in output if item.get("type") == "compaction"]
-        if len(output) != 1 or len(compaction_items) != 1:
+        if len(compaction_items) != 1:
             raise RuntimeError(
-                "Remote compaction v2 expected exactly one compaction output item, "
+                "Remote compaction v2 expected one compaction output item, "
                 f"received {len(compaction_items)} from {len(output)} output items"
             )
         return CompactedResponse(
             id=completed.get("id", ""),
-            output=compaction_items,
+            output=output,
             usage=_usage_from_backend(completed.get("usage")),
         )

{codex_backend_sdk-0.5.0 → codex_backend_sdk-0.5.2}/docs/api-reference.md

@@ -139,10 +139,13 @@ instance. Streaming is not exposed by `parse()`.
 | `text` | object or unset | Text verbosity/format controls. |
 | `tools`, `tool_choice` | JSON-compatible | Tool context retained during compaction. |
 | `parallel_tool_calls`, `prompt_cache_key`, `service_tier` | optional | Forwarded when supplied. |
-Returns `CompactedResponse`. Its `output` contains the single opaque encrypted
-`compaction` item returned by explicit remote compaction v2; `usage` preserves
-backend token accounting. The public helper remains stable even though the
-backend transport moved from `/responses/compact` to `/responses`.
+Returns `CompactedResponse`. Its ordered `output` preserves every item emitted
+by explicit remote compaction v2 and must contain exactly one opaque encrypted
+`compaction` item; `usage` preserves backend token accounting. The current
+backend normally emits only that anchor, but the SDK also retains any nonopaque
+items a future or model-dependent response may carry. The public helper remains
+stable even though the backend transport moved from `/responses/compact` to
+`/responses`.
 
 #### `client.responses.websocket`
 

{codex_backend_sdk-0.5.0 → codex_backend_sdk-0.5.2}/docs/backend-api.md

@@ -271,7 +271,7 @@ explicit remote-compaction-v2 contract on the normal streaming Responses route.
 }
 ```
 
-**Response** — SSE containing exactly one completed compaction item:
+**Response** — SSE currently observed with exactly one completed compaction item:
 ```json
 {
   "id": "resp_...",
@@ -281,6 +281,8 @@ explicit remote-compaction-v2 contract on the normal streaming Responses route.
 }
 ```
 - `output` replaces the original history; pass it as `input` in subsequent calls.
+- The SDK preserves any additional nonopaque output items in their emitted order
+  while still requiring exactly one opaque compaction anchor.
 - The `compaction` item is opaque on the client side.
 
 **SDK method**: `client.responses.compact(...)`

{codex_backend_sdk-0.5.0 → codex_backend_sdk-0.5.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "codex-backend-sdk"
-version = "0.5.0"
+version = "0.5.2"
 description = "Unofficial Python SDK for the ChatGPT Codex backend API"
 readme = "README.md"
 license = { text = "MIT" }

{codex_backend_sdk-0.5.0 → codex_backend_sdk-0.5.2}/tests/test_remote_control_resource.py

@@ -3,13 +3,18 @@ import json
 import pytest
 
 from codex_backend_sdk import OpenAI
-from codex_backend_sdk.resources.remote_control import RemoteControlEnrollment
+from codex_backend_sdk.resources.remote_control import (
+    RemoteControlConnection,
+    RemoteControlConnectionClosed,
+    RemoteControlEnrollment,
+)
 
 
 class FakeSocket:
     def __init__(self):
         self.connected = True
         self.sent = []
+        self.pings = []
         self.received = [json.dumps({"type": "ping", "cursor": "cursor-2"})]
 
     def send(self, message):
@@ -18,6 +23,9 @@ class FakeSocket:
     def recv(self):
         return self.received.pop(0)
 
+    def ping(self, payload=b""):
+        self.pings.append(payload)
+
     def close(self):
         self.connected = False
 
@@ -277,6 +285,7 @@ def test_remote_control_connection_builds_codex_headers_and_tracks_cursor():
         websocket_factory=factory,
     )
     connection.send({"type": "ack", "client_id": "client-1"})
+    connection.ping(b"heartbeat")
     received = connection.receive()
     connection.close()
 
@@ -287,6 +296,25 @@ def test_remote_control_connection_builds_codex_headers_and_tracks_cursor():
     assert "Authorization: Bearer remote-token" in headers
     assert "x-codex-subscribe-cursor: cursor-1" in headers
     assert json.loads(socket.sent[0]) == {"type": "ack", "client_id": "client-1"}
+    assert socket.pings == [b"heartbeat"]
     assert received["type"] == "ping"
     assert connection.subscribe_cursor == "cursor-2"
     assert connection.connected is False
+
+
+@pytest.mark.parametrize("closed_frame", ["", b""])
+def test_remote_control_connection_reports_an_empty_close_frame(closed_frame):
+    socket = FakeSocket()
+    socket.received = [closed_frame]
+    connection = RemoteControlConnection(
+        socket,
+        websocket_url="wss://example.test/remote",
+        enrollment=enrollment(),
+        installation_id="installation-1",
+        server_name="Desktop",
+        protocol_version="3",
+        subscribe_cursor="stale-cursor",
+    )
+
+    with pytest.raises(RemoteControlConnectionClosed, match="closed without"):
+        connection.receive()

{codex_backend_sdk-0.5.0 → codex_backend_sdk-0.5.2}/tests/test_responses_resource.py

@@ -400,6 +400,43 @@ def test_responses_compact_sends_shared_request_fields():
     assert compacted.output == [{"type": "compaction", "encrypted_content": "opaque"}]
 
 
+def test_responses_compact_preserves_nonopaque_output_items_in_backend_order():
+    class PreservingFakeClient(FakeClient):
+        def _post(self, path, *, body, stream=False, **options):
+            self.posts.append((path, body, stream, options))
+            return FakeSSE([
+                (
+                    'data: {"type":"response.output_item.done","item":'
+                    '{"type":"message","role":"assistant","content":'
+                    '[{"type":"output_text","text":"Recent work"}]}}'
+                ),
+                "",
+                (
+                    'data: {"type":"response.output_item.done","item":'
+                    '{"type":"compaction","encrypted_content":"opaque"}}'
+                ),
+                "",
+                (
+                    'data: {"type":"response.completed","response":'
+                    '{"id":"resp_preserved","model":"gpt-test",'
+                    '"usage":{"input_tokens":11,"output_tokens":7,"total_tokens":18}}}'
+                ),
+            ])
+
+    compacted = PreservingFakeClient().responses.compact(
+        input=[{"role": "user", "content": "Long context"}],
+    )
+
+    assert compacted.output == [
+        {
+            "type": "message",
+            "role": "assistant",
+            "content": [{"type": "output_text", "text": "Recent work"}],
+        },
+        {"type": "compaction", "encrypted_content": "opaque"},
+    ]
+
+
 def test_responses_create_rejects_official_params_not_exposed_by_codex_backend():
     client = FakeClient()
 

{codex_backend_sdk-0.5.0 → codex_backend_sdk-0.5.2}/uv.lock

@@ -160,7 +160,7 @@ wheels = [
 
 [[package]]
 name = "codex-backend-sdk"
-version = "0.5.0"
+version = "0.5.2"
 source = { editable = "." }
 dependencies = [
     { name = "pydantic" },