zscaler-sdk-python 1.2.4__tar.gz → 1.4.0__tar.gz

{zscaler_sdk_python-1.2.4 → zscaler_sdk_python-1.4.0}/PKG-INFO

@@ -1,29 +1,29 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 1.2.4
+Version: 1.4.0
 Summary: Official Python SDK for the Zscaler Products
 Home-page: https://github.com/zscaler/zscaler-sdk-python
 License: MIT
 Keywords: zscaler,sdk,zpa,zia,zdx,zcc,ztw,zwa
 Author: Zscaler, Inc.
 Author-email: devrel@zscaler.com
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.9.2,<4.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
 Classifier: Topic :: Security
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Provides-Extra: dev
 Requires-Dist: aenum (>=3.1.11)
 Requires-Dist: arrow (>=1.3.0)
-Requires-Dist: cryptography (>=43.0.0)
+Requires-Dist: cryptography (>=45.0.2)
 Requires-Dist: flatdict (>=4.0.0)
 Requires-Dist: pydash (>=8.0.3)
 Requires-Dist: pyjwt (>=2.8.0)

{zscaler_sdk_python-1.2.4 → zscaler_sdk_python-1.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zscaler-sdk-python"
-version = "1.2.4"
+version = "1.4.0"
 description = "Official Python SDK for the Zscaler Products"
 authors = ["Zscaler, Inc. <devrel@zscaler.com>"]
 license = "MIT"
@@ -28,9 +28,9 @@ packages = [
 "Bug Tracker" = "https://github.com/zscaler/zscaler-sdk-python/issues"
 
 [tool.poetry.dependencies]
-python = ">=3.9,<4.0"
+python = ">=3.9.2,<4.0"
 requests = ">=2.32.3"
-cryptography = ">=43.0.0"
+cryptography = ">=45.0.2"
 pyyaml = ">=6.0.0"
 pytz = ">=2024.2"
 python-box = ">=7.3.0"

{zscaler_sdk_python-1.2.4 → zscaler_sdk_python-1.4.0}/zscaler/__init__.py

@@ -29,7 +29,7 @@ __license__ = "MIT"
 __contributors__ = [
     "William Guilherme",
 ]
-__version__ = "1.2.4"
+__version__ = "1.4.0"
 
 
 from zscaler.oneapi_client import Client as ZscalerClient  # noqa

zscaler_sdk_python-1.4.0/zscaler/errors/http_error.py

@@ -0,0 +1,10 @@
+class HTTPError(Exception):
+    def __init__(self, url, response_details, response_body):
+        self.status_code = response_details.status_code
+        self.url = url
+        self.response_headers = response_details.headers
+        self.message = f"HTTP {self.status_code} {response_body}"
+        super().__init__(self.message)  # ✅ important
+
+    def __str__(self):
+        return self.message

zscaler_sdk_python-1.4.0/zscaler/errors/response_checker.py

@@ -0,0 +1,57 @@
+import json
+import logging
+from zscaler.errors.http_error import HTTPError
+from zscaler.errors.zscaler_api_error import ZscalerAPIError
+from zscaler.exceptions import HTTPException, ZscalerAPIException
+from zscaler.exceptions import exceptions
+
+logger = logging.getLogger(__name__)
+
+@staticmethod
+def check_response_for_error(url, response_details, response_body):
+    """
+    Checks HTTP response for errors in the response body.
+
+    Args:
+        url (str): URL of the response
+        response_details (requests.Response): Response object with details
+        response_body (str): Response body in JSON or plain string
+
+    Returns:
+        Tuple(dict or None, error or None)
+    """
+    # Defensive check: if response_details is not a real HTTP response, skip
+    if not hasattr(response_details, "headers"):
+        logger.debug(f"[SKIP] check_response_for_error received non-Response object: {type(response_details)}")
+        return response_details, None
+
+    content_type = response_details.headers.get("Content-Type", "")
+    is_json = "application/json" in content_type
+    body_text = response_body if isinstance(response_body, str) else str(response_body)
+
+    try:
+        formatted_response = json.loads(response_body) if is_json else response_body
+    except json.JSONDecodeError as e:
+        logger.warning(f"Non-JSON response from {url}: {body_text}")
+        if exceptions.raise_exception:
+            raise HTTPException(url, response_details, body_text)
+        return None, HTTPError(url, response_details, body_text)
+
+    # ✅ Only now we are confident it's safe to access .status_code
+    status_code = response_details.status_code
+
+    if 200 <= status_code < 300:
+        return formatted_response, None
+
+    try:
+        error = ZscalerAPIError(url, response_details, formatted_response)
+        if exceptions.raise_exception:
+            raise ZscalerAPIException(error)
+        return None, error
+
+    except Exception as e:
+        logger.exception("Failed to construct ZscalerAPIError.")
+        generic_error = HTTPError(url, response_details, formatted_response)
+        if exceptions.raise_exception:
+            raise HTTPException(str(generic_error)) from e
+        return None, generic_error

{zscaler_sdk_python-1.2.4 → zscaler_sdk_python-1.4.0}/zscaler/errors/zscaler_api_error.py

@@ -1,50 +1,40 @@
-from zscaler.errors.error import Error
 import json
 
 
-class ZscalerAPIError(Error):
+class ZscalerAPIError(Exception):
     def __init__(self, url, response_details, response_body, service_type=""):
         self.status_code = response_details.status_code
         self.url = url
+        self.service_type = service_type.lower()
         self.headers = response_details.headers
         self.stack = ""
-        self.service_type = service_type.lower()
 
-        # Ensure response_body is a dict
         if not isinstance(response_body, dict):
             response_body = {"message": str(response_body)}
 
-        # Initialize fields
-        self.error_code = None
-        self.error_message = None
-        self.params = None
-        self.path = None
-
-        # Populate based on service type
-        if self.service_type == "zpa":
-            self.error_code = response_body.get("id")
-            self.error_message = response_body.get("reason")
-            self.params = response_body.get("params")
-        else:  # default to ZIA/others
-            self.error_code = response_body.get("code") or response_body.get("id")
-            self.error_message = response_body.get("message") or response_body.get("reason")
-
-        self.params = self.params or []
+        self.error_code = response_body.get("code") or response_body.get("id")
+        self.error_message = response_body.get("message") or response_body.get("reason")
+        self.params = response_body.get("params", [])
         self.path = response_body.get("path")
 
-        # Construct message string
         message_parts = [f"HTTP {self.status_code}"]
         if self.error_code:
-            message_parts.append(self.error_code)
+            message_parts.append(str(self.error_code))
         if self.error_message:
             message_parts.append(self.error_message)
         if self.params:
             message_parts.append(f"Parameters: {', '.join(self.params)}")
 
         self.message = " ".join(message_parts)
+        super().__init__(self.message)  # ✅ This is what makes it raise-able
 
     def __str__(self):
-        error_payload = {"status": self.status_code, "code": self.error_code, "message": self.error_message, "url": self.url}
+        error_payload = {
+            "status": self.status_code,
+            "code": self.error_code,
+            "message": self.error_message,
+            "url": self.url,
+        }
         if self.params:
             error_payload["params"] = self.params
         if self.path:

{zscaler_sdk_python-1.2.4 → zscaler_sdk_python-1.4.0}/zscaler/exceptions/exceptions.py

@@ -1,5 +1,6 @@
 import json
 
+raise_exception = False
 
 # Zscaler Base Exceptions
 class ZscalerBaseException(Exception):

{zscaler_sdk_python-1.2.4 → zscaler_sdk_python-1.4.0}/zscaler/helpers.py

@@ -117,7 +117,14 @@ def to_snake_case(string):
         "truncate_large_udpdns_response": "truncateLargeUDPDNSResponse",
         "enableZCCRevert": "enable_zcc_revert",
         "enableZiaDR": "enable_zia_dr",
-        "purge_kerberos_preferred_dc_cache": "purgeKerberosPreferredDCCache"
+        "purgeKerberosPreferredDCCache": "purge_kerberos_preferred_dc_cache",
+        
+        # ZPA Edge Cases
+        "serverGroupDTOs": "server_group_dtos",
+        "extranetDTO": "extranet_dto",
+        "locationGroupDTO": "location_group_dto",
+        "locationDTO": "location_dto",
+        "predefinedADPControls": "predefined_adp_controls"
     }
 
     if string in FIELD_EXCEPTIONS:
@@ -242,7 +249,14 @@ def to_lower_camel_case(string):
         "enable_zcc_revert": "enableZCCRevert",
         "delete_dhcp_option121_routes": "deleteDHCPOption121Routes",
         "enableZiaDR": "enable_zia_dr",
-        "purgeKerberosPreferredDCCache": "purge_kerberos_preferred_dc_cache"
+        "purgeKerberosPreferredDCCache": "purge_kerberos_preferred_dc_cache",
+        
+        # ZPA Edge Cases
+        "server_group_dtos": "serverGroupDTOs",
+        "extranet_dto": "extranetDTO",
+        "location_group_dto": "locationGroupDTO",
+        "location_dto": "locationDTO",
+        "predefined_adp_controls": "predefinedADPControls"
     }
 
     if string in FIELD_EXCEPTIONS:

{zscaler_sdk_python-1.2.4 → zscaler_sdk_python-1.4.0}/zscaler/oneapi_http_client.py

@@ -1,12 +1,7 @@
-import json
 import requests
 import logging
 import os
 import time
-from zscaler.errors.http_error import HTTPError
-from zscaler.errors.zscaler_api_error import ZscalerAPIError
-from zscaler.exceptions import HTTPException, ZscalerAPIException
-from http import HTTPStatus
 from zscaler.logger import dump_request, dump_response
 from zscaler.zcc.legacy import LegacyZCCClientHelper
 from zscaler.ztw.legacy import LegacyZTWClientHelper
@@ -25,7 +20,7 @@ class HTTPClient:
     Custom HTTP clients should inherit from this class.
     """
 
-    raise_exception = False
+    # raise_exception = False
 
     def __init__(
         self,
@@ -335,52 +330,6 @@ class HTTPClient:
             # logger.error(f"Unexpected error during request execution: {error}")
             return (None, error)
 
-    @staticmethod
-    def check_response_for_error(url, response_details, response_body):
-        """
-        Checks HTTP response for errors in the response body.
-
-        Args:
-            url (str): URL of the response
-            response_details (requests.Response): Response object with details
-            response_body (str): Response body in JSON or plain string
-
-        Returns:
-            Tuple(dict or None, error or None)
-        """
-        content_type = response_details.headers.get("Content-Type", "")
-        is_json = "application/json" in content_type
-
-        # Attempt to parse JSON safely
-        try:
-            formatted_response = json.loads(response_body) if is_json else response_body
-        except json.JSONDecodeError as e:
-            logger.error(f"Failed to parse JSON response: {e}")
-            if HTTPClient.raise_exception:
-                raise HTTPException(f"Invalid JSON response from {url}: {response_body}")
-            return None, HTTPError(url, response_details, response_body)
-
-        status_code = response_details.status_code
-
-        if 200 <= status_code < 300:
-            return formatted_response, None
-
-        # Defensive error handling block (minimal, correct)
-        try:
-            error = ZscalerAPIError(url, response_details, formatted_response)
-            # logger.debug(f"Raw API Error JSON: {json.dumps(formatted_response, indent=2)}")
-            if HTTPClient.raise_exception:
-                raise ZscalerAPIException(error)
-            return None, error
-
-        except Exception as e:
-            # Catch-all in case ZscalerAPIError constructor fails
-            logger.exception("Failed to construct ZscalerAPIError.")
-            generic_error = HTTPError(url, response_details, formatted_response)
-            if HTTPClient.raise_exception:
-                raise HTTPException(str(generic_error)) from e
-            return None, generic_error
-
     @staticmethod
     def format_binary_data(data):
         """Formats binary data for multipart uploads."""

{zscaler_sdk_python-1.2.4 → zscaler_sdk_python-1.4.0}/zscaler/oneapi_oauth_client.py

@@ -7,6 +7,7 @@ from cryptography.hazmat.backends import default_backend
 from cryptography.hazmat.primitives import serialization
 from zscaler.user_agent import UserAgent
 from zscaler.oneapi_http_client import HTTPClient
+from zscaler.errors.response_checker import check_response_for_error
 
 logger = logging.getLogger(__name__)
 
@@ -193,7 +194,7 @@ class OAuth:
                 response = self.authenticate()
 
                 # Check the response body for error messages using check_response_for_error
-                parsed_response, err = HTTPClient.check_response_for_error(response.url, response, response.text)
+                parsed_response, err = check_response_for_error(response.url, response, response.text)
 
                 if err:
                     logging.error(f"Error during authentication: {err}")

{zscaler_sdk_python-1.2.4 → zscaler_sdk_python-1.4.0}/zscaler/request_executor.py

@@ -8,13 +8,14 @@ from zscaler.user_agent import UserAgent
 from zscaler.error_messages import ERROR_MESSAGE_429_MISSING_DATE_X_RESET
 from http import HTTPStatus
 from zscaler.helpers import convert_keys_to_snake_case, convert_keys_to_camel_case
+from zscaler.errors.response_checker import check_response_for_error
+from zscaler.exceptions import exceptions
 from zscaler.zcc.legacy import LegacyZCCClientHelper
 from zscaler.ztw.legacy import LegacyZTWClientHelper
 from zscaler.zdx.legacy import LegacyZDXClientHelper
 from zscaler.zpa.legacy import LegacyZPAClientHelper
 from zscaler.zia.legacy import LegacyZIAClientHelper
 from zscaler.zwa.legacy import LegacyZWAClientHelper
-# from zscaler.logger import setup_logging  # ✅ Import here
 
 logger = logging.getLogger('zscaler-sdk-python')
 
@@ -118,7 +119,7 @@ class RequestExecutor:
             zwa_legacy_client=self.zwa_legacy_client,
         )
 
-        HTTPClient.raise_exception = self._config["client"].get("raiseException", False)
+        exceptions.raise_exception = self._config["client"].get("raiseException", False)
         self._custom_headers = {}
 
     def get_base_url(self, endpoint: str) -> str:
@@ -331,9 +332,6 @@ class RequestExecutor:
         """
         try:
             request, response, response_body, error = self.fire_request(request)
-            logger.debug(
-                f"[DEBUG] Got response: {response} (status: {getattr(response, 'status_code', 'N/A')}) | error: {error}"
-            )
         except Exception as ex:
             logger.error(f"Exception during HTTP request: {ex}")
             return None, ex
@@ -354,7 +352,7 @@ class RequestExecutor:
             return response, None
 
         try:
-            response_data, error = self._http_client.check_response_for_error(request["url"], response, response_body)
+            response_data, error = check_response_for_error(request["url"], response, response_body)
         except Exception as ex:
             logger.error(f"Exception while checking response for errors: {ex}")
             return None, ex
@@ -463,33 +461,59 @@ class RequestExecutor:
             request_start_time (float): Original start time of request.
 
         Returns:
-            Tuple of request, response object, response body, and error.
+            Tuple of (request, response object, response body, error).
         """
         current_req_start_time = time.time()
         max_retries = self._max_retries
         req_timeout = self._request_timeout
 
+        # Check if total elapsed time exceeds the configured request timeout
         if req_timeout > 0 and (current_req_start_time - request_start_time) > req_timeout:
             logger.warning("Request Timeout exceeded.")
             return None, None, None, Exception("Request Timeout exceeded.")
 
+        # Perform the actual HTTP request
         response, error = self._http_client.send_request(request)
 
+        # If a low-level error occurred (network, request construction, etc.)
         if error:
-            # logger.error(f"Error sending request: {error}")
             return request, response, response.text if response else None, error
 
-        headers = response.headers
+        # Check for 401 -> Trigger re-auth if we still have retries left
+        if response.status_code == 401:
+            # We only want to attempt refreshing the token if we haven't hit max_retries
+            if attempts < max_retries:
+                logger.info("Got 401 response; clearing token and re-authenticating.")
+                self._oauth.clear_access_token()
+
+                try:
+                    fresh_token = self._oauth._get_access_token()
+                except Exception as e:
+                    # If re-auth fails, return immediately
+                    logger.error(f"Token refresh failed after 401: {e}")
+                    return request, response, response.text, e
+
+                # Update the request with the new token
+                request["headers"]["Authorization"] = f"Bearer {fresh_token}"
+                attempts += 1
+                return self.fire_request_helper(request, attempts, request_start_time)
+            else:
+                logger.error("401 Unauthorized - token refresh attempts exhausted.")
+                return request, response, response.text, Exception("401 Unauthorized - token refresh attempts exhausted.")
 
+        # Handle “retryable” statuses such as 429, 503, etc.
         if attempts < max_retries and self.is_retryable_status(response.status_code):
-            backoff_seconds = self.get_retry_after(headers, logger)
+            backoff_seconds = self.get_retry_after(response.headers, logger)
             if backoff_seconds is None:
                 return None, response, response.text, Exception(ERROR_MESSAGE_429_MISSING_DATE_X_RESET)
-            logger.info(f"Hit rate limit. Retrying request in {backoff_seconds} seconds.")
+
+            logger.info(f"Hit rate limit or retryable status {response.status_code}. "
+                        f"Retrying request in {backoff_seconds} seconds.")
             time.sleep(backoff_seconds)
             attempts += 1
             return self.fire_request_helper(request, attempts, request_start_time)
 
+        # If we reach here, no further retries; return whatever we got
         return request, response, response.text, None
 
     def is_retryable_status(self, status):
@@ -570,7 +594,13 @@ class RequestExecutor:
 
     def get_retry_after(self, headers, logger):
         retry_limit_reset_header = (
-            headers.get("x-ratelimit-reset") or headers.get("X-RateLimit-Reset") or headers.get("RateLimit-Reset")
+            headers.get("x-ratelimit-reset") or 
+            headers.get("X-RateLimit-Reset") or
+            headers.get("RateLimit-Reset") or
+            
+            # ZCC Specific Rate Limiting Headers (LegacyZCCClientHelper)
+            headers.get("X-Rate-Limit-Retry-After-Seconds") or # ZCC /downloadDevices Rate Limiting Header (LegacyZCCClientHelper)
+            headers.get("X-Rate-Limit-Remaining") # (LegacyZCCClientHelper)
         )
         retry_after = headers.get("Retry-After") or headers.get("retry-after")