-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: provokateurin <kate@provokateurin.de>
- Loading branch information
1 parent
fd92a25
commit 9cc9526
Showing
2 changed files
with
132 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,125 @@ | ||
"""Nextcloud API for declaring TaskProcessing provider.""" | ||
|
||
import contextlib | ||
import dataclasses | ||
|
||
from ..._exceptions import NextcloudException, NextcloudExceptionNotFound | ||
from ..._misc import require_capabilities | ||
from ..._session import AsyncNcSessionApp, NcSessionApp | ||
|
||
_EP_SUFFIX: str = "ai_provider/task_processing" | ||
|
||
|
||
@dataclasses.dataclass | ||
class TaskProcessingProvider: | ||
"""TaskProcessing provider description.""" | ||
|
||
def __init__(self, raw_data: dict): | ||
self._raw_data = raw_data | ||
|
||
@property | ||
def name(self) -> str: | ||
"""Unique ID for the provider.""" | ||
return self._raw_data["name"] | ||
|
||
@property | ||
def display_name(self) -> str: | ||
"""Providers display name.""" | ||
return self._raw_data["display_name"] | ||
|
||
@property | ||
def task_type(self) -> str: | ||
"""The TaskType provided by this provider.""" | ||
return self._raw_data["task_type"] | ||
|
||
def __repr__(self): | ||
return f"<{self.__class__.__name__} name={self.name}, type={self.task_type}>" | ||
|
||
|
||
class _TaskProcessingProviderAPI: | ||
"""API for TaskProcessing providers, available as **nc.providers.task_processing.<method>**.""" | ||
|
||
def __init__(self, session: NcSessionApp): | ||
self._session = session | ||
|
||
def register(self, name: str, display_name: str, task_type: str) -> None: | ||
"""Registers or edit the TaskProcessing provider.""" | ||
require_capabilities("app_api", self._session.capabilities) | ||
params = { | ||
"name": name, | ||
"displayName": display_name, | ||
"taskType": task_type, | ||
} | ||
self._session.ocs("POST", f"{self._session.ae_url}/{_EP_SUFFIX}", json=params) | ||
|
||
def unregister(self, name: str, not_fail=True) -> None: | ||
"""Removes TaskProcessing provider.""" | ||
require_capabilities("app_api", self._session.capabilities) | ||
try: | ||
self._session.ocs("DELETE", f"{self._session.ae_url}/{_EP_SUFFIX}", params={"name": name}) | ||
except NextcloudExceptionNotFound as e: | ||
if not not_fail: | ||
raise e from None | ||
|
||
def next_task(self, task_type: str): | ||
"""Get the next task processing task from Nextcloud""" | ||
with contextlib.suppress(NextcloudException): | ||
return self._session.ocs( | ||
"GET", | ||
"/ocs/v2.php/taskprocessing/tasks/next", | ||
json={"taskTypeId": task_type}, | ||
) | ||
|
||
def report_result(self, task_id: int, output: [str, str] = None, error_message: str = None) -> None: | ||
"""Report results of the task processing to Nextcloud.""" | ||
with contextlib.suppress(NextcloudException): | ||
return self._session.ocs( | ||
"POST", | ||
f"/ocs/v2.php/taskprocessing/tasks/{task_id}/result", | ||
json={"taskId": task_id, "output": output, "errorMessage": error_message}, | ||
) | ||
|
||
|
||
class _AsyncTaskProcessingProviderAPI: | ||
"""Async API for TaskProcessing providers.""" | ||
|
||
def __init__(self, session: AsyncNcSessionApp): | ||
self._session = session | ||
|
||
async def register(self, name: str, display_name: str, task_type: str) -> None: | ||
"""Registers or edit the TaskProcessing provider.""" | ||
require_capabilities("app_api", await self._session.capabilities) | ||
params = { | ||
"name": name, | ||
"displayName": display_name, | ||
"taskType": task_type, | ||
} | ||
await self._session.ocs("POST", f"{self._session.ae_url}/{_EP_SUFFIX}", json=params) | ||
|
||
async def unregister(self, name: str, not_fail=True) -> None: | ||
"""Removes TaskProcessing provider.""" | ||
require_capabilities("app_api", await self._session.capabilities) | ||
try: | ||
await self._session.ocs("DELETE", f"{self._session.ae_url}/{_EP_SUFFIX}", params={"name": name}) | ||
except NextcloudExceptionNotFound as e: | ||
if not not_fail: | ||
raise e from None | ||
|
||
async def next_task(self, task_type: str): | ||
"""Get the next task processing task from Nextcloud""" | ||
with contextlib.suppress(NextcloudException): | ||
return await self._session.ocs( | ||
"GET", | ||
"/ocs/v2.php/taskprocessing/tasks/next", | ||
json={"taskTypeId": task_type}, | ||
) | ||
|
||
async def report_result(self, task_id: int, output: [str, str] = None, error_message: str = None) -> None: | ||
"""Report results of the task processing to Nextcloud.""" | ||
require_capabilities("app_api", await self._session.capabilities) | ||
with contextlib.suppress(NextcloudException): | ||
await self._session.ocs( | ||
"POST", | ||
f"/ocs/v2.php/taskprocessing/tasks/{task_id}/result", | ||
json={"taskId": task_id, "output": output, "errorMessage": error_message}, | ||
) |