nc-py-api 0.21.0__py3-none-any.whl → 0.22.0__py3-none-any.whl

nc_py_api/__init__.py

@@ -2,6 +2,7 @@
 
 from . import ex_app, options
 from ._exceptions import (
+    ModelFetchError,
     NextcloudException,
     NextcloudExceptionNotFound,
     NextcloudMissingCapabilities,

nc_py_api/_exceptions.py

@@ -65,3 +65,7 @@ def check_error(response: Response, info: str = ""):
         response.raise_for_status()
     except HTTPError as e:
         raise NextcloudException(status_code, reason=response.reason, info=info) from e
+
+
+class ModelFetchError(Exception):
+    """Exception raised when model fetching fails."""

nc_py_api/_version.py

@@ -1,3 +1,3 @@
 """Version of nc_py_api."""
 
-__version__ = "0.21.0"
+__version__ = "0.22.0"

nc_py_api/ex_app/integration_fastapi.py

@@ -7,6 +7,7 @@ import hashlib
 import json
 import os
 import typing
+from traceback import format_exc
 from urllib.parse import urlparse
 
 import niquests
@@ -22,10 +23,10 @@ from fastapi.responses import JSONResponse, PlainTextResponse
 from starlette.requests import HTTPConnection, Request
 from starlette.types import ASGIApp, Receive, Scope, Send
 
+from .._exceptions import ModelFetchError
 from .._misc import get_username_secret_from_headers
 from ..nextcloud import AsyncNextcloudApp, NextcloudApp
 from ..talk_bot import TalkBotMessage
-from .defs import LogLvl
 from .misc import persistent_storage
 
 
@@ -60,6 +61,7 @@ def set_handlers(
     default_init: bool = True,
     models_to_fetch: dict[str, dict] | None = None,
     map_app_static: bool = True,
+    trigger_handler: typing.Callable[[str], typing.Awaitable[None] | None] | None = None,
 ):
     """Defines handlers for the application.
 
@@ -70,13 +72,30 @@ def set_handlers(
 
         .. note:: When this parameter is ``False``, the provision of ``models_to_fetch`` is not allowed.
 
-    :param models_to_fetch: Dictionary describing which models should be downloaded during `init`.
+    :param models_to_fetch: Dictionary describing which models should be downloaded during `init` of the form:
+        .. code-block:: python
+            {
+                "model_url_1": {
+                    "save_path": "path_or_filename_to_save_the_model_to",
+                },
+                "huggingface_model_name_1": {
+                    "max_workers": 4,
+                    "cache_dir": "path_to_cache_dir",
+                    "revision": "revision_to_fetch",
+                    ...
+                },
+                ...
+            }
+
 
         .. note:: ``huggingface_hub`` package should be present for automatic models fetching.
+                  All model options are optional and can be left empty.
 
     :param map_app_static: Should be folders ``js``, ``css``, ``l10n``, ``img`` automatically mounted in FastAPI or not.
 
         .. note:: First, presence of these directories in the current working dir is checked, then one directory higher.
+
+    :param trigger_handler: callback that is called for task processing `trigger` events with the id of the provider.
     """
     if models_to_fetch is not None and default_init is False:
         raise ValueError("`models_to_fetch` can be defined only with `default_init`=True.")
@@ -109,6 +128,21 @@ def set_handlers(
     if map_app_static:
         __map_app_static_folders(fast_api_app)
 
+    if trigger_handler:
+        if asyncio.iscoroutinefunction(trigger_handler):
+
+            @fast_api_app.post("/trigger")
+            async def trigger_callback(providerId: str):  # pylint: disable=invalid-name
+                await trigger_handler(providerId)
+                return JSONResponse(content={})
+
+        else:
+
+            @fast_api_app.post("/trigger")
+            def trigger_callback(providerId: str):  # pylint: disable=invalid-name
+                trigger_handler(providerId)
+                return JSONResponse(content={})
+
 
 def __map_app_static_folders(fast_api_app: FastAPI):
     """Function to mount all necessary static folders to FastAPI."""
@@ -121,74 +155,98 @@ def __map_app_static_folders(fast_api_app: FastAPI):
 
 
 def fetch_models_task(nc: NextcloudApp, models: dict[str, dict], progress_init_start_value: int) -> None:
-    """Use for cases when you want to define custom `/init` but still need to easy download models."""
+    """Use for cases when you want to define custom `/init` but still need to easy download models.
+
+    :param nc: NextcloudApp instance.
+    :param models_to_fetch: Dictionary describing which models should be downloaded of the form:
+        .. code-block:: python
+            {
+                "model_url_1": {
+                    "save_path": "path_or_filename_to_save_the_model_to",
+                },
+                "huggingface_model_name_1": {
+                    "max_workers": 4,
+                    "cache_dir": "path_to_cache_dir",
+                    "revision": "revision_to_fetch",
+                    ...
+                },
+                ...
+            }
+
+        .. note:: ``huggingface_hub`` package should be present for automatic models fetching.
+                  All model options are optional and can be left empty.
+
+    :param progress_init_start_value: Integer value defining from which percent the progress should start.
+
+    :raises ModelFetchError: in case of a model download error.
+    :raises NextcloudException: in case of a network error reaching the Nextcloud server.
+    """
     if models:
         current_progress = progress_init_start_value
         percent_for_each = min(int((100 - progress_init_start_value) / len(models)), 99)
         for model in models:
-            if model.startswith(("http://", "https://")):
-                models[model]["path"] = __fetch_model_as_file(
-                    current_progress, percent_for_each, nc, model, models[model]
-                )
-            else:
-                models[model]["path"] = __fetch_model_as_snapshot(
-                    current_progress, percent_for_each, nc, model, models[model]
-                )
-            current_progress += percent_for_each
+            try:
+                if model.startswith(("http://", "https://")):
+                    models[model]["path"] = __fetch_model_as_file(
+                        current_progress, percent_for_each, nc, model, models[model]
+                    )
+                else:
+                    models[model]["path"] = __fetch_model_as_snapshot(
+                        current_progress, percent_for_each, nc, model, models[model]
+                    )
+                current_progress += percent_for_each
+            except BaseException as e:  # noqa pylint: disable=broad-exception-caught
+                nc.set_init_status(current_progress, f"Downloading of '{model}' failed: {e}: {format_exc()}")
+                raise ModelFetchError(f"Downloading of '{model}' failed.") from e
     nc.set_init_status(100)
 
 
 def __fetch_model_as_file(
     current_progress: int, progress_for_task: int, nc: NextcloudApp, model_path: str, download_options: dict
-) -> str | None:
+) -> str:
     result_path = download_options.pop("save_path", urlparse(model_path).path.split("/")[-1])
-    try:
-
-        with niquests.get("GET", model_path, stream=True) as response:
-            if not response.is_success:
-                nc.log(LogLvl.ERROR, f"Downloading of '{model_path}' returned {response.status_code} status.")
-                return None
-            downloaded_size = 0
-            linked_etag = ""
-            for each_history in response.history:
-                linked_etag = each_history.headers.get("X-Linked-ETag", "")
-                if linked_etag:
-                    break
-            if not linked_etag:
-                linked_etag = response.headers.get("X-Linked-ETag", response.headers.get("ETag", ""))
-            total_size = int(response.headers.get("Content-Length"))
-            try:
-                existing_size = os.path.getsize(result_path)
-            except OSError:
-                existing_size = 0
-            if linked_etag and total_size == existing_size:
-                with builtins.open(result_path, "rb") as file:
-                    sha256_hash = hashlib.sha256()
-                    for byte_block in iter(lambda: file.read(4096), b""):
-                        sha256_hash.update(byte_block)
-                    if f'"{sha256_hash.hexdigest()}"' == linked_etag:
-                        nc.set_init_status(min(current_progress + progress_for_task, 99))
-                        return None
-
-            with builtins.open(result_path, "wb") as file:
-                last_progress = current_progress
-                for chunk in response.iter_raw(-1):
-                    downloaded_size += file.write(chunk)
-                    if total_size:
-                        new_progress = min(current_progress + int(progress_for_task * downloaded_size / total_size), 99)
-                        if new_progress != last_progress:
-                            nc.set_init_status(new_progress)
-                            last_progress = new_progress
-
-        return result_path
-    except Exception as e:  # noqa pylint: disable=broad-exception-caught
-        nc.log(LogLvl.ERROR, f"Downloading of '{model_path}' raised an exception: {e}")
-
-    return None
+    with niquests.get(model_path, stream=True) as response:
+        if not response.ok:
+            raise ModelFetchError(
+                f"Downloading of '{model_path}' failed, returned ({response.status_code}) {response.text}"
+            )
+        downloaded_size = 0
+        linked_etag = ""
+        for each_history in response.history:
+            linked_etag = each_history.headers.get("X-Linked-ETag", "")
+            if linked_etag:
+                break
+        if not linked_etag:
+            linked_etag = response.headers.get("X-Linked-ETag", response.headers.get("ETag", ""))
+        total_size = int(response.headers.get("Content-Length"))
+        try:
+            existing_size = os.path.getsize(result_path)
+        except OSError:
+            existing_size = 0
+        if linked_etag and total_size == existing_size:
+            with builtins.open(result_path, "rb") as file:
+                sha256_hash = hashlib.sha256()
+                for byte_block in iter(lambda: file.read(4096), b""):
+                    sha256_hash.update(byte_block)
+                if f'"{sha256_hash.hexdigest()}"' == linked_etag:
+                    nc.set_init_status(min(current_progress + progress_for_task, 99))
+                    return result_path
+
+        with builtins.open(result_path, "wb") as file:
+            last_progress = current_progress
+            for chunk in response.iter_raw(-1):
+                downloaded_size += file.write(chunk)
+                if total_size:
+                    new_progress = min(current_progress + int(progress_for_task * downloaded_size / total_size), 99)
+                    if new_progress != last_progress:
+                        nc.set_init_status(new_progress)
+                        last_progress = new_progress
+
+    return result_path
 
 
 def __fetch_model_as_snapshot(
-    current_progress: int, progress_for_task, nc: NextcloudApp, mode_name: str, download_options: dict
+    current_progress: int, progress_for_task, nc: NextcloudApp, model_name: str, download_options: dict
 ) -> str:
     from huggingface_hub import snapshot_download  # noqa isort:skip pylint: disable=C0415 disable=E0401
     from tqdm import tqdm  # noqa isort:skip pylint: disable=C0415 disable=E0401
@@ -201,7 +259,7 @@ def __fetch_model_as_snapshot(
     workers = download_options.pop("max_workers", 2)
     cache = download_options.pop("cache_dir", persistent_storage())
     return snapshot_download(
-        mode_name, tqdm_class=TqdmProgress, **download_options, max_workers=workers, cache_dir=cache
+        model_name, tqdm_class=TqdmProgress, **download_options, max_workers=workers, cache_dir=cache
     )
 
 

nc_py_api/options.py

@@ -4,6 +4,8 @@ Each setting only affects newly created instances of **Nextcloud**/**NextcloudAp
 Specifying options in **kwargs** has higher priority than this.
 """
 
+# pylint: disable=invalid-name
+
 from os import environ
 
 from dotenv import load_dotenv

{nc_py_api-0.21.0.dist-info → nc_py_api-0.22.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nc-py-api
-Version: 0.21.0
+Version: 0.22.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/

{nc_py_api-0.21.0.dist-info → nc_py_api-0.22.0.dist-info}/RECORD

@@ -1,13 +1,13 @@
-nc_py_api/__init__.py,sha256=FOju0DYizwYYzWBgID8Ebx0GeId-faNqd4Z_3K0216o,439
+nc_py_api/__init__.py,sha256=S5IytGqp8PkWnmcZXRFPSVEwfeb4iZ8xPeCmSf4sTFQ,460
 nc_py_api/_deffered_error.py,sha256=BpEe_tBqflwfj2Zolb67nhW-K16XX-WbcY2IH_6u8fo,319
-nc_py_api/_exceptions.py,sha256=0jcbjsNnLaxaWdxXCCaO5gpcHuzIGowIwcirJMb_i6E,2324
+nc_py_api/_exceptions.py,sha256=_4k-uzpKdW5_WjqVE_saoGFJ1YqWx7W6kr-wgpBume0,2414
 nc_py_api/_misc.py,sha256=dUzCP9VmyhtICTsn1aexlFAYUioBm40k6Zh-YE5WwCY,3333
 nc_py_api/_preferences.py,sha256=OtovFZuGHnHYKjdDjSnUappO795tW8Oxj7qVaejHWpQ,2479
 nc_py_api/_preferences_ex.py,sha256=Y6sDBrFJc7lk8BoDUfjC_iwOfjSbPPNPpcSxsL1fyIM,6391
 nc_py_api/_session.py,sha256=u45U4USdgbegBj3oAnm-OErFng2fAyleH1dWgshJSso,22018
 nc_py_api/_talk_api.py,sha256=0Uo7OduYniuuX3UQPb468RyGJJ-PWBCgJ5HoPuz5Qa0,51068
 nc_py_api/_theming.py,sha256=hTr3nuOemSuRFZaPy9iXNmBM7rDgQHECH43tHMWGqEY,1870
-nc_py_api/_version.py,sha256=nv6lCFaAcG4Ms4JWx1XWaoZkKMQx16XOvb93dfYRBFo,52
+nc_py_api/_version.py,sha256=hUeDIevdzurgTsk1Uo0m8u0An4IWucrh8zxG1wW377o,52
 nc_py_api/activity.py,sha256=t9VDSnnaXRNOvALqOSGCeXSQZ-426pCOMSfQ96JHys4,9574
 nc_py_api/apps.py,sha256=Us2y2lszdxXlD8t6kxwd5_Nrrmazc0EvZXIH9O-ol80,9315
 nc_py_api/calendar_api.py,sha256=a2Q5EGf5_swWPYkUbHnoEg6h1S9KTEUQD7f7DljGHYY,1442
@@ -15,7 +15,7 @@ nc_py_api/loginflow_v2.py,sha256=QgR99Q59Q1My5U_PeLFkIAvEKhX_H7bIRrBZdddvmo4,576
 nc_py_api/nextcloud.py,sha256=cKdsw0n_yFNdI-N8IIVIQKkSqmEzJnQtLBVqo24EVdM,22849
 nc_py_api/notes.py,sha256=aM0SLVGKv8nBv_qI3z8sN08Z2721wLJUmEdwlo2EK1g,15112
 nc_py_api/notifications.py,sha256=WgzV21TuLOhLk-UEjhBSbMsIi2isa5MmAx6cbe0pc2Y,9187
-nc_py_api/options.py,sha256=W9RSLTtltW1W-Y3iSllRr2-VikFB5wARSiBEaAcw-AI,1719
+nc_py_api/options.py,sha256=fuAiua3HiFUZYLB7X3-6L7rp3oxYOJCLWCTyeA0nUIA,1751
 nc_py_api/talk.py,sha256=OZFemYkDOaM6o4xAK3EvQbjMFiK75E5qnsCDyihIElg,29368
 nc_py_api/talk_bot.py,sha256=QXaKKwIRRcOAnqoJgfzK3ub0aDPTUmTkagls-a0XZW0,16840
 nc_py_api/user_status.py,sha256=I101nwYS8X1WvC8AnLa2f3qJUCPDPHrbq-ke0h1VT4E,13282
@@ -25,7 +25,7 @@ nc_py_api/weather_status.py,sha256=wAkjuJPjxc0Rxe4za0BzfwB0XeUmkCXoisJtTH3-qdQ,7
 nc_py_api/webhooks.py,sha256=BGHRtankgbUkcqBRJTFShjRLpaVoFNcjLsrVitoNziM,8083
 nc_py_api/ex_app/__init__.py,sha256=6Lwid4bBXOSrZf_ocf5m8qkkO1OgYxG0GTs4q6Nw72o,691
 nc_py_api/ex_app/defs.py,sha256=FaQInH3jLugKxDUqpwrXdkMT-lBxmoqWmXJXc11fa6A,727
-nc_py_api/ex_app/integration_fastapi.py,sha256=0ILut8galBUO7S_oq17qoU512d407ok5siHb9zwaJuQ,11037
+nc_py_api/ex_app/integration_fastapi.py,sha256=BxE7oMZ5q2D5mRjTsd7k9mZEU7XH2yYp8fQvBHHUWgc,13392
 nc_py_api/ex_app/logger.py,sha256=nAHLObuPvl3UBLrlqZulgoxxVaAJ661iP4F6bTW-V-Y,1475
 nc_py_api/ex_app/misc.py,sha256=c7B0uE8isaIi4SQbxURGUuWjZaaXiLg3Ov6cqvRYplE,2298
 nc_py_api/ex_app/occ_commands.py,sha256=hb2BJuvFKIigvLycSCyAe9v6hedq4Gfu2junQZTaK_M,5219
@@ -45,8 +45,8 @@ nc_py_api/files/_files.py,sha256=t7KBZE3fHmfVk0WZuQF9usCMY_b4rzX1ct1aIZx3RYw,143
 nc_py_api/files/files.py,sha256=A05iT_s5cYMK1MtarqdjTZP9QA1l_SiINq805VLrzuY,24999
 nc_py_api/files/files_async.py,sha256=GoTPswMgozcx3Vkbj4YSitNeP7vpPJ4lIbrCnj77rP4,25858
 nc_py_api/files/sharing.py,sha256=VRZCl-TYK6dbu9rUHPs3_jcVozu1EO8bLGZwoRpiLsU,14439
-nc_py_api-0.21.0.dist-info/METADATA,sha256=1_bTNOf0ffu3Qt3KKuFiHgjLNncKXDKSCziG5g-Suo8,8024
-nc_py_api-0.21.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-nc_py_api-0.21.0.dist-info/licenses/AUTHORS,sha256=B2Q9q9XH3PAxJp0V3GiKQc1l0z7vtGDpDHqda-ISWKM,616
-nc_py_api-0.21.0.dist-info/licenses/LICENSE.txt,sha256=OLEMh401fAumGHfRSna365MLIfnjdTcdOHZ6QOzMjkg,1551
-nc_py_api-0.21.0.dist-info/RECORD,,
+nc_py_api-0.22.0.dist-info/METADATA,sha256=6CGpk5oqgcosb-sjxhP4RVmyHd92ratTVSZjbPaZL1E,8024
+nc_py_api-0.22.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+nc_py_api-0.22.0.dist-info/licenses/AUTHORS,sha256=B2Q9q9XH3PAxJp0V3GiKQc1l0z7vtGDpDHqda-ISWKM,616
+nc_py_api-0.22.0.dist-info/licenses/LICENSE.txt,sha256=OLEMh401fAumGHfRSna365MLIfnjdTcdOHZ6QOzMjkg,1551
+nc_py_api-0.22.0.dist-info/RECORD,,