orca-sdk 0.1.0__py3-none-any.whl

orca_sdk/_generated_api_client/api/telemetry/record_prediction_feedback_telemetry_prediction_feedback_put.py

@@ -0,0 +1,171 @@
+"""
+This file is generated by the openapi-python-client tool via the generate_api_client.py script
+
+It is a customized template from the openapi-python-client tool's default template:
+https://github.com/openapi-generators/openapi-python-client/blob/861ef5622f10fc96d240dc9becb0edf94e61446c/openapi_python_client/templates/endpoint_module.py.jinja
+
+The main changes are:
+- Update the API call responses to either return the successful response type or raise an error by:
+    - Updating the _parse_response function to raise an error if the response status code is not in the 2xx range
+- Inject a client into every method via a context manager
+"""
+
+from http import HTTPStatus
+from typing import Any, Dict, List
+
+import httpx
+
+from ...client import _client_context
+from ...errors import get_error_for_response
+from ...models.prediction_feedback_request import PredictionFeedbackRequest
+from ...models.prediction_feedback_result import PredictionFeedbackResult
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: List["PredictionFeedbackRequest"],
+) -> dict[str, Any]:
+    headers: Dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "put",
+        "url": "/telemetry/prediction/feedback",
+    }
+
+    _body = []
+    for body_item_data in body:
+        body_item = body_item_data.to_dict()
+        _body.append(body_item)
+
+    _kwargs["json"] = _body
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(*, response: httpx.Response) -> PredictionFeedbackResult:
+    if response.status_code == 200:
+        response_200 = PredictionFeedbackResult.from_dict(response.json())
+
+        return response_200
+    if response.status_code == 401:
+        raise get_error_for_response(response)
+    if response.status_code == 500:
+        raise get_error_for_response(response)
+    if response.status_code == 503:
+        raise get_error_for_response(response)
+    if response.status_code == 422:
+        raise get_error_for_response(response)
+
+
+def _build_response(*, response: httpx.Response) -> Response[PredictionFeedbackResult]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    body: List["PredictionFeedbackRequest"],
+) -> Response[PredictionFeedbackResult]:
+    """Record Prediction Feedback
+
+    Args:
+        body (List['PredictionFeedbackRequest']):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[PredictionFeedbackResult]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    with _client_context() as client:
+        response = client.get_httpx_client().request(
+            **kwargs,
+        )
+
+        return _build_response(response=response)
+
+
+def sync(
+    *,
+    body: List["PredictionFeedbackRequest"],
+) -> PredictionFeedbackResult:
+    """Record Prediction Feedback
+
+    Args:
+        body (List['PredictionFeedbackRequest']):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        PredictionFeedbackResult
+    """
+
+    return sync_detailed(
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    body: List["PredictionFeedbackRequest"],
+) -> Response[PredictionFeedbackResult]:
+    """Record Prediction Feedback
+
+    Args:
+        body (List['PredictionFeedbackRequest']):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[PredictionFeedbackResult]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    with _client_context() as client:
+        response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(response=response)
+
+
+async def asyncio(
+    *,
+    body: List["PredictionFeedbackRequest"],
+) -> PredictionFeedbackResult:
+    """Record Prediction Feedback
+
+    Args:
+        body (List['PredictionFeedbackRequest']):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        PredictionFeedbackResult
+    """
+
+    return (
+        await asyncio_detailed(
+            body=body,
+        )
+    ).parsed

orca_sdk/_generated_api_client/api/telemetry/update_prediction_telemetry_prediction_prediction_id_patch.py

@@ -0,0 +1,181 @@
+"""
+This file is generated by the openapi-python-client tool via the generate_api_client.py script
+
+It is a customized template from the openapi-python-client tool's default template:
+https://github.com/openapi-generators/openapi-python-client/blob/861ef5622f10fc96d240dc9becb0edf94e61446c/openapi_python_client/templates/endpoint_module.py.jinja
+
+The main changes are:
+- Update the API call responses to either return the successful response type or raise an error by:
+    - Updating the _parse_response function to raise an error if the response status code is not in the 2xx range
+- Inject a client into every method via a context manager
+"""
+
+from http import HTTPStatus
+from typing import Any, Dict
+
+import httpx
+
+from ...client import _client_context
+from ...errors import get_error_for_response
+from ...models.update_prediction_request import UpdatePredictionRequest
+from ...types import Response
+
+
+def _get_kwargs(
+    prediction_id: str,
+    *,
+    body: UpdatePredictionRequest,
+) -> dict[str, Any]:
+    headers: Dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "patch",
+        "url": f"/telemetry/prediction/{prediction_id}",
+    }
+
+    _body = body.to_dict()
+
+    _kwargs["json"] = _body
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(*, response: httpx.Response) -> None:
+    if response.status_code == 200:
+        response_200 = response.json()
+        return response_200
+    if response.status_code == 401:
+        raise get_error_for_response(response)
+    if response.status_code == 500:
+        raise get_error_for_response(response)
+    if response.status_code == 503:
+        raise get_error_for_response(response)
+    if response.status_code == 422:
+        raise get_error_for_response(response)
+    if response.status_code == 404:
+        raise get_error_for_response(response)
+
+
+def _build_response(*, response: httpx.Response) -> Response[None]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(response=response),
+    )
+
+
+def sync_detailed(
+    prediction_id: str,
+    *,
+    body: UpdatePredictionRequest,
+) -> Response[None]:
+    """Update Prediction
+
+    Args:
+        prediction_id (str):
+        body (UpdatePredictionRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[None]
+    """
+
+    kwargs = _get_kwargs(
+        prediction_id=prediction_id,
+        body=body,
+    )
+
+    with _client_context() as client:
+        response = client.get_httpx_client().request(
+            **kwargs,
+        )
+
+        return _build_response(response=response)
+
+
+def sync(
+    prediction_id: str,
+    *,
+    body: UpdatePredictionRequest,
+) -> None:
+    """Update Prediction
+
+    Args:
+        prediction_id (str):
+        body (UpdatePredictionRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        None
+    """
+
+    return sync_detailed(
+        prediction_id=prediction_id,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    prediction_id: str,
+    *,
+    body: UpdatePredictionRequest,
+) -> Response[None]:
+    """Update Prediction
+
+    Args:
+        prediction_id (str):
+        body (UpdatePredictionRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[None]
+    """
+
+    kwargs = _get_kwargs(
+        prediction_id=prediction_id,
+        body=body,
+    )
+
+    with _client_context() as client:
+        response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(response=response)
+
+
+async def asyncio(
+    prediction_id: str,
+    *,
+    body: UpdatePredictionRequest,
+) -> None:
+    """Update Prediction
+
+    Args:
+        prediction_id (str):
+        body (UpdatePredictionRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        None
+    """
+
+    return (
+        await asyncio_detailed(
+            prediction_id=prediction_id,
+            body=body,
+        )
+    ).parsed

orca_sdk/_generated_api_client/client.py

@@ -0,0 +1,216 @@
+"""
+This file is generated by the openapi-python-client tool via the generate_api_client.py script
+
+It is a customized template from the openapi-python-client tool's default template:
+https://github.com/openapi-generators/openapi-python-client/blob/5cfe4e1d594951725844ea470fc9d61f40c08093/openapi_python_client/templates/client.py.jinja
+
+The main changes are:
+- add a lazy initialized global client singleton that is injected into every api method via a context manager
+- add methods for setting headers and base URL on the global client singleton
+"""
+
+import os
+import ssl
+from contextlib import contextmanager
+from typing import Any, Optional, Union
+
+import httpx
+from attrs import define, evolve, field
+
+
+@define
+class Client:
+    """A class for keeping track of data related to the API
+
+    The following are accepted as keyword arguments and will be used to construct httpx Clients internally:
+
+        ``base_url``: The base URL for the API, all requests are made to a relative path to this URL
+
+        ``cookies``: A dictionary of cookies to be sent with every request
+
+        ``headers``: A dictionary of headers to be sent with every request
+
+        ``timeout``: The maximum amount of a time a request can take. API functions will raise
+        httpx.TimeoutException if this is exceeded.
+
+        ``verify_ssl``: Whether or not to verify the SSL certificate of the API server. This should be True in production,
+        but can be set to False for testing purposes.
+
+        ``follow_redirects``: Whether or not to follow redirects. Default value is False.
+
+        ``httpx_args``: A dictionary of additional arguments to be passed to the ``httpx.Client`` and ``httpx.AsyncClient`` constructor.
+
+
+    Attributes:
+        raise_on_unexpected_status: Whether or not to raise an errors.UnexpectedStatus if the API returns a
+            status code that was not documented in the source OpenAPI document. Can also be provided as a keyword
+            argument to the constructor.
+    """
+
+    raise_on_unexpected_status: bool = field(default=False, kw_only=True)
+    _base_url: str = field(alias="base_url")
+    _cookies: dict[str, str] = field(factory=dict, kw_only=True, alias="cookies")
+    _headers: dict[str, str] = field(factory=dict, kw_only=True, alias="headers")
+    _timeout: Optional[httpx.Timeout] = field(default=None, kw_only=True, alias="timeout")
+    _verify_ssl: Union[str, bool, ssl.SSLContext] = field(default=True, kw_only=True, alias="verify_ssl")
+    _follow_redirects: bool = field(default=False, kw_only=True, alias="follow_redirects")
+    _httpx_args: dict[str, Any] = field(factory=dict, kw_only=True, alias="httpx_args")
+    _client: Optional[httpx.Client] = field(default=None, init=False)
+    _async_client: Optional[httpx.AsyncClient] = field(default=None, init=False)
+
+    def with_headers(self, headers: dict[str, str]) -> "Client":
+        """Get a new client matching this one with additional headers"""
+        if self._client is not None:
+            self._client.headers.update(headers)
+        if self._async_client is not None:
+            self._async_client.headers.update(headers)
+        return evolve(self, headers={**self._headers, **headers})
+
+    def with_cookies(self, cookies: dict[str, str]) -> "Client":
+        """Get a new client matching this one with additional cookies"""
+        if self._client is not None:
+            self._client.cookies.update(cookies)
+        if self._async_client is not None:
+            self._async_client.cookies.update(cookies)
+        return evolve(self, cookies={**self._cookies, **cookies})
+
+    def with_timeout(self, timeout: httpx.Timeout) -> "Client":
+        """Get a new client matching this one with a new timeout (in seconds)"""
+        if self._client is not None:
+            self._client.timeout = timeout
+        if self._async_client is not None:
+            self._async_client.timeout = timeout
+        return evolve(self, timeout=timeout)
+
+    def set_httpx_client(self, client: httpx.Client) -> "Client":
+        """Manually set the underlying httpx.Client
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._client = client
+        return self
+
+    def get_httpx_client(self) -> httpx.Client:
+        """Get the underlying httpx.Client, constructing a new one if not previously set"""
+        if self._client is None:
+            self._client = httpx.Client(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._client
+
+    def __enter__(self) -> "Client":
+        """Enter a context manager for self.client—you cannot enter twice (see httpx docs)"""
+        self.get_httpx_client().__enter__()
+        return self
+
+    def __exit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for internal httpx.Client (see httpx docs)"""
+        self.get_httpx_client().__exit__(*args, **kwargs)
+
+    def set_async_httpx_client(self, async_client: httpx.AsyncClient) -> "Client":
+        """Manually the underlying httpx.AsyncClient
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._async_client = async_client
+        return self
+
+    def get_async_httpx_client(self) -> httpx.AsyncClient:
+        """Get the underlying httpx.AsyncClient, constructing a new one if not previously set"""
+        if self._async_client is None:
+            self._async_client = httpx.AsyncClient(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._async_client
+
+    async def __aenter__(self) -> "Client":
+        """Enter a context manager for underlying httpx.AsyncClient—you cannot enter twice (see httpx docs)"""
+        await self.get_async_httpx_client().__aenter__()
+        return self
+
+    async def __aexit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for underlying httpx.AsyncClient (see httpx docs)"""
+        await self.get_async_httpx_client().__aexit__(*args, **kwargs)
+
+
+# this must be initialized lazily to ensure that the environment variables are set
+_client: Optional["Client"] = None
+
+
+def get_base_url():
+    """Get the base URL for the global client singleton"""
+    global _client
+    if _client is not None:
+        return _client._base_url
+    return os.environ.get("ORCA_API_URL", "https://api.orcadb.ai/")
+
+
+def get_headers():
+    """Get the headers for the global client singleton"""
+    global _client
+    if _client is not None:
+        return _client._headers
+    headers = {}
+    api_key = os.environ.get("ORCA_API_KEY")
+    if api_key is not None:
+        headers["Api-Key"] = api_key
+    return headers
+
+
+def get_client():
+    """Get the global client singleton"""
+    global _client
+    if _client is None:
+        _client = Client(base_url=get_base_url(), headers=get_headers())
+    return _client
+
+
+def set_headers(headers: dict[str, str]):
+    """Set the headers for the global client singleton"""
+    global _client
+    _client = Client(base_url=get_base_url(), headers=headers)
+    return _client
+
+
+def set_base_url(base_url: str):
+    """Set the base URL for the global client singleton"""
+    global _client
+    _client = Client(base_url=base_url, headers=_client._headers if _client is not None else {})
+    return _client
+
+
+@contextmanager
+def headers_context(headers: dict[str, str]):
+    """Set the headers for the global client singleton within a context manager"""
+    global _client
+    old_client = get_client()
+    set_headers(headers=headers)
+    yield
+    _client = old_client
+
+
+@contextmanager
+def base_url_context(base_url: str):
+    """Set the base URL for the global client singleton within a context manager"""
+    global _client
+    old_client = get_client()
+    set_base_url(base_url=base_url)
+    yield
+    _client = old_client
+
+
+@contextmanager
+def _client_context():
+    yield get_client()

orca_sdk/_generated_api_client/errors.py

@@ -0,0 +1,38 @@
+"""
+This file is generated by the openapi-python-client tool via the generate_api_client.py script
+
+It is a customized template from the openapi-python-client tool's default template:
+https://github.com/openapi-generators/openapi-python-client/blob/861ef5622f10fc96d240dc9becb0edf94e61446c/openapi_python_client/templates/errors.py.jinja
+
+The main change is:
+- Returning the appropriate python exception for Orca API's error responses
+"""
+
+import httpx
+
+
+def get_error_for_response(response: httpx.Response):
+    """Raise an appropriate exception based on the response status code and content"""
+    if response.status_code == 401:
+        return ValueError("Invalid API key")
+    elif response.status_code == 403:
+        return PermissionError(response.json()["reason"])
+    elif response.status_code == 404:
+        resource = response.json()["resource"]
+        if resource is not None:
+            return LookupError(f"The {resource} you are looking for does not exist")
+        else:
+            return RuntimeError(f"Unknown API route: {response.url}")
+    elif response.status_code == 405:
+        return RuntimeError(f"Unknown method {response.request.method} for API route: {response.url}")
+    elif response.status_code == 409:
+        return RuntimeError(response.json()["constraint"])
+    elif response.status_code == 422:
+        issues = [f"{issue['loc'][-1]}: {issue['msg']}" for issue in response.json()["validation_issues"]]
+        return ValueError("Invalid input:\n\t" + "\n\t".join(issues))
+    elif response.status_code == 500:
+        return RuntimeError(f"Unexpected server error: {response.json()['message']}")
+    elif response.status_code == 503:
+        return RuntimeError("Orca API is currently unavailable, please try again later")
+    else:
+        return RuntimeError(f"Unexpected status code: {response.status_code}")