Merge pull request #437 from dvonthenen/httpx-stream-func

Implements Raw Byte Stream Access for Speak REST

Author: davidvonthenen

deepgram/clients/abstract_async_client.py

@@ -60,7 +60,29 @@ async def get(
             **kwargs,
         )
 
-    async def post_file(
+    async def post_raw(
+        self,
+        url: str,
+        options: Optional[Dict] = None,
+        addons: Optional[Dict] = None,
+        headers: Optional[Dict] = None,
+        timeout: Optional[httpx.Timeout] = None,
+        **kwargs,
+    ) -> httpx.Response:
+        """
+        Make a POST request to the specified URL and return response in raw bytes.
+        """
+        return await self._handle_request_raw(
+            "POST",
+            url,
+            params=options,
+            addons=addons,
+            headers=headers,
+            timeout=timeout,
+            **kwargs,
+        )
+
+    async def post_memory(
         self,
         url: str,
         file_result: List,
@@ -69,11 +91,11 @@ async def post_file(
         headers: Optional[Dict] = None,
         timeout: Optional[httpx.Timeout] = None,
         **kwargs,
-    ) -> Dict[str, Union[str, object]]:
+    ) -> Dict[str, Union[str, io.BytesIO]]:
         """
-        Make a POST request to the specified URL and return a file response.
+        Make a POST request to the specified URL and return response in memory.
         """
-        return await self._handle_request_file(
+        return await self._handle_request_memory(
             "POST",
             url,
             file_result=file_result,
@@ -224,7 +246,7 @@ async def _handle_request(
     # pylint: enable-msg=too-many-locals,too-many-branches,too-many-locals
 
     # pylint: disable-msg=too-many-locals,too-many-branches
-    async def _handle_request_file(
+    async def _handle_request_memory(
         self,
         method: str,
         url: str,
@@ -234,7 +256,7 @@ async def _handle_request_file(
         headers: Optional[Dict] = None,
         timeout: Optional[httpx.Timeout] = None,
         **kwargs,
-    ) -> Dict[str, Union[str, object]]:
+    ) -> Dict[str, Union[str, io.BytesIO]]:
         _url = url
         if params is not None:
             _url = append_query_params(_url, params)
@@ -253,7 +275,7 @@ async def _handle_request_file(
                 )
                 response.raise_for_status()
 
-                ret: Dict[str, Union[str, object]] = {}
+                ret: Dict[str, Union[str, io.BytesIO]] = {}
                 for item in file_result:
                     if item in response.headers:
                         ret[item] = response.headers[item]
@@ -288,3 +310,51 @@ async def _handle_request_file(
             raise
 
     # pylint: enable-msg=too-many-locals,too-many-branches
+
+    # pylint: disable-msg=too-many-locals,too-many-branches
+    async def _handle_request_raw(
+        self,
+        method: str,
+        url: str,
+        params: Optional[Dict] = None,
+        addons: Optional[Dict] = None,
+        headers: Optional[Dict] = None,
+        timeout: Optional[httpx.Timeout] = None,
+        **kwargs,
+    ) -> httpx.Response:
+        _url = url
+        if params is not None:
+            _url = append_query_params(_url, params)
+        if addons is not None:
+            _url = append_query_params(_url, addons)
+        _headers = self._config.headers
+        if headers is not None:
+            _headers.update(headers)
+        if timeout is None:
+            timeout = httpx.Timeout(30.0, connect=10.0)
+
+        try:
+            client = httpx.AsyncClient(timeout=timeout)
+            req = client.build_request(method, _url, headers=_headers, **kwargs)
+            return await client.send(req, stream=True)
+
+        except httpx.HTTPError as e1:
+            if isinstance(e1, httpx.HTTPStatusError):
+                status_code = e1.response.status_code or 500
+                try:
+                    json_object = json.loads(e1.response.text)
+                    raise DeepgramApiError(
+                        json_object.get("err_msg"),
+                        str(status_code),
+                        json.dumps(json_object),
+                    ) from e1
+                except json.decoder.JSONDecodeError as e2:
+                    raise DeepgramUnknownApiError(e2.msg, str(status_code)) from e2
+                except ValueError as e2:
+                    raise DeepgramUnknownApiError(str(e2), str(status_code)) from e2
+            else:
+                raise  # pylint: disable-msg=try-except-raise
+        except Exception:  # pylint: disable-msg=try-except-raise
+            raise
+
+    # pylint: enable-msg=too-many-locals,too-many-branches

deepgram/clients/abstract_sync_client.py

@@ -60,7 +60,29 @@ def get(
             **kwargs,
         )
 
-    def post_file(
+    def post_raw(
+        self,
+        url: str,
+        options: Optional[Dict] = None,
+        addons: Optional[Dict] = None,
+        headers: Optional[Dict] = None,
+        timeout: Optional[httpx.Timeout] = None,
+        **kwargs,
+    ) -> httpx.Response:
+        """
+        Make a POST request to the specified URL and return response in raw bytes.
+        """
+        return self._handle_request_raw(
+            "POST",
+            url,
+            params=options,
+            addons=addons,
+            headers=headers,
+            timeout=timeout,
+            **kwargs,
+        )
+
+    def post_memory(
         self,
         url: str,
         file_result: List,
@@ -69,11 +91,11 @@ def post_file(
         headers: Optional[Dict] = None,
         timeout: Optional[httpx.Timeout] = None,
         **kwargs,
-    ) -> Dict[str, Union[str, io.BytesIO, object]]:
+    ) -> Dict[str, Union[str, io.BytesIO]]:
         """
-        Make a POST request to the specified URL and return a file response.
+        Make a POST request to the specified URL and return response in memory.
         """
-        return self._handle_request_file(
+        return self._handle_request_memory(
             "POST",
             url,
             file_result=file_result,
@@ -222,7 +244,7 @@ def _handle_request(
     # pylint: enable-msg=too-many-locals,too-many-branches
 
     # pylint: disable-msg=too-many-branches,too-many-locals
-    def _handle_request_file(
+    def _handle_request_memory(
         self,
         method: str,
         url: str,
@@ -232,7 +254,7 @@ def _handle_request_file(
         headers: Optional[Dict] = None,
         timeout: Optional[httpx.Timeout] = None,
         **kwargs,
-    ) -> Dict[str, Union[str, io.BytesIO, object]]:
+    ) -> Dict[str, Union[str, io.BytesIO]]:
         _url = url
         if params is not None:
             _url = append_query_params(_url, params)
@@ -249,7 +271,7 @@ def _handle_request_file(
                 response = client.request(method, _url, headers=_headers, **kwargs)
                 response.raise_for_status()
 
-                ret: Dict[str, Union[str, object]] = {}
+                ret: Dict[str, Union[str, io.BytesIO]] = {}
                 for item in file_result:
                     if item in response.headers:
                         ret[item] = response.headers[item]
@@ -284,3 +306,51 @@ def _handle_request_file(
             raise
 
     # pylint: disable-msg=too-many-branches,too-many-locals
+
+    # pylint: disable-msg=too-many-branches,too-many-locals
+    def _handle_request_raw(
+        self,
+        method: str,
+        url: str,
+        params: Optional[Dict] = None,
+        addons: Optional[Dict] = None,
+        headers: Optional[Dict] = None,
+        timeout: Optional[httpx.Timeout] = None,
+        **kwargs,
+    ) -> httpx.Response:
+        _url = url
+        if params is not None:
+            _url = append_query_params(_url, params)
+        if addons is not None:
+            _url = append_query_params(_url, addons)
+        _headers = self._config.headers
+        if headers is not None:
+            _headers.update(headers)
+        if timeout is None:
+            timeout = httpx.Timeout(30.0, connect=10.0)
+
+        try:
+            client = httpx.Client(timeout=timeout)
+            req = client.build_request(method, _url, headers=_headers, **kwargs)
+            return client.send(req, stream=True)
+
+        except httpx.HTTPError as e1:
+            if isinstance(e1, httpx.HTTPStatusError):
+                status_code = e1.response.status_code or 500
+                try:
+                    json_object = json.loads(e1.response.text)
+                    raise DeepgramApiError(
+                        json_object.get("err_msg"),
+                        str(status_code),
+                        json.dumps(json_object),
+                    ) from e1
+                except json.decoder.JSONDecodeError as e2:
+                    raise DeepgramUnknownApiError(e2.msg, str(status_code)) from e2
+                except ValueError as e2:
+                    raise DeepgramUnknownApiError(str(e2), str(status_code)) from e2
+            else:
+                raise  # pylint: disable-msg=try-except-raise
+        except Exception:  # pylint: disable-msg=try-except-raise
+            raise
+
+    # pylint: disable-msg=too-many-branches,too-many-locals

deepgram/clients/listen/v1/websocket/options.py

@@ -50,7 +50,8 @@ class LiveOptions(DataClassJsonMixin):  # pylint: disable=too-many-instance-attr
     # since it gets translated to a string to be placed as a query parameter, will keep `str` for now
     # but will change this to `Optional[Union[bool, int]]` in a future release
     endpointing: Optional[Union[str, bool, int]] = field(
-        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
+        default=None,
+        metadata=dataclass_config(exclude=lambda f: f is None),
     )
     # pylint: enable=W0511
     extra: Optional[Union[List[str], str]] = field(
@@ -137,10 +138,18 @@ def check(self):
         logger.setLevel(verboselogs.ERROR)
 
         if self.tier:
-            logger.error(
+            logger.warning(
                 "WARNING: Tier is deprecated. Will be removed in a future version."
             )
 
+        if isinstance(self.endpointing) == str:
+            logger.warning(
+                "WARNING: endpointing's current type previous was `Optional[str]` which is incorrect"
+                " for backward compatibility we are keeping it as `Optional[Union[str, bool, int]]`"
+                " since it gets translated to a string to be placed as a query parameter, will keep `str` for now"
+                " but will change this to `Optional[Union[bool, int]]` in a future release"
+            )
+
         logger.setLevel(prev)
 
         return True