feldera 0.131.0__py3-none-any.whl → 0.192.0__py3-none-any.whl

feldera/rest/config.py

@@ -1,33 +1,44 @@
-from typing import Optional
-
-
-class Config:
-    """
-    :class:`.FelderaClient`'s credentials and configuration parameters
-    """
-
-    def __init__(
-        self,
-        url: str,
-        api_key: Optional[str] = None,
-        version: Optional[str] = None,
-        timeout: Optional[float] = None,
-        connection_timeout: Optional[float] = None,
-        requests_verify: bool = True,
-    ) -> None:
-        """
-        :param url: The url to the Feldera API (ex: https://try.feldera.com)
-        :param api_key: The optional API key to access Feldera
-        :param version: The version of the API to use
-        :param timeout: The timeout for the HTTP requests
-        :param connection_timeout: The connection timeout for the HTTP requests
-        :param requests_verify: The `verify` parameter passed to the requests
-            library. `True` by default.
-        """
-
-        self.url: str = url
-        self.api_key: Optional[str] = api_key
-        self.version: Optional[str] = version or "v0"
-        self.timeout: Optional[float] = timeout
-        self.connection_timeout: Optional[float] = connection_timeout
-        self.requests_verify: bool = requests_verify
+import logging
+import os
+from typing import Optional
+
+from feldera.rest._helpers import requests_verify_from_env
+
+
+class Config:
+    """
+    :class:`.FelderaClient` configuration, which includes authentication information
+    and the address of the Feldera API the client will interact with.
+    """
+
+    def __init__(
+        self,
+        url: Optional[str] = None,
+        api_key: Optional[str] = None,
+        version: Optional[str] = None,
+        timeout: Optional[float] = None,
+        connection_timeout: Optional[float] = None,
+        requests_verify: Optional[bool | str] = None,
+        health_recovery_timeout: Optional[int] = None,
+    ) -> None:
+        """
+        See documentation of the `FelderaClient` constructor for the other arguments.
+
+        :param version: (Optional) Version of the API to use.
+            Default: `v0`.
+        :param health_recovery_timeout: (Optional) Maximum time in seconds to wait for cluster health recovery after a 502 error.
+            Default: `300` (5 minutes).
+        """
+        self.url: str = url or os.environ.get("FELDERA_HOST") or "http://localhost:8080"
+        self.api_key: Optional[str] = api_key or os.environ.get("FELDERA_API_KEY")
+        self.version: str = version or "v0"
+        self.timeout: Optional[float] = timeout
+        self.connection_timeout: Optional[float] = connection_timeout
+        self.health_recovery_timeout: int = health_recovery_timeout or 300
+        env_verify = requests_verify_from_env()
+        self.requests_verify: bool | str = (
+            requests_verify if requests_verify is not None else env_verify
+        )
+
+        if self.requests_verify is False:
+            logging.warning("Feldera client: TLS verification is disabled!")

feldera/rest/errors.py

@@ -1,5 +1,6 @@
 from requests import Response
 import json
+from urllib.parse import urlparse
 
 
 class FelderaError(Exception):
@@ -40,6 +41,21 @@ class FelderaAPIError(FelderaError):
                 self.details = json_data.get("details")
             except Exception:
                 self.message = request.text
+                err_msg += request.text
+
+        err_msg += f"\nResponse Status: {request.status_code}"
+
+        if int(request.status_code) == 401:
+            parsed = urlparse(request.request.url)
+
+            auth_err = f"\nAuthorization error: Failed to connect to '{parsed.scheme}://{parsed.hostname}': "
+            auth = request.request.headers.get("Authorization")
+            if auth is None:
+                err_msg += f"{auth_err} API key not set"
+            else:
+                err_msg += f"{auth_err} invalid API key"
+
+        err_msg = err_msg.strip()
 
         super().__init__(err_msg)