nc-py-api 0.16.0__tar.gz → 0.17.1__tar.gz

{nc_py_api-0.16.0 → nc_py_api-0.17.1}/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.17.1 - 2024-09-06]
+
+### Added
+
+- NextcloudApp: `setup_nextcloud_logging` function to support transparently sending logs to Nextcloud. #294
+
+### Fixed
+
+- NextcloudApp: `nc.log` now suppresses all exceptions to safe call it anywhere(for example in exception handlers). #293
+
+## [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

{nc_py_api-0.16.0 → nc_py_api-0.17.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nc-py-api
-Version: 0.16.0
+Version: 0.17.1
 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.16.0 → nc_py_api-0.17.1}/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.16.0 → nc_py_api-0.17.1}/nc_py_api/_version.py

@@ -1,3 +1,3 @@
 """Version of nc_py_api."""
 
-__version__ = "0.16.0"
+__version__ = "0.17.1"

{nc_py_api-0.16.0 → nc_py_api-0.17.1}/nc_py_api/apps.py

@@ -1,7 +1,6 @@
 """Nextcloud API for working with applications."""
 
 import dataclasses
-import datetime
 
 from ._misc import require_capabilities
 from ._session import AsyncNcSessionBasic, NcSessionBasic
@@ -34,18 +33,6 @@ class ExAppInfo:
         """Flag indicating if the application enabled."""
         return bool(self._raw_data["enabled"])
 
-    @property
-    def last_check_time(self) -> datetime.datetime:
-        """Time of the last successful application check."""
-        return datetime.datetime.utcfromtimestamp(int(self._raw_data["last_check_time"])).replace(
-            tzinfo=datetime.timezone.utc
-        )
-
-    @property
-    def system(self) -> bool:
-        """**DEPRECATED** Flag indicating if the application is a system application."""
-        return True
-
     def __repr__(self):
         return f"<{self.__class__.__name__} id={self.app_id}, ver={self.version}>"
 

{nc_py_api-0.16.0 → nc_py_api-0.17.1}/nc_py_api/ex_app/__init__.py

@@ -10,6 +10,7 @@ from .integration_fastapi import (
     set_handlers,
     talk_bot_msg,
 )
+from .logging import setup_nextcloud_logging
 from .misc import (
     get_computation_device,
     get_model_path,

nc_py_api-0.17.1/nc_py_api/ex_app/logging.py

@@ -0,0 +1,46 @@
+"""Transparent logging support to store logs in the nextcloud.log."""
+
+import logging
+import threading
+
+from ..nextcloud import NextcloudApp
+from .defs import LogLvl
+
+LOGLVL_MAP = {
+    logging.NOTSET: LogLvl.DEBUG,
+    logging.DEBUG: LogLvl.DEBUG,
+    logging.INFO: LogLvl.INFO,
+    logging.WARNING: LogLvl.WARNING,
+    logging.ERROR: LogLvl.ERROR,
+    logging.CRITICAL: LogLvl.FATAL,
+}
+
+THREAD_LOCAL = threading.local()
+
+
+class _NextcloudLogsHandler(logging.Handler):
+    def __init__(self):
+        super().__init__()
+
+    def emit(self, record):
+        if THREAD_LOCAL.__dict__.get("nc_py_api.loghandler", False):
+            return
+
+        try:
+            THREAD_LOCAL.__dict__["nc_py_api.loghandler"] = True
+            log_entry = self.format(record)
+            log_level = record.levelno
+            NextcloudApp().log(LOGLVL_MAP.get(log_level, LogLvl.FATAL), log_entry, fast_send=True)
+        except Exception:  # noqa pylint: disable=broad-exception-caught
+            self.handleError(record)
+        finally:
+            THREAD_LOCAL.__dict__["nc_py_api.loghandler"] = False
+
+
+def setup_nextcloud_logging(logger_name: str | None = None, logging_level: int = logging.DEBUG):
+    """Function to easily send all or selected log entries to Nextcloud."""
+    logger = logging.getLogger(logger_name)
+    nextcloud_handler = _NextcloudLogsHandler()
+    nextcloud_handler.setLevel(logging_level)
+    logger.addHandler(nextcloud_handler)
+    return nextcloud_handler

nc_py_api-0.17.1/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.16.0 → nc_py_api-0.17.1}/nc_py_api/nextcloud.py

@@ -348,13 +348,18 @@ class NextcloudApp(_NextcloudBasic):
             return bool(self._session.ocs("GET", "/ocs/v1.php/apps/app_api/ex-app/state"))
         return False
 
-    def log(self, log_lvl: LogLvl, content: str) -> None:
+    def log(self, log_lvl: LogLvl, content: str, fast_send: bool = False) -> None:
         """Writes log to the Nextcloud log file."""
-        if self.check_capabilities("app_api"):
-            return
-        if int(log_lvl) < self.capabilities["app_api"].get("loglevel", 0):
-            return
-        self._session.ocs("POST", f"{self._session.ae_url}/log", json={"level": int(log_lvl), "message": content})
+        int_log_lvl = int(log_lvl)
+        if int_log_lvl < 0 or int_log_lvl > 4:
+            raise ValueError("Invalid `log_lvl` value")
+        if not fast_send:
+            if self.check_capabilities("app_api"):
+                return
+            if int_log_lvl < self.capabilities["app_api"].get("loglevel", 0):
+                return
+        with contextlib.suppress(Exception):
+            self._session.ocs("POST", f"{self._session.ae_url}/log", json={"level": int_log_lvl, "message": content})
 
     def users_list(self) -> list[str]:
         """Returns list of users on the Nextcloud instance."""
@@ -478,13 +483,20 @@ class AsyncNextcloudApp(_AsyncNextcloudBasic):
             return bool(await self._session.ocs("GET", "/ocs/v1.php/apps/app_api/ex-app/state"))
         return False
 
-    async def log(self, log_lvl: LogLvl, content: str) -> None:
+    async def log(self, log_lvl: LogLvl, content: str, fast_send: bool = False) -> None:
         """Writes log to the Nextcloud log file."""
-        if await self.check_capabilities("app_api"):
-            return
-        if int(log_lvl) < (await self.capabilities)["app_api"].get("loglevel", 0):
-            return
-        await self._session.ocs("POST", f"{self._session.ae_url}/log", json={"level": int(log_lvl), "message": content})
+        int_log_lvl = int(log_lvl)
+        if int_log_lvl < 0 or int_log_lvl > 4:
+            raise ValueError("Invalid `log_lvl` value")
+        if not fast_send:
+            if await self.check_capabilities("app_api"):
+                return
+            if int_log_lvl < (await self.capabilities)["app_api"].get("loglevel", 0):
+                return
+        with contextlib.suppress(Exception):
+            await self._session.ocs(
+                "POST", f"{self._session.ae_url}/log", json={"level": int_log_lvl, "message": content}
+            )
 
     async def users_list(self) -> list[str]:
         """Returns list of users on the Nextcloud instance."""

{nc_py_api-0.16.0 → nc_py_api-0.17.1}/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.16.0/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.16.0/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.16.0/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.16.0/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},
-            )