# Code generated by ndpgen. DO NOT EDIT. # # This file contains client wrappers for the Task host service. # It is intended for use in Navidrome plugins built with extism-py. # # IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. # The @extism.import_fn decorators are only detected when defined in the plugin's # main __init__.py file. Copy the needed functions from this file into your plugin. from dataclasses import dataclass from typing import Any import extism import json import base64 class HostFunctionError(Exception): """Raised when a host function returns an error.""" pass @extism.import_fn("extism:host/user", "task_createqueue") def _task_createqueue(offset: int) -> int: """Raw host function - do not call directly.""" ... @extism.import_fn("extism:host/user", "task_enqueue") def _task_enqueue(offset: int) -> int: """Raw host function - do not call directly.""" ... @extism.import_fn("extism:host/user", "task_get") def _task_get(offset: int) -> int: """Raw host function - do not call directly.""" ... @extism.import_fn("extism:host/user", "task_cancel") def _task_cancel(offset: int) -> int: """Raw host function - do not call directly.""" ... def task_create_queue(name: str, config: Any) -> None: """CreateQueue creates a named task queue with the given configuration. Zero-value fields in config use sensible defaults. If a queue with the same name already exists, returns an error. On startup, this also recovers any stale "running" tasks from a previous crash. Args: name: str parameter. config: Any parameter. Raises: HostFunctionError: If the host function returns an error. """ request = { "name": name, "config": config, } request_bytes = json.dumps(request).encode("utf-8") request_mem = extism.memory.alloc(request_bytes) response_offset = _task_createqueue(request_mem.offset) response_mem = extism.memory.find(response_offset) response = json.loads(extism.memory.string(response_mem)) if response.get("error"): raise HostFunctionError(response["error"]) def task_enqueue(queue_name: str, payload: bytes) -> str: """Enqueue adds a task to the named queue. Returns the task ID. payload is opaque bytes passed back to the plugin on execution. Args: queue_name: str parameter. payload: bytes parameter. Returns: str: The result value. Raises: HostFunctionError: If the host function returns an error. """ request = { "queueName": queue_name, "payload": base64.b64encode(payload).decode("ascii"), } request_bytes = json.dumps(request).encode("utf-8") request_mem = extism.memory.alloc(request_bytes) response_offset = _task_enqueue(request_mem.offset) response_mem = extism.memory.find(response_offset) response = json.loads(extism.memory.string(response_mem)) if response.get("error"): raise HostFunctionError(response["error"]) return response.get("result", "") def task_get(task_id: str) -> Any: """Get returns the current state of a task including its status, message, and attempt count. Args: task_id: str parameter. Returns: Any: The result value. Raises: HostFunctionError: If the host function returns an error. """ request = { "taskId": task_id, } request_bytes = json.dumps(request).encode("utf-8") request_mem = extism.memory.alloc(request_bytes) response_offset = _task_get(request_mem.offset) response_mem = extism.memory.find(response_offset) response = json.loads(extism.memory.string(response_mem)) if response.get("error"): raise HostFunctionError(response["error"]) return response.get("result", None) def task_cancel(task_id: str) -> None: """Cancel cancels a pending task. Returns error if already running, completed, or failed. Args: task_id: str parameter. Raises: HostFunctionError: If the host function returns an error. """ request = { "taskId": task_id, } request_bytes = json.dumps(request).encode("utf-8") request_mem = extism.memory.alloc(request_bytes) response_offset = _task_cancel(request_mem.offset) response_mem = extism.memory.find(response_offset) response = json.loads(extism.memory.string(response_mem)) if response.get("error"): raise HostFunctionError(response["error"])