Ayon-Python-Api 0.5.1__tar.gz → 0.5.3__tar.gz

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

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

{ayon-python-api-0.5.1 → ayon-python-api-0.5.3}/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.1 → ayon-python-api-0.5.3}/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.1 → ayon-python-api-0.5.3}/ayon_api/entity_hub.py

@@ -36,11 +36,20 @@ 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, 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
 
         self._project_name = project_name
         self._entities_by_id = {}
@@ -65,6 +74,18 @@ class EntityHub(object):
 
         return self._allow_data_changes
 
+    @property
+    def path_start_with_slash(self):
+        """Folder path should start with slash.
+
+        This changed in 0.6.x server version.
+
+        Returns:
+            bool: Path starts with slash.
+        """
+
+        return self._path_start_with_slash
+
     @property
     def project_name(self):
         """Project name which is maintained by hub.
@@ -2419,10 +2440,13 @@ class FolderEntity(BaseEntity):
 
         if self._path is None:
             parent = self.parent
-            path = self.name
             if parent.entity_type == "folder":
                 parent_path = parent.path
-                path = "/".join([parent_path, path])
+                path = "/".join([parent_path, self.name])
+            elif self._entity_hub.path_start_with_slash:
+                path = "/{}".format(self.name)
+            else:
+                path = self.name
             self._path = path
         return self._path
 

{ayon-python-api-0.5.1 → ayon-python-api-0.5.3}/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
@@ -176,6 +181,11 @@ class RestApiResponse(object):
         return self.status
 
     def raise_for_status(self, message=None):
+        if self._response is None:
+            if self._data and self._data.get("detail"):
+                raise ServerError(self._data["detail"])
+            raise ValueError("Response is not available.")
+
         try:
             self._response.raise_for_status()
         except requests.exceptions.HTTPError as exc:
@@ -358,7 +368,7 @@ class ServerAPI(object):
         self,
         base_url,
         token=None,
-        site_id=None,
+        site_id=_PLACEHOLDER,
         client_version=None,
         default_settings_variant=None,
         sender=None,
@@ -377,11 +387,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
 
@@ -411,6 +424,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 = {
@@ -936,6 +951,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
@@ -1512,8 +1547,9 @@ class ServerAPI(object):
             "sourceTopic": source_topic,
             "targetTopic": target_topic,
             "sender": sender,
-            "maxRetries": max_retries,
         }
+        if max_retries is not None:
+            kwargs["maxRetries"] = max_retries
         if sequential is not None:
             kwargs["sequential"] = sequential
         if description is not None:
@@ -1877,31 +1913,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)
@@ -3653,7 +3703,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"}
 
@@ -3674,6 +3724,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)
@@ -3891,7 +3943,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"}
 
@@ -3912,6 +3964,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)
@@ -3992,6 +4046,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)
@@ -4098,7 +4154,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"}
 
@@ -4366,7 +4422,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"}
 
@@ -4446,6 +4502,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)
@@ -4825,7 +4883,7 @@ class ServerAPI(object):
                 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"}
 
@@ -4888,6 +4946,8 @@ 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"]
@@ -5007,6 +5067,10 @@ 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)
             output[repre_id] = RepresentationParents(
                 version, product, folder, project
             )
@@ -6317,3 +6381,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.1 → ayon-python-api-0.5.3}/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.1 → ayon-python-api-0.5.3}/ayon_api/version.py

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

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

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

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

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