mlops-python-sdk 0.0.1__py3-none-any.whl

mlops/__init__.py

@@ -0,0 +1,46 @@
+"""
+XClient Python SDK for accessing XCloud Service API.
+
+This package provides a client library for interacting with the XCloud Service API.
+"""
+
+from .api.client import Client, AuthenticatedClient
+from .connection_config import (
+    ConnectionConfig,
+    ProxyTypes,
+)
+from .exceptions import (
+    XClientException,
+    TimeoutException,
+    NotFoundException,
+    AuthenticationException,
+    InvalidArgumentException,
+    NotEnoughSpaceException,
+    RateLimitException,
+    APIException,
+)
+from .task import Task, TaskClient
+
+__all__ = [
+    # API
+    "Client",
+    "AuthenticatedClient",
+    # Connection config
+    "ConnectionConfig",
+    "ProxyTypes",
+    # Exceptions
+    "XClientException",
+    "TimeoutException",
+    "NotFoundException",
+    "AuthenticationException",
+    "InvalidArgumentException",
+    "NotEnoughSpaceException",
+    "RateLimitException",
+    "APIException",
+    # Task SDK
+    "Task",
+    "TaskClient",
+]
+
+__version__ = "1.0.0"
+

mlops/api/client/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing XCloud Service API"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

mlops/api/client/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

mlops/api/client/api/tasks/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

mlops/api/client/api/tasks/cancel_task.py

@@ -0,0 +1,196 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.error_response import ErrorResponse
+from ...models.message_response import MessageResponse
+from ...types import UNSET, Response
+
+
+def _get_kwargs(
+    id: int,
+    *,
+    cluster_id: int,
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
+
+    params["cluster_id"] = cluster_id
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "delete",
+        "url": f"/tasks/{id}",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[ErrorResponse, MessageResponse]]:
+    if response.status_code == 200:
+        response_200 = MessageResponse.from_dict(response.json())
+
+        return response_200
+    if response.status_code == 401:
+        response_401 = ErrorResponse.from_dict(response.json())
+
+        return response_401
+    if response.status_code == 403:
+        response_403 = ErrorResponse.from_dict(response.json())
+
+        return response_403
+    if response.status_code == 404:
+        response_404 = ErrorResponse.from_dict(response.json())
+
+        return response_404
+    if response.status_code == 500:
+        response_500 = ErrorResponse.from_dict(response.json())
+
+        return response_500
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[ErrorResponse, MessageResponse]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+    cluster_id: int,
+) -> Response[Union[ErrorResponse, MessageResponse]]:
+    """Cancel task
+
+     Cancel the specified task
+
+    Args:
+        id (int):
+        cluster_id (int):
+
+    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[Union[ErrorResponse, MessageResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        cluster_id=cluster_id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+    cluster_id: int,
+) -> Optional[Union[ErrorResponse, MessageResponse]]:
+    """Cancel task
+
+     Cancel the specified task
+
+    Args:
+        id (int):
+        cluster_id (int):
+
+    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:
+        Union[ErrorResponse, MessageResponse]
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+        cluster_id=cluster_id,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+    cluster_id: int,
+) -> Response[Union[ErrorResponse, MessageResponse]]:
+    """Cancel task
+
+     Cancel the specified task
+
+    Args:
+        id (int):
+        cluster_id (int):
+
+    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[Union[ErrorResponse, MessageResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        cluster_id=cluster_id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+    cluster_id: int,
+) -> Optional[Union[ErrorResponse, MessageResponse]]:
+    """Cancel task
+
+     Cancel the specified task
+
+    Args:
+        id (int):
+        cluster_id (int):
+
+    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:
+        Union[ErrorResponse, MessageResponse]
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+            cluster_id=cluster_id,
+        )
+    ).parsed

mlops/api/client/api/tasks/delete_task.py

@@ -0,0 +1,204 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.error_response import ErrorResponse
+from ...models.message_response import MessageResponse
+from ...types import UNSET, Response
+
+
+def _get_kwargs(
+    id: int,
+    *,
+    cluster_id: int,
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
+
+    params["cluster_id"] = cluster_id
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "delete",
+        "url": f"/tasks/{id}/delete",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[ErrorResponse, MessageResponse]]:
+    if response.status_code == 200:
+        response_200 = MessageResponse.from_dict(response.json())
+
+        return response_200
+    if response.status_code == 400:
+        response_400 = ErrorResponse.from_dict(response.json())
+
+        return response_400
+    if response.status_code == 401:
+        response_401 = ErrorResponse.from_dict(response.json())
+
+        return response_401
+    if response.status_code == 403:
+        response_403 = ErrorResponse.from_dict(response.json())
+
+        return response_403
+    if response.status_code == 404:
+        response_404 = ErrorResponse.from_dict(response.json())
+
+        return response_404
+    if response.status_code == 500:
+        response_500 = ErrorResponse.from_dict(response.json())
+
+        return response_500
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[ErrorResponse, MessageResponse]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+    cluster_id: int,
+) -> Response[Union[ErrorResponse, MessageResponse]]:
+    """Delete task record
+
+     Delete a task record from the database. This should only be used for tasks that are already
+    completed, failed, or cancelled. Cannot delete running or pending tasks.
+
+    Args:
+        id (int):
+        cluster_id (int):
+
+    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[Union[ErrorResponse, MessageResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        cluster_id=cluster_id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+    cluster_id: int,
+) -> Optional[Union[ErrorResponse, MessageResponse]]:
+    """Delete task record
+
+     Delete a task record from the database. This should only be used for tasks that are already
+    completed, failed, or cancelled. Cannot delete running or pending tasks.
+
+    Args:
+        id (int):
+        cluster_id (int):
+
+    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:
+        Union[ErrorResponse, MessageResponse]
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+        cluster_id=cluster_id,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+    cluster_id: int,
+) -> Response[Union[ErrorResponse, MessageResponse]]:
+    """Delete task record
+
+     Delete a task record from the database. This should only be used for tasks that are already
+    completed, failed, or cancelled. Cannot delete running or pending tasks.
+
+    Args:
+        id (int):
+        cluster_id (int):
+
+    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[Union[ErrorResponse, MessageResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        cluster_id=cluster_id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+    cluster_id: int,
+) -> Optional[Union[ErrorResponse, MessageResponse]]:
+    """Delete task record
+
+     Delete a task record from the database. This should only be used for tasks that are already
+    completed, failed, or cancelled. Cannot delete running or pending tasks.
+
+    Args:
+        id (int):
+        cluster_id (int):
+
+    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:
+        Union[ErrorResponse, MessageResponse]
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+            cluster_id=cluster_id,
+        )
+    ).parsed

mlops/api/client/api/tasks/get_task.py

@@ -0,0 +1,196 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.error_response import ErrorResponse
+from ...models.task import Task
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    id: int,
+    *,
+    cluster_id: Union[Unset, int] = UNSET,
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
+
+    params["cluster_id"] = cluster_id
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": f"/tasks/{id}",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[ErrorResponse, Task]]:
+    if response.status_code == 200:
+        response_200 = Task.from_dict(response.json())
+
+        return response_200
+    if response.status_code == 401:
+        response_401 = ErrorResponse.from_dict(response.json())
+
+        return response_401
+    if response.status_code == 403:
+        response_403 = ErrorResponse.from_dict(response.json())
+
+        return response_403
+    if response.status_code == 404:
+        response_404 = ErrorResponse.from_dict(response.json())
+
+        return response_404
+    if response.status_code == 500:
+        response_500 = ErrorResponse.from_dict(response.json())
+
+        return response_500
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[ErrorResponse, Task]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+    cluster_id: Union[Unset, int] = UNSET,
+) -> Response[Union[ErrorResponse, Task]]:
+    """Get task details
+
+     Get detailed task information by task ID (Slurm job ID) and cluster ID
+
+    Args:
+        id (int):
+        cluster_id (Union[Unset, int]):
+
+    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[Union[ErrorResponse, Task]]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        cluster_id=cluster_id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+    cluster_id: Union[Unset, int] = UNSET,
+) -> Optional[Union[ErrorResponse, Task]]:
+    """Get task details
+
+     Get detailed task information by task ID (Slurm job ID) and cluster ID
+
+    Args:
+        id (int):
+        cluster_id (Union[Unset, int]):
+
+    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:
+        Union[ErrorResponse, Task]
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+        cluster_id=cluster_id,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+    cluster_id: Union[Unset, int] = UNSET,
+) -> Response[Union[ErrorResponse, Task]]:
+    """Get task details
+
+     Get detailed task information by task ID (Slurm job ID) and cluster ID
+
+    Args:
+        id (int):
+        cluster_id (Union[Unset, int]):
+
+    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[Union[ErrorResponse, Task]]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        cluster_id=cluster_id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+    cluster_id: Union[Unset, int] = UNSET,
+) -> Optional[Union[ErrorResponse, Task]]:
+    """Get task details
+
+     Get detailed task information by task ID (Slurm job ID) and cluster ID
+
+    Args:
+        id (int):
+        cluster_id (Union[Unset, int]):
+
+    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:
+        Union[ErrorResponse, Task]
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+            cluster_id=cluster_id,
+        )
+    ).parsed