nc-py-api 0.15.1__py3-none-any.whl → 0.16.0__py3-none-any.whl

nc_py_api/_version.py

@@ -1,3 +1,3 @@
 """Version of nc_py_api."""
 
-__version__ = "0.15.1"
+__version__ = "0.16.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/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.dist-info → nc_py_api-0.16.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nc-py-api
-Version: 0.15.1
+Version: 0.16.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.15.1.dist-info → nc_py_api-0.16.0.dist-info}/RECORD

@@ -7,7 +7,7 @@ nc_py_api/_preferences_ex.py,sha256=tThj6U0ZZMaBZ-jUkjrbaI0xDnafWsBowQKsC6gjOQs,
 nc_py_api/_session.py,sha256=iFv8_xkPA_erhUNvSvjUJvhKL3yCnq2xHNkL8PHLbrA,20180
 nc_py_api/_talk_api.py,sha256=0Uo7OduYniuuX3UQPb468RyGJJ-PWBCgJ5HoPuz5Qa0,51068
 nc_py_api/_theming.py,sha256=hTr3nuOemSuRFZaPy9iXNmBM7rDgQHECH43tHMWGqEY,1870
-nc_py_api/_version.py,sha256=Dt9IkBN4iUg27P2-Ta2TsVPTw9f6Af6hqftxqxv33m0,52
+nc_py_api/_version.py,sha256=vw6VrjuPRin5Pm7VDRrwjw0_FOOwigsu-NyVCk5I4Ys,52
 nc_py_api/activity.py,sha256=t9VDSnnaXRNOvALqOSGCeXSQZ-426pCOMSfQ96JHys4,9574
 nc_py_api/apps.py,sha256=tc3Qg-V7au0inUQGOv1Mj7Td5sEGiHOjCjRq1mN41x0,9763
 nc_py_api/calendar.py,sha256=-T6CJ8cRbJZTLtxSEDWuuYpD29DMJGCTfLONmtxZV9w,1445
@@ -34,7 +34,7 @@ nc_py_api/ex_app/uvicorn_fastapi.py,sha256=WLtNmWXMBKN6CMip2uhKcgy4mC2Ch9AmNfwRS
 nc_py_api/ex_app/providers/__init__.py,sha256=jmUBdbAgzUCdYyHl8V5UCNYJI-FFpxPQQ4iEAoURKQs,43
 nc_py_api/ex_app/providers/providers.py,sha256=_1zWAgg9ol2u82Huf-yxFfxviGwtEeLIxDWTTYY2jJQ,1955
 nc_py_api/ex_app/providers/speech_to_text.py,sha256=JFD1ksdhXjpr5UFm5npqCxepqB5x-kdHG9CpPoGofx0,4959
-nc_py_api/ex_app/providers/task_processing.py,sha256=zZHjOwTwNIRV5e25jm4Yy4eR0weGwvaU-ooY5YNYsfg,7656
+nc_py_api/ex_app/providers/task_processing.py,sha256=h-H3fGK30c9M-VUpk7I9WGc730t9OCoSZ6vf7lB7xdA,9874
 nc_py_api/ex_app/providers/text_processing.py,sha256=VUZMZ2fof-c6JD7mTKHTZBWbDMOqxDllMCNQFOlHXXk,5265
 nc_py_api/ex_app/providers/translations.py,sha256=io8UgVhdQXFmP7KnrJQx5Vtl8Dz0Z0EVZ0bt3hV7C7A,6112
 nc_py_api/ex_app/ui/__init__.py,sha256=jUMU7_miFF-Q8BQNT90KZYQiLy_a3OvEyK6y8eRMKRk,38
@@ -45,11 +45,11 @@ nc_py_api/ex_app/ui/top_menu.py,sha256=oCgGtIoMYbp-5iN5aXEbT7Q88HtccR7hg6IBFgbby
 nc_py_api/ex_app/ui/ui.py,sha256=OqFHKn6oIZli8T1wnv6YtQ4glNfeNb90WwGCvtWI1Z4,1632
 nc_py_api/files/__init__.py,sha256=p1RecBNkZCuu8_mf-y_mkbotj9fGsCDSFRl7hGkI1CA,17003
 nc_py_api/files/_files.py,sha256=_s_f8xbzQPEH2F2LNwomI9CxscYHryus1pMZ_vW00C4,13666
-nc_py_api/files/files.py,sha256=Yj388MJp_EdM-2neM9EnALaLnSR6zMJbYxXzHpHmOmI,24577
+nc_py_api/files/files.py,sha256=DuAMkfmRGtNJntMIo-yEYhZ-a3KhhhnwKATcGqpxJL4,24569
 nc_py_api/files/files_async.py,sha256=rEIT6P1Pb7TeTub1dAB5IKpR4LDqHWc5LclAEzpiHEQ,25410
 nc_py_api/files/sharing.py,sha256=VRZCl-TYK6dbu9rUHPs3_jcVozu1EO8bLGZwoRpiLsU,14439
-nc_py_api-0.15.1.dist-info/METADATA,sha256=B2DQ8CnwPgrDIQDbr_CdAX5dwXGWuSDWSmj53QpiFhw,9466
-nc_py_api-0.15.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-nc_py_api-0.15.1.dist-info/licenses/AUTHORS,sha256=Y1omFHyI8ned9k4jJXs2ATgmgi1GmQ7EZ6S1gxqnX2k,572
-nc_py_api-0.15.1.dist-info/licenses/LICENSE.txt,sha256=OLEMh401fAumGHfRSna365MLIfnjdTcdOHZ6QOzMjkg,1551
-nc_py_api-0.15.1.dist-info/RECORD,,
+nc_py_api-0.16.0.dist-info/METADATA,sha256=tQ-TcI5upBWSmV436b2NxQ873SmfcwtmQT_qqrTrs3Y,9466
+nc_py_api-0.16.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+nc_py_api-0.16.0.dist-info/licenses/AUTHORS,sha256=Y1omFHyI8ned9k4jJXs2ATgmgi1GmQ7EZ6S1gxqnX2k,572
+nc_py_api-0.16.0.dist-info/licenses/LICENSE.txt,sha256=OLEMh401fAumGHfRSna365MLIfnjdTcdOHZ6QOzMjkg,1551
+nc_py_api-0.16.0.dist-info/RECORD,,