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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ayon_python_api
-Version: 1.2.2
+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.2 → ayon_python_api-1.2.4}/ayon_api/__init__.py

@@ -222,11 +222,17 @@ from ._api import (
     create_representation,
     update_representation,
     delete_representation,
+    get_workfile_entities,
+    get_workfile_entity,
+    get_workfile_entity_by_id,
+    create_workfile_entity,
+    update_workfile_entity,
+    delete_workfile_entity,
     get_workfiles_info,
     get_workfile_info,
     get_workfile_info_by_id,
-    delete_workfile_info,
     update_workfile_info,
+    delete_workfile_info,
     get_full_link_type_name,
     get_link_types,
     get_link_type,
@@ -265,7 +271,9 @@ from ._api import (
     get_version_thumbnail,
     get_workfile_thumbnail,
     create_thumbnail,
+    create_thumbnail_with_stream,
     update_thumbnail,
+    update_thumbnail_from_stream,
 )
 
 
@@ -491,11 +499,17 @@ __all__ = (
     "create_representation",
     "update_representation",
     "delete_representation",
+    "get_workfile_entities",
+    "get_workfile_entity",
+    "get_workfile_entity_by_id",
+    "create_workfile_entity",
+    "update_workfile_entity",
+    "delete_workfile_entity",
     "get_workfiles_info",
     "get_workfile_info",
     "get_workfile_info_by_id",
-    "delete_workfile_info",
     "update_workfile_info",
+    "delete_workfile_info",
     "get_full_link_type_name",
     "get_link_types",
     "get_link_type",
@@ -534,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.2 → ayon_python_api-1.2.4}/ayon_api/_api.py

@@ -6157,8 +6157,9 @@ def delete_representation(
     )
 
 
-def get_workfiles_info(
+def get_workfile_entities(
     project_name: str,
+    *,
     workfile_ids: Optional[Iterable[str]] = None,
     task_ids: Optional[Iterable[str]] = None,
     paths: Optional[Iterable[str]] = None,
@@ -6167,7 +6168,6 @@ def get_workfiles_info(
     tags: Optional[Iterable[str]] = None,
     has_links: Optional[str] = None,
     fields: Optional[Iterable[str]] = None,
-    own_attributes=_PLACEHOLDER,
 ) -> Generator[WorkfileInfoDict, None, None]:
     """Workfile info entities by passed filters.
 
@@ -6186,8 +6186,6 @@ def get_workfiles_info(
         fields (Optional[Iterable[str]]): Fields to be queried for
             representation. All possible fields are returned if 'None' is
             passed.
-        own_attributes (Optional[bool]): DEPRECATED: Not supported for
-            workfiles.
 
     Returns:
         Generator[WorkfileInfoDict, None, None]: Queried workfile info
@@ -6195,7 +6193,7 @@ def get_workfiles_info(
 
     """
     con = get_server_api_connection()
-    return con.get_workfiles_info(
+    return con.get_workfile_entities(
         project_name=project_name,
         workfile_ids=workfile_ids,
         task_ids=task_ids,
@@ -6205,16 +6203,15 @@ def get_workfiles_info(
         tags=tags,
         has_links=has_links,
         fields=fields,
-        own_attributes=own_attributes,
     )
 
 
-def get_workfile_info(
+def get_workfile_entity(
     project_name: str,
     task_id: str,
     path: str,
+    *,
     fields: Optional[Iterable[str]] = None,
-    own_attributes=_PLACEHOLDER,
 ) -> Optional[WorkfileInfoDict]:
     """Workfile info entity by task id and workfile path.
 
@@ -6225,28 +6222,25 @@ def get_workfile_info(
         fields (Optional[Iterable[str]]): Fields to be queried for
             representation. All possible fields are returned if 'None' is
             passed.
-        own_attributes (Optional[bool]): DEPRECATED: Not supported for
-            workfiles.
 
     Returns:
         Optional[WorkfileInfoDict]: Workfile info entity or None.
 
     """
     con = get_server_api_connection()
-    return con.get_workfile_info(
+    return con.get_workfile_entity(
         project_name=project_name,
         task_id=task_id,
         path=path,
         fields=fields,
-        own_attributes=own_attributes,
     )
 
 
-def get_workfile_info_by_id(
+def get_workfile_entity_by_id(
     project_name: str,
     workfile_id: str,
+    *,
     fields: Optional[Iterable[str]] = None,
-    own_attributes=_PLACEHOLDER,
 ) -> Optional[WorkfileInfoDict]:
     """Workfile info entity by id.
 
@@ -6256,23 +6250,119 @@ def get_workfile_info_by_id(
         fields (Optional[Iterable[str]]): Fields to be queried for
             representation. All possible fields are returned if 'None' is
             passed.
-        own_attributes (Optional[bool]): DEPRECATED: Not supported for
-            workfiles.
 
     Returns:
         Optional[WorkfileInfoDict]: Workfile info entity or None.
 
     """
     con = get_server_api_connection()
-    return con.get_workfile_info_by_id(
+    return con.get_workfile_entity_by_id(
         project_name=project_name,
         workfile_id=workfile_id,
         fields=fields,
-        own_attributes=own_attributes,
     )
 
 
-def delete_workfile_info(
+def create_workfile_entity(
+    project_name: str,
+    path: str,
+    task_id: str,
+    *,
+    thumbnail_id: Optional[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,
+    workfile_id: Optional[str] = None,
+) -> str:
+    """Create new workfile.
+
+    Args:
+        project_name (str): Project name.
+        path (str): Representation name.
+        task_id (str): Parent task id.
+        thumbnail_id (Optional[str]): Thumbnail id.
+        attrib (Optional[dict[str, Any]]): Representation attributes.
+        data (Optional[dict[str, Any]]): Representation data.
+        tags (Optional[Iterable[str]]): Representation tags.
+        status (Optional[str]): Representation status.
+        active (Optional[bool]): Representation active state.
+        workfile_id (Optional[str]): Workfile info id. If not
+            passed new id is generated.
+
+    Returns:
+        str: Workfile info id.
+
+    """
+    con = get_server_api_connection()
+    return con.create_workfile_entity(
+        project_name=project_name,
+        path=path,
+        task_id=task_id,
+        thumbnail_id=thumbnail_id,
+        attrib=attrib,
+        data=data,
+        tags=tags,
+        status=status,
+        active=active,
+        workfile_id=workfile_id,
+    )
+
+
+def update_workfile_entity(
+    project_name: str,
+    workfile_id: str,
+    *,
+    path: Optional[str] = None,
+    task_id: Optional[str] = None,
+    attrib: Optional[dict[str, Any]] = None,
+    data: Optional[dict[str, Any]] = None,
+    tags: Optional[Iterable[str]] = None,
+    status: Optional[str] = None,
+    active: Optional[bool] = None,
+    thumbnail_id: Optional[str] = NOT_SET,
+    created_by: Optional[str] = None,
+    updated_by: Optional[str] = None,
+) -> None:
+    """Update workfile entity on server.
+
+    Update of ``attrib`` does change only passed attributes. If you want
+        to unset value, use ``None``.
+
+    Args:
+        project_name (str): Project name.
+        workfile_id (str): Workfile id.
+        path (Optional[str]): New rootless workfile path..
+        task_id (Optional[str]): New parent task id.
+        attrib (Optional[dict[str, Any]]): New attributes.
+        data (Optional[dict[str, Any]]): New data.
+        tags (Optional[Iterable[str]]): New tags.
+        status (Optional[str]): New status.
+        active (Optional[bool]): New active state.
+        thumbnail_id (Optional[str]): New thumbnail id.
+        created_by (Optional[str]): New created by username.
+        updated_by (Optional[str]): New updated by username.
+
+    """
+    con = get_server_api_connection()
+    return con.update_workfile_entity(
+        project_name=project_name,
+        workfile_id=workfile_id,
+        path=path,
+        task_id=task_id,
+        attrib=attrib,
+        data=data,
+        tags=tags,
+        status=status,
+        active=active,
+        thumbnail_id=thumbnail_id,
+        created_by=created_by,
+        updated_by=updated_by,
+    )
+
+
+def delete_workfile_entity(
     project_name: str,
     workfile_id: str,
 ) -> None:
@@ -6284,12 +6374,127 @@ def delete_workfile_info(
 
     """
     con = get_server_api_connection()
-    return con.delete_workfile_info(
+    return con.delete_workfile_entity(
         project_name=project_name,
         workfile_id=workfile_id,
     )
 
 
+def get_workfiles_info(
+    project_name: str,
+    workfile_ids: Optional[Iterable[str]] = None,
+    task_ids: Optional[Iterable[str]] = None,
+    paths: Optional[Iterable[str]] = None,
+    path_regex: Optional[str] = None,
+    statuses: Optional[Iterable[str]] = None,
+    tags: Optional[Iterable[str]] = None,
+    has_links: Optional[str] = None,
+    fields: Optional[Iterable[str]] = None,
+    own_attributes=_PLACEHOLDER,
+) -> Generator[WorkfileInfoDict, None, None]:
+    """DEPRECATED Workfile info entities by passed filters.
+
+    Args:
+        project_name (str): Project under which the entity is located.
+        workfile_ids (Optional[Iterable[str]]): Workfile ids.
+        task_ids (Optional[Iterable[str]]): Task ids.
+        paths (Optional[Iterable[str]]): Rootless workfiles paths.
+        path_regex (Optional[str]): Regex filter for workfile path.
+        statuses (Optional[Iterable[str]]): Workfile info statuses used
+            for filtering.
+        tags (Optional[Iterable[str]]): Workfile info tags used
+            for filtering.
+        has_links (Optional[Literal[IN, OUT, ANY]]): Filter
+            representations with IN/OUT/ANY links.
+        fields (Optional[Iterable[str]]): Fields to be queried for
+            representation. All possible fields are returned if 'None' is
+            passed.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            workfiles.
+
+    Returns:
+        Generator[WorkfileInfoDict, None, None]: Queried workfile info
+            entites.
+
+    """
+    con = get_server_api_connection()
+    return con.get_workfiles_info(
+        project_name=project_name,
+        workfile_ids=workfile_ids,
+        task_ids=task_ids,
+        paths=paths,
+        path_regex=path_regex,
+        statuses=statuses,
+        tags=tags,
+        has_links=has_links,
+        fields=fields,
+        own_attributes=own_attributes,
+    )
+
+
+def get_workfile_info(
+    project_name: str,
+    task_id: str,
+    path: str,
+    fields: Optional[Iterable[str]] = None,
+    own_attributes=_PLACEHOLDER,
+) -> Optional[WorkfileInfoDict]:
+    """DEPRECATED Workfile info entity by task id and workfile path.
+
+    Args:
+        project_name (str): Project under which the entity is located.
+        task_id (str): Task id.
+        path (str): Rootless workfile path.
+        fields (Optional[Iterable[str]]): Fields to be queried for
+            representation. All possible fields are returned if 'None' is
+            passed.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            workfiles.
+
+    Returns:
+        Optional[WorkfileInfoDict]: Workfile info entity or None.
+
+    """
+    con = get_server_api_connection()
+    return con.get_workfile_info(
+        project_name=project_name,
+        task_id=task_id,
+        path=path,
+        fields=fields,
+        own_attributes=own_attributes,
+    )
+
+
+def get_workfile_info_by_id(
+    project_name: str,
+    workfile_id: str,
+    fields: Optional[Iterable[str]] = None,
+    own_attributes=_PLACEHOLDER,
+) -> Optional[WorkfileInfoDict]:
+    """DEPRECATED Workfile info entity by id.
+
+    Args:
+        project_name (str): Project under which the entity is located.
+        workfile_id (str): Workfile info id.
+        fields (Optional[Iterable[str]]): Fields to be queried for
+            representation. All possible fields are returned if 'None' is
+            passed.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            workfiles.
+
+    Returns:
+        Optional[WorkfileInfoDict]: Workfile info entity or None.
+
+    """
+    con = get_server_api_connection()
+    return con.get_workfile_info_by_id(
+        project_name=project_name,
+        workfile_id=workfile_id,
+        fields=fields,
+        own_attributes=own_attributes,
+    )
+
+
 def update_workfile_info(
     project_name: str,
     workfile_id: str,
@@ -6304,7 +6509,7 @@ def update_workfile_info(
     created_by: Optional[str] = None,
     updated_by: Optional[str] = None,
 ) -> None:
-    """Update workfile entity on server.
+    """DEPRECATED Update workfile entity on server.
 
     Update of ``attrib`` does change only passed attributes. If you want
         to unset value, use ``None``.
@@ -6341,6 +6546,24 @@ def update_workfile_info(
     )
 
 
+def delete_workfile_info(
+    project_name: str,
+    workfile_id: str,
+) -> None:
+    """DEPRECATED Delete workfile entity on server.
+
+    Args:
+        project_name (str): Project name.
+        workfile_id (str): Workfile id to delete.
+
+    """
+    con = get_server_api_connection()
+    return con.delete_workfile_info(
+        project_name=project_name,
+        workfile_id=workfile_id,
+    )
+
+
 def get_full_link_type_name(
     link_type_name: str,
     input_type: str,
@@ -7503,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,
@@ -7528,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.2 → 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,
@@ -109,6 +120,11 @@ class BaseServerAPI:
     ) -> Optional[ProjectDict]:
         raise NotImplementedError()
 
+    def get_user(
+        self, username: Optional[str] = None
+    ) -> Optional[dict[str, Any]]:
+        raise NotImplementedError()
+
     def _prepare_fields(
         self,
         entity_type: str,

{ayon_python_api-1.2.2 → 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,