cribl-control-plane 0.0.21__py3-none-any.whl → 0.4.0b23__py3-none-any.whl

cribl_control_plane/tokens.py

@@ -0,0 +1,210 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from .basesdk import BaseSDK
+from cribl_control_plane import errors, models, utils
+from cribl_control_plane._hooks import HookContext
+from cribl_control_plane.types import OptionalNullable, UNSET
+from cribl_control_plane.utils.unmarshal_json_response import unmarshal_json_response
+from typing import Any, Mapping, Optional
+
+
+class Tokens(BaseSDK):
+    def get(
+        self,
+        *,
+        password: str,
+        username: str,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.CreateAuthLoginResponse:
+        r"""Log in and fetch an authentication token
+
+        This endpoint is unavailable on Cribl.Cloud.Instead, follow the instructions at https://docs.cribl.io/stream/api-tutorials/#criblcloud to get an Auth token for Cribl.Cloud.
+
+        :param password:
+        :param username:
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.LoginInfo(
+            password=password,
+            username=username,
+        )
+
+        req = self._build_request(
+            method="POST",
+            path="/auth/login",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=True,
+            request_has_path_params=False,
+            request_has_query_params=False,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request, False, False, "json", models.LoginInfo
+            ),
+            allow_empty_value=None,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+            else:
+                retries = utils.RetryConfig(
+                    "backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
+                )
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="createAuthLogin",
+                oauth2_scopes=[],
+                security_source=None,
+            ),
+            request=req,
+            error_status_codes=["401", "429", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return models.CreateAuthLoginResponse(
+                result=unmarshal_json_response(models.AuthToken, http_res), headers={}
+            )
+        if utils.match_response(http_res, "429", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(errors.ErrorData, http_res)
+            raise errors.Error(response_data, http_res)
+        if utils.match_response(http_res, ["401", "4XX"], "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        raise errors.APIError("Unexpected response received", http_res)
+
+    async def get_async(
+        self,
+        *,
+        password: str,
+        username: str,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.CreateAuthLoginResponse:
+        r"""Log in and fetch an authentication token
+
+        This endpoint is unavailable on Cribl.Cloud.Instead, follow the instructions at https://docs.cribl.io/stream/api-tutorials/#criblcloud to get an Auth token for Cribl.Cloud.
+
+        :param password:
+        :param username:
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.LoginInfo(
+            password=password,
+            username=username,
+        )
+
+        req = self._build_request_async(
+            method="POST",
+            path="/auth/login",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=True,
+            request_has_path_params=False,
+            request_has_query_params=False,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request, False, False, "json", models.LoginInfo
+            ),
+            allow_empty_value=None,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+            else:
+                retries = utils.RetryConfig(
+                    "backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
+                )
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="createAuthLogin",
+                oauth2_scopes=[],
+                security_source=None,
+            ),
+            request=req,
+            error_status_codes=["401", "429", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return models.CreateAuthLoginResponse(
+                result=unmarshal_json_response(models.AuthToken, http_res), headers={}
+            )
+        if utils.match_response(http_res, "429", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(errors.ErrorData, http_res)
+            raise errors.Error(response_data, http_res)
+        if utils.match_response(http_res, ["401", "4XX"], "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        raise errors.APIError("Unexpected response received", http_res)

cribl_control_plane/utils/__init__.py

@@ -2,6 +2,8 @@
 
 from typing import TYPE_CHECKING
 from importlib import import_module
+import builtins
+import sys
 
 if TYPE_CHECKING:
     from .annotations import get_discriminator
@@ -161,6 +163,18 @@ _dynamic_imports: dict[str, str] = {
 }
 
 
+def dynamic_import(modname, retries=3):
+    for attempt in range(retries):
+        try:
+            return import_module(modname, __package__)
+        except KeyError:
+            # Clear any half-initialized module and retry
+            sys.modules.pop(modname, None)
+            if attempt == retries - 1:
+                break
+    raise KeyError(f"Failed to import module '{modname}' after {retries} attempts")
+
+
 def __getattr__(attr_name: str) -> object:
     module_name = _dynamic_imports.get(attr_name)
     if module_name is None:
@@ -169,9 +183,8 @@ def __getattr__(attr_name: str) -> object:
         )
 
     try:
-        module = import_module(module_name, __package__)
-        result = getattr(module, attr_name)
-        return result
+        module = dynamic_import(module_name)
+        return getattr(module, attr_name)
     except ImportError as e:
         raise ImportError(
             f"Failed to import {attr_name} from {module_name}: {e}"
@@ -183,5 +196,5 @@ def __getattr__(attr_name: str) -> object:
 
 
 def __dir__():
-    lazy_attrs = list(_dynamic_imports.keys())
-    return sorted(lazy_attrs)
+    lazy_attrs = builtins.list(_dynamic_imports.keys())
+    return builtins.sorted(lazy_attrs)

cribl_control_plane/utils/annotations.py

@@ -3,6 +3,7 @@
 from enum import Enum
 from typing import Any, Optional
 
+
 def get_discriminator(model: Any, fieldname: str, key: str) -> str:
     """
     Recursively search for the discriminator attribute in a model.
@@ -25,31 +26,54 @@ def get_discriminator(model: Any, fieldname: str, key: str) -> str:
 
         if isinstance(field, dict):
             if key in field:
-                return f'{field[key]}'
+                return f"{field[key]}"
 
         if hasattr(field, fieldname):
             attr = getattr(field, fieldname)
             if isinstance(attr, Enum):
-                return f'{attr.value}'
-            return f'{attr}'
+                return f"{attr.value}"
+            return f"{attr}"
 
         if hasattr(field, upper_fieldname):
             attr = getattr(field, upper_fieldname)
             if isinstance(attr, Enum):
-                return f'{attr.value}'
-            return f'{attr}'
+                return f"{attr.value}"
+            return f"{attr}"
 
         return None
 
+    def search_nested_discriminator(obj: Any) -> Optional[str]:
+        """Recursively search for discriminator in nested structures."""
+        # First try direct field lookup
+        discriminator = get_field_discriminator(obj)
+        if discriminator is not None:
+            return discriminator
+
+        # If it's a dict, search in nested values
+        if isinstance(obj, dict):
+            for value in obj.values():
+                if isinstance(value, list):
+                    # Search in list items
+                    for item in value:
+                        nested_discriminator = search_nested_discriminator(item)
+                        if nested_discriminator is not None:
+                            return nested_discriminator
+                elif isinstance(value, dict):
+                    # Search in nested dict
+                    nested_discriminator = search_nested_discriminator(value)
+                    if nested_discriminator is not None:
+                        return nested_discriminator
+
+        return None
 
     if isinstance(model, list):
         for field in model:
-            discriminator = get_field_discriminator(field)
+            discriminator = search_nested_discriminator(field)
             if discriminator is not None:
                 return discriminator
 
-    discriminator = get_field_discriminator(model)
+    discriminator = search_nested_discriminator(model)
     if discriminator is not None:
         return discriminator
 
-    raise ValueError(f'Could not find discriminator field {fieldname} in {model}')
+    raise ValueError(f"Could not find discriminator field {fieldname} in {model}")

cribl_control_plane/utils/eventstreaming.py

@@ -17,6 +17,9 @@ T = TypeVar("T")
 
 
 class EventStream(Generic[T]):
+    # Holds a reference to the SDK client to avoid it being garbage collected
+    # and cause termination of the underlying httpx client.
+    client_ref: Optional[object]
     response: httpx.Response
     generator: Generator[T, None, None]
 
@@ -25,9 +28,11 @@ class EventStream(Generic[T]):
         response: httpx.Response,
         decoder: Callable[[str], T],
         sentinel: Optional[str] = None,
+        client_ref: Optional[object] = None,
     ):
         self.response = response
         self.generator = stream_events(response, decoder, sentinel)
+        self.client_ref = client_ref
 
     def __iter__(self):
         return self
@@ -43,6 +48,9 @@ class EventStream(Generic[T]):
 
 
 class EventStreamAsync(Generic[T]):
+    # Holds a reference to the SDK client to avoid it being garbage collected
+    # and cause termination of the underlying httpx client.
+    client_ref: Optional[object]
     response: httpx.Response
     generator: AsyncGenerator[T, None]
 
@@ -51,9 +59,11 @@ class EventStreamAsync(Generic[T]):
         response: httpx.Response,
         decoder: Callable[[str], T],
         sentinel: Optional[str] = None,
+        client_ref: Optional[object] = None,
     ):
         self.response = response
         self.generator = stream_events_async(response, decoder, sentinel)
+        self.client_ref = client_ref
 
     def __aiter__(self):
         return self

cribl_control_plane/utils/forms.py

@@ -142,16 +142,21 @@ def serialize_multipart_form(
         if field_metadata.file:
             if isinstance(val, List):
                 # Handle array of files
+                array_field_name = f_name + "[]"
                 for file_obj in val:
                     if not _is_set(file_obj):
                         continue
-                        
-                    file_name, content, content_type = _extract_file_properties(file_obj)
+
+                    file_name, content, content_type = _extract_file_properties(
+                        file_obj
+                    )
 
                     if content_type is not None:
-                        files.append((f_name + "[]", (file_name, content, content_type)))
+                        files.append(
+                            (array_field_name, (file_name, content, content_type))
+                        )
                     else:
-                        files.append((f_name + "[]", (file_name, content)))
+                        files.append((array_field_name, (file_name, content)))
             else:
                 # Handle single file
                 file_name, content, content_type = _extract_file_properties(val)
@@ -161,11 +166,16 @@ def serialize_multipart_form(
                 else:
                     files.append((f_name, (file_name, content)))
         elif field_metadata.json:
-            files.append((f_name, (
-                None,
-                marshal_json(val, request_field_types[name]),
-                "application/json",
-            )))
+            files.append(
+                (
+                    f_name,
+                    (
+                        None,
+                        marshal_json(val, request_field_types[name]),
+                        "application/json",
+                    ),
+                )
+            )
         else:
             if isinstance(val, List):
                 values = []
@@ -175,7 +185,8 @@ def serialize_multipart_form(
                         continue
                     values.append(_val_to_string(value))
 
-                form[f_name + "[]"] = values
+                array_field_name = f_name + "[]"
+                form[array_field_name] = values
             else:
                 form[f_name] = _val_to_string(val)
     return media_type, form, files

cribl_control_plane/utils/queryparams.py

@@ -27,12 +27,13 @@ from .forms import _populate_form
 def get_query_params(
     query_params: Any,
     gbls: Optional[Any] = None,
+    allow_empty_value: Optional[List[str]] = None,
 ) -> Dict[str, List[str]]:
     params: Dict[str, List[str]] = {}
 
-    globals_already_populated = _populate_query_params(query_params, gbls, params, [])
+    globals_already_populated = _populate_query_params(query_params, gbls, params, [], allow_empty_value)
     if _is_set(gbls):
-        _populate_query_params(gbls, None, params, globals_already_populated)
+        _populate_query_params(gbls, None, params, globals_already_populated, allow_empty_value)
 
     return params
 
@@ -42,6 +43,7 @@ def _populate_query_params(
     gbls: Any,
     query_param_values: Dict[str, List[str]],
     skip_fields: List[str],
+    allow_empty_value: Optional[List[str]] = None,
 ) -> List[str]:
     globals_already_populated: List[str] = []
 
@@ -69,6 +71,16 @@ def _populate_query_params(
             globals_already_populated.append(name)
 
         f_name = field.alias if field.alias is not None else name
+
+        allow_empty_set = set(allow_empty_value or [])
+        should_include_empty = f_name in allow_empty_set and (
+            value is None or value == [] or value == ""
+        )
+
+        if should_include_empty:
+            query_param_values[f_name] = [""]
+            continue
+
         serialization = metadata.serialization
         if serialization is not None:
             serialized_parms = _get_serialized_params(

cribl_control_plane/utils/retries.py

@@ -3,7 +3,9 @@
 import asyncio
 import random
 import time
-from typing import List
+from datetime import datetime
+from email.utils import parsedate_to_datetime
+from typing import List, Optional
 
 import httpx
 
@@ -51,9 +53,11 @@ class Retries:
 
 class TemporaryError(Exception):
     response: httpx.Response
+    retry_after: Optional[int]
 
     def __init__(self, response: httpx.Response):
         self.response = response
+        self.retry_after = _parse_retry_after_header(response)
 
 
 class PermanentError(Exception):
@@ -63,6 +67,62 @@ class PermanentError(Exception):
         self.inner = inner
 
 
+def _parse_retry_after_header(response: httpx.Response) -> Optional[int]:
+    """Parse Retry-After header from response.
+
+    Returns:
+        Retry interval in milliseconds, or None if header is missing or invalid.
+    """
+    retry_after_header = response.headers.get("retry-after")
+    if not retry_after_header:
+        return None
+
+    try:
+        seconds = float(retry_after_header)
+        return round(seconds * 1000)
+    except ValueError:
+        pass
+
+    try:
+        retry_date = parsedate_to_datetime(retry_after_header)
+        delta = (retry_date - datetime.now(retry_date.tzinfo)).total_seconds()
+        return round(max(0, delta) * 1000)
+    except (ValueError, TypeError):
+        pass
+
+    return None
+
+
+def _get_sleep_interval(
+    exception: Exception,
+    initial_interval: int,
+    max_interval: int,
+    exponent: float,
+    retries: int,
+) -> float:
+    """Get sleep interval for retry with exponential backoff.
+
+    Args:
+        exception: The exception that triggered the retry.
+        initial_interval: Initial retry interval in milliseconds.
+        max_interval: Maximum retry interval in milliseconds.
+        exponent: Base for exponential backoff calculation.
+        retries: Current retry attempt count.
+
+    Returns:
+        Sleep interval in seconds.
+    """
+    if (
+        isinstance(exception, TemporaryError)
+        and exception.retry_after is not None
+        and exception.retry_after > 0
+    ):
+        return exception.retry_after / 1000
+
+    sleep = (initial_interval / 1000) * exponent**retries + random.uniform(0, 1)
+    return min(sleep, max_interval / 1000)
+
+
 def retry(func, retries: Retries):
     if retries.config.strategy == "backoff":
 
@@ -183,8 +243,10 @@ def retry_with_backoff(
                     return exception.response
 
                 raise
-            sleep = (initial_interval / 1000) * exponent**retries + random.uniform(0, 1)
-            sleep = min(sleep, max_interval / 1000)
+
+            sleep = _get_sleep_interval(
+                exception, initial_interval, max_interval, exponent, retries
+            )
             time.sleep(sleep)
             retries += 1
 
@@ -211,7 +273,9 @@ async def retry_with_backoff_async(
                     return exception.response
 
                 raise
-            sleep = (initial_interval / 1000) * exponent**retries + random.uniform(0, 1)
-            sleep = min(sleep, max_interval / 1000)
+
+            sleep = _get_sleep_interval(
+                exception, initial_interval, max_interval, exponent, retries
+            )
             await asyncio.sleep(sleep)
             retries += 1

cribl_control_plane/utils/security.py

@@ -82,6 +82,11 @@ def get_security_from_env(security: Any, security_class: Any) -> Optional[BaseMo
             "CRIBLCONTROLPLANE_TOKEN_URL"
         )
 
+    if os.getenv("CRIBLCONTROLPLANE_AUDIENCE"):
+        security_dict.setdefault("client_oauth", {})["audience"] = os.getenv(
+            "CRIBLCONTROLPLANE_AUDIENCE"
+        )
+
     return security_class(**security_dict) if security_dict else None
 
 

cribl_control_plane/utils/unmarshal_json_response.py

@@ -1,12 +1,26 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
-from typing import Any, Optional
+from typing import Any, Optional, Type, TypeVar, overload
 
 import httpx
 
 from .serializers import unmarshal_json
 from cribl_control_plane import errors
 
+T = TypeVar("T")
+
+
+@overload
+def unmarshal_json_response(
+    typ: Type[T], http_res: httpx.Response, body: Optional[str] = None
+) -> T: ...
+
+
+@overload
+def unmarshal_json_response(
+    typ: Any, http_res: httpx.Response, body: Optional[str] = None
+) -> Any: ...
+
 
 def unmarshal_json_response(
     typ: Any, http_res: httpx.Response, body: Optional[str] = None

cribl_control_plane/versions.py

@@ -0,0 +1,31 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from .basesdk import BaseSDK
+from .sdkconfiguration import SDKConfiguration
+from cribl_control_plane.branches import Branches
+from cribl_control_plane.commits import Commits
+from cribl_control_plane.statuses import Statuses
+from cribl_control_plane.versions_configs import VersionsConfigs
+from typing import Optional
+
+
+class Versions(BaseSDK):
+    branches: Branches
+    commits: Commits
+    configs: VersionsConfigs
+    statuses: Statuses
+
+    def __init__(
+        self, sdk_config: SDKConfiguration, parent_ref: Optional[object] = None
+    ) -> None:
+        BaseSDK.__init__(self, sdk_config, parent_ref=parent_ref)
+        self.sdk_configuration = sdk_config
+        self._init_sdks()
+
+    def _init_sdks(self):
+        self.branches = Branches(self.sdk_configuration, parent_ref=self.parent_ref)
+        self.commits = Commits(self.sdk_configuration, parent_ref=self.parent_ref)
+        self.configs = VersionsConfigs(
+            self.sdk_configuration, parent_ref=self.parent_ref
+        )
+        self.statuses = Statuses(self.sdk_configuration, parent_ref=self.parent_ref)