volcano-sdk-python 0.9.4__py3-none-any.whl → 0.10.1__py3-none-any.whl

volcano_sdk/__init__.py

@@ -19,6 +19,10 @@ from .models import (
     AuthSession,
     AuthStateCallback,
     AuthSubscription,
+    DurableExecution,
+    DurableExecutionFailure,
+    DurableExecutionPage,
+    DurableExecutionStatus,
     EmailChangeResult,
     FunctionResponse,
     LinkedOAuthProvider,
@@ -54,6 +58,10 @@ __all__ = [
     "AuthSubscription",
     "AuthenticationError",
     "ConflictError",
+    "DurableExecution",
+    "DurableExecutionFailure",
+    "DurableExecutionPage",
+    "DurableExecutionStatus",
     "EmailChangeResult",
     "FunctionResponse",
     "LinkedOAuthProvider",

volcano_sdk/_function_resolution.py

@@ -28,7 +28,14 @@ _LOCK_STRIPES = 64
 
 
 def _now() -> float:
-    """Read the clock lifetimes are measured against, immune to wall-clock jumps."""
+    """Read the clock used for cache lifetimes.
+
+    Returns
+    -------
+    float
+        Monotonic seconds, unaffected by wall-clock adjustments.
+
+    """
     return time.monotonic()
 
 
@@ -62,7 +69,14 @@ _stripes = [threading.Lock() for _ in range(_LOCK_STRIPES)]
 
 
 def resolve_lock(api_url: str, authorization: str, name: str) -> threading.Lock:
-    """Return the lock that serializes resolving one name."""
+    """Select the lock for resolving one name.
+
+    Returns
+    -------
+    threading.Lock
+        A shared stripe keyed by API URL, credential, and function name.
+
+    """
     return _stripes[hash((api_url, authorization, name)) % _LOCK_STRIPES]
 
 
@@ -75,6 +89,12 @@ def valid_invoke_url(value: object, api_url: str) -> str | None:
 
     Anything unusable yields None so the caller falls back to the API path. A
     malformed server response must not raise out of invoke().
+
+    Returns
+    -------
+    str or None
+        The accepted URL unchanged, or None to use the API endpoint.
+
     """
     if not isinstance(value, str):
         return None
@@ -91,6 +111,12 @@ def _absolute_url_scheme(value: str) -> str:
 
     Unparseable input yields "" rather than raising, so a malformed URL reads
     as unusable to every caller.
+
+    Returns
+    -------
+    str
+        The lowercase scheme, or an empty string for an invalid authority or URL.
+
     """
     if not value or any(character.isspace() for character in value):
         return ""
@@ -105,7 +131,14 @@ def _absolute_url_scheme(value: str) -> str:
 
 
 def lookup(api_url: str, authorization: str, name: str) -> CachedOutcome | None:
-    """Return the cached outcome for a name, or None when it must be resolved."""
+    """Look up a function within its API and credential scope.
+
+    Returns
+    -------
+    CachedOutcome or None
+        An unexpired resolution or remembered miss; None requires a new resolve.
+
+    """
     key = (api_url, authorization, name)
     now = _now()
     with _lock:

volcano_sdk/_generated/api/databases/list_database_regions.py

@@ -68,6 +68,8 @@ def sync_detailed(
     """ List platform-supported regions for database provisioning
 
      Returns the regions enabled for database provisioning in this platform environment.
+    These are the same regions offered for function deployment, and the only values
+    the `region` field of a database accepts.
     This is a public endpoint that doesn't require authentication.
 
     Raises:
@@ -97,6 +99,8 @@ def sync(
     """ List platform-supported regions for database provisioning
 
      Returns the regions enabled for database provisioning in this platform environment.
+    These are the same regions offered for function deployment, and the only values
+    the `region` field of a database accepts.
     This is a public endpoint that doesn't require authentication.
 
     Raises:
@@ -121,6 +125,8 @@ async def asyncio_detailed(
     """ List platform-supported regions for database provisioning
 
      Returns the regions enabled for database provisioning in this platform environment.
+    These are the same regions offered for function deployment, and the only values
+    the `region` field of a database accepts.
     This is a public endpoint that doesn't require authentication.
 
     Raises:
@@ -150,6 +156,8 @@ async def asyncio(
     """ List platform-supported regions for database provisioning
 
      Returns the regions enabled for database provisioning in this platform environment.
+    These are the same regions offered for function deployment, and the only values
+    the `region` field of a database accepts.
     This is a public endpoint that doesn't require authentication.
 
     Raises:

volcano_sdk/_generated/api/durable_functions/__init__.py

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

volcano_sdk/_generated/api/durable_functions/create_durable_function.py

@@ -0,0 +1,295 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.create_durable_function_body import CreateDurableFunctionBody
+from ...models.durable_function import DurableFunction
+from ...models.error import Error
+from typing import cast
+from uuid import UUID
+
+
+
+def _get_kwargs(
+    id: UUID,
+    *,
+    body: CreateDurableFunctionBody,
+
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+
+    
+
+    
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/projects/{id}/durable-functions".format(id=quote(str(id), safe=""),),
+    }
+
+    _kwargs["files"] = body.to_multipart()
+
+    headers["Content-Type"] = "multipart/form-data; boundary=+++"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> DurableFunction | Error | None:
+    if response.status_code == 200:
+        response_200 = DurableFunction.from_dict(response.json())
+
+
+
+        return response_200
+
+    if response.status_code == 201:
+        response_201 = DurableFunction.from_dict(response.json())
+
+
+
+        return response_201
+
+    if response.status_code == 400:
+        response_400 = Error.from_dict(response.json())
+
+
+
+        return response_400
+
+    if response.status_code == 403:
+        response_403 = Error.from_dict(response.json())
+
+
+
+        return response_403
+
+    if response.status_code == 409:
+        response_409 = Error.from_dict(response.json())
+
+
+
+        return response_409
+
+    if response.status_code == 500:
+        response_500 = Error.from_dict(response.json())
+
+
+
+        return response_500
+
+    if response.status_code == 503:
+        response_503 = Error.from_dict(response.json())
+
+
+
+        return response_503
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[DurableFunction | Error]:
+    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: UUID,
+    *,
+    client: AuthenticatedClient,
+    body: CreateDurableFunctionBody,
+
+) -> Response[DurableFunction | Error]:
+    """ Create or update a durable function
+
+     Upload a durable function source bundle. Creates the function on the
+    first call for a name and redeploys it on every call after that, the
+    same create-or-update contract `POST /projects/{id}/functions` has.
+
+    Volcano builds and deploys asynchronously. A deployment that starts
+    immediately returns `status: provisioning`, then transitions to `active`
+    or `failed`; a deployment that has to wait for a running one is exposed
+    through `pending_deployment_id`. Existing executions keep running
+    against the runtime they started on.
+
+    The `durable` configuration is derived from the project's plan rather
+    than supplied here, and is fixed once the function exists. A name
+    already held by a standard function is rejected with 409: a function
+    cannot change kind.
+
+    Args:
+        id (UUID):
+        body (CreateDurableFunctionBody):
+
+    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[DurableFunction | Error]
+     """
+
+
+    kwargs = _get_kwargs(
+        id=id,
+body=body,
+
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+def sync(
+    id: UUID,
+    *,
+    client: AuthenticatedClient,
+    body: CreateDurableFunctionBody,
+
+) -> DurableFunction | Error | None:
+    """ Create or update a durable function
+
+     Upload a durable function source bundle. Creates the function on the
+    first call for a name and redeploys it on every call after that, the
+    same create-or-update contract `POST /projects/{id}/functions` has.
+
+    Volcano builds and deploys asynchronously. A deployment that starts
+    immediately returns `status: provisioning`, then transitions to `active`
+    or `failed`; a deployment that has to wait for a running one is exposed
+    through `pending_deployment_id`. Existing executions keep running
+    against the runtime they started on.
+
+    The `durable` configuration is derived from the project's plan rather
+    than supplied here, and is fixed once the function exists. A name
+    already held by a standard function is rejected with 409: a function
+    cannot change kind.
+
+    Args:
+        id (UUID):
+        body (CreateDurableFunctionBody):
+
+    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:
+        DurableFunction | Error
+     """
+
+
+    return sync_detailed(
+        id=id,
+client=client,
+body=body,
+
+    ).parsed
+
+async def asyncio_detailed(
+    id: UUID,
+    *,
+    client: AuthenticatedClient,
+    body: CreateDurableFunctionBody,
+
+) -> Response[DurableFunction | Error]:
+    """ Create or update a durable function
+
+     Upload a durable function source bundle. Creates the function on the
+    first call for a name and redeploys it on every call after that, the
+    same create-or-update contract `POST /projects/{id}/functions` has.
+
+    Volcano builds and deploys asynchronously. A deployment that starts
+    immediately returns `status: provisioning`, then transitions to `active`
+    or `failed`; a deployment that has to wait for a running one is exposed
+    through `pending_deployment_id`. Existing executions keep running
+    against the runtime they started on.
+
+    The `durable` configuration is derived from the project's plan rather
+    than supplied here, and is fixed once the function exists. A name
+    already held by a standard function is rejected with 409: a function
+    cannot change kind.
+
+    Args:
+        id (UUID):
+        body (CreateDurableFunctionBody):
+
+    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[DurableFunction | Error]
+     """
+
+
+    kwargs = _get_kwargs(
+        id=id,
+body=body,
+
+    )
+
+    response = await client.get_async_httpx_client().request(
+        **kwargs
+    )
+
+    return _build_response(client=client, response=response)
+
+async def asyncio(
+    id: UUID,
+    *,
+    client: AuthenticatedClient,
+    body: CreateDurableFunctionBody,
+
+) -> DurableFunction | Error | None:
+    """ Create or update a durable function
+
+     Upload a durable function source bundle. Creates the function on the
+    first call for a name and redeploys it on every call after that, the
+    same create-or-update contract `POST /projects/{id}/functions` has.
+
+    Volcano builds and deploys asynchronously. A deployment that starts
+    immediately returns `status: provisioning`, then transitions to `active`
+    or `failed`; a deployment that has to wait for a running one is exposed
+    through `pending_deployment_id`. Existing executions keep running
+    against the runtime they started on.
+
+    The `durable` configuration is derived from the project's plan rather
+    than supplied here, and is fixed once the function exists. A name
+    already held by a standard function is rejected with 409: a function
+    cannot change kind.
+
+    Args:
+        id (UUID):
+        body (CreateDurableFunctionBody):
+
+    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:
+        DurableFunction | Error
+     """
+
+
+    return (await asyncio_detailed(
+        id=id,
+client=client,
+body=body,
+
+    )).parsed

volcano_sdk/_generated/api/durable_functions/create_durable_function_scheduler.py

@@ -0,0 +1,259 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.create_function_scheduler_request import CreateFunctionSchedulerRequest
+from ...models.error import Error
+from ...models.function_scheduler import FunctionScheduler
+from typing import cast
+from uuid import UUID
+
+
+
+def _get_kwargs(
+    id: UUID,
+    function_id: str,
+    *,
+    body: CreateFunctionSchedulerRequest,
+
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+
+    
+
+    
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/projects/{id}/durable-functions/{function_id}/schedulers".format(id=quote(str(id), safe=""),function_id=quote(str(function_id), safe=""),),
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Error | FunctionScheduler | None:
+    if response.status_code == 201:
+        response_201 = FunctionScheduler.from_dict(response.json())
+
+
+
+        return response_201
+
+    if response.status_code == 400:
+        response_400 = Error.from_dict(response.json())
+
+
+
+        return response_400
+
+    if response.status_code == 403:
+        response_403 = Error.from_dict(response.json())
+
+
+
+        return response_403
+
+    if response.status_code == 404:
+        response_404 = Error.from_dict(response.json())
+
+
+
+        return response_404
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[Error | FunctionScheduler]:
+    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: UUID,
+    function_id: str,
+    *,
+    client: AuthenticatedClient,
+    body: CreateFunctionSchedulerRequest,
+
+) -> Response[Error | FunctionScheduler]:
+    """ Create a scheduler for a durable function
+
+     Each tick starts an execution rather than invoking the function, under
+    an execution name derived from the run, so a retried tick resolves to
+    the execution it already started. Requested regions must be a subset of
+    the function's deployed regions.
+
+    A tick draws on the same durable allowances and concurrency cap a
+    manual start does, and a tick that would exceed the cap fails that run.
+
+    Args:
+        id (UUID):
+        function_id (str):
+        body (CreateFunctionSchedulerRequest):
+
+    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[Error | FunctionScheduler]
+     """
+
+
+    kwargs = _get_kwargs(
+        id=id,
+function_id=function_id,
+body=body,
+
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+def sync(
+    id: UUID,
+    function_id: str,
+    *,
+    client: AuthenticatedClient,
+    body: CreateFunctionSchedulerRequest,
+
+) -> Error | FunctionScheduler | None:
+    """ Create a scheduler for a durable function
+
+     Each tick starts an execution rather than invoking the function, under
+    an execution name derived from the run, so a retried tick resolves to
+    the execution it already started. Requested regions must be a subset of
+    the function's deployed regions.
+
+    A tick draws on the same durable allowances and concurrency cap a
+    manual start does, and a tick that would exceed the cap fails that run.
+
+    Args:
+        id (UUID):
+        function_id (str):
+        body (CreateFunctionSchedulerRequest):
+
+    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:
+        Error | FunctionScheduler
+     """
+
+
+    return sync_detailed(
+        id=id,
+function_id=function_id,
+client=client,
+body=body,
+
+    ).parsed
+
+async def asyncio_detailed(
+    id: UUID,
+    function_id: str,
+    *,
+    client: AuthenticatedClient,
+    body: CreateFunctionSchedulerRequest,
+
+) -> Response[Error | FunctionScheduler]:
+    """ Create a scheduler for a durable function
+
+     Each tick starts an execution rather than invoking the function, under
+    an execution name derived from the run, so a retried tick resolves to
+    the execution it already started. Requested regions must be a subset of
+    the function's deployed regions.
+
+    A tick draws on the same durable allowances and concurrency cap a
+    manual start does, and a tick that would exceed the cap fails that run.
+
+    Args:
+        id (UUID):
+        function_id (str):
+        body (CreateFunctionSchedulerRequest):
+
+    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[Error | FunctionScheduler]
+     """
+
+
+    kwargs = _get_kwargs(
+        id=id,
+function_id=function_id,
+body=body,
+
+    )
+
+    response = await client.get_async_httpx_client().request(
+        **kwargs
+    )
+
+    return _build_response(client=client, response=response)
+
+async def asyncio(
+    id: UUID,
+    function_id: str,
+    *,
+    client: AuthenticatedClient,
+    body: CreateFunctionSchedulerRequest,
+
+) -> Error | FunctionScheduler | None:
+    """ Create a scheduler for a durable function
+
+     Each tick starts an execution rather than invoking the function, under
+    an execution name derived from the run, so a retried tick resolves to
+    the execution it already started. Requested regions must be a subset of
+    the function's deployed regions.
+
+    A tick draws on the same durable allowances and concurrency cap a
+    manual start does, and a tick that would exceed the cap fails that run.
+
+    Args:
+        id (UUID):
+        function_id (str):
+        body (CreateFunctionSchedulerRequest):
+
+    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:
+        Error | FunctionScheduler
+     """
+
+
+    return (await asyncio_detailed(
+        id=id,
+function_id=function_id,
+client=client,
+body=body,
+
+    )).parsed