ayon-python-api 0.5.3__tar.gz → 0.5.4__tar.gz

{ayon-python-api-0.5.3 → ayon-python-api-0.5.4}/PKG-INFO

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

{ayon-python-api-0.5.3 → ayon-python-api-0.5.4}/ayon_api/entity_hub.py

@@ -2549,7 +2549,10 @@ class FolderEntity(BaseEntity):
         if self.thumbnail_id is not UNKNOWN_VALUE:
             output["thumbnailId"] = self.thumbnail_id
 
-        if self._entity_hub.allow_data_changes:
+        if (
+            self._entity_hub.allow_data_changes
+            and self._data is not UNKNOWN_VALUE
+        ):
             output["data"] = self._data
         return output
 

{ayon-python-api-0.5.3 → ayon-python-api-0.5.4}/ayon_api/server_api.py

@@ -363,6 +363,10 @@ class ServerAPI(object):
         max_retries (Optional[int]): Number of retries for requests.
     """
     _default_max_retries = 3
+    # 1 MB chunk by default
+    # TODO find out if these are reasonable default value
+    default_download_chunk_size = 1024 * 1024
+    default_upload_chunk_size = 1024 * 1024
 
     def __init__(
         self,
@@ -1596,6 +1600,10 @@ class ServerAPI(object):
         download happens in thread and other thread want to catch changes over
         time.
 
+        Todos:
+            Use retries and timeout.
+            Return RestApiResponse.
+
         Args:
             endpoint (str): Endpoint or URL to file that should be downloaded.
             filepath (str): Path where file will be downloaded.
@@ -1606,8 +1614,7 @@ class ServerAPI(object):
         """
 
         if not chunk_size:
-            # 1 MB chunk by default
-            chunk_size = 1024 * 1024
+            chunk_size = self.default_download_chunk_size
 
         if endpoint.startswith(self._base_url):
             url = endpoint
@@ -1634,33 +1641,93 @@ class ServerAPI(object):
             progress.set_transfer_done()
         return progress
 
-    def _upload_file(self, url, filepath, progress, request_type=None):
+    @staticmethod
+    def _upload_chunks_iter(file_stream, progress, chunk_size):
+        """Generator that yields chunks of file.
+
+        Args:
+            file_stream (io.BinaryIO): Byte stream.
+            progress (TransferProgress): Object to track upload progress.
+            chunk_size (int): Size of chunks that are uploaded at once.
+
+        Yields:
+            bytes: Chunk of file.
+        """
+
+        # Get size of file
+        file_stream.seek(0, io.SEEK_END)
+        size = file_stream.tell()
+        file_stream.seek(0)
+        # Set content size to progress object
+        progress.set_content_size(size)
+
+        while True:
+            chunk = file_stream.read(chunk_size)
+            if not chunk:
+                break
+            progress.add_transferred_chunk(len(chunk))
+            yield chunk
+
+    def _upload_file(
+        self,
+        url,
+        filepath,
+        progress,
+        request_type=None,
+        chunk_size=None,
+        **kwargs
+    ):
+        """
+
+        Args:
+            url (str): Url where file will be uploaded.
+            filepath (str): Source filepath.
+            progress (TransferProgress): Object that gives ability to track
+                progress.
+            request_type (Optional[RequestType]): Type of request that will
+                be used. Default is PUT.
+            chunk_size (Optional[int]): Size of chunks that are uploaded
+                at once.
+            **kwargs (Any): Additional arguments that will be passed
+                to request function.
+
+        Returns:
+            RestApiResponse: Server response.
+        """
+
         if request_type is None:
             request_type = RequestTypes.put
-        kwargs = {}
+
         if self._session is None:
-            kwargs["headers"] = self.get_headers()
+            headers = kwargs.setdefault("headers", {})
+            for key, value in self.get_headers().items():
+                if key not in headers:
+                    headers[key] = value
             post_func = self._base_functions_mapping[request_type]
         else:
             post_func = self._session_functions_mapping[request_type]
 
+        if not chunk_size:
+            chunk_size = self.default_upload_chunk_size
+
         with open(filepath, "rb") as stream:
-            stream.seek(0, io.SEEK_END)
-            size = stream.tell()
-            stream.seek(0)
-            progress.set_content_size(size)
-            response = post_func(url, data=stream, **kwargs)
+            response = post_func(
+                url,
+                data=self._upload_chunks_iter(stream, progress, chunk_size),
+                **kwargs
+            )
+
         response.raise_for_status()
-        progress.set_transferred_size(size)
         return response
 
     def upload_file(
-        self, endpoint, filepath, progress=None, request_type=None
+        self, endpoint, filepath, progress=None, request_type=None, **kwargs
     ):
         """Upload file to server.
 
         Todos:
-            Uploading with more detailed progress.
+            Use retries and timeout.
+            Return RestApiResponse.
 
         Args:
             endpoint (str): Endpoint or url where file will be uploaded.
@@ -1669,6 +1736,8 @@ class ServerAPI(object):
                 to track upload progress.
             request_type (Optional[RequestType]): Type of request that will
                 be used to upload file.
+            **kwargs (Any): Additional arguments that will be passed
+                to request function.
 
         Returns:
             requests.Response: Response object.
@@ -1690,7 +1759,9 @@ class ServerAPI(object):
         progress.set_started()
 
         try:
-            return self._upload_file(url, filepath, progress, request_type)
+            return self._upload_file(
+                url, filepath, progress, request_type, **kwargs
+            )
 
         except Exception as exc:
             progress.set_failed(str(exc))
@@ -4719,7 +4790,7 @@ class ServerAPI(object):
             own_attributes=own_attributes
         )
         return {
-            version["parent"]: version
+            version["productId"]: version
             for version in versions
         }
 
@@ -4833,6 +4904,23 @@ class ServerAPI(object):
         )
         return latest_version["id"] == version_id
 
+    def _representation_conversion(self, representation):
+        if "context" in representation:
+            orig_context = representation["context"]
+            context = {}
+            if orig_context and orig_context != "null":
+                context = json.loads(orig_context)
+            representation["context"] = context
+
+        repre_files = representation.get("files")
+        if not repre_files:
+            return
+
+        for repre_file in repre_files:
+            repre_file_size = repre_file.get("size")
+            if repre_file_size is not None:
+                repre_file["size"] = int(repre_file["size"])
+
     def get_representations(
         self,
         project_name,
@@ -4880,7 +4968,9 @@ class ServerAPI(object):
             fields = set(fields)
             if "attrib" in fields:
                 fields.remove("attrib")
-                fields |= self.get_attributes_fields_for_type("representation")
+                fields |= self.get_attributes_fields_for_type(
+                    "representation"
+                )
 
         use_rest = False
         if "data" in fields and not self.graphql_allows_data_in_query:
@@ -4949,12 +5039,7 @@ class ServerAPI(object):
                 else:
                     self._convert_entity_data(repre)
 
-                if "context" in repre:
-                    orig_context = repre["context"]
-                    context = {}
-                    if orig_context and orig_context != "null":
-                        context = json.loads(orig_context)
-                    repre["context"] = context
+                self._representation_conversion(repre)
 
                 if own_attributes:
                     fill_own_attribs(repre)
@@ -5067,7 +5152,6 @@ class ServerAPI(object):
             version = repre.pop("version")
             product = version.pop("product")
             folder = product.pop("folder")
-            self._convert_entity_data(repre)
             self._convert_entity_data(version)
             self._convert_entity_data(product)
             self._convert_entity_data(folder)
@@ -5523,16 +5607,14 @@ class ServerAPI(object):
             return thumbnail_id
 
         mime_type = self._get_thumbnail_mime_type(src_filepath)
-        with open(src_filepath, "rb") as stream:
-            content = stream.read()
-
-        response = self.raw_post(
+        response = self.upload_file(
             "projects/{}/thumbnails".format(project_name),
+            src_filepath,
+            request_type=RequestTypes.post,
             headers={"Content-Type": mime_type},
-            data=content
         )
         response.raise_for_status()
-        return response.data["id"]
+        return response.json()["id"]
 
     def update_thumbnail(self, project_name, thumbnail_id, src_filepath):
         """Change thumbnail content by id.
@@ -5553,13 +5635,11 @@ class ServerAPI(object):
             raise ValueError("Entered filepath does not exist.")
 
         mime_type = self._get_thumbnail_mime_type(src_filepath)
-        with open(src_filepath, "rb") as stream:
-            content = stream.read()
-
-        response = self.raw_put(
+        response = self.upload_file(
             "projects/{}/thumbnails/{}".format(project_name, thumbnail_id),
+            src_filepath,
+            request_type=RequestTypes.put,
             headers={"Content-Type": mime_type},
-            data=content
         )
         response.raise_for_status()
 

{ayon-python-api-0.5.3 → ayon-python-api-0.5.4}/ayon_api/version.py

@@ -1,2 +1,2 @@
 """Package declaring Python API for Ayon server."""
-__version__ = "0.5.3"
+__version__ = "0.5.4"

{ayon-python-api-0.5.3 → ayon-python-api-0.5.4}/ayon_python_api.egg-info/PKG-INFO

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

{ayon-python-api-0.5.3 → ayon-python-api-0.5.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ayon-python-api"
-version = "0.5.3"
+version = "0.5.4"
 description = "AYON Python API"
 license = {file = "LICENSE"}
 readme = {file = "README.md", content-type = "text/markdown"}