Don't swallow audio import errors (#302)

Author: twitchard

poetry.lock

@@ -67,6 +67,7 @@ simpleaudio = { version = "^1.0.4", optional = true}
 sounddevice = { version = "^0.4.6", optional = true}
 typing_extensions = ">= 4.0.0"
 websockets = "^13.1"
+exceptiongroup = "^1.3.0"
 
 [tool.poetry.dev-dependencies]
 mypy = "1.0.1"

pyproject.toml

@@ -3,15 +3,19 @@
 
 import asyncio
 from io import BytesIO
+from typing import Optional
+from exceptiongroup import ExceptionGroup
 
 from hume.core.api_error import ApiError
 
+_import_error: Optional[ModuleNotFoundError] = None
 try:
     import pydub.playback
     from pydub import AudioSegment
-    _HAS_AUDIO_DEPENDENCIES = True
-except ModuleNotFoundError:
-    _HAS_AUDIO_DEPENDENCIES = False
+except ModuleNotFoundError as e:
+    _import_error = e
+
+
 
 
 # NOTE:
@@ -26,7 +30,7 @@ async def play_audio(byte_str: bytes) -> None:
     Args:
         byte_str (bytes): Byte string of audio data.
     """
-    if not _HAS_AUDIO_DEPENDENCIES:
-        raise ApiError(body='Run `pip install "hume[microphone]"` to install dependencies required to use audio playback.')
+    if _import_error:
+        raise ExceptionGroup('Run `pip install "hume[microphone]"` to install dependencies required to use audio playback.', [_import_error])
     segment = AudioSegment.from_file(BytesIO(byte_str)) # type: ignore
     await asyncio.to_thread(pydub.playback.play, segment)

src/hume/empathic_voice/chat/audio/audio_utilities.py

@@ -8,22 +8,26 @@
 import contextlib
 import dataclasses
 import logging
-from typing import AsyncIterator, ClassVar, Iterator
+from typing import AsyncIterator, ClassVar, Iterator, List
+from exceptiongroup import ExceptionGroup
 
 from hume.core.api_error import ApiError
 from hume.empathic_voice.chat.audio.asyncio_utilities import Stream
 
+_FAILED_IMPORTS: List[ModuleNotFoundError] = []
+
 try:
     import _cffi_backend as cffi_backend # type: ignore
-    import sounddevice # type: ignore
     from _cffi_backend import \
         _CDataBase as CDataBase  # pylint: disable=no-name-in-module
-    from sounddevice import CallbackFlags, RawInputStream
-
-    _HAS_AUDIO_DEPENDENCIES = True
-except ModuleNotFoundError:
-    _HAS_AUDIO_DEPENDENCIES = False
+except ModuleNotFoundError as e:
+    _FAILED_IMPORTS.append(e)
 
+try:
+    import sounddevice # type: ignore
+    from sounddevice import CallbackFlags, RawInputStream # type: ignore
+except ModuleNotFoundError as e:
+    _FAILED_IMPORTS.append(e)
 
 logger = logging.getLogger(__name__)
 
@@ -50,8 +54,8 @@ def context(cls, *, device: int | None = DEFAULT_DEVICE) -> Iterator["Microphone
         Args:
             device (int | None): Input device ID.
         """
-        if not _HAS_AUDIO_DEPENDENCIES:
-            raise ApiError(body='Run `pip install "hume[microphone]"` to install dependencies required to use microphone playback.')
+        if _FAILED_IMPORTS:
+            raise ExceptionGroup("Importing audio libraries failed. Ensure you have installed the hume[microphone] extra `pip install 'hume[microphone]'` to use audio features.", _FAILED_IMPORTS)
 
         if device is None:
             device = sounddevice.default.device[0]