Update OpenAI package version and enhance client creation error handling

Author: btfranklin

pdm.lock

@@ -6,7 +6,7 @@ authors = [
     {name = "B.T. Franklin", email = "[email protected]"},
 ]
 dependencies = [
-    "openai>=1.57.0",
+    "openai>=2.1.0",
     "python-dotenv>=1.0.1",
     "click>=8.1.7",
 ]

pyproject.toml

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import os
-
 from dotenv import load_dotenv
 from openai import OpenAI
 
@@ -25,7 +24,13 @@ def create_openai_client(*, timeout: int | None = None) -> OpenAI:
     client_kwargs: dict[str, object] = {"api_key": api_key}
     client_kwargs["timeout"] = timeout or DEFAULT_TIMEOUT_SECONDS
 
-    return OpenAI(**client_kwargs)
+    client = OpenAI(**client_kwargs)
+    if not hasattr(client, "responses"):
+        raise RuntimeError(
+            "Installed openai package does not expose the Responses API. "
+            "Upgrade to a newer openai release (e.g. `pip install -U openai`)."
+        )
+    return client
 
 
 __all__ = ["create_openai_client", "MissingAPIKeyError"]

src/compendiumscribe/create_llm_clients.py

@@ -9,7 +9,6 @@
 from typing import Any, Iterable
 
 from openai import OpenAI
-
 from .model import Compendium
 
 
@@ -272,7 +271,11 @@ def _execute_deep_research(
     return response
 
 
-def _await_completion(client: OpenAI, response: Any, config: ResearchConfig):
+def _await_completion(
+    client: OpenAI,
+    response: Any,
+    config: ResearchConfig,
+):
     attempts = 0
     current = response
 

src/compendiumscribe/research_domain.py

@@ -1,20 +1,16 @@
-from types import SimpleNamespace
+from __future__ import annotations
 
 import pytest
 
-from compendiumscribe.create_llm_clients import (
-    MissingAPIKeyError,
-    create_openai_client,
-)
+from compendiumscribe.create_llm_clients import create_openai_client
 
 
-class DummyOpenAI:
-    def __init__(self, **kwargs):
-        self.kwargs = kwargs
+def test_create_openai_client_requires_responses_support(monkeypatch):
+    class DummyOpenAI:
+        def __init__(self, **_kwargs):
+            pass
 
-
-def test_create_openai_client_requires_api_key(monkeypatch):
-    monkeypatch.delenv("OPENAI_API_KEY", raising=False)
+    monkeypatch.setenv("OPENAI_API_KEY", "test-key")
     monkeypatch.setattr(
         "compendiumscribe.create_llm_clients.load_dotenv",
         lambda: None,
@@ -24,25 +20,36 @@ def test_create_openai_client_requires_api_key(monkeypatch):
         DummyOpenAI,
     )
 
-    with pytest.raises(MissingAPIKeyError):
+    with pytest.raises(RuntimeError) as exc_info:
         create_openai_client()
 
+    assert "Responses API" in str(exc_info.value)
+
 
-def test_create_openai_client_uses_timeout(monkeypatch):
-    monkeypatch.setenv("OPENAI_API_KEY", "sk-test")
-    captured = {}
+def test_create_openai_client_returns_native_client(monkeypatch):
+    instances: list[object] = []
 
-    def fake_openai(**kwargs):
-        captured.update(kwargs)
-        return SimpleNamespace(**kwargs)
+    class DummyResponses:
+        pass
 
+    class DummyOpenAI:
+        def __init__(self, **kwargs):
+            self.kwargs = kwargs
+            self.responses = DummyResponses()
+            instances.append(self)
+
+    monkeypatch.setenv("OPENAI_API_KEY", "test-key")
+    monkeypatch.setattr(
+        "compendiumscribe.create_llm_clients.load_dotenv",
+        lambda: None,
+    )
     monkeypatch.setattr(
         "compendiumscribe.create_llm_clients.OpenAI",
-        fake_openai,
+        DummyOpenAI,
     )
 
     client = create_openai_client(timeout=123)
 
-    assert captured["api_key"] == "sk-test"
-    assert captured["timeout"] == 123
-    assert client.api_key == "sk-test"
+    assert client is instances[0]
+    assert isinstance(client.responses, DummyResponses)
+    assert instances[0].kwargs["timeout"] == 123