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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ayon-python-api
-Version: 0.5.2
+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.2 → ayon-python-api-0.5.4}/ayon_api/_api.py

@@ -374,7 +374,7 @@ def get_default_settings_variant():
     """
 
     con = get_server_api_connection()
-    return con.get_client_version()
+    return con.get_default_settings_variant()
 
 
 def set_default_settings_variant(variant):

{ayon-python-api-0.5.2 → ayon-python-api-0.5.4}/ayon_api/constants.py

@@ -3,6 +3,10 @@ SERVER_URL_ENV_KEY = "AYON_SERVER_URL"
 SERVER_API_ENV_KEY = "AYON_API_KEY"
 SERVER_TIMEOUT_ENV_KEY = "AYON_SERVER_TIMEOUT"
 SERVER_RETRIES_ENV_KEY = "AYON_SERVER_RETRIES"
+# Default variant used for settings
+DEFAULT_VARIANT_ENV_KEY = "AYON_DEFAULT_SETTINGS_VARIANT"
+# Default site id used for connection
+SITE_ID_ENV_KEY = "AYON_SITE_ID"
 
 # Backwards compatibility
 SERVER_TOKEN_ENV_KEY = SERVER_API_ENV_KEY
@@ -40,6 +44,7 @@ DEFAULT_PROJECT_FIELDS = {
     "code",
     "config",
     "createdAt",
+    "data",
 }
 
 # --- Folders ---
@@ -52,6 +57,7 @@ DEFAULT_FOLDER_FIELDS = {
     "parentId",
     "active",
     "thumbnailId",
+    "data",
 }
 
 # --- Tasks ---
@@ -63,6 +69,7 @@ DEFAULT_TASK_FIELDS = {
     "folderId",
     "active",
     "assignees",
+    "data",
 }
 
 # --- Products ---
@@ -72,6 +79,7 @@ DEFAULT_PRODUCT_FIELDS = {
     "folderId",
     "active",
     "productType",
+    "data",
 }
 
 # --- Versions ---
@@ -86,6 +94,7 @@ DEFAULT_VERSION_FIELDS = {
     "thumbnailId",
     "createdAt",
     "updatedAt",
+    "data",
 }
 
 # --- Representations ---
@@ -96,6 +105,7 @@ DEFAULT_REPRESENTATION_FIELDS = {
     "createdAt",
     "active",
     "versionId",
+    "data",
 }
 
 REPRESENTATION_FILES_FIELDS = {
@@ -119,6 +129,7 @@ DEFAULT_WORKFILE_INFO_FIELDS = {
     "thumbnailId",
     "updatedAt",
     "updatedBy",
+    "data",
 }
 
 DEFAULT_EVENT_FIELDS = {

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

@@ -36,15 +36,18 @@ class EntityHub(object):
     """
 
     def __init__(
-        self, project_name, connection=None, allow_data_changes=False
+        self, project_name, connection=None, allow_data_changes=None
     ):
         if not connection:
             connection = get_server_api_connection()
-        major, minor, _, _, _ = connection.server_version_tuple
+        major, minor, patch, _, _ = connection.server_version_tuple
         path_start_with_slash = True
         if (major, minor) < (0, 6):
             path_start_with_slash = False
 
+        if allow_data_changes is None:
+            allow_data_changes = connection.graphql_allows_data_in_query
+
         self._connection = connection
         self._path_start_with_slash = path_start_with_slash
 
@@ -2546,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.2 → ayon-python-api-0.5.4}/ayon_api/server_api.py

@@ -9,6 +9,9 @@ import platform
 import copy
 import uuid
 from contextlib import contextmanager
+
+import six
+
 try:
     from http import HTTPStatus
 except ImportError:
@@ -27,7 +30,6 @@ except ImportError:
         from json import JSONDecodeError as RequestsJSONDecodeError
 
 from .constants import (
-    SERVER_TIMEOUT_ENV_KEY,
     SERVER_RETRIES_ENV_KEY,
     DEFAULT_PRODUCT_TYPE_FIELDS,
     DEFAULT_PROJECT_FIELDS,
@@ -76,8 +78,11 @@ from .utils import (
     create_dependency_package_basename,
     ThumbnailContent,
     get_default_timeout,
+    get_default_settings_variant,
+    get_default_site_id,
 )
 
+_PLACEHOLDER = object()
 PatternType = type(re.compile(""))
 JSONDecodeError = getattr(json, "JSONDecodeError", ValueError)
 # This should be collected from server schema
@@ -358,12 +363,16 @@ 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,
         base_url,
         token=None,
-        site_id=None,
+        site_id=_PLACEHOLDER,
         client_version=None,
         default_settings_variant=None,
         sender=None,
@@ -382,11 +391,14 @@ class ServerAPI(object):
         self._graphql_url = "{}/graphql".format(base_url)
         self._log = None
         self._access_token = token
+        # Allow to have 'site_id' to 'None'
+        if site_id is _PLACEHOLDER:
+            site_id = get_default_site_id()
         self._site_id = site_id
         self._client_version = client_version
         self._default_settings_variant = (
             default_settings_variant
-            or "production"
+            or get_default_settings_variant()
         )
         self._sender = sender
 
@@ -416,6 +428,8 @@ class ServerAPI(object):
         self._server_version = None
         self._server_version_tuple = None
 
+        self._graphql_allows_data_in_query = None
+
         self._session = None
 
         self._base_functions_mapping = {
@@ -941,6 +955,26 @@ class ServerAPI(object):
     server_version = property(get_server_version)
     server_version_tuple = property(get_server_version_tuple)
 
+    @property
+    def graphql_allows_data_in_query(self):
+        """GraphlQl query can support 'data' field.
+
+        This applies only to project hierarchy entities 'project', 'folder',
+        'task', 'product', 'version' and 'representation'. Others like 'user'
+        still require to use rest api to access 'data'.
+
+        Returns:
+            bool: True if server supports 'data' field in GraphQl query.
+        """
+
+        if self._graphql_allows_data_in_query is None:
+            major, minor, patch, _, _ = self.server_version_tuple
+            graphql_allows_data_in_query = True
+            if (major, minor, patch) < (0, 5, 5):
+                graphql_allows_data_in_query = False
+            self._graphql_allows_data_in_query = graphql_allows_data_in_query
+        return self._graphql_allows_data_in_query
+
     def _get_user_info(self):
         if self._access_token is None:
             return None
@@ -1566,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.
@@ -1576,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
@@ -1604,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.
@@ -1639,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.
@@ -1660,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))
@@ -1883,31 +1984,45 @@ class ServerAPI(object):
             return set(DEFAULT_EVENT_FIELDS)
 
         if entity_type == "project":
-            entity_type_defaults = DEFAULT_PROJECT_FIELDS
+            entity_type_defaults = set(DEFAULT_PROJECT_FIELDS)
+            if not self.graphql_allows_data_in_query:
+                entity_type_defaults.discard("data")
 
         elif entity_type == "folder":
-            entity_type_defaults = DEFAULT_FOLDER_FIELDS
+            entity_type_defaults = set(DEFAULT_FOLDER_FIELDS)
+            if not self.graphql_allows_data_in_query:
+                entity_type_defaults.discard("data")
 
         elif entity_type == "task":
-            entity_type_defaults = DEFAULT_TASK_FIELDS
+            entity_type_defaults = set(DEFAULT_TASK_FIELDS)
+            if not self.graphql_allows_data_in_query:
+                entity_type_defaults.discard("data")
 
         elif entity_type == "product":
-            entity_type_defaults = DEFAULT_PRODUCT_FIELDS
+            entity_type_defaults = set(DEFAULT_PRODUCT_FIELDS)
+            if not self.graphql_allows_data_in_query:
+                entity_type_defaults.discard("data")
 
         elif entity_type == "version":
-            entity_type_defaults = DEFAULT_VERSION_FIELDS
+            entity_type_defaults = set(DEFAULT_VERSION_FIELDS)
+            if not self.graphql_allows_data_in_query:
+                entity_type_defaults.discard("data")
 
         elif entity_type == "representation":
             entity_type_defaults = (
                 DEFAULT_REPRESENTATION_FIELDS
                 | REPRESENTATION_FILES_FIELDS
             )
+            if not self.graphql_allows_data_in_query:
+                entity_type_defaults.discard("data")
 
         elif entity_type == "productType":
-            entity_type_defaults = DEFAULT_PRODUCT_TYPE_FIELDS
+            entity_type_defaults = set(DEFAULT_PRODUCT_TYPE_FIELDS)
 
         elif entity_type == "workfile":
-            entity_type_defaults = DEFAULT_WORKFILE_INFO_FIELDS
+            entity_type_defaults = set(DEFAULT_WORKFILE_INFO_FIELDS)
+            if not self.graphql_allows_data_in_query:
+                entity_type_defaults.discard("data")
 
         elif entity_type == "user":
             entity_type_defaults = set(DEFAULT_USER_FIELDS)
@@ -3659,7 +3774,7 @@ class ServerAPI(object):
                 fields |= self.get_attributes_fields_for_type("folder")
 
         use_rest = False
-        if "data" in fields:
+        if "data" in fields and not self.graphql_allows_data_in_query:
             use_rest = True
             fields = {"id"}
 
@@ -3680,6 +3795,8 @@ class ServerAPI(object):
 
                 if use_rest:
                     folder = self.get_rest_folder(project_name, folder["id"])
+                else:
+                    self._convert_entity_data(folder)
 
                 if own_attributes:
                     fill_own_attribs(folder)
@@ -3897,7 +4014,7 @@ class ServerAPI(object):
                 fields |= self.get_attributes_fields_for_type("task")
 
         use_rest = False
-        if "data" in fields:
+        if "data" in fields and not self.graphql_allows_data_in_query:
             use_rest = True
             fields = {"id"}
 
@@ -3918,6 +4035,8 @@ class ServerAPI(object):
 
                 if use_rest:
                     task = self.get_rest_task(project_name, task["id"])
+                else:
+                    self._convert_entity_data(task)
 
                 if own_attributes:
                     fill_own_attribs(task)
@@ -3998,6 +4117,8 @@ class ServerAPI(object):
 
         if use_rest:
             product = self.get_rest_product(project_name, product["id"])
+        else:
+            self._convert_entity_data(product)
 
         if own_attributes:
             fill_own_attribs(product)
@@ -4104,7 +4225,7 @@ class ServerAPI(object):
             fields = self.get_default_fields_for_type("product")
 
         use_rest = False
-        if "data" in fields:
+        if "data" in fields and not self.graphql_allows_data_in_query:
             use_rest = True
             fields = {"id"}
 
@@ -4372,7 +4493,7 @@ class ServerAPI(object):
         fields |= {"id", "version"}
 
         use_rest = False
-        if "data" in fields:
+        if "data" in fields and not self.graphql_allows_data_in_query:
             use_rest = True
             fields = {"id"}
 
@@ -4452,6 +4573,8 @@ class ServerAPI(object):
                         version = self.get_rest_version(
                             project_name, version["id"]
                         )
+                    else:
+                        self._convert_entity_data(version)
 
                     if own_attributes:
                         fill_own_attribs(version)
@@ -4667,7 +4790,7 @@ class ServerAPI(object):
             own_attributes=own_attributes
         )
         return {
-            version["parent"]: version
+            version["productId"]: version
             for version in versions
         }
 
@@ -4781,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,
@@ -4828,10 +4968,12 @@ 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:
+        if "data" in fields and not self.graphql_allows_data_in_query:
             use_rest = True
             fields = {"id"}
 
@@ -4894,13 +5036,10 @@ class ServerAPI(object):
                     repre = self.get_rest_representation(
                         project_name, repre["id"]
                     )
+                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)
@@ -5013,6 +5152,9 @@ class ServerAPI(object):
             version = repre.pop("version")
             product = version.pop("product")
             folder = product.pop("folder")
+            self._convert_entity_data(version)
+            self._convert_entity_data(product)
+            self._convert_entity_data(folder)
             output[repre_id] = RepresentationParents(
                 version, product, folder, project
             )
@@ -5465,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.
@@ -5495,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()
 
@@ -6323,3 +6461,13 @@ class ServerAPI(object):
                     op_result["detail"],
                 ))
         return op_results
+
+    def _convert_entity_data(self, entity):
+        if not entity:
+            return
+        entity_data = entity.get("data")
+        if (
+            entity_data is not None
+            and isinstance(entity_data, six.string_types)
+        ):
+            entity["data"] = json.loads(entity_data)

{ayon-python-api-0.5.2 → ayon-python-api-0.5.4}/ayon_api/utils.py

@@ -16,7 +16,11 @@ except ImportError:
 import requests
 import unidecode
 
-from .constants import SERVER_TIMEOUT_ENV_KEY
+from .constants import (
+    SERVER_TIMEOUT_ENV_KEY,
+    DEFAULT_VARIANT_ENV_KEY,
+    SITE_ID_ENV_KEY,
+)
 from .exceptions import UrlError
 
 REMOVED_VALUE = object()
@@ -46,6 +50,26 @@ def get_default_timeout():
     return 10.0
 
 
+def get_default_settings_variant():
+    """Default settings variant.
+
+    Returns:
+        str: Settings variant from environment variable or 'production'.
+    """
+
+    return os.environ.get(DEFAULT_VARIANT_ENV_KEY) or "production"
+
+
+def get_default_site_id():
+    """Site id used for server connection.
+
+    Returns:
+        Union[str, None]: Site id from environment variable or None.
+    """
+
+    return os.environ.get(SITE_ID_ENV_KEY)
+
+
 class ThumbnailContent:
     """Wrapper for thumbnail content.
 

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

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

{ayon-python-api-0.5.2 → 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.2
+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.2 → ayon-python-api-0.5.4}/pyproject.toml

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