update back to use import optional dependencies

Author: kateforsberg13

griptape/drivers/assistant/openai_assistant_driver.py

@@ -8,6 +8,7 @@
 from griptape.artifacts import BaseArtifact, TextArtifact
 from griptape.drivers.assistant import BaseAssistantDriver
 from griptape.events import EventBus, TextChunkEvent
+from griptape.utils import import_optional_dependency
 from griptape.utils.decorators import lazy_property
 
 if TYPE_CHECKING:
@@ -22,16 +23,16 @@ class OpenAiAssistantDriver(BaseAssistantDriver):
     @staticmethod
     def _create_event_handler_class() -> type[AssistantEventHandler]:  # pyright: ignore[reportInvalidTypeForm]
         """Lazily import and create EventHandler class."""
-        from openai import AssistantEventHandler
+        AssistantEventHandler = import_optional_dependency("openai").AssistantEventHandler
 
         class EventHandler(AssistantEventHandler):
             @override
-            def on_text_delta(self, delta: TextDelta, snapshot: Text) -> None:  # pyright: ignore[reportUndefinedVariable]
+            def on_text_delta(self, delta, snapshot) -> None:  # pyright: ignore[reportUndefinedVariable]
                 if delta.value is not None:
                     EventBus.publish_event(TextChunkEvent(token=delta.value))
 
             @override
-            def on_tool_call_delta(self, delta: ToolCallDelta, snapshot: ToolCall) -> None:  # pyright: ignore[reportUndefinedVariable]
+            def on_tool_call_delta(self, delta, snapshot) -> None:  # pyright: ignore[reportUndefinedVariable]
                 if delta.type == "code_interpreter" and delta.code_interpreter is not None:
                     if delta.code_interpreter.input:
                         EventBus.publish_event(TextChunkEvent(token=delta.code_interpreter.input))
@@ -55,14 +56,13 @@ def on_tool_call_delta(self, delta: ToolCallDelta, snapshot: ToolCall) -> None:
     )
     auto_create_thread: bool = field(default=True, kw_only=True)
 
-    _client: Optional[openai.OpenAI] = field(  # pyright: ignore[reportInvalidTypeForm]
+    _client: Optional[openai.OpenAI] = field(
         default=None, kw_only=True, alias="client", metadata={"serializable": False}
     )
 
     @lazy_property()
-    def client(self) -> openai.OpenAI:  # pyright: ignore[reportInvalidTypeForm]
-        import openai
-
+    def client(self) -> openai.OpenAI:
+        openai = import_optional_dependency("openai")
         return openai.OpenAI(
             base_url=self.base_url,
             api_key=self.api_key,

griptape/drivers/audio_transcription/openai_audio_transcription_driver.py

@@ -7,6 +7,7 @@
 
 from griptape.artifacts import AudioArtifact, TextArtifact
 from griptape.drivers.audio_transcription import BaseAudioTranscriptionDriver
+from griptape.utils import import_optional_dependency
 from griptape.utils.decorators import lazy_property
 
 if TYPE_CHECKING:
@@ -15,19 +16,20 @@
 
 @define
 class OpenAiAudioTranscriptionDriver(BaseAudioTranscriptionDriver):
+    # These defaults were changed from openai.api_type, openai.api_version, and openai.organization
+    # to None because those module-level attributes don't exist in OpenAI SDK v1.0+
     api_type: Optional[str] = field(default=None, kw_only=True)
     api_version: Optional[str] = field(default=None, kw_only=True, metadata={"serializable": True})
     base_url: Optional[str] = field(default=None, kw_only=True, metadata={"serializable": True})
     api_key: Optional[str] = field(default=None, kw_only=True, metadata={"serializable": False})
     organization: Optional[str] = field(default=None, kw_only=True, metadata={"serializable": True})
-    _client: Optional[openai.OpenAI] = field(  # pyright: ignore[reportInvalidTypeForm]
+    _client: Optional[openai.OpenAI] = field(
         default=None, kw_only=True, alias="client", metadata={"serializable": False}
     )
 
     @lazy_property()
-    def client(self) -> openai.OpenAI:  # pyright: ignore[reportInvalidTypeForm]
-        import openai
-
+    def client(self) -> openai.OpenAI:
+        openai = import_optional_dependency("openai")
         return openai.OpenAI(api_key=self.api_key, base_url=self.base_url, organization=self.organization)
 
     def try_run(self, audio: AudioArtifact, prompts: Optional[list[str]] = None) -> TextArtifact:

griptape/drivers/embedding/azure_openai_embedding_driver.py

@@ -6,6 +6,7 @@
 
 from griptape.drivers.embedding.openai import OpenAiEmbeddingDriver
 from griptape.tokenizers import OpenAiTokenizer
+from griptape.utils import import_optional_dependency
 from griptape.utils.decorators import lazy_property
 
 if TYPE_CHECKING:
@@ -43,14 +44,13 @@ class AzureOpenAiEmbeddingDriver(OpenAiEmbeddingDriver):
         default=Factory(lambda self: OpenAiTokenizer(model=self.model), takes_self=True),
         kw_only=True,
     )
-    _client: Optional[openai.AzureOpenAI] = field(  # pyright: ignore[reportInvalidTypeForm]
+    _client: Optional[openai.AzureOpenAI] = field(
         default=None, kw_only=True, alias="client", metadata={"serializable": False}
     )
 
     @lazy_property()
-    def client(self) -> openai.AzureOpenAI:  # pyright: ignore[reportInvalidTypeForm]
-        import openai
-
+    def client(self) -> openai.AzureOpenAI:
+        openai = import_optional_dependency("openai")
         return openai.AzureOpenAI(
             organization=self.organization,
             api_key=self.api_key,

griptape/drivers/embedding/openai_embedding_driver.py

@@ -6,6 +6,7 @@
 
 from griptape.drivers.embedding import BaseEmbeddingDriver
 from griptape.tokenizers import OpenAiTokenizer
+from griptape.utils import import_optional_dependency
 from griptape.utils.decorators import lazy_property
 
 if TYPE_CHECKING:
@@ -40,14 +41,13 @@ class OpenAiEmbeddingDriver(BaseEmbeddingDriver):
         default=Factory(lambda self: OpenAiTokenizer(model=self.model), takes_self=True),
         kw_only=True,
     )
-    _client: Optional[openai.OpenAI] = field(  # pyright: ignore[reportInvalidTypeForm]
+    _client: Optional[openai.OpenAI] = field(
         default=None, kw_only=True, alias="client", metadata={"serializable": False}
     )
 
     @lazy_property()
-    def client(self) -> openai.OpenAI:  # pyright: ignore[reportInvalidTypeForm]
-        import openai
-
+    def client(self) -> openai.OpenAI:
+        openai = import_optional_dependency("openai")
         return openai.OpenAI(api_key=self.api_key, base_url=self.base_url, organization=self.organization)
 
     def try_embed_chunk(self, chunk: str, **kwargs) -> list[float]:

griptape/drivers/image_generation/azure_openai_image_generation_driver.py

@@ -5,6 +5,7 @@
 from attrs import Factory, define, field
 
 from griptape.drivers.image_generation.openai import OpenAiImageGenerationDriver
+from griptape.utils import import_optional_dependency
 from griptape.utils.decorators import lazy_property
 
 if TYPE_CHECKING:
@@ -37,14 +38,13 @@ class AzureOpenAiImageGenerationDriver(OpenAiImageGenerationDriver):
         metadata={"serializable": False},
     )
     api_version: str = field(default="2024-02-01", kw_only=True, metadata={"serializable": True})
-    _client: Optional[openai.AzureOpenAI] = field(  # pyright: ignore[reportInvalidTypeForm]
+    _client: Optional[openai.AzureOpenAI] = field(
         default=None, kw_only=True, alias="client", metadata={"serializable": False}
     )
 
     @lazy_property()
-    def client(self) -> openai.AzureOpenAI:  # pyright: ignore[reportInvalidTypeForm]
-        import openai
-
+    def client(self) -> openai.AzureOpenAI:
+        openai = import_optional_dependency("openai")
         return openai.AzureOpenAI(
             organization=self.organization,
             api_key=self.api_key,

griptape/drivers/image_generation/openai_image_generation_driver.py

@@ -6,6 +6,7 @@
 from attrs import Factory, define, field, fields_dict
 
 from griptape.drivers.image_generation import BaseImageGenerationDriver
+from griptape.utils import import_optional_dependency
 from griptape.utils.decorators import lazy_property
 
 if TYPE_CHECKING:
@@ -40,6 +41,8 @@ class OpenAiImageGenerationDriver(BaseImageGenerationDriver):
         output_format: Optional and only supported for gpt-image-1. Can be either 'png' or 'jpeg'.
     """
 
+    # These defaults were changed from openai.api_type, openai.api_version, and openai.organization
+    # to None because those module-level attributes don't exist in OpenAI SDK v1.0+
     api_type: Optional[str] = field(default=None, kw_only=True)
     api_version: Optional[str] = field(default=None, kw_only=True, metadata={"serializable": True})
     base_url: Optional[str] = field(default=None, kw_only=True, metadata={"serializable": True})
@@ -83,27 +86,23 @@ class OpenAiImageGenerationDriver(BaseImageGenerationDriver):
         kw_only=True,
         metadata={"serializable": True, "model_allowlist": ["gpt-image-1"]},
     )
-    _client: Optional[openai.OpenAI] = field(  # pyright: ignore[reportInvalidTypeForm]
+    _client: Optional[openai.OpenAI] = field(
         default=None, kw_only=True, alias="client", metadata={"serializable": False}
     )
     ignored_exception_types: tuple[type[Exception], ...] = field(
-        default=Factory(lambda self: self._default_ignored_exception_types(), takes_self=True),
+        default=Factory(
+            lambda: (
+                import_optional_dependency("openai").BadRequestError,
+                import_optional_dependency("openai").AuthenticationError,
+                import_optional_dependency("openai").PermissionDeniedError,
+                import_optional_dependency("openai").NotFoundError,
+                import_optional_dependency("openai").ConflictError,
+                import_optional_dependency("openai").UnprocessableEntityError,
+            ),
+        ),
         kw_only=True,
     )
 
-    def _default_ignored_exception_types(self) -> tuple[type[Exception], ...]:
-        """Lazily import openai and return default exception types."""
-        import openai
-
-        return (
-            openai.BadRequestError,
-            openai.AuthenticationError,
-            openai.PermissionDeniedError,
-            openai.NotFoundError,
-            openai.ConflictError,
-            openai.UnprocessableEntityError,
-        )
-
     @image_size.validator  # pyright: ignore[reportAttributeAccessIssue, reportOptionalMemberAccess]
     def validate_image_size(self, attribute: str, value: str | None) -> None:
         """Validates the image size based on the model.
@@ -129,9 +128,8 @@ def validate_image_size(self, attribute: str, value: str | None) -> None:
             raise ValueError(f"Image size, {value}, must be one of the following: {allowed_sizes}")
 
     @lazy_property()
-    def client(self) -> openai.OpenAI:  # pyright: ignore[reportInvalidTypeForm]
-        import openai
-
+    def client(self) -> openai.OpenAI:
+        openai = import_optional_dependency("openai")
         return openai.OpenAI(api_key=self.api_key, base_url=self.base_url, organization=self.organization)
 
     def try_text_to_image(self, prompts: list[str], negative_prompts: Optional[list[str]] = None) -> ImageArtifact:

griptape/drivers/prompt/azure_openai_chat_prompt_driver.py

@@ -5,6 +5,7 @@
 from attrs import Factory, define, field
 
 from griptape.drivers.prompt.openai import OpenAiChatPromptDriver
+from griptape.utils import import_optional_dependency
 from griptape.utils.decorators import lazy_property
 
 if TYPE_CHECKING:
@@ -39,14 +40,13 @@ class AzureOpenAiChatPromptDriver(OpenAiChatPromptDriver):
         metadata={"serializable": False},
     )
     api_version: str = field(default="2024-10-21", kw_only=True, metadata={"serializable": True})
-    _client: Optional[openai.AzureOpenAI] = field(  # pyright: ignore[reportInvalidTypeForm]
+    _client: Optional[openai.AzureOpenAI] = field(
         default=None, kw_only=True, alias="client", metadata={"serializable": False}
     )
 
     @lazy_property()
-    def client(self) -> openai.AzureOpenAI:  # pyright: ignore[reportInvalidTypeForm]
-        import openai
-
+    def client(self) -> openai.AzureOpenAI:
+        openai = import_optional_dependency("openai")
         return openai.AzureOpenAI(
             organization=self.organization,
             api_key=self.api_key,

griptape/drivers/prompt/openai_chat_prompt_driver.py

@@ -30,6 +30,7 @@
 from griptape.configs.defaults_config import Defaults
 from griptape.drivers.prompt import BasePromptDriver
 from griptape.tokenizers import BaseTokenizer, OpenAiTokenizer
+from griptape.utils import import_optional_dependency
 from griptape.utils.decorators import lazy_property
 
 if TYPE_CHECKING:
@@ -92,34 +93,29 @@ class OpenAiChatPromptDriver(BasePromptDriver):
     )
     parallel_tool_calls: bool = field(default=True, kw_only=True, metadata={"serializable": True})
     ignored_exception_types: tuple[type[Exception], ...] = field(
-        default=Factory(lambda self: self._default_ignored_exception_types(), takes_self=True),
+        default=Factory(
+            lambda: (
+                import_optional_dependency("openai").BadRequestError,
+                import_optional_dependency("openai").AuthenticationError,
+                import_optional_dependency("openai").PermissionDeniedError,
+                import_optional_dependency("openai").NotFoundError,
+                import_optional_dependency("openai").ConflictError,
+                import_optional_dependency("openai").UnprocessableEntityError,
+            ),
+        ),
         kw_only=True,
     )
     modalities: list[str] = field(factory=list, kw_only=True, metadata={"serializable": True})
     audio: dict = field(
         default=Factory(lambda: {"voice": "alloy", "format": "pcm16"}), kw_only=True, metadata={"serializable": True}
     )
-    _client: Optional[openai.OpenAI] = field(  # pyright: ignore[reportInvalidTypeForm]
+    _client: Optional[openai.OpenAI] = field(
         default=None, kw_only=True, alias="client", metadata={"serializable": False}
     )
 
-    def _default_ignored_exception_types(self) -> tuple[type[Exception], ...]:
-        """Lazily import openai and return default exception types."""
-        import openai
-
-        return (
-            openai.BadRequestError,
-            openai.AuthenticationError,
-            openai.PermissionDeniedError,
-            openai.NotFoundError,
-            openai.ConflictError,
-            openai.UnprocessableEntityError,
-        )
-
     @lazy_property()
-    def client(self) -> openai.OpenAI:  # pyright: ignore[reportInvalidTypeForm]
-        import openai
-
+    def client(self) -> openai.OpenAI:
+        openai = import_optional_dependency("openai")
         return openai.OpenAI(
             base_url=self.base_url,
             api_key=self.api_key,

griptape/drivers/text_to_speech/azure_openai_text_to_speech_driver.py

@@ -5,6 +5,7 @@
 from attrs import Factory, define, field
 
 from griptape.drivers.text_to_speech.openai import OpenAiTextToSpeechDriver
+from griptape.utils import import_optional_dependency
 from griptape.utils.decorators import lazy_property
 
 if TYPE_CHECKING:
@@ -38,14 +39,13 @@ class AzureOpenAiTextToSpeechDriver(OpenAiTextToSpeechDriver):
         metadata={"serializable": False},
     )
     api_version: str = field(default="2024-07-01-preview", kw_only=True, metadata={"serializable": True})
-    _client: Optional[openai.AzureOpenAI] = field(  # pyright: ignore[reportInvalidTypeForm]
+    _client: Optional[openai.AzureOpenAI] = field(
         default=None, kw_only=True, alias="client", metadata={"serializable": False}
     )
 
     @lazy_property()
-    def client(self) -> openai.AzureOpenAI:  # pyright: ignore[reportInvalidTypeForm]
-        import openai
-
+    def client(self) -> openai.AzureOpenAI:
+        openai = import_optional_dependency("openai")
         return openai.AzureOpenAI(
             organization=self.organization,
             api_key=self.api_key,

griptape/drivers/text_to_speech/openai_text_to_speech_driver.py

@@ -6,6 +6,7 @@
 
 from griptape.artifacts.audio_artifact import AudioArtifact
 from griptape.drivers.text_to_speech import BaseTextToSpeechDriver
+from griptape.utils import import_optional_dependency
 from griptape.utils.decorators import lazy_property
 
 if TYPE_CHECKING:
@@ -21,19 +22,20 @@ class OpenAiTextToSpeechDriver(BaseTextToSpeechDriver):
         metadata={"serializable": True},
     )
     format: Literal["mp3", "opus", "aac", "flac"] = field(default="mp3", kw_only=True, metadata={"serializable": True})
+    # These defaults were changed from openai.api_type, openai.api_version, and openai.organization
+    # to None because those module-level attributes don't exist in OpenAI SDK v1.0+
     api_type: Optional[str] = field(default=None, kw_only=True)
     api_version: Optional[str] = field(default=None, kw_only=True, metadata={"serializable": True})
     base_url: Optional[str] = field(default=None, kw_only=True, metadata={"serializable": True})
     api_key: Optional[str] = field(default=None, kw_only=True)
     organization: Optional[str] = field(default=None, kw_only=True, metadata={"serializable": True})
-    _client: Optional[openai.OpenAI] = field(  # pyright: ignore[reportInvalidTypeForm]
+    _client: Optional[openai.OpenAI] = field(
         default=None, kw_only=True, alias="client", metadata={"serializable": False}
     )
 
     @lazy_property()
-    def client(self) -> openai.OpenAI:  # pyright: ignore[reportInvalidTypeForm]
-        import openai
-
+    def client(self) -> openai.OpenAI:
+        openai = import_optional_dependency("openai")
         return openai.OpenAI(
             api_key=self.api_key,
             base_url=self.base_url,