nc-py-api 0.15.1__tar.gz → 0.17.0__tar.gz

{nc_py_api-0.15.1 → nc_py_api-0.17.0}/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.17.0 - 2024-09-05]
+
+### Added
+
+- `message_type` property to TalkBotMessage. #292
+
+### Changed
+
+- NextcloudApp: `TextProcessing`, `Speech2Text` and `Translation` AI Providers API was removed. #289
+
+## [0.16.0 - 2024-08-12]
+
+### Changed
+
+- NextcloudApp: rework of TaskProcessing provider API. #284
+
+### Fixed
+
+- `nc.files.makedirs` not working properly on Windows. #280 Thanks to @Wuli6
+
 ## [0.15.1 - 2024-07-30]
 
 ### Fixed

{nc_py_api-0.15.1 → nc_py_api-0.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nc-py-api
-Version: 0.15.1
+Version: 0.17.0
 Summary: Nextcloud Python Framework
 Project-URL: Changelog, https://github.com/cloud-py-api/nc_py_api/blob/main/CHANGELOG.md
 Project-URL: Documentation, https://cloud-py-api.github.io/nc_py_api/
@@ -101,23 +101,22 @@ Python library that provides a robust and well-documented API that allows develo
  * **Sync + Async**: Provides both sync and async APIs.
 
 ### Capabilities
-| **_Capability_**      | Nextcloud 27 | Nextcloud 28 | Nextcloud 29 | Nextcloud 30 |
-|-----------------------|:------------:|:------------:|:------------:|:------------:|
-| Calendar              |      ✅       |      ✅       |      ✅       |      ✅       |
-| File System & Tags    |      ✅       |      ✅       |      ✅       |      ✅       |
-| Nextcloud Talk        |      ✅       |      ✅       |      ✅       |      ✅       |
-| Notifications         |      ✅       |      ✅       |      ✅       |      ✅       |
-| Shares                |      ✅       |      ✅       |      ✅       |      ✅       |
-| Users & Groups        |      ✅       |      ✅       |      ✅       |      ✅       |
-| User & Weather status |      ✅       |      ✅       |      ✅       |      ✅       |
-| Other APIs***         |      ✅       |      ✅       |      ✅       |      ✅       |
-| Talk Bot API*         |      ✅       |      ✅       |      ✅       |      ✅       |
-| Settings UI API*      |     N/A      |     N/A      |      ✅       |      ✅       |
-| AI Providers API**    |     N/A      |     N/A      |      ✅       |      ✅       |
+| **_Capability_**             | Nextcloud 27 | Nextcloud 28 | Nextcloud 29 | Nextcloud 30 |
+|------------------------------|:------------:|:------------:|:------------:|:------------:|
+| Calendar                     |      ✅       |      ✅       |      ✅       |      ✅       |
+| File System & Tags           |      ✅       |      ✅       |      ✅       |      ✅       |
+| Nextcloud Talk               |      ✅       |      ✅       |      ✅       |      ✅       |
+| Notifications                |      ✅       |      ✅       |      ✅       |      ✅       |
+| Shares                       |      ✅       |      ✅       |      ✅       |      ✅       |
+| Users & Groups               |      ✅       |      ✅       |      ✅       |      ✅       |
+| User & Weather status        |      ✅       |      ✅       |      ✅       |      ✅       |
+| Other APIs**                 |      ✅       |      ✅       |      ✅       |      ✅       |
+| Talk Bot API*                |      ✅       |      ✅       |      ✅       |      ✅       |
+| Settings UI API*             |     N/A      |     N/A      |      ✅       |      ✅       |
+| TaskProcessing Provider API* |     N/A      |     N/A      |     N/A      |      ✅       |
 
 &ast;_available only for **NextcloudApp**_<br>
-&ast;&ast;_available only for **NextcloudApp**: SpeechToText, TextProcessing, Translation_<br>
-&ast;&ast;&ast;_Activity, Notes_
+&ast;&ast;_Activity, Notes_
 
 ### Differences between the Nextcloud and NextcloudApp classes
 

{nc_py_api-0.15.1 → nc_py_api-0.17.0}/README.md

@@ -24,23 +24,22 @@ Python library that provides a robust and well-documented API that allows develo
  * **Sync + Async**: Provides both sync and async APIs.
 
 ### Capabilities
-| **_Capability_**      | Nextcloud 27 | Nextcloud 28 | Nextcloud 29 | Nextcloud 30 |
-|-----------------------|:------------:|:------------:|:------------:|:------------:|
-| Calendar              |      ✅       |      ✅       |      ✅       |      ✅       |
-| File System & Tags    |      ✅       |      ✅       |      ✅       |      ✅       |
-| Nextcloud Talk        |      ✅       |      ✅       |      ✅       |      ✅       |
-| Notifications         |      ✅       |      ✅       |      ✅       |      ✅       |
-| Shares                |      ✅       |      ✅       |      ✅       |      ✅       |
-| Users & Groups        |      ✅       |      ✅       |      ✅       |      ✅       |
-| User & Weather status |      ✅       |      ✅       |      ✅       |      ✅       |
-| Other APIs***         |      ✅       |      ✅       |      ✅       |      ✅       |
-| Talk Bot API*         |      ✅       |      ✅       |      ✅       |      ✅       |
-| Settings UI API*      |     N/A      |     N/A      |      ✅       |      ✅       |
-| AI Providers API**    |     N/A      |     N/A      |      ✅       |      ✅       |
+| **_Capability_**             | Nextcloud 27 | Nextcloud 28 | Nextcloud 29 | Nextcloud 30 |
+|------------------------------|:------------:|:------------:|:------------:|:------------:|
+| Calendar                     |      ✅       |      ✅       |      ✅       |      ✅       |
+| File System & Tags           |      ✅       |      ✅       |      ✅       |      ✅       |
+| Nextcloud Talk               |      ✅       |      ✅       |      ✅       |      ✅       |
+| Notifications                |      ✅       |      ✅       |      ✅       |      ✅       |
+| Shares                       |      ✅       |      ✅       |      ✅       |      ✅       |
+| Users & Groups               |      ✅       |      ✅       |      ✅       |      ✅       |
+| User & Weather status        |      ✅       |      ✅       |      ✅       |      ✅       |
+| Other APIs**                 |      ✅       |      ✅       |      ✅       |      ✅       |
+| Talk Bot API*                |      ✅       |      ✅       |      ✅       |      ✅       |
+| Settings UI API*             |     N/A      |     N/A      |      ✅       |      ✅       |
+| TaskProcessing Provider API* |     N/A      |     N/A      |     N/A      |      ✅       |
 
 &ast;_available only for **NextcloudApp**_<br>
-&ast;&ast;_available only for **NextcloudApp**: SpeechToText, TextProcessing, Translation_<br>
-&ast;&ast;&ast;_Activity, Notes_
+&ast;&ast;_Activity, Notes_
 
 ### Differences between the Nextcloud and NextcloudApp classes
 

{nc_py_api-0.15.1 → nc_py_api-0.17.0}/nc_py_api/_version.py

@@ -1,3 +1,3 @@
 """Version of nc_py_api."""
 
-__version__ = "0.15.1"
+__version__ = "0.17.0"

nc_py_api-0.17.0/nc_py_api/ex_app/providers/providers.py

@@ -0,0 +1,24 @@
+"""Nextcloud API for AI Providers."""
+
+from ..._session import AsyncNcSessionApp, NcSessionApp
+from .task_processing import _AsyncTaskProcessingProviderAPI, _TaskProcessingProviderAPI
+
+
+class ProvidersApi:
+    """Class that encapsulates all AI Providers functionality."""
+
+    task_processing: _TaskProcessingProviderAPI
+    """TaskProcessing Provider API."""
+
+    def __init__(self, session: NcSessionApp):
+        self.task_processing = _TaskProcessingProviderAPI(session)
+
+
+class AsyncProvidersApi:
+    """Class that encapsulates all AI Providers functionality."""
+
+    task_processing: _AsyncTaskProcessingProviderAPI
+    """TaskProcessing Provider API."""
+
+    def __init__(self, session: AsyncNcSessionApp):
+        self.task_processing = _AsyncTaskProcessingProviderAPI(session)

{nc_py_api-0.15.1 → nc_py_api-0.17.0}/nc_py_api/ex_app/providers/task_processing.py

@@ -3,35 +3,101 @@
 import contextlib
 import dataclasses
 import typing
+from enum import IntEnum
+
+from pydantic import RootModel
+from pydantic.dataclasses import dataclass
 
 from ..._exceptions import NextcloudException, NextcloudExceptionNotFound
-from ..._misc import clear_from_params_empty, require_capabilities
+from ..._misc import require_capabilities
 from ..._session import AsyncNcSessionApp, NcSessionApp
 
 _EP_SUFFIX: str = "ai_provider/task_processing"
 
 
-@dataclasses.dataclass
-class TaskProcessingProvider:
-    """TaskProcessing provider description."""
+class ShapeType(IntEnum):
+    """Enum for shape types."""
+
+    NUMBER = 0
+    TEXT = 1
+    IMAGE = 2
+    AUDIO = 3
+    VIDEO = 4
+    FILE = 5
+    ENUM = 6
+    LIST_OF_NUMBERS = 10
+    LIST_OF_TEXTS = 11
+    LIST_OF_IMAGES = 12
+    LIST_OF_AUDIOS = 13
+    LIST_OF_VIDEOS = 14
+    LIST_OF_FILES = 15
+
+
+@dataclass
+class ShapeEnumValue:
+    """Data object for input output shape enum slot value."""
+
+    name: str
+    """Name of the enum slot value which will be displayed in the UI"""
+    value: str
+    """Value of the enum slot value"""
+
 
-    def __init__(self, raw_data: dict):
-        self._raw_data = raw_data
+@dataclass
+class ShapeDescriptor:
+    """Data object for input output shape entries."""
 
-    @property
-    def name(self) -> str:
-        """Unique ID for the provider."""
-        return self._raw_data["name"]
+    name: str
+    """Name of the shape entry"""
+    description: str
+    """Description of the shape entry"""
+    shape_type: ShapeType
+    """Type of the shape entry"""
 
-    @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"]
+@dataclass
+class TaskType:
+    """TaskType description for the provider."""
+
+    id: str
+    """The unique ID for the task type."""
+    name: str
+    """The localized name of the task type."""
+    description: str
+    """The localized description of the task type."""
+    input_shape: list[ShapeDescriptor]
+    """The input shape of the task."""
+    output_shape: list[ShapeDescriptor]
+    """The output shape of the task."""
+
+
+@dataclass
+class TaskProcessingProvider:
+
+    id: str
+    """Unique ID for the provider."""
+    name: str
+    """The localized name of this provider"""
+    task_type: str
+    """The TaskType provided by this provider."""
+    expected_runtime: int = dataclasses.field(default=0)
+    """Expected runtime of the task in seconds."""
+    optional_input_shape: list[ShapeDescriptor] = dataclasses.field(default_factory=list)
+    """Optional input shape of the task."""
+    optional_output_shape: list[ShapeDescriptor] = dataclasses.field(default_factory=list)
+    """Optional output shape of the task."""
+    input_shape_enum_values: dict[str, list[ShapeEnumValue]] = dataclasses.field(default_factory=dict)
+    """The option dict for each input shape ENUM slot."""
+    input_shape_defaults: dict[str, str | int | float] = dataclasses.field(default_factory=dict)
+    """The default values for input shape slots."""
+    optional_input_shape_enum_values: dict[str, list[ShapeEnumValue]] = dataclasses.field(default_factory=dict)
+    """The option list for each optional input shape ENUM slot."""
+    optional_input_shape_defaults: dict[str, str | int | float] = dataclasses.field(default_factory=dict)
+    """The default values for optional input shape slots."""
+    output_shape_enum_values: dict[str, list[ShapeEnumValue]] = dataclasses.field(default_factory=dict)
+    """The option list for each output shape ENUM slot."""
+    optional_output_shape_enum_values: dict[str, list[ShapeEnumValue]] = dataclasses.field(default_factory=dict)
+    """The option list for each optional output shape ENUM slot."""
 
     def __repr__(self):
         return f"<{self.__class__.__name__} name={self.name}, type={self.task_type}>"
@@ -44,17 +110,16 @@ class _TaskProcessingProviderAPI:
         self._session = session
 
     def register(
-        self, name: str, display_name: str, task_type: str, custom_task_type: dict[str, typing.Any] | None = None
+        self,
+        provider: TaskProcessingProvider,
+        custom_task_type: TaskType | None = None,
     ) -> None:
         """Registers or edit the TaskProcessing provider."""
         require_capabilities("app_api", self._session.capabilities)
         params = {
-            "name": name,
-            "displayName": display_name,
-            "taskType": task_type,
-            "customTaskType": custom_task_type,
+            "provider": RootModel(provider).model_dump(),
+            **({"customTaskType": RootModel(custom_task_type).model_dump()} if custom_task_type else {}),
         }
-        clear_from_params_empty(["customTaskType"], params)
         self._session.ocs("POST", f"{self._session.ae_url}/{_EP_SUFFIX}", json=params)
 
     def unregister(self, name: str, not_fail=True) -> None:
@@ -123,17 +188,16 @@ class _AsyncTaskProcessingProviderAPI:
         self._session = session
 
     async def register(
-        self, name: str, display_name: str, task_type: str, custom_task_type: dict[str, typing.Any] | None = None
+        self,
+        provider: TaskProcessingProvider,
+        custom_task_type: TaskType | None = None,
     ) -> None:
         """Registers or edit the TaskProcessing provider."""
         require_capabilities("app_api", await self._session.capabilities)
         params = {
-            "name": name,
-            "displayName": display_name,
-            "taskType": task_type,
-            "customTaskType": custom_task_type,
+            "provider": RootModel(provider).model_dump(),
+            **({"customTaskType": RootModel(custom_task_type).model_dump()} if custom_task_type else {}),
         }
-        clear_from_params_empty(["customTaskType"], params)
         await self._session.ocs("POST", f"{self._session.ae_url}/{_EP_SUFFIX}", json=params)
 
     async def unregister(self, name: str, not_fail=True) -> None:

{nc_py_api-0.15.1 → nc_py_api-0.17.0}/nc_py_api/files/files.py

@@ -174,7 +174,7 @@ class FilesAPI:
         path = path.lstrip("/")
         result = None
         for i in Path(path).parts:
-            _path = os.path.join(_path, i)
+            _path = f"{_path}/{i}"
             if not exist_ok:
                 result = self.mkdir(_path)
             else:

{nc_py_api-0.15.1 → nc_py_api-0.17.0}/nc_py_api/talk_bot.py

@@ -29,6 +29,11 @@ class TalkBotMessage:
     def __init__(self, raw_data: dict):
         self._raw_data = raw_data
 
+    @property
+    def message_type(self) -> str:
+        """The type of message like Join, Leave, Create, Activity, etc."""
+        return self._raw_data["type"]
+
     @property
     def actor_id(self) -> str:
         """One of the attendee types followed by the ``/`` character and a unique identifier within the given type.

{nc_py_api-0.15.1 → nc_py_api-0.17.0}/pyproject.toml

@@ -129,6 +129,7 @@ lint.select = [
   "W",
 ]
 lint.extend-ignore = [
+  "D101",
   "D105",
   "D107",
   "D203",
@@ -173,7 +174,6 @@ master.py-version = "3.10"
 master.extension-pkg-allow-list = [
   "pydantic",
 ]
-design.max-attributes = 8
 design.max-locals = 20
 design.max-branches = 16
 design.max-returns = 8
@@ -206,6 +206,7 @@ messages_control.disable = [
   "line-too-long",
   "too-few-public-methods",
   "too-many-public-methods",
+  "too-many-instance-attributes",
 ]
 
 [tool.pytest.ini_options]

nc_py_api-0.15.1/nc_py_api/ex_app/providers/providers.py

@@ -1,45 +0,0 @@
-"""Nextcloud API for AI Providers."""
-
-from ..._session import AsyncNcSessionApp, NcSessionApp
-from .speech_to_text import _AsyncSpeechToTextProviderAPI, _SpeechToTextProviderAPI
-from .task_processing import _AsyncTaskProcessingProviderAPI, _TaskProcessingProviderAPI
-from .text_processing import _AsyncTextProcessingProviderAPI, _TextProcessingProviderAPI
-from .translations import _AsyncTranslationsProviderAPI, _TranslationsProviderAPI
-
-
-class ProvidersApi:
-    """Class that encapsulates all AI Providers functionality."""
-
-    speech_to_text: _SpeechToTextProviderAPI
-    """SpeechToText Provider API."""
-    text_processing: _TextProcessingProviderAPI
-    """TextProcessing Provider API."""
-    translations: _TranslationsProviderAPI
-    """Translations Provider API."""
-    task_processing: _TaskProcessingProviderAPI
-    """TaskProcessing Provider API."""
-
-    def __init__(self, session: NcSessionApp):
-        self.speech_to_text = _SpeechToTextProviderAPI(session)
-        self.text_processing = _TextProcessingProviderAPI(session)
-        self.translations = _TranslationsProviderAPI(session)
-        self.task_processing = _TaskProcessingProviderAPI(session)
-
-
-class AsyncProvidersApi:
-    """Class that encapsulates all AI Providers functionality."""
-
-    speech_to_text: _AsyncSpeechToTextProviderAPI
-    """SpeechToText Provider API."""
-    text_processing: _AsyncTextProcessingProviderAPI
-    """TextProcessing Provider API."""
-    translations: _AsyncTranslationsProviderAPI
-    """Translations Provider API."""
-    task_processing: _AsyncTaskProcessingProviderAPI
-    """TaskProcessing Provider API."""
-
-    def __init__(self, session: AsyncNcSessionApp):
-        self.speech_to_text = _AsyncSpeechToTextProviderAPI(session)
-        self.text_processing = _AsyncTextProcessingProviderAPI(session)
-        self.translations = _AsyncTranslationsProviderAPI(session)
-        self.task_processing = _AsyncTaskProcessingProviderAPI(session)

nc_py_api-0.15.1/nc_py_api/ex_app/providers/speech_to_text.py

@@ -1,128 +0,0 @@
-"""Nextcloud API for declaring SpeechToText 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/speech_to_text"
-
-
-@dataclasses.dataclass
-class SpeechToTextProvider:
-    """Speech2Text 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 action_handler(self) -> str:
-        """Relative ExApp url which will be called by Nextcloud."""
-        return self._raw_data["action_handler"]
-
-    def __repr__(self):
-        return f"<{self.__class__.__name__} name={self.name}, handler={self.action_handler}>"
-
-
-class _SpeechToTextProviderAPI:
-    """API for Speech2Text providers, avalaible as **nc.providers.text_processing.<method>**."""
-
-    def __init__(self, session: NcSessionApp):
-        self._session = session
-
-    def register(self, name: str, display_name: str, callback_url: str) -> None:
-        """Registers or edit the SpeechToText provider."""
-        require_capabilities("app_api", self._session.capabilities)
-        params = {
-            "name": name,
-            "displayName": display_name,
-            "actionHandler": callback_url,
-        }
-        self._session.ocs("POST", f"{self._session.ae_url}/{_EP_SUFFIX}", json=params)
-
-    def unregister(self, name: str, not_fail=True) -> None:
-        """Removes SpeechToText 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 get_entry(self, name: str) -> SpeechToTextProvider | None:
-        """Get information of the SpeechToText."""
-        require_capabilities("app_api", self._session.capabilities)
-        try:
-            return SpeechToTextProvider(
-                self._session.ocs("GET", f"{self._session.ae_url}/{_EP_SUFFIX}", params={"name": name})
-            )
-        except NextcloudExceptionNotFound:
-            return None
-
-    def report_result(self, task_id: int, result: str = "", error: str = "") -> None:
-        """Report results of speech to text task to Nextcloud."""
-        require_capabilities("app_api", self._session.capabilities)
-        with contextlib.suppress(NextcloudException):
-            self._session.ocs(
-                "PUT",
-                f"{self._session.ae_url}/{_EP_SUFFIX}",
-                json={"taskId": task_id, "result": result, "error": error},
-            )
-
-
-class _AsyncSpeechToTextProviderAPI:
-    """Async API for Speech2Text providers."""
-
-    def __init__(self, session: AsyncNcSessionApp):
-        self._session = session
-
-    async def register(self, name: str, display_name: str, callback_url: str) -> None:
-        """Registers or edit the SpeechToText provider."""
-        require_capabilities("app_api", await self._session.capabilities)
-        params = {
-            "name": name,
-            "displayName": display_name,
-            "actionHandler": callback_url,
-        }
-        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 SpeechToText 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 get_entry(self, name: str) -> SpeechToTextProvider | None:
-        """Get information of the SpeechToText."""
-        require_capabilities("app_api", await self._session.capabilities)
-        try:
-            return SpeechToTextProvider(
-                await self._session.ocs("GET", f"{self._session.ae_url}/{_EP_SUFFIX}", params={"name": name})
-            )
-        except NextcloudExceptionNotFound:
-            return None
-
-    async def report_result(self, task_id: int, result: str = "", error: str = "") -> None:
-        """Report results of speech to text task to Nextcloud."""
-        require_capabilities("app_api", await self._session.capabilities)
-        with contextlib.suppress(NextcloudException):
-            await self._session.ocs(
-                "PUT",
-                f"{self._session.ae_url}/{_EP_SUFFIX}",
-                json={"taskId": task_id, "result": result, "error": error},
-            )

nc_py_api-0.15.1/nc_py_api/ex_app/providers/text_processing.py

@@ -1,135 +0,0 @@
-"""Nextcloud API for declaring TextProcessing 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/text_processing"
-
-
-@dataclasses.dataclass
-class TextProcessingProvider:
-    """TextProcessing 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 action_handler(self) -> str:
-        """Relative ExApp url which will be called by Nextcloud."""
-        return self._raw_data["action_handler"]
-
-    @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}, handler={self.action_handler}>"
-
-
-class _TextProcessingProviderAPI:
-    """API for TextProcessing providers, avalaible as **nc.providers.speech_to_text.<method>**."""
-
-    def __init__(self, session: NcSessionApp):
-        self._session = session
-
-    def register(self, name: str, display_name: str, callback_url: str, task_type: str) -> None:
-        """Registers or edit the TextProcessing provider."""
-        require_capabilities("app_api", self._session.capabilities)
-        params = {
-            "name": name,
-            "displayName": display_name,
-            "actionHandler": callback_url,
-            "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 TextProcessing 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 get_entry(self, name: str) -> TextProcessingProvider | None:
-        """Get information of the TextProcessing."""
-        require_capabilities("app_api", self._session.capabilities)
-        try:
-            return TextProcessingProvider(
-                self._session.ocs("GET", f"{self._session.ae_url}/{_EP_SUFFIX}", params={"name": name})
-            )
-        except NextcloudExceptionNotFound:
-            return None
-
-    def report_result(self, task_id: int, result: str = "", error: str = "") -> None:
-        """Report results of the text processing to Nextcloud."""
-        require_capabilities("app_api", self._session.capabilities)
-        with contextlib.suppress(NextcloudException):
-            self._session.ocs(
-                "PUT",
-                f"{self._session.ae_url}/{_EP_SUFFIX}",
-                json={"taskId": task_id, "result": result, "error": error},
-            )
-
-
-class _AsyncTextProcessingProviderAPI:
-    """Async API for TextProcessing providers."""
-
-    def __init__(self, session: AsyncNcSessionApp):
-        self._session = session
-
-    async def register(self, name: str, display_name: str, callback_url: str, task_type: str) -> None:
-        """Registers or edit the TextProcessing provider."""
-        require_capabilities("app_api", await self._session.capabilities)
-        params = {
-            "name": name,
-            "displayName": display_name,
-            "actionHandler": callback_url,
-            "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 TextProcessing 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 get_entry(self, name: str) -> TextProcessingProvider | None:
-        """Get information of the TextProcessing."""
-        require_capabilities("app_api", await self._session.capabilities)
-        try:
-            return TextProcessingProvider(
-                await self._session.ocs("GET", f"{self._session.ae_url}/{_EP_SUFFIX}", params={"name": name})
-            )
-        except NextcloudExceptionNotFound:
-            return None
-
-    async def report_result(self, task_id: int, result: str = "", error: str = "") -> None:
-        """Report results of the text processing to Nextcloud."""
-        require_capabilities("app_api", await self._session.capabilities)
-        with contextlib.suppress(NextcloudException):
-            await self._session.ocs(
-                "PUT",
-                f"{self._session.ae_url}/{_EP_SUFFIX}",
-                json={"taskId": task_id, "result": result, "error": error},
-            )

nc_py_api-0.15.1/nc_py_api/ex_app/providers/translations.py

@@ -1,165 +0,0 @@
-"""Nextcloud API for declaring Translations 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/translation"
-
-
-@dataclasses.dataclass
-class TranslationsProvider:
-    """Translations 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 from_languages(self) -> dict[str, str]:
-        """Input languages supported by provider."""
-        return self._raw_data["from_languages"]
-
-    @property
-    def to_languages(self) -> dict[str, str]:
-        """Output languages supported by provider."""
-        return self._raw_data["to_languages"]
-
-    @property
-    def action_handler(self) -> str:
-        """Relative ExApp url which will be called by Nextcloud."""
-        return self._raw_data["action_handler"]
-
-    @property
-    def action_handler_detect_lang(self) -> str:
-        """Relative ExApp url which will be called by Nextcloud to detect language."""
-        return self._raw_data.get("action_detect_lang", "")
-
-    def __repr__(self):
-        return f"<{self.__class__.__name__} name={self.name}, handler={self.action_handler}>"
-
-
-class _TranslationsProviderAPI:
-    """API for Translations providers, avalaible as **nc.providers.translations.<method>**."""
-
-    def __init__(self, session: NcSessionApp):
-        self._session = session
-
-    def register(
-        self,
-        name: str,
-        display_name: str,
-        callback_url: str,
-        from_languages: dict[str, str],
-        to_languages: dict[str, str],
-        detect_lang_callback_url: str = "",
-    ) -> None:
-        """Registers or edit the Translations provider."""
-        require_capabilities("app_api", self._session.capabilities)
-        params = {
-            "name": name,
-            "displayName": display_name,
-            "fromLanguages": from_languages,
-            "toLanguages": to_languages,
-            "actionHandler": callback_url,
-            "actionDetectLang": detect_lang_callback_url,
-        }
-        self._session.ocs("POST", f"{self._session.ae_url}/{_EP_SUFFIX}", json=params)
-
-    def unregister(self, name: str, not_fail=True) -> None:
-        """Removes Translations 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 get_entry(self, name: str) -> TranslationsProvider | None:
-        """Get information of the TranslationsProvider."""
-        require_capabilities("app_api", self._session.capabilities)
-        try:
-            return TranslationsProvider(
-                self._session.ocs("GET", f"{self._session.ae_url}/{_EP_SUFFIX}", params={"name": name})
-            )
-        except NextcloudExceptionNotFound:
-            return None
-
-    def report_result(self, task_id: int, result: str = "", error: str = "") -> None:
-        """Report results of translation task to Nextcloud."""
-        require_capabilities("app_api", self._session.capabilities)
-        with contextlib.suppress(NextcloudException):
-            self._session.ocs(
-                "PUT",
-                f"{self._session.ae_url}/{_EP_SUFFIX}",
-                json={"taskId": task_id, "result": result, "error": error},
-            )
-
-
-class _AsyncTranslationsProviderAPI:
-    """Async API for Translations providers."""
-
-    def __init__(self, session: AsyncNcSessionApp):
-        self._session = session
-
-    async def register(
-        self,
-        name: str,
-        display_name: str,
-        callback_url: str,
-        from_languages: dict[str, str],
-        to_languages: dict[str, str],
-        detect_lang_callback_url: str = "",
-    ) -> None:
-        """Registers or edit the Translations provider."""
-        require_capabilities("app_api", await self._session.capabilities)
-        params = {
-            "name": name,
-            "displayName": display_name,
-            "fromLanguages": from_languages,
-            "toLanguages": to_languages,
-            "actionHandler": callback_url,
-            "actionDetectLang": detect_lang_callback_url,
-        }
-        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 Translations 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 get_entry(self, name: str) -> TranslationsProvider | None:
-        """Get information of the TranslationsProvider."""
-        require_capabilities("app_api", await self._session.capabilities)
-        try:
-            return TranslationsProvider(
-                await self._session.ocs("GET", f"{self._session.ae_url}/{_EP_SUFFIX}", params={"name": name})
-            )
-        except NextcloudExceptionNotFound:
-            return None
-
-    async def report_result(self, task_id: int, result: str = "", error: str = "") -> None:
-        """Report results of translation task to Nextcloud."""
-        require_capabilities("app_api", await self._session.capabilities)
-        with contextlib.suppress(NextcloudException):
-            await self._session.ocs(
-                "PUT",
-                f"{self._session.ae_url}/{_EP_SUFFIX}",
-                json={"taskId": task_id, "result": result, "error": error},
-            )