ayon-python-api 1.2.6__tar.gz → 1.2.8__tar.gz

{ayon_python_api-1.2.6/ayon_python_api.egg-info → ayon_python_api-1.2.8}/PKG-INFO

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

{ayon_python_api-1.2.6 → ayon_python_api-1.2.8}/ayon_api/__init__.py

@@ -70,6 +70,8 @@ from ._api import (
     delete,
     download_file_to_stream,
     download_file,
+    download_project_file,
+    download_project_file_to_stream,
     upload_file_from_stream,
     upload_file,
     upload_reviewable,
@@ -349,6 +351,8 @@ __all__ = (
     "delete",
     "download_file_to_stream",
     "download_file",
+    "download_project_file",
+    "download_project_file_to_stream",
     "upload_file_from_stream",
     "upload_file",
     "upload_reviewable",

{ayon_python_api-1.2.6 → ayon_python_api-1.2.8}/ayon_api/_api.py

@@ -992,6 +992,80 @@ def download_file(
     )
 
 
+def download_project_file(
+    project_name: str,
+    file_id: str,
+    filepath: str,
+    *,
+    chunk_size: Optional[int] = None,
+    progress: Optional[TransferProgress] = None,
+) -> TransferProgress:
+    """Download project file to filepath.
+
+    Project files are usually binary files, such as images, videos,
+        or other media files that can be accessed via api endpoint
+        '{server url}/api/projects/{project_name}/files/{file_id}'.
+
+    Args:
+        project_name (str): Project name.
+        file_id (str): File id.
+        filepath (str): Path where file will be downloaded.
+        chunk_size (Optional[int]): Size of chunks that are received
+            in single loop.
+        progress (Optional[TransferProgress]): Object that gives ability
+            to track download progress.
+
+    Returns:
+        TransferProgress: Progress object.
+
+    """
+    con = get_server_api_connection()
+    return con.download_project_file(
+        project_name=project_name,
+        file_id=file_id,
+        filepath=filepath,
+        chunk_size=chunk_size,
+        progress=progress,
+    )
+
+
+def download_project_file_to_stream(
+    project_name: str,
+    file_id: str,
+    stream: StreamType,
+    *,
+    chunk_size: Optional[int] = None,
+    progress: Optional[TransferProgress] = None,
+) -> TransferProgress:
+    """Download project file to a stream.
+
+    Project files are usually binary files, such as images, videos,
+        or other media files that can be accessed via api endpoint
+        '{server url}/api/projects/{project_name}/files/{file_id}'.
+
+    Args:
+        project_name (str): Project name.
+        file_id (str): File id.
+        stream (StreamType): Stream where output will be stored.
+        chunk_size (Optional[int]): Size of chunks that are received
+            in single loop.
+        progress (Optional[TransferProgress]): Object that gives ability
+            to track download progress.
+
+    Returns:
+        TransferProgress: Progress object.
+
+    """
+    con = get_server_api_connection()
+    return con.download_project_file_to_stream(
+        project_name=project_name,
+        file_id=file_id,
+        stream=stream,
+        chunk_size=chunk_size,
+        progress=progress,
+    )
+
+
 def upload_file_from_stream(
     endpoint: str,
     stream: StreamType,
@@ -4932,6 +5006,8 @@ def get_products(
             Use 'None' if folder is direct child of project.
         product_types (Optional[Iterable[str]]): Product types used for
             filtering.
+        product_base_types (Optional[Iterable[str]]): Product base types
+            used for filtering.
         product_name_regex (Optional[str]): Filter products by name regex.
         product_path_regex (Optional[str]): Filter products by path regex.
             Path starts with folder path and ends with product name.

{ayon_python_api-1.2.6 → ayon_python_api-1.2.8}/ayon_api/_api_helpers/lists.py

@@ -26,7 +26,15 @@ class ListsAPI(BaseServerAPI):
         active: Optional[bool] = None,
         fields: Optional[Iterable[str]] = None,
     ) -> Generator[dict[str, Any], None, None]:
-        """Fetch entity lists from server.
+        """Fetch entity lists from AYON server.
+
+        Warnings:
+            You can't get list items for lists with different 'entityType' in
+                one call.
+
+        Notes:
+            To get list items, you have to pass 'items' field or
+                'items.{sub-fields you want}' to 'fields' argument.
 
         Args:
             project_name (str): Project name where entity lists are.
@@ -42,7 +50,30 @@ class ListsAPI(BaseServerAPI):
         """
         if fields is None:
             fields = self.get_default_fields_for_type("entityList")
-        fields = set(fields)
+
+        # List does not have 'attrib' field but has 'allAttrib' field
+        #   which is json string and contains only values that are set
+        o_fields = tuple(fields)
+        fields = set()
+        requires_attrib = False
+        for field in o_fields:
+            if field == "attrib" or field.startswith("attrib."):
+                requires_attrib = True
+                field = "allAttrib"
+            fields.add(field)
+
+        if "items" in fields:
+            fields.discard("items")
+            fields |= {
+                "items.id",
+                "items.entityId",
+                "items.entityType",
+                "items.position",
+            }
+
+        available_attribs = []
+        if requires_attrib:
+            available_attribs = self.get_attributes_for_type("list")
 
         if active is not None:
             fields.add("active")
@@ -66,6 +97,15 @@ class ListsAPI(BaseServerAPI):
                 if isinstance(attributes, str):
                     entity_list["attributes"] = json.loads(attributes)
 
+                if requires_attrib:
+                    all_attrib = json.loads(
+                        entity_list.get("allAttrib") or "{}"
+                    )
+                    entity_list["attrib"] = {
+                        attrib_name: all_attrib.get(attrib_name)
+                        for attrib_name in available_attribs
+                    }
+
                 self._convert_entity_data(entity_list)
 
                 yield entity_list
@@ -170,9 +210,8 @@ class ListsAPI(BaseServerAPI):
                 kwargs[key] = value
 
         response = self.post(
-            f"projects/{project_name}/lists/{list_id}/items",
+            f"projects/{project_name}/lists",
             **kwargs
-
         )
         response.raise_for_status()
         return list_id
@@ -343,7 +382,7 @@ class ListsAPI(BaseServerAPI):
             mode (EntityListItemMode): Mode of items update.
 
         """
-        response = self.post(
+        response = self.patch(
             f"projects/{project_name}/lists/{list_id}/items",
             items=items,
             mode=mode,

{ayon_python_api-1.2.6 → ayon_python_api-1.2.8}/ayon_api/constants.py

@@ -247,6 +247,7 @@ DEFAULT_ACTIVITY_FIELDS = {
 DEFAULT_ENTITY_LIST_FIELDS = {
     "id",
     "count",
+    "allAttrib",
     "attributes",
     "active",
     "createdBy",
@@ -259,8 +260,4 @@ DEFAULT_ENTITY_LIST_FIELDS = {
     "tags",
     "updatedAt",
     "updatedBy",
-    "items.id",
-    "items.entityId",
-    "items.entityType",
-    "items.position",
 }

{ayon_python_api-1.2.6 → ayon_python_api-1.2.8}/ayon_api/entity_hub.py

@@ -1418,7 +1418,9 @@ class EntityData(dict):
     """
     def __init__(self, *args, **kwargs) -> None:
         super().__init__(*args, **kwargs)
-        self._orig_data = copy.deepcopy(self)
+        self._orig_data = {}
+        # Fill orig data
+        self.lock()
 
     def get_changes(self) -> dict[str, Any]:
         """Changes in entity data.
@@ -1437,10 +1439,10 @@ class EntityData(dict):
                 output[key] = None
             elif key not in self._orig_data:
                 # New value was set
-                output[key] = self[key]
+                output[key] = copy.deepcopy(self[key])
             elif self[key] != self._orig_data[key]:
                 # Value was changed
-                output[key] = self[key]
+                output[key] = copy.deepcopy(self[key])
         return output
 
     def get_new_entity_value(self) -> dict[str, AttributeValueType]:
@@ -1460,7 +1462,25 @@ class EntityData(dict):
     def lock(self) -> None:
         """Lock changes of entity data."""
 
-        self._orig_data = copy.deepcopy(self)
+        orig_data = {}
+        for key, value in self.items():
+            try:
+                key = copy.deepcopy(key)
+            except RecursionError:
+                raise RuntimeError(
+                    f"Failed to create copy of key '{key}'"
+                    " because of recursion."
+                )
+
+            try:
+                orig_data[key] = copy.deepcopy(value)
+            except RecursionError:
+                raise RuntimeError(
+                    f"Failed to create copy of value '{key}'"
+                    " because of recursion."
+                )
+
+        self._orig_data = orig_data
 
 
 class BaseEntity(ABC):
@@ -1562,6 +1582,8 @@ class BaseEntity(ABC):
         self._tags = copy.deepcopy(tags)
         self._thumbnail_id = thumbnail_id
 
+        if name == label:
+            label = None
         self._orig_name = name
         self._orig_label = label
         self._orig_status = status

{ayon_python_api-1.2.6 → ayon_python_api-1.2.8}/ayon_api/server_api.py

@@ -1329,7 +1329,7 @@ class ServerAPI(
     def _endpoint_to_url(
         self,
         endpoint: str,
-        use_rest: Optional[bool] = True
+        use_rest: bool = True,
     ) -> str:
         """Cleanup endpoint and return full url to AYON server.
 
@@ -1347,25 +1347,53 @@ class ServerAPI(
         endpoint = endpoint.lstrip("/").rstrip("/")
         if endpoint.startswith(self._base_url):
             return endpoint
-        base_url = self._rest_url if use_rest else self._graphql_url
+        base_url = self._rest_url if use_rest else self._base_url
         return f"{base_url}/{endpoint}"
 
     def _download_file_to_stream(
-        self, url: str, stream, chunk_size, progress
+        self,
+        url: str,
+        stream: StreamType,
+        chunk_size: int,
+        progress: TransferProgress,
     ):
-        kwargs = {"stream": True}
+        headers = self.get_headers()
+        kwargs = {
+            "stream": True,
+            "headers": headers,
+        }
         if self._session is None:
-            kwargs["headers"] = self.get_headers()
             get_func = self._base_functions_mapping[RequestTypes.get]
         else:
             get_func = self._session_functions_mapping[RequestTypes.get]
 
-        with get_func(url, **kwargs) as response:
-            response.raise_for_status()
-            progress.set_content_size(response.headers["Content-length"])
-            for chunk in response.iter_content(chunk_size=chunk_size):
-                stream.write(chunk)
-                progress.add_transferred_chunk(len(chunk))
+        retries = self.get_default_max_retries()
+        for attempt in range(retries):
+            # Continue in download
+            offset = progress.get_transferred_size()
+            if offset > 0:
+                headers["Range"] = f"bytes={offset}-"
+
+            try:
+                with get_func(url, **kwargs) as response:
+                    response.raise_for_status()
+                    if progress.get_content_size() is None:
+                        progress.set_content_size(
+                            response.headers["Content-length"]
+                        )
+
+                    for chunk in response.iter_content(chunk_size=chunk_size):
+                        stream.write(chunk)
+                        progress.add_transferred_chunk(len(chunk))
+                break
+
+            except (
+                requests.exceptions.Timeout,
+                requests.exceptions.ConnectionError,
+            ):
+                if attempt == retries:
+                    raise
+                progress.next_attempt()
 
     def download_file_to_stream(
         self,
@@ -1399,7 +1427,7 @@ class ServerAPI(
         if not chunk_size:
             chunk_size = self.default_download_chunk_size
 
-        url = self._endpoint_to_url(endpoint)
+        url = self._endpoint_to_url(endpoint, use_rest=False)
 
         if progress is None:
             progress = TransferProgress()
@@ -1470,6 +1498,76 @@ class ServerAPI(
 
         return progress
 
+    def download_project_file(
+        self,
+        project_name: str,
+        file_id: str,
+        filepath: str,
+        *,
+        chunk_size: Optional[int] = None,
+        progress: Optional[TransferProgress] = None,
+    ) -> TransferProgress:
+        """Download project file to filepath.
+
+        Project files are usually binary files, such as images, videos,
+            or other media files that can be accessed via api endpoint
+            '{server url}/api/projects/{project_name}/files/{file_id}'.
+
+        Args:
+            project_name (str): Project name.
+            file_id (str): File id.
+            filepath (str): Path where file will be downloaded.
+            chunk_size (Optional[int]): Size of chunks that are received
+                in single loop.
+            progress (Optional[TransferProgress]): Object that gives ability
+                to track download progress.
+
+        Returns:
+            TransferProgress: Progress object.
+
+        """
+        return self.download_file(
+            f"api/projects/{project_name}/files/{file_id}",
+            filepath,
+            chunk_size=chunk_size,
+            progress=progress,
+        )
+
+    def download_project_file_to_stream(
+        self,
+        project_name: str,
+        file_id: str,
+        stream: StreamType,
+        *,
+        chunk_size: Optional[int] = None,
+        progress: Optional[TransferProgress] = None,
+    ) -> TransferProgress:
+        """Download project file to a stream.
+
+        Project files are usually binary files, such as images, videos,
+            or other media files that can be accessed via api endpoint
+            '{server url}/api/projects/{project_name}/files/{file_id}'.
+
+        Args:
+            project_name (str): Project name.
+            file_id (str): File id.
+            stream (StreamType): Stream where output will be stored.
+            chunk_size (Optional[int]): Size of chunks that are received
+                in single loop.
+            progress (Optional[TransferProgress]): Object that gives ability
+                to track download progress.
+
+        Returns:
+            TransferProgress: Progress object.
+
+        """
+        return self.download_file_to_stream(
+            f"api/projects/{project_name}/files/{file_id}",
+            stream,
+            chunk_size=chunk_size,
+            progress=progress,
+        )
+
     @staticmethod
     def _upload_chunks_iter(
         file_stream: StreamType,
@@ -1543,11 +1641,27 @@ class ServerAPI(
         if not chunk_size:
             chunk_size = self.default_upload_chunk_size
 
-        response = post_func(
-            url,
-            data=self._upload_chunks_iter(stream, progress, chunk_size),
-            **kwargs
-        )
+        retries = self.get_default_max_retries()
+        response = None
+        for attempt in range(retries):
+            try:
+                response = post_func(
+                    url,
+                    data=self._upload_chunks_iter(
+                        stream, progress, chunk_size
+                    ),
+                    **kwargs
+                )
+                break
+
+            except (
+                requests.exceptions.Timeout,
+                requests.exceptions.ConnectionError,
+            ):
+                if attempt == retries:
+                    raise
+                progress.next_attempt()
+                progress.reset_transferred()
 
         response.raise_for_status()
         return response
@@ -1842,6 +1956,8 @@ class ServerAPI(
 
         elif entity_type == "entityList":
             entity_type_defaults = set(DEFAULT_ENTITY_LIST_FIELDS)
+            # Attributes scope is 'list'
+            entity_type = "list"
 
         else:
             raise ValueError(f"Unknown entity type \"{entity_type}\"")

{ayon_python_api-1.2.6 → ayon_python_api-1.2.8}/ayon_api/utils.py

@@ -796,6 +796,7 @@ class TransferProgress:
     """Object to store progress of download/upload from/to server."""
 
     def __init__(self):
+        self._attempt: int = 0
         self._started: bool = False
         self._transfer_done: bool = False
         self._transferred: int = 0
@@ -850,6 +851,17 @@ class TransferProgress:
         if self._started:
             raise ValueError("Progress already started")
         self._started = True
+        self._attempt = 1
+
+    def get_attempt(self) -> int:
+        """Find out which attempt of progress it is."""
+        return self._attempt
+
+    def next_attempt(self) -> None:
+        """Start new attempt of progress."""
+        if not self._started:
+            raise ValueError("Progress did not start yet")
+        self._attempt += 1
 
     def get_transfer_done(self) -> bool:
         """Transfer finished.
@@ -921,6 +933,10 @@ class TransferProgress:
         """
         self._transferred = transferred
 
+    def reset_transferred(self) -> None:
+        """Reset transferred size to initial value."""
+        self._transferred = 0
+
     def add_transferred_chunk(self, chunk_size: int):
         """Add transferred chunk size in bytes.
 

{ayon_python_api-1.2.6 → ayon_python_api-1.2.8}/ayon_api/version.py

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

{ayon_python_api-1.2.6 → ayon_python_api-1.2.8/ayon_python_api.egg-info}/PKG-INFO

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

{ayon_python_api-1.2.6 → ayon_python_api-1.2.8}/pyproject.toml

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