cribl-control-plane 0.0.13__py3-none-any.whl

cribl_control_plane/basesdk.py

@@ -0,0 +1,358 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from .sdkconfiguration import SDKConfiguration
+from cribl_control_plane import errors, models, utils
+from cribl_control_plane._hooks import (
+    AfterErrorContext,
+    AfterSuccessContext,
+    BeforeRequestContext,
+)
+from cribl_control_plane.utils import (
+    RetryConfig,
+    SerializedRequestBody,
+    get_body_content,
+)
+import httpx
+from typing import Callable, List, Mapping, Optional, Tuple
+from urllib.parse import parse_qs, urlparse
+
+
+class BaseSDK:
+    sdk_configuration: SDKConfiguration
+
+    def __init__(self, sdk_config: SDKConfiguration) -> None:
+        self.sdk_configuration = sdk_config
+
+    def _get_url(self, base_url, url_variables):
+        sdk_url, sdk_variables = self.sdk_configuration.get_server_details()
+
+        if base_url is None:
+            base_url = sdk_url
+
+        if url_variables is None:
+            url_variables = sdk_variables
+
+        return utils.template_url(base_url, url_variables)
+
+    def _build_request_async(
+        self,
+        method,
+        path,
+        base_url,
+        url_variables,
+        request,
+        request_body_required,
+        request_has_path_params,
+        request_has_query_params,
+        user_agent_header,
+        accept_header_value,
+        _globals=None,
+        security=None,
+        timeout_ms: Optional[int] = None,
+        get_serialized_body: Optional[
+            Callable[[], Optional[SerializedRequestBody]]
+        ] = None,
+        url_override: Optional[str] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> httpx.Request:
+        client = self.sdk_configuration.async_client
+        return self._build_request_with_client(
+            client,
+            method,
+            path,
+            base_url,
+            url_variables,
+            request,
+            request_body_required,
+            request_has_path_params,
+            request_has_query_params,
+            user_agent_header,
+            accept_header_value,
+            _globals,
+            security,
+            timeout_ms,
+            get_serialized_body,
+            url_override,
+            http_headers,
+        )
+
+    def _build_request(
+        self,
+        method,
+        path,
+        base_url,
+        url_variables,
+        request,
+        request_body_required,
+        request_has_path_params,
+        request_has_query_params,
+        user_agent_header,
+        accept_header_value,
+        _globals=None,
+        security=None,
+        timeout_ms: Optional[int] = None,
+        get_serialized_body: Optional[
+            Callable[[], Optional[SerializedRequestBody]]
+        ] = None,
+        url_override: Optional[str] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> httpx.Request:
+        client = self.sdk_configuration.client
+        return self._build_request_with_client(
+            client,
+            method,
+            path,
+            base_url,
+            url_variables,
+            request,
+            request_body_required,
+            request_has_path_params,
+            request_has_query_params,
+            user_agent_header,
+            accept_header_value,
+            _globals,
+            security,
+            timeout_ms,
+            get_serialized_body,
+            url_override,
+            http_headers,
+        )
+
+    def _build_request_with_client(
+        self,
+        client,
+        method,
+        path,
+        base_url,
+        url_variables,
+        request,
+        request_body_required,
+        request_has_path_params,
+        request_has_query_params,
+        user_agent_header,
+        accept_header_value,
+        _globals=None,
+        security=None,
+        timeout_ms: Optional[int] = None,
+        get_serialized_body: Optional[
+            Callable[[], Optional[SerializedRequestBody]]
+        ] = None,
+        url_override: Optional[str] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> httpx.Request:
+        query_params = {}
+
+        url = url_override
+        if url is None:
+            url = utils.generate_url(
+                self._get_url(base_url, url_variables),
+                path,
+                request if request_has_path_params else None,
+                _globals if request_has_path_params else None,
+            )
+
+            query_params = utils.get_query_params(
+                request if request_has_query_params else None,
+                _globals if request_has_query_params else None,
+            )
+        else:
+            # Pick up the query parameter from the override so they can be
+            # preserved when building the request later on (necessary as of
+            # httpx 0.28).
+            parsed_override = urlparse(str(url_override))
+            query_params = parse_qs(parsed_override.query, keep_blank_values=True)
+
+        headers = utils.get_headers(request, _globals)
+        headers["Accept"] = accept_header_value
+        headers[user_agent_header] = self.sdk_configuration.user_agent
+
+        if security is not None:
+            if callable(security):
+                security = security()
+        security = utils.get_security_from_env(security, models.Security)
+        if security is not None:
+            security_headers, security_query_params = utils.get_security(security)
+            headers = {**headers, **security_headers}
+            query_params = {**query_params, **security_query_params}
+
+        serialized_request_body = SerializedRequestBody()
+        if get_serialized_body is not None:
+            rb = get_serialized_body()
+            if request_body_required and rb is None:
+                raise ValueError("request body is required")
+
+            if rb is not None:
+                serialized_request_body = rb
+
+        if (
+            serialized_request_body.media_type is not None
+            and serialized_request_body.media_type
+            not in (
+                "multipart/form-data",
+                "multipart/mixed",
+            )
+        ):
+            headers["content-type"] = serialized_request_body.media_type
+
+        if http_headers is not None:
+            for header, value in http_headers.items():
+                headers[header] = value
+
+        timeout = timeout_ms / 1000 if timeout_ms is not None else None
+
+        return client.build_request(
+            method,
+            url,
+            params=query_params,
+            content=serialized_request_body.content,
+            data=serialized_request_body.data,
+            files=serialized_request_body.files,
+            headers=headers,
+            timeout=timeout,
+        )
+
+    def do_request(
+        self,
+        hook_ctx,
+        request,
+        error_status_codes,
+        stream=False,
+        retry_config: Optional[Tuple[RetryConfig, List[str]]] = None,
+    ) -> httpx.Response:
+        client = self.sdk_configuration.client
+        logger = self.sdk_configuration.debug_logger
+
+        hooks = self.sdk_configuration.__dict__["_hooks"]
+
+        def do():
+            http_res = None
+            try:
+                req = hooks.before_request(BeforeRequestContext(hook_ctx), request)
+                logger.debug(
+                    "Request:\nMethod: %s\nURL: %s\nHeaders: %s\nBody: %s",
+                    req.method,
+                    req.url,
+                    req.headers,
+                    get_body_content(req),
+                )
+
+                if client is None:
+                    raise ValueError("client is required")
+
+                http_res = client.send(req, stream=stream)
+            except Exception as e:
+                _, e = hooks.after_error(AfterErrorContext(hook_ctx), None, e)
+                if e is not None:
+                    logger.debug("Request Exception", exc_info=True)
+                    raise e
+
+            if http_res is None:
+                logger.debug("Raising no response SDK error")
+                raise errors.NoResponseError("No response received")
+
+            logger.debug(
+                "Response:\nStatus Code: %s\nURL: %s\nHeaders: %s\nBody: %s",
+                http_res.status_code,
+                http_res.url,
+                http_res.headers,
+                "<streaming response>" if stream else http_res.text,
+            )
+
+            if utils.match_status_codes(error_status_codes, http_res.status_code):
+                result, err = hooks.after_error(
+                    AfterErrorContext(hook_ctx), http_res, None
+                )
+                if err is not None:
+                    logger.debug("Request Exception", exc_info=True)
+                    raise err
+                if result is not None:
+                    http_res = result
+                else:
+                    logger.debug("Raising unexpected SDK error")
+                    raise errors.APIError("Unexpected error occurred", http_res)
+
+            return http_res
+
+        if retry_config is not None:
+            http_res = utils.retry(do, utils.Retries(retry_config[0], retry_config[1]))
+        else:
+            http_res = do()
+
+        if not utils.match_status_codes(error_status_codes, http_res.status_code):
+            http_res = hooks.after_success(AfterSuccessContext(hook_ctx), http_res)
+
+        return http_res
+
+    async def do_request_async(
+        self,
+        hook_ctx,
+        request,
+        error_status_codes,
+        stream=False,
+        retry_config: Optional[Tuple[RetryConfig, List[str]]] = None,
+    ) -> httpx.Response:
+        client = self.sdk_configuration.async_client
+        logger = self.sdk_configuration.debug_logger
+
+        hooks = self.sdk_configuration.__dict__["_hooks"]
+
+        async def do():
+            http_res = None
+            try:
+                req = hooks.before_request(BeforeRequestContext(hook_ctx), request)
+                logger.debug(
+                    "Request:\nMethod: %s\nURL: %s\nHeaders: %s\nBody: %s",
+                    req.method,
+                    req.url,
+                    req.headers,
+                    get_body_content(req),
+                )
+
+                if client is None:
+                    raise ValueError("client is required")
+
+                http_res = await client.send(req, stream=stream)
+            except Exception as e:
+                _, e = hooks.after_error(AfterErrorContext(hook_ctx), None, e)
+                if e is not None:
+                    logger.debug("Request Exception", exc_info=True)
+                    raise e
+
+            if http_res is None:
+                logger.debug("Raising no response SDK error")
+                raise errors.NoResponseError("No response received")
+
+            logger.debug(
+                "Response:\nStatus Code: %s\nURL: %s\nHeaders: %s\nBody: %s",
+                http_res.status_code,
+                http_res.url,
+                http_res.headers,
+                "<streaming response>" if stream else http_res.text,
+            )
+
+            if utils.match_status_codes(error_status_codes, http_res.status_code):
+                result, err = hooks.after_error(
+                    AfterErrorContext(hook_ctx), http_res, None
+                )
+                if err is not None:
+                    logger.debug("Request Exception", exc_info=True)
+                    raise err
+                if result is not None:
+                    http_res = result
+                else:
+                    logger.debug("Raising unexpected SDK error")
+                    raise errors.APIError("Unexpected error occurred", http_res)
+
+            return http_res
+
+        if retry_config is not None:
+            http_res = await utils.retry_async(
+                do, utils.Retries(retry_config[0], retry_config[1])
+            )
+        else:
+            http_res = await do()
+
+        if not utils.match_status_codes(error_status_codes, http_res.status_code):
+            http_res = hooks.after_success(AfterSuccessContext(hook_ctx), http_res)
+
+        return http_res

cribl_control_plane/errors/__init__.py

@@ -0,0 +1,60 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from typing import TYPE_CHECKING
+from importlib import import_module
+
+if TYPE_CHECKING:
+    from .apierror import APIError
+    from .criblcontrolplaneerror import CriblControlPlaneError
+    from .error import Error, ErrorData
+    from .healthstatus_error import HealthStatusError, HealthStatusErrorData
+    from .no_response_error import NoResponseError
+    from .responsevalidationerror import ResponseValidationError
+
+__all__ = [
+    "APIError",
+    "CriblControlPlaneError",
+    "Error",
+    "ErrorData",
+    "HealthStatusError",
+    "HealthStatusErrorData",
+    "NoResponseError",
+    "ResponseValidationError",
+]
+
+_dynamic_imports: dict[str, str] = {
+    "APIError": ".apierror",
+    "CriblControlPlaneError": ".criblcontrolplaneerror",
+    "Error": ".error",
+    "ErrorData": ".error",
+    "HealthStatusError": ".healthstatus_error",
+    "HealthStatusErrorData": ".healthstatus_error",
+    "NoResponseError": ".no_response_error",
+    "ResponseValidationError": ".responsevalidationerror",
+}
+
+
+def __getattr__(attr_name: str) -> object:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(
+            f"No {attr_name} found in _dynamic_imports for module name -> {__name__} "
+        )
+
+    try:
+        module = import_module(module_name, __package__)
+        result = getattr(module, attr_name)
+        return result
+    except ImportError as e:
+        raise ImportError(
+            f"Failed to import {attr_name} from {module_name}: {e}"
+        ) from e
+    except AttributeError as e:
+        raise AttributeError(
+            f"Failed to get {attr_name} from {module_name}: {e}"
+        ) from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)

cribl_control_plane/errors/apierror.py

@@ -0,0 +1,38 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+import httpx
+from typing import Optional
+
+from cribl_control_plane.errors import CriblControlPlaneError
+
+MAX_MESSAGE_LEN = 10_000
+
+
+class APIError(CriblControlPlaneError):
+    """The fallback error class if no more specific error class is matched."""
+
+    def __init__(
+        self, message: str, raw_response: httpx.Response, body: Optional[str] = None
+    ):
+        body_display = body or raw_response.text or '""'
+
+        if message:
+            message += ": "
+        message += f"Status {raw_response.status_code}"
+
+        headers = raw_response.headers
+        content_type = headers.get("content-type", '""')
+        if content_type != "application/json":
+            if " " in content_type:
+                content_type = f'"{content_type}"'
+            message += f" Content-Type {content_type}"
+
+        if len(body_display) > MAX_MESSAGE_LEN:
+            truncated = body_display[:MAX_MESSAGE_LEN]
+            remaining = len(body_display) - MAX_MESSAGE_LEN
+            body_display = f"{truncated}...and {remaining} more chars"
+
+        message += f". Body: {body_display}"
+        message = message.strip()
+
+        super().__init__(message, raw_response, body)

cribl_control_plane/errors/criblcontrolplaneerror.py

@@ -0,0 +1,26 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+import httpx
+from typing import Optional
+
+
+class CriblControlPlaneError(Exception):
+    """The base class for all HTTP error responses."""
+
+    message: str
+    status_code: int
+    body: str
+    headers: httpx.Headers
+    raw_response: httpx.Response
+
+    def __init__(
+        self, message: str, raw_response: httpx.Response, body: Optional[str] = None
+    ):
+        self.message = message
+        self.status_code = raw_response.status_code
+        self.body = body if body is not None else raw_response.text
+        self.headers = raw_response.headers
+        self.raw_response = raw_response
+
+    def __str__(self):
+        return self.message

cribl_control_plane/errors/error.py

@@ -0,0 +1,24 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.errors import CriblControlPlaneError
+from cribl_control_plane.types import BaseModel
+import httpx
+from typing import Optional
+
+
+class ErrorData(BaseModel):
+    message: Optional[str] = None
+    r"""Error message"""
+
+
+class Error(CriblControlPlaneError):
+    data: ErrorData
+
+    def __init__(
+        self, data: ErrorData, raw_response: httpx.Response, body: Optional[str] = None
+    ):
+        fallback = body or raw_response.text
+        message = str(data.message) or fallback
+        super().__init__(message, raw_response, body)
+        self.data = data

cribl_control_plane/errors/healthstatus_error.py

@@ -0,0 +1,38 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.errors import CriblControlPlaneError
+from cribl_control_plane.models import healthstatus as models_healthstatus
+from cribl_control_plane.types import BaseModel
+from cribl_control_plane.utils import validate_open_enum
+import httpx
+import pydantic
+from pydantic.functional_validators import PlainValidator
+from typing import Optional
+from typing_extensions import Annotated
+
+
+class HealthStatusErrorData(BaseModel):
+    status: Annotated[
+        models_healthstatus.Status, PlainValidator(validate_open_enum(False))
+    ]
+
+    start_time: Annotated[float, pydantic.Field(alias="startTime")]
+
+    role: Annotated[
+        Optional[models_healthstatus.Role], PlainValidator(validate_open_enum(False))
+    ] = None
+
+
+class HealthStatusError(CriblControlPlaneError):
+    data: HealthStatusErrorData
+
+    def __init__(
+        self,
+        data: HealthStatusErrorData,
+        raw_response: httpx.Response,
+        body: Optional[str] = None,
+    ):
+        message = body or raw_response.text
+        super().__init__(message, raw_response, body)
+        self.data = data

cribl_control_plane/errors/no_response_error.py

@@ -0,0 +1,13 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+class NoResponseError(Exception):
+    """Error raised when no HTTP response is received from the server."""
+
+    message: str
+
+    def __init__(self, message: str = "No response received"):
+        self.message = message
+        super().__init__(message)
+
+    def __str__(self):
+        return self.message

cribl_control_plane/errors/responsevalidationerror.py

@@ -0,0 +1,25 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+import httpx
+from typing import Optional
+
+from cribl_control_plane.errors import CriblControlPlaneError
+
+
+class ResponseValidationError(CriblControlPlaneError):
+    """Error raised when there is a type mismatch between the response data and the expected Pydantic model."""
+
+    def __init__(
+        self,
+        message: str,
+        raw_response: httpx.Response,
+        cause: Exception,
+        body: Optional[str] = None,
+    ):
+        message = f"{message}: {cause}"
+        super().__init__(message, raw_response, body)
+
+    @property
+    def cause(self):
+        """Normally the Pydantic ValidationError"""
+        return self.__cause__