ayon-python-api 1.2.3__tar.gz → 1.2.4__tar.gz

{ayon_python_api-1.2.3 → ayon_python_api-1.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ayon_python_api
-Version: 1.2.3
+Version: 1.2.4
 Summary: AYON Python API
 Home-page: https://github.com/ynput/ayon-python-api
 Author: ynput.io

{ayon_python_api-1.2.3 → ayon_python_api-1.2.4}/ayon_api/__init__.py

@@ -271,7 +271,9 @@ from ._api import (
     get_version_thumbnail,
     get_workfile_thumbnail,
     create_thumbnail,
+    create_thumbnail_with_stream,
     update_thumbnail,
+    update_thumbnail_from_stream,
 )
 
 
@@ -546,5 +548,7 @@ __all__ = (
     "get_version_thumbnail",
     "get_workfile_thumbnail",
     "create_thumbnail",
+    "create_thumbnail_with_stream",
     "update_thumbnail",
+    "update_thumbnail_from_stream",
 )

{ayon_python_api-1.2.3 → ayon_python_api-1.2.4}/ayon_api/_api.py

@@ -7726,6 +7726,34 @@ def create_thumbnail(
     )
 
 
+def create_thumbnail_with_stream(
+    project_name: str,
+    stream: StreamType,
+    thumbnail_id: Optional[str] = None,
+) -> str:
+    """Create new thumbnail on server from byte stream.
+
+    Args:
+        project_name (str): Project where the thumbnail will be created
+            and can be used.
+        stream (StreamType): Thumbnail content stream.
+        thumbnail_id (Optional[str]): Prepared if of thumbnail.
+
+    Returns:
+        str: Created thumbnail id.
+
+    Raises:
+        ValueError: When a thumbnail source cannot be processed.
+
+    """
+    con = get_server_api_connection()
+    return con.create_thumbnail_with_stream(
+        project_name=project_name,
+        stream=stream,
+        thumbnail_id=thumbnail_id,
+    )
+
+
 def update_thumbnail(
     project_name: str,
     thumbnail_id: str,
@@ -7751,3 +7779,27 @@ def update_thumbnail(
         thumbnail_id=thumbnail_id,
         src_filepath=src_filepath,
     )
+
+
+def update_thumbnail_from_stream(
+    project_name: str,
+    thumbnail_id: str,
+    stream: StreamType,
+) -> None:
+    """Change thumbnail content by id.
+
+    Update can be also used to create new thumbnail.
+
+    Args:
+        project_name (str): Project where the thumbnail will be created
+            and can be used.
+        thumbnail_id (str): Thumbnail id to update.
+        stream (StreamType): Thumbnail content stream.
+
+    """
+    con = get_server_api_connection()
+    return con.update_thumbnail_from_stream(
+        project_name=project_name,
+        thumbnail_id=thumbnail_id,
+        stream=stream,
+    )

{ayon_python_api-1.2.3 → ayon_python_api-1.2.4}/ayon_api/_api_helpers/base.py

@@ -13,6 +13,7 @@ if typing.TYPE_CHECKING:
         AnyEntityDict,
         ServerVersion,
         ProjectDict,
+        StreamType,
     )
 
 _PLACEHOLDER = object()
@@ -84,6 +85,16 @@ class BaseServerAPI:
     ) -> requests.Response:
         raise NotImplementedError()
 
+    def upload_file_from_stream(
+        self,
+        endpoint: str,
+        stream: StreamType,
+        progress: Optional[TransferProgress] = None,
+        request_type: Optional[RequestType] = None,
+        **kwargs
+    ) -> requests.Response:
+        raise NotImplementedError()
+
     def download_file(
         self,
         endpoint: str,

{ayon_python_api-1.2.3 → ayon_python_api-1.2.4}/ayon_api/_api_helpers/thumbnails.py

@@ -2,9 +2,11 @@ from __future__ import annotations
 
 import os
 import warnings
+import typing
 from typing import Optional
 
 from ayon_api.utils import (
+    get_media_mime_type_for_stream,
     get_media_mime_type,
     ThumbnailContent,
     RequestTypes,
@@ -13,6 +15,9 @@ from ayon_api.utils import (
 
 from .base import BaseServerAPI
 
+if typing.TYPE_CHECKING:
+    from .typing import StreamType
+
 
 class ThumbnailsAPI(BaseServerAPI):
     def get_thumbnail_by_id(
@@ -259,6 +264,45 @@ class ThumbnailsAPI(BaseServerAPI):
         response.raise_for_status()
         return response.json()["id"]
 
+    def create_thumbnail_with_stream(
+        self,
+        project_name: str,
+        stream: StreamType,
+        thumbnail_id: Optional[str] = None,
+    ) -> str:
+        """Create new thumbnail on server from byte stream.
+
+        Args:
+            project_name (str): Project where the thumbnail will be created
+                and can be used.
+            stream (StreamType): Thumbnail content stream.
+            thumbnail_id (Optional[str]): Prepared if of thumbnail.
+
+        Returns:
+            str: Created thumbnail id.
+
+        Raises:
+            ValueError: When a thumbnail source cannot be processed.
+
+        """
+        if thumbnail_id:
+            self.update_thumbnail_from_stream(
+                project_name,
+                thumbnail_id,
+                stream
+            )
+            return thumbnail_id
+
+        mime_type = get_media_mime_type_for_stream(stream)
+        response = self.upload_file_from_stream(
+            f"projects/{project_name}/thumbnails",
+            stream,
+            request_type=RequestTypes.post,
+            headers={"Content-Type": mime_type},
+        )
+        response.raise_for_status()
+        return response.json()["id"]
+
     def update_thumbnail(
         self, project_name: str, thumbnail_id: str, src_filepath: str
     ) -> None:
@@ -288,6 +332,32 @@ class ThumbnailsAPI(BaseServerAPI):
         )
         response.raise_for_status()
 
+    def update_thumbnail_from_stream(
+        self,
+        project_name: str,
+        thumbnail_id: str,
+        stream: StreamType,
+    ) -> None:
+        """Change thumbnail content by id.
+
+        Update can be also used to create new thumbnail.
+
+        Args:
+            project_name (str): Project where the thumbnail will be created
+                and can be used.
+            thumbnail_id (str): Thumbnail id to update.
+            stream (StreamType): Thumbnail content stream.
+
+        """
+        mime_type = get_media_mime_type_for_stream(stream)
+        response = self.upload_file_from_stream(
+            f"projects/{project_name}/thumbnails/{thumbnail_id}",
+            stream,
+            request_type=RequestTypes.put,
+            headers={"Content-Type": mime_type},
+        )
+        response.raise_for_status()
+
     def _prepare_thumbnail_content(
         self,
         project_name: str,

{ayon_python_api-1.2.3 → ayon_python_api-1.2.4}/ayon_api/constants.py

@@ -252,4 +252,8 @@ DEFAULT_ENTITY_LIST_FIELDS = {
     "tags",
     "updatedAt",
     "updatedBy",
+    "items.id",
+    "items.entityId",
+    "items.entityType",
+    "items.position",
 }

{ayon_python_api-1.2.3 → ayon_python_api-1.2.4}/ayon_api/graphql_queries.py

@@ -680,9 +680,25 @@ def entity_lists_graphql_query(fields):
     entity_lists_field = project_field.add_field_with_edges("entityLists")
     entity_lists_field.set_filter("ids", entity_list_ids)
 
-    nested_fields = fields_to_dict(set(fields))
+    fields = set(fields)
+    items_field_names = set()
+    for field_name in set(fields):
+        field_name.removeprefix("items")
+        if not field_name.startswith("items"):
+            continue
+
+        fields.discard(field_name)
+        field_name = field_name.removeprefix("items").lstrip(".")
+        if field_name:
+            items_field_names.add(field_name)
 
     query_queue = collections.deque()
+    if items_field_names:
+        items_field = entity_lists_field.add_field_with_edges("items")
+        for field_name in items_field_names:
+            items_field.add_edge_field(field_name)
+
+    nested_fields = fields_to_dict(set(fields))
     for key, value in nested_fields.items():
         query_queue.append((key, value, entity_lists_field))
 

{ayon_python_api-1.2.3 → ayon_python_api-1.2.4}/ayon_api/operations.py

@@ -15,6 +15,7 @@ if typing.TYPE_CHECKING:
     from .server_api import ServerAPI
     from .typing import (
         NewFolderDict,
+        NewTaskDict,
         NewProductDict,
         NewVersionDict,
         NewRepresentationDict,
@@ -76,6 +77,7 @@ def new_folder_entity(
     folder_type: str,
     parent_id: Optional[str] = None,
     status: Optional[str] = None,
+    active: Optional[bool] = None,
     tags: Optional[list[str]] = None,
     attribs: Optional[dict[str, Any]] = None,
     data: Optional[dict[str, Any]] = None,
@@ -89,6 +91,7 @@ def new_folder_entity(
         folder_type (str): Type of folder.
         parent_id (Optional[str]): Parent folder id.
         status (Optional[str]): Product status.
+        active (Optional[bool]): Active status..
         tags (Optional[list[str]]): List of tags.
         attribs (Optional[dict[str, Any]]): Explicitly set attributes
             of folder.
@@ -125,6 +128,67 @@ def new_folder_entity(
         output["status"] = status
     if tags:
         output["tags"] = tags
+    if active is not None:
+        output["active"] = active
+    return output
+
+
+def new_task_entity(
+    name: str,
+    task_type: str,
+    folder_id: str,
+    *,
+    label: Optional[str] = None,
+    assignees: Optional[list[str]] = None,
+    attrib: Optional[dict[str, Any]] = None,
+    data: Optional[dict[str, Any]] = None,
+    tags: Optional[list[str]] = None,
+    status: Optional[str] = None,
+    active: Optional[bool] = None,
+    thumbnail_id: Optional[str] = None,
+    task_id: Optional[str] = None,
+) -> NewTaskDict:
+    """Create skeleton data of task entity.
+
+    Args:
+        name (str): Folder name.
+        task_type (str): Task type.
+        folder_id (str): Parent folder id.
+        label (Optional[str]): Label of folder.
+        assignees (Optional[list[str]]): Task assignees.
+        attrib (Optional[dict[str, Any]]): Task attributes.
+        data (Optional[dict[str, Any]]): Task data.
+        tags (Optional[list[str]]): Task tags.
+        status (Optional[str]): Task status.
+        active (Optional[bool]): Task active state.
+        thumbnail_id (Optional[str]): Task thumbnail id.
+        task_id (Optional[str]): Task id. If not passed new id is
+            generated.
+
+    Returns:
+        NewTaskDict: Skeleton of task entity.
+
+    """
+    if not task_id:
+        task_id = create_entity_id()
+    output = {
+        "id": task_id,
+        "name": name,
+        "taskType": task_type,
+        "folderId": folder_id,
+    }
+    for key, value in (
+        ("label", label),
+        ("attrib", attrib),
+        ("data", data),
+        ("tags", tags),
+        ("status", status),
+        ("assignees", assignees),
+        ("active", active),
+        ("thumbnailId", thumbnail_id),
+    ):
+        if value is not None:
+            output[key] = value
     return output
 
 
@@ -1046,6 +1110,10 @@ class OperationsSession(object):
             "taskType": task_type,
             "folderId": folder_id,
         }
+        if tags is not None:
+            tags = list(tags)
+        if assignees is not None:
+            assignees = list(assignees)
         for key, value in (
             ("label", label),
             ("attrib", attrib),

{ayon_python_api-1.2.3 → ayon_python_api-1.2.4}/ayon_api/typing.py

@@ -362,6 +362,21 @@ class NewFolderDict(TypedDict):
     tags: NotRequired[list[str]]
 
 
+class NewTaskDict(TypedDict):
+    id: str
+    name: str
+    task_type: str
+    folder_id: str
+    label: NotRequired[str]
+    assignees: NotRequired[list[str]]
+    attrib: NotRequired[dict[str, Any]]
+    data: NotRequired[dict[str, Any]]
+    thumbnailId: NotRequired[str]
+    active: NotRequired[bool]
+    status: NotRequired[str]
+    tags: NotRequired[list[str]]
+
+
 class NewProductDict(TypedDict):
     id: str
     name: str

{ayon_python_api-1.2.3 → ayon_python_api-1.2.4}/ayon_api/version.py

@@ -1,2 +1,2 @@
 """Package declaring Python API for AYON server."""
-__version__ = "1.2.3"
+__version__ = "1.2.4"

{ayon_python_api-1.2.3 → ayon_python_api-1.2.4}/ayon_python_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ayon-python-api
-Version: 1.2.3
+Version: 1.2.4
 Summary: AYON Python API
 Home-page: https://github.com/ynput/ayon-python-api
 Author: ynput.io

{ayon_python_api-1.2.3 → ayon_python_api-1.2.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ayon_python_api"
-version = "1.2.3"
+version = "1.2.4"
 description = "AYON Python API"
 license = {file = "LICENSE"}
 readme = {file = "README.md", content-type = "text/markdown"}