Make openai optional (#91)

Author: samuelcolvin

.github/workflows/ci.yml

@@ -80,7 +80,15 @@ jobs:
         with:
           enable-cache: true
 
-      - run: uv run --python 3.12 --frozen --extra vertexai --extra groq pytest tests/test_live.py -v --durations=100
+      - run: >
+          uv run
+          --python 3.12
+          --frozen
+          --extra openai
+          --extra vertexai
+          --extra groq
+          pytest tests/test_live.py -v
+          --durations=100
         env:
           PYDANTIC_AI_LIVE_TEST_DANGEROUS: 'CHARGE-ME!'
           OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
@@ -171,8 +179,6 @@ jobs:
     environment: release
 
     permissions:
-      # necessary while private, see https://github.com/actions/checkout/issues/254#issuecomment-1961296625
-      contents: read
       id-token: write
 
     steps:

docs/install.md

@@ -19,7 +19,7 @@ To use Logfire with PydanticAI, install PydanticAI with the `logfire` optional g
 pip/uv-add 'pydantic-ai[logfire]'
 ```
 
-From there, follow the [Logfire setup cods](logfire.md#integrating-logfire) to configure Logfire.
+From there, follow the [Logfire setup docs](logfire.md#integrating-logfire) to configure Logfire.
 
 ## Running Examples
 
@@ -31,4 +31,4 @@ To install extra dependencies required to run examples, install the `examples` o
 pip/uv-add 'pydantic-ai[examples]'
 ```
 
-For next steps, follow the instructions [in the examples](examples/index.md).
+To run the examples, follow instructions [in the examples](examples/index.md).

pydantic_ai/models/groq.py

@@ -6,10 +6,6 @@
 from datetime import datetime, timezone
 from typing import Literal, overload
 
-from groq import NOT_GIVEN, AsyncGroq, AsyncStream
-from groq.types import chat
-from groq.types.chat import ChatCompletion, ChatCompletionChunk
-from groq.types.chat.chat_completion_chunk import ChoiceDeltaToolCall
 from httpx import AsyncClient as AsyncHTTPClient
 from typing_extensions import assert_never
 
@@ -36,6 +32,17 @@
     check_allow_model_requests,
 )
 
+try:
+    from groq import NOT_GIVEN, AsyncGroq, AsyncStream
+    from groq.types import chat
+    from groq.types.chat import ChatCompletion, ChatCompletionChunk
+    from groq.types.chat.chat_completion_chunk import ChoiceDeltaToolCall
+except ImportError as e:
+    raise ImportError(
+        'Please install `groq` to use the Groq model, '
+        "you can use the `groq` optional group — `pip install 'pydantic-ai[groq]'`"
+    ) from e
+
 GroqModelName = Literal[
     'llama-3.1-70b-versatile',
     'llama3-groq-70b-8192-tool-use-preview',

pydantic_ai/models/openai.py

@@ -7,10 +7,6 @@
 from typing import Literal, overload
 
 from httpx import AsyncClient as AsyncHTTPClient
-from openai import NOT_GIVEN, AsyncOpenAI, AsyncStream
-from openai.types import ChatModel, chat
-from openai.types.chat import ChatCompletionChunk
-from openai.types.chat.chat_completion_chunk import ChoiceDeltaToolCall
 from typing_extensions import assert_never
 
 from .. import UnexpectedModelBehavior, _utils, result
@@ -36,6 +32,17 @@
     check_allow_model_requests,
 )
 
+try:
+    from openai import NOT_GIVEN, AsyncOpenAI, AsyncStream
+    from openai.types import ChatModel, chat
+    from openai.types.chat import ChatCompletionChunk
+    from openai.types.chat.chat_completion_chunk import ChoiceDeltaToolCall
+except ImportError as e:
+    raise ImportError(
+        'Please install `openai` to use the OpenAI model, '
+        "you can use the `openai` optional group — `pip install 'pydantic-ai[openai]'`"
+    ) from e
+
 
 @dataclass(init=False)
 class OpenAIModel(Model):

pyproject.toml

@@ -38,28 +38,22 @@ dependencies = [
     "griffe>=1.3.2",
     "httpx>=0.27.2",
     "logfire-api>=1.2.0",
-    "openai>=1.54.3",
     "pydantic>=2.10",
 ]
 
 [project.optional-dependencies]
-vertexai = [
-    "google-auth>=2.36.0",
-    "requests>=2.32.3",
-]
-logfire = [
-    "logfire>=2.3",
-]
+openai = ["openai>=1.54.3"]
+vertexai = ["google-auth>=2.36.0", "requests>=2.32.3"]
+groq = ["groq>=0.12.0"]
+logfire = ["logfire>=2.3"]
 examples = [
     "asyncpg>=0.30.0",
     "fastapi>=0.115.4",
     "logfire[asyncpg,fastapi]>=2.3",
     "python-multipart>=0.0.17",
     "rich>=13.9.2",
     "uvicorn>=0.32.0",
-]
-groq = [
-    "groq>=0.12.0",
+    "pydantic-ai[openai,vertexai,groq]",
 ]
 
 [dependency-groups]

tests/models/test_model.py

@@ -1,27 +1,18 @@
-from typing import TYPE_CHECKING
-
 import pytest
 
 from pydantic_ai import UserError
 from pydantic_ai.models import infer_model
 from pydantic_ai.models.gemini import GeminiModel
-from pydantic_ai.models.openai import OpenAIModel
-from tests.conftest import TestEnv
-
-if TYPE_CHECKING:
-    from pydantic_ai.models.vertexai import VertexAIModel
+from tests.conftest import TestEnv, try_import
 
-    google_auth_installed = True
+with try_import() as openai_imports_successful:
+    from pydantic_ai.models.openai import OpenAIModel
 
-else:
-    try:
-        from pydantic_ai.models.vertexai import VertexAIModel
-    except ImportError:
-        google_auth_installed = False
-    else:
-        google_auth_installed = True
+with try_import() as vertexai_imports_successful:
+    from pydantic_ai.models.vertexai import VertexAIModel
 
 
+@pytest.mark.skipif(not openai_imports_successful(), reason='openai not installed')
 def test_infer_str_openai(env: TestEnv):
     env.set('OPENAI_API_KEY', 'via-env-var')
     m = infer_model('openai:gpt-3.5-turbo')
@@ -39,7 +30,7 @@ def test_infer_str_gemini(env: TestEnv):
     assert m.name() == 'gemini-1.5-flash'
 
 
-@pytest.mark.skipif(not google_auth_installed, reason='google-auth not installed')
+@pytest.mark.skipif(not vertexai_imports_successful(), reason='google-auth not installed')
 def test_infer_vertexai(env: TestEnv):
     m = infer_model('vertexai:gemini-1.5-flash')
     assert isinstance(m, VertexAIModel)

tests/models/test_openai.py

@@ -9,18 +9,6 @@
 
 import pytest
 from inline_snapshot import snapshot
-from openai import AsyncOpenAI
-from openai.types import chat
-from openai.types.chat.chat_completion import Choice
-from openai.types.chat.chat_completion_chunk import (
-    Choice as ChunkChoice,
-    ChoiceDelta,
-    ChoiceDeltaToolCall,
-    ChoiceDeltaToolCallFunction,
-)
-from openai.types.chat.chat_completion_message import ChatCompletionMessage
-from openai.types.chat.chat_completion_message_tool_call import Function
-from openai.types.completion_usage import CompletionUsage, PromptTokensDetails
 from typing_extensions import TypedDict
 
 from pydantic_ai import Agent, ModelRetry, UnexpectedModelBehavior, _utils
@@ -34,11 +22,29 @@
     ToolReturn,
     UserPrompt,
 )
-from pydantic_ai.models.openai import OpenAIModel
 from pydantic_ai.result import Cost
-from tests.conftest import IsNow
+from tests.conftest import IsNow, try_import
+
+with try_import() as imports_successful:
+    from openai import AsyncOpenAI
+    from openai.types import chat
+    from openai.types.chat.chat_completion import Choice
+    from openai.types.chat.chat_completion_chunk import (
+        Choice as ChunkChoice,
+        ChoiceDelta,
+        ChoiceDeltaToolCall,
+        ChoiceDeltaToolCallFunction,
+    )
+    from openai.types.chat.chat_completion_message import ChatCompletionMessage
+    from openai.types.chat.chat_completion_message_tool_call import Function
+    from openai.types.completion_usage import CompletionUsage, PromptTokensDetails
+
+    from pydantic_ai.models.openai import OpenAIModel
 
-pytestmark = pytest.mark.anyio
+pytestmark = [
+    pytest.mark.skipif(not imports_successful(), reason='openai not installed'),
+    pytest.mark.anyio,
+]
 
 
 def test_init():