Ayon-Python-Api 1.0.12__tar.gz → 1.1.1__tar.gz

{ayon-python-api-1.0.12 → ayon-python-api-1.1.1}/PKG-INFO

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

{ayon-python-api-1.0.12 → ayon-python-api-1.1.1}/ayon_api/__init__.py

@@ -214,6 +214,7 @@ from ._api import (
     get_thumbnail_by_id,
     get_thumbnail,
     get_folder_thumbnail,
+    get_task_thumbnail,
     get_version_thumbnail,
     get_workfile_thumbnail,
     create_thumbnail,
@@ -459,6 +460,7 @@ __all__ = (
     "get_thumbnail_by_id",
     "get_thumbnail",
     "get_folder_thumbnail",
+    "get_task_thumbnail",
     "get_version_thumbnail",
     "get_workfile_thumbnail",
     "create_thumbnail",

{ayon-python-api-1.0.12 → ayon-python-api-1.1.1}/ayon_api/_api.py

@@ -706,6 +706,7 @@ def get_server_version_tuple() -> Tuple[int, int, int, str, str]:
 def get_users(
     project_name: Optional[str] = None,
     usernames: Optional[Iterable[str]] = None,
+    emails: Optional[Iterable[str]] = None,
     fields: Optional[Iterable[str]] = None,
 ) -> Generator[Dict[str, Any], None, None]:
     """Get Users.
@@ -716,6 +717,7 @@ def get_users(
     Args:
         project_name (Optional[str]): Project name.
         usernames (Optional[Iterable[str]]): Filter by usernames.
+        emails (Optional[Iterable[str]]): Filter by emails.
         fields (Optional[Iterable[str]]): Fields to be queried
             for users.
 
@@ -727,6 +729,7 @@ def get_users(
     return con.get_users(
         project_name=project_name,
         usernames=usernames,
+        emails=emails,
         fields=fields,
     )
 
@@ -5472,6 +5475,7 @@ def create_representation(
     files: Optional[List[Dict[str, Any]]] = None,
     attrib: Optional[Dict[str, Any]] = None,
     data: Optional[Dict[str, Any]] = None,
+    traits: Optional[Dict[str, Any]] = None,
     tags: Optional[List[str]] = None,
     status: Optional[str] = None,
     active: Optional[bool] = None,
@@ -5486,6 +5490,8 @@ def create_representation(
         files (Optional[list[dict]]): Representation files information.
         attrib (Optional[dict[str, Any]]): Representation attributes.
         data (Optional[dict[str, Any]]): Representation data.
+        traits (Optional[dict[str, Any]]): Representation traits
+            serialized data as dict.
         tags (Optional[Iterable[str]]): Representation tags.
         status (Optional[str]): Representation status.
         active (Optional[bool]): Representation active state.
@@ -5504,6 +5510,7 @@ def create_representation(
         files=files,
         attrib=attrib,
         data=data,
+        traits=traits,
         tags=tags,
         status=status,
         active=active,
@@ -5519,6 +5526,7 @@ def update_representation(
     files: Optional[List[Dict[str, Any]]] = None,
     attrib: Optional[Dict[str, Any]] = None,
     data: Optional[Dict[str, Any]] = None,
+    traits: Optional[Dict[str, Any]] = None,
     tags: Optional[List[str]] = None,
     status: Optional[str] = None,
     active: Optional[bool] = None,
@@ -5539,6 +5547,7 @@ def update_representation(
             information.
         attrib (Optional[dict[str, Any]]): New attributes.
         data (Optional[dict[str, Any]]): New data.
+        traits (Optional[dict[str, Any]]): New traits.
         tags (Optional[Iterable[str]]): New tags.
         status (Optional[str]): New status.
         active (Optional[bool]): New active state.
@@ -5553,6 +5562,7 @@ def update_representation(
         files=files,
         attrib=attrib,
         data=data,
+        traits=traits,
         tags=tags,
         status=status,
         active=active,
@@ -5698,9 +5708,10 @@ def get_thumbnail_by_id(
 ) -> ThumbnailContent:
     """Get thumbnail from server by id.
 
-    Permissions of thumbnails are related to entities so thumbnails must
-    be queried per entity. So an entity type and entity type is required
-    to be passed.
+    Warnings:
+        Please keep in mind that used endpoint is allowed only for admins
+            and managers. Use 'get_thumbnail' with entity type and id
+            to allow access for artists.
 
     Notes:
         It is recommended to use one of prepared entity type specific
@@ -5736,7 +5747,7 @@ def get_thumbnail(
     """Get thumbnail from server.
 
     Permissions of thumbnails are related to entities so thumbnails must
-    be queried per entity. So an entity type and entity type is required
+    be queried per entity. So an entity type and entity id is required
     to be passed.
 
     Notes:
@@ -5794,6 +5805,28 @@ def get_folder_thumbnail(
     )
 
 
+def get_task_thumbnail(
+    project_name: str,
+    task_id: str,
+) -> ThumbnailContent:
+    """Prepared method to receive thumbnail for task entity.
+
+    Args:
+        project_name (str): Project under which the entity is located.
+        task_id (str): Folder id for which thumbnail should be returned.
+
+    Returns:
+        ThumbnailContent: Thumbnail content wrapper. Does not have to be
+            valid.
+
+    """
+    con = get_server_api_connection()
+    return con.get_task_thumbnail(
+        project_name=project_name,
+        task_id=task_id,
+    )
+
+
 def get_version_thumbnail(
     project_name: str,
     version_id: str,

{ayon-python-api-1.0.12 → ayon-python-api-1.1.1}/ayon_api/constants.py

@@ -131,6 +131,7 @@ DEFAULT_REPRESENTATION_FIELDS = {
     "data",
     "status",
     "tags",
+    "traits",
 }
 
 REPRESENTATION_FILES_FIELDS = {

{ayon-python-api-1.0.12 → ayon-python-api-1.1.1}/ayon_api/entity_hub.py

@@ -49,66 +49,22 @@ class EntityHub(object):
     Args:
         project_name (str): Name of project where changes will happen.
         connection (ServerAPI): Connection to server with logged user.
-        allow_data_changes (bool): This option gives ability to change 'data'
-            key on entities. This is not recommended as 'data' may be used for
-            secure information and would also slow down server queries. Content
-            of 'data' key can't be received only GraphQl.
 
     """
 
-    def __init__(
-        self, project_name, connection=None, allow_data_changes=None
-    ):
+    def __init__(self, project_name, connection=None):
         if not connection:
             connection = get_server_api_connection()
-        major, minor, _, _, _ = 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 = {}
         self._entities_by_parent_id = collections.defaultdict(list)
         self._project_entity = UNKNOWN_VALUE
 
-        self._allow_data_changes = allow_data_changes
-
         self._path_reset_queue = None
 
-    @property
-    def allow_data_changes(self):
-        """Entity hub allows changes of 'data' key on entities.
-
-        Data are private and not all users may have access to them.
-
-        Older version of AYON server allowed to get 'data' for entity only
-        using REST api calls, which means to query each entity on-by-one
-        from server.
-
-        Returns:
-            bool: Data changes are allowed.
-
-        """
-        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.
@@ -898,8 +854,7 @@ class EntityHub(object):
             self._connection.get_default_fields_for_type("folder")
         )
         folder_fields.add("hasProducts")
-        if self._allow_data_changes:
-            folder_fields.add("data")
+        folder_fields.add("data")
         return folder_fields
 
     def _get_task_fields(self) -> Set[str]:
@@ -1717,10 +1672,7 @@ class BaseEntity(ABC):
 
         """
         changes = {}
-        if (
-            self._entity_hub.allow_data_changes
-            and self._data is not UNKNOWN_VALUE
-        ):
+        if self._data is not UNKNOWN_VALUE:
             data_changes = self._data.get_changes()
             if data_changes:
                 changes["data"] = data_changes
@@ -3149,10 +3101,8 @@ class FolderEntity(BaseEntity):
             if parent.entity_type == "folder":
                 parent_path = parent.path
                 path = "/".join([parent_path, self.name])
-            elif self._entity_hub.path_start_with_slash:
-                path = "/{}".format(self.name)
             else:
-                path = self.name
+                path = "/{}".format(self.name)
             self._path = path
         return self._path
 
@@ -3260,10 +3210,7 @@ class FolderEntity(BaseEntity):
         if self.thumbnail_id is not UNKNOWN_VALUE:
             output["thumbnailId"] = self.thumbnail_id
 
-        if (
-            self._entity_hub.allow_data_changes
-            and self._data is not UNKNOWN_VALUE
-        ):
+        if self._data is not UNKNOWN_VALUE:
             output["data"] = self._data.get_new_entity_value()
         return output
 
@@ -3451,10 +3398,7 @@ class TaskEntity(BaseEntity):
         if self.assignees:
             output["assignees"] = self.assignees
 
-        if (
-            self._entity_hub.allow_data_changes
-            and self._data is not UNKNOWN_VALUE
-        ):
+        if self._data is not UNKNOWN_VALUE:
             output["data"] = self._data.get_new_entity_value()
         return output
 
@@ -3561,10 +3505,7 @@ class ProductEntity(BaseEntity):
         if self.tags:
             output["tags"] = self.tags
 
-        if (
-            self._entity_hub.allow_data_changes
-            and self._data is not UNKNOWN_VALUE
-        ):
+        if self._data is not UNKNOWN_VALUE:
             output["data"] = self._data.get_new_entity_value()
         return output
 
@@ -3693,9 +3634,6 @@ class VersionEntity(BaseEntity):
         if self.status:
             output["status"] = self.status
 
-        if (
-            self._entity_hub.allow_data_changes
-            and self._data is not UNKNOWN_VALUE
-        ):
+        if self._data is not UNKNOWN_VALUE:
             output["data"] = self._data.get_new_entity_value()
         return output

{ayon-python-api-1.0.12 → ayon-python-api-1.1.1}/ayon_api/graphql_queries.py

@@ -341,6 +341,7 @@ def versions_graphql_query(fields):
     project_name_var = query.add_variable("projectName", "String!")
     product_ids_var = query.add_variable("productIds", "[String!]")
     version_ids_var = query.add_variable("versionIds", "[String!]")
+    task_ids_var = query.add_variable("taskIds", "[String!]")
     versions_var = query.add_variable("versions", "[Int!]")
     hero_only_var = query.add_variable("heroOnly", "Boolean")
     latest_only_var = query.add_variable("latestOnly", "Boolean")
@@ -357,6 +358,7 @@ def versions_graphql_query(fields):
     versions_field.set_filter("ids", version_ids_var)
     versions_field.set_filter("productIds", product_ids_var)
     versions_field.set_filter("versions", versions_var)
+    versions_field.set_filter("taskIds", task_ids_var)
     versions_field.set_filter("heroOnly", hero_only_var)
     versions_field.set_filter("latestOnly", latest_only_var)
     versions_field.set_filter("heroOrLatestOnly", hero_or_latest_only_var)
@@ -617,10 +619,12 @@ def events_graphql_query(fields, order, use_states=False):
 def users_graphql_query(fields):
     query = GraphQlQuery("Users")
     names_var = query.add_variable("userNames", "[String!]")
+    emails_var = query.add_variable("emails", "[String!]")
     project_name_var = query.add_variable("projectName", "String!")
 
     users_field = query.add_field_with_edges("users")
     users_field.set_filter("names", names_var)
+    users_field.set_filter("emails", emails_var)
     users_field.set_filter("projectName", project_name_var)
 
     nested_fields = fields_to_dict(set(fields))

{ayon-python-api-1.0.12 → ayon-python-api-1.1.1}/ayon_api/operations.py

@@ -276,7 +276,8 @@ def new_representation_entity(
     tags=None,
     attribs=None,
     data=None,
-    entity_id=None
+    traits=None,
+    entity_id=None,
 ):
     """Create skeleton data of representation entity.
 
@@ -290,6 +291,8 @@ def new_representation_entity(
         attribs (Optional[Dict[str, Any]]): Explicitly set attributes
             of representation.
         data (Optional[Dict[str, Any]]): Representation entity data.
+        traits (Optional[Dict[str, Any]]): Representation traits. Empty
+            if not passed.
         entity_id (Optional[str]): Predefined id of entity. New id is created
             if not passed.
 
@@ -309,8 +312,10 @@ def new_representation_entity(
         "files": files,
         "name": name,
         "data": data,
-        "attrib": attribs
+        "attrib": attribs,
     }
+    if traits:
+        output["traits"] = traits
     if tags:
         output["tags"] = tags
     if status:
@@ -1188,7 +1193,10 @@ class OperationsSession(object):
                 update_data[key] = value
 
         return self.update_entity(
-            project_name, "product", update_data
+            project_name,
+            "product",
+            product_id,
+            update_data
         )
 
     def delete_product(self, project_name, product_id):
@@ -1356,6 +1364,7 @@ class OperationsSession(object):
         files=None,
         attrib=None,
         data=None,
+        traits=None,
         tags=None,
         status=None,
         active=None,
@@ -1370,6 +1379,8 @@ class OperationsSession(object):
             files (Optional[list[dict]]): Representation files information.
             attrib (Optional[dict[str, Any]]): Representation attributes.
             data (Optional[dict[str, Any]]): Representation data.
+            traits (Optional[Dict[str, Any]]): Representation traits. Empty
+                if not passed.
             tags (Optional[Iterable[str]]): Representation tags.
             status (Optional[str]): Representation status.
             active (Optional[bool]): Representation active state.
@@ -1391,6 +1402,7 @@ class OperationsSession(object):
             ("files", files),
             ("attrib", attrib),
             ("data", data),
+            ("traits", traits),
             ("tags", tags),
             ("status", status),
             ("active", active),
@@ -1413,6 +1425,7 @@ class OperationsSession(object):
         files=None,
         attrib=None,
         data=None,
+        traits=None,
         tags=None,
         status=None,
         active=None,
@@ -1433,6 +1446,7 @@ class OperationsSession(object):
                 information.
             attrib (Optional[dict[str, Any]]): New attributes.
             data (Optional[dict[str, Any]]): New data.
+            traits (Optional[Dict[str, Any]]): New representation traits.
             tags (Optional[Iterable[str]]): New tags.
             status (Optional[str]): New status.
             active (Optional[bool]): New active state.
@@ -1448,6 +1462,7 @@ class OperationsSession(object):
             ("files", files),
             ("attrib", attrib),
             ("data", data),
+            ("traits", traits),
             ("tags", tags),
             ("status", status),
             ("active", active),
@@ -1456,7 +1471,10 @@ class OperationsSession(object):
                 update_data[key] = value
 
         return self.update_entity(
-            project_name, "representation", update_data
+            project_name,
+            "representation",
+            representation_id,
+            update_data
         )
 
     def delete_representation(self, project_name, representation_id):

{ayon-python-api-1.0.12 → ayon-python-api-1.1.1}/ayon_api/server_api.py

@@ -52,7 +52,6 @@ from .constants import (
     DEFAULT_EVENT_FIELDS,
     DEFAULT_ACTIVITY_FIELDS,
     DEFAULT_USER_FIELDS,
-    DEFAULT_LINK_FIELDS,
 )
 from .graphql import GraphQlQuery, INTROSPECTION_QUERY
 from .graphql_queries import (
@@ -520,7 +519,7 @@ class ServerAPI(object):
         self._server_version = None
         self._server_version_tuple = None
 
-        self._graphql_allows_data_in_query = None
+        self._graphql_allows_traits_in_representations: Optional[bool] = None
 
         self._session = None
 
@@ -1097,24 +1096,15 @@ class ServerAPI(object):
     )
 
     @property
-    def graphql_allows_data_in_query(self) -> bool:
-        """GraphQl 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:
+    def graphql_allows_traits_in_representations(self) -> bool:
+        """Check server support for representation traits."""
+        if self._graphql_allows_traits_in_representations 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
+            self._graphql_allows_traits_in_representations = (
+                (major, minor, patch) >= (1, 7, 5)
+            )
+        return self._graphql_allows_traits_in_representations
+
 
     def _get_user_info(self) -> Optional[Dict[str, Any]]:
         if self._access_token is None:
@@ -1143,6 +1133,7 @@ class ServerAPI(object):
         self,
         project_name: Optional[str] = None,
         usernames: Optional[Iterable[str]] = None,
+        emails: Optional[Iterable[str]] = None,
         fields: Optional[Iterable[str]] = None,
     ) -> Generator[Dict[str, Any], None, None]:
         """Get Users.
@@ -1153,6 +1144,7 @@ class ServerAPI(object):
         Args:
             project_name (Optional[str]): Project name.
             usernames (Optional[Iterable[str]]): Filter by usernames.
+            emails (Optional[Iterable[str]]): Filter by emails.
             fields (Optional[Iterable[str]]): Fields to be queried
                 for users.
 
@@ -1167,6 +1159,22 @@ class ServerAPI(object):
                 return
             filters["userNames"] = list(usernames)
 
+        if emails is not None:
+            emails = set(emails)
+            if not emails:
+                return
+
+            major, minor, patch, _, _ = self.server_version_tuple
+            emails_filter_available = (major, minor, patch) > (1, 7, 3)
+            if not emails_filter_available:
+                server_version = self.get_server_version()
+                raise ValueError(
+                    "Filtering by emails is not supported by"
+                    f" server version {server_version}."
+                )
+
+            filters["emails"] = list(emails)
+
         if project_name is not None:
             filters["projectName"] = project_name
 
@@ -1249,6 +1257,7 @@ class ServerAPI(object):
             "Content-Type": content_type,
             "x-ayon-platform": platform.system().lower(),
             "x-ayon-hostname": platform.node(),
+            "referer": self.get_base_url(),
         }
         if self._site_id is not None:
             headers["x-ayon-site-id"] = self._site_id
@@ -1656,21 +1665,6 @@ class ServerAPI(object):
             )
             if value is not None
         }
-        # 'progress' and 'retries' are available since 0.5.x server version
-        major, minor, _, _, _ = self.server_version_tuple
-        if (major, minor) < (0, 5):
-            args = []
-            if progress is not None:
-                args.append("progress")
-            if retries is not None:
-                args.append("retries")
-            fields = ", ".join(f"'{f}'" for f in args)
-            ending = "s" if len(args) > 1 else ""
-            raise ValueError(
-                 f"Your server version '{self.server_version}' does not"
-                 f" support update of {fields} field{ending} on event."
-                 " The fields are supported since server version '0.5'."
-            )
 
         response = self.patch(
             f"events/{event_id}",
@@ -2730,36 +2724,27 @@ class ServerAPI(object):
 
         if entity_type == "project":
             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 = set(DEFAULT_FOLDER_FIELDS)
-            if not self.graphql_allows_data_in_query:
-                entity_type_defaults.discard("data")
 
         elif entity_type == "task":
             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 = set(DEFAULT_PRODUCT_FIELDS)
-            if not self.graphql_allows_data_in_query:
-                entity_type_defaults.discard("data")
 
         elif entity_type == "version":
             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")
+
+            if not self.graphql_allows_traits_in_representations:
+                entity_type_defaults.discard("traits")
 
         elif entity_type == "folderType":
             entity_type_defaults = set(DEFAULT_FOLDER_TYPE_FIELDS)
@@ -2772,8 +2757,6 @@ class ServerAPI(object):
 
         elif entity_type == "workfile":
             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)
@@ -4646,10 +4629,14 @@ class ServerAPI(object):
             return
 
         self._prepare_fields("project", fields, own_attributes)
+        if active is not None:
+            fields.add("active")
 
         query = projects_graphql_query(fields)
         for parsed_data in query.continuous_query(self):
             for project in parsed_data["projects"]:
+                if active is not None and active is not project["active"]:
+                    continue
                 if own_attributes:
                     fill_own_attribs(project)
                 yield project
@@ -4930,15 +4917,10 @@ class ServerAPI(object):
             fields = set(fields)
             self._prepare_fields("folder", fields)
 
-        use_rest = False
-        if "data" in fields and not self.graphql_allows_data_in_query:
-            use_rest = True
-            fields = {"id"}
-
         if active is not None:
             fields.add("active")
 
-        if own_attributes and not use_rest:
+        if own_attributes:
             fields.add("ownAttrib")
 
         query = folders_graphql_query(fields)
@@ -4950,10 +4932,7 @@ class ServerAPI(object):
                 if active is not None and active is not folder["active"]:
                     continue
 
-                if use_rest:
-                    folder = self.get_rest_folder(project_name, folder["id"])
-                else:
-                    self._convert_entity_data(folder)
+                self._convert_entity_data(folder)
 
                 if own_attributes:
                     fill_own_attribs(folder)
@@ -5325,11 +5304,6 @@ class ServerAPI(object):
             fields = set(fields)
             self._prepare_fields("task", fields, own_attributes)
 
-        use_rest = False
-        if "data" in fields and not self.graphql_allows_data_in_query:
-            use_rest = True
-            fields = {"id"}
-
         if active is not None:
             fields.add("active")
 
@@ -5342,10 +5316,7 @@ class ServerAPI(object):
                 if active is not None and active is not task["active"]:
                     continue
 
-                if use_rest:
-                    task = self.get_rest_task(project_name, task["id"])
-                else:
-                    self._convert_entity_data(task)
+                self._convert_entity_data(task)
 
                 if own_attributes:
                     fill_own_attribs(task)
@@ -5487,11 +5458,6 @@ class ServerAPI(object):
             fields = set(fields)
             self._prepare_fields("task", fields, own_attributes)
 
-        use_rest = False
-        if "data" in fields and not self.graphql_allows_data_in_query:
-            use_rest = True
-            fields = {"id"}
-
         if active is not None:
             fields.add("active")
 
@@ -5510,10 +5476,7 @@ class ServerAPI(object):
                     if active is not None and active is not task["active"]:
                         continue
 
-                    if use_rest:
-                        task = self.get_rest_task(project_name, task["id"])
-                    else:
-                        self._convert_entity_data(task)
+                    self._convert_entity_data(task)
 
                     if own_attributes:
                         fill_own_attribs(task)
@@ -5763,15 +5726,11 @@ class ServerAPI(object):
         project_name: str,
         product: "ProductDict",
         active: "Union[bool, None]",
-        use_rest: bool,
     ) -> Optional["ProductDict"]:
         if active is not None and product["active"] is not active:
             return None
 
-        if use_rest:
-            product = self.get_rest_product(project_name, product["id"])
-        else:
-            self._convert_entity_data(product)
+        self._convert_entity_data(product)
 
         return product
 
@@ -5864,11 +5823,6 @@ class ServerAPI(object):
         else:
             fields = self.get_default_fields_for_type("product")
 
-        use_rest = False
-        if "data" in fields and not self.graphql_allows_data_in_query:
-            use_rest = True
-            fields = {"id"}
-
         if active is not None:
             fields.add("active")
 
@@ -5926,7 +5880,7 @@ class ServerAPI(object):
             products_by_folder_id = collections.defaultdict(list)
             for product in products:
                 filtered_product = self._filter_product(
-                    project_name, product, active, use_rest
+                    project_name, product, active
                 )
                 if filtered_product is not None:
                     folder_id = filtered_product["folderId"]
@@ -5940,7 +5894,7 @@ class ServerAPI(object):
         else:
             for product in products:
                 filtered_product = self._filter_product(
-                    project_name, product, active, use_rest
+                    project_name, product, active
                 )
                 if filtered_product is not None:
                     yield filtered_product
@@ -6287,11 +6241,6 @@ class ServerAPI(object):
         # Make sure fields have minimum required fields
         fields |= {"id", "version"}
 
-        use_rest = False
-        if "data" in fields and not self.graphql_allows_data_in_query:
-            use_rest = True
-            fields = {"id"}
-
         if active is not None:
             fields.add("active")
 
@@ -6364,12 +6313,7 @@ class ServerAPI(object):
                     if not hero and version["version"] < 0:
                         continue
 
-                    if use_rest:
-                        version = self.get_rest_version(
-                            project_name, version["id"]
-                        )
-                    else:
-                        self._convert_entity_data(version)
+                    self._convert_entity_data(version)
 
                     yield version
 
@@ -6931,11 +6875,6 @@ class ServerAPI(object):
             fields = set(fields)
             self._prepare_fields("representation", fields)
 
-        use_rest = False
-        if "data" in fields and not self.graphql_allows_data_in_query:
-            use_rest = True
-            fields = {"id"}
-
         if active is not None:
             fields.add("active")
 
@@ -7017,12 +6956,7 @@ class ServerAPI(object):
                 if active is not None and active is not repre["active"]:
                     continue
 
-                if use_rest:
-                    repre = self.get_rest_representation(
-                        project_name, repre["id"]
-                    )
-                else:
-                    self._convert_entity_data(repre)
+                self._convert_entity_data(repre)
 
                 self._representation_conversion(repre)
 
@@ -7452,6 +7386,7 @@ class ServerAPI(object):
         files: Optional[List[Dict[str, Any]]] = None,
         attrib: Optional[Dict[str, Any]] = None,
         data: Optional[Dict[str, Any]] = None,
+        traits: Optional[Dict[str, Any]] = None,
         tags: Optional[List[str]]=None,
         status: Optional[str] = None,
         active: Optional[bool] = None,
@@ -7466,6 +7401,8 @@ class ServerAPI(object):
             files (Optional[list[dict]]): Representation files information.
             attrib (Optional[dict[str, Any]]): Representation attributes.
             data (Optional[dict[str, Any]]): Representation data.
+            traits (Optional[dict[str, Any]]): Representation traits
+                serialized data as dict.
             tags (Optional[Iterable[str]]): Representation tags.
             status (Optional[str]): Representation status.
             active (Optional[bool]): Representation active state.
@@ -7487,6 +7424,7 @@ class ServerAPI(object):
             ("files", files),
             ("attrib", attrib),
             ("data", data),
+            ("traits", traits),
             ("tags", tags),
             ("status", status),
             ("active", active),
@@ -7510,6 +7448,7 @@ class ServerAPI(object):
         files: Optional[List[Dict[str, Any]]] = None,
         attrib: Optional[Dict[str, Any]] = None,
         data: Optional[Dict[str, Any]] = None,
+        traits: Optional[Dict[str, Any]] = None,
         tags: Optional[List[str]] = None,
         status: Optional[str] = None,
         active: Optional[bool] = None,
@@ -7530,6 +7469,7 @@ class ServerAPI(object):
                 information.
             attrib (Optional[dict[str, Any]]): New attributes.
             data (Optional[dict[str, Any]]): New data.
+            traits (Optional[dict[str, Any]]): New traits.
             tags (Optional[Iterable[str]]): New tags.
             status (Optional[str]): New status.
             active (Optional[bool]): New active state.
@@ -7542,6 +7482,7 @@ class ServerAPI(object):
             ("files", files),
             ("attrib", attrib),
             ("data", data),
+            ("traits", traits),
             ("tags", tags),
             ("status", status),
             ("active", active),
@@ -7765,9 +7706,10 @@ class ServerAPI(object):
     ) -> ThumbnailContent:
         """Get thumbnail from server by id.
 
-        Permissions of thumbnails are related to entities so thumbnails must
-        be queried per entity. So an entity type and entity type is required
-        to be passed.
+        Warnings:
+            Please keep in mind that used endpoint is allowed only for admins
+                and managers. Use 'get_thumbnail' with entity type and id
+                to allow access for artists.
 
         Notes:
             It is recommended to use one of prepared entity type specific
@@ -7802,7 +7744,7 @@ class ServerAPI(object):
         """Get thumbnail from server.
 
         Permissions of thumbnails are related to entities so thumbnails must
-        be queried per entity. So an entity type and entity type is required
+        be queried per entity. So an entity type and entity id is required
         to be passed.
 
         Notes:
@@ -7826,10 +7768,17 @@ class ServerAPI(object):
 
         """
         if thumbnail_id:
-            return self.get_thumbnail_by_id(project_name, thumbnail_id)
+            warnings.warn(
+                (
+                    "Function 'get_thumbnail' got 'thumbnail_id' which"
+                    " is deprecated and will be removed in future version."
+                ),
+                DeprecationWarning
+            )
 
         if entity_type in (
             "folder",
+            "task",
             "version",
             "workfile",
         ):
@@ -7859,10 +7808,36 @@ class ServerAPI(object):
                 valid.
 
         """
+        if thumbnail_id:
+            warnings.warn(
+                (
+                    "Function 'get_folder_thumbnail' got 'thumbnail_id' which"
+                    " is deprecated and will be removed in future version."
+                ),
+                DeprecationWarning
+            )
         return self.get_thumbnail(
-            project_name, "folder", folder_id, thumbnail_id
+            project_name, "folder", folder_id
         )
 
+    def get_task_thumbnail(
+        self,
+        project_name: str,
+        task_id: str,
+    ) -> ThumbnailContent:
+        """Prepared method to receive thumbnail for task entity.
+
+        Args:
+            project_name (str): Project under which the entity is located.
+            task_id (str): Folder id for which thumbnail should be returned.
+
+        Returns:
+            ThumbnailContent: Thumbnail content wrapper. Does not have to be
+                valid.
+
+        """
+        return self.get_thumbnail(project_name, "task", task_id)
+
     def get_version_thumbnail(
         self,
         project_name: str,
@@ -7883,8 +7858,16 @@ class ServerAPI(object):
                 valid.
 
         """
+        if thumbnail_id:
+            warnings.warn(
+                (
+                    "Function 'get_version_thumbnail' got 'thumbnail_id' which"
+                    " is deprecated and will be removed in future version."
+                ),
+                DeprecationWarning
+            )
         return self.get_thumbnail(
-            project_name, "version", version_id, thumbnail_id
+            project_name, "version", version_id
         )
 
     def get_workfile_thumbnail(
@@ -7907,8 +7890,17 @@ class ServerAPI(object):
                 valid.
 
         """
+        if thumbnail_id:
+            warnings.warn(
+                (
+                    "Function 'get_workfile_thumbnail' got 'thumbnail_id'"
+                    " which is deprecated and will be removed in future"
+                    " version."
+                ),
+                DeprecationWarning
+            )
         return self.get_thumbnail(
-            project_name, "workfile", workfile_id, thumbnail_id
+            project_name, "workfile", workfile_id
         )
 
     def create_thumbnail(
@@ -8345,22 +8337,8 @@ class ServerAPI(object):
         kwargs = {
             "input": input_id,
             "output": output_id,
+            "linkType": full_link_type_name,
         }
-        major, minor, patch, rel, _ = self.server_version_tuple
-        rel_regex = re.compile(r"rc\.[0-5]")
-        if (
-            ((major, minor, patch) == (1, 0, 0) and rel_regex.match(rel))
-            or (major, minor, patch) < (1, 0, 0)
-        ):
-            kwargs["link"] = full_link_type_name
-            if link_name:
-                raise UnsupportedServerVersion(
-                    "Link name is not supported"
-                    f" for version of AYON server {self.server_version}"
-                )
-        else:
-            kwargs["linkType"] = full_link_type_name
-
         if link_name:
             kwargs["name"] = link_name
 
@@ -8522,23 +8500,6 @@ class ServerAPI(object):
             return output
 
         link_fields = {"id", "links"}
-        # Backwards compatibility for server version 1.0.0-rc.5 and lower
-        # ---------
-        major, minor, patch, rel, _ = self.server_version_tuple
-        rel_regex = re.compile(r"rc\.[0-5]")
-        if (
-            ((major, minor, patch) == (1, 0, 0) and rel_regex.match(rel))
-            or (major, minor, patch) < (1, 0, 0)
-        ):
-            fields = set(DEFAULT_LINK_FIELDS)
-            fields.discard("name")
-            link_fields.discard("links")
-            link_fields |= {
-                f"links.{field}"
-                for field in fields
-            }
-        # ---------
-
         query = query_func(link_fields)
         for attr, filter_value in filters.items():
             query.set_variable_value(attr, filter_value)

{ayon-python-api-1.0.12 → ayon-python-api-1.1.1}/ayon_api/utils.py

@@ -4,6 +4,7 @@ import datetime
 import uuid
 import string
 import platform
+import traceback
 import collections
 from urllib.parse import urlparse, urlencode
 import typing
@@ -322,18 +323,38 @@ def _try_parse_url(url: str) -> Optional[str]:
 
 
 def _try_connect_to_server(
-    url: str, timeout: Optional[float] = None
-) -> bool:
+    url: str,
+    timeout: Optional[float],
+    verify: Optional["Union[str, bool]"],
+    cert: Optional[str],
+) -> Optional[str]:
     if timeout is None:
         timeout = get_default_timeout()
+
+    if verify is None:
+        verify = os.environ.get("AYON_CA_FILE") or True
+
+    if cert is None:
+        cert = os.environ.get("AYON_CERT_FILE") or None
+
     try:
         # TODO add validation if the url lead to AYON server
         #   - this won't validate if the url lead to 'google.com'
-        requests.get(url, timeout=timeout)
+        response = requests.get(
+            url,
+            timeout=timeout,
+            verify=verify,
+            cert=cert,
+        )
+        if response.history:
+            return response.history[-1].headers["location"].rstrip("/")
+        return url
 
-    except BaseException:
-        return False
-    return True
+    except Exception:
+        print(f"Failed to connect to '{url}'")
+        traceback.print_exc()
+
+    return None
 
 
 def login_to_server(
@@ -463,7 +484,12 @@ def is_token_valid(
     return False
 
 
-def validate_url(url: str, timeout: Optional[int] = None) -> str:
+def validate_url(
+    url: str,
+    timeout: Optional[int] = None,
+    verify: Optional["Union[str, bool]"] = None,
+    cert: Optional[str] = None,
+) -> str:
     """Validate url if is valid and server is available.
 
     Validation checks if can be parsed as url and contains scheme.
@@ -520,12 +546,23 @@ def validate_url(url: str, timeout: Optional[int] = None) -> str:
     # Try add 'https://' scheme if is missing
     # - this will trigger UrlError if both will crash
     if not parsed_url.scheme:
-        new_url = "https://" + modified_url
-        if _try_connect_to_server(new_url, timeout=timeout):
+        new_url = _try_connect_to_server(
+            "http://" + modified_url,
+            timeout=timeout,
+            verify=verify,
+            cert=cert,
+        )
+        if new_url:
             return new_url
 
-    if _try_connect_to_server(modified_url, timeout=timeout):
-        return modified_url
+    new_url = _try_connect_to_server(
+        modified_url,
+        timeout=timeout,
+        verify=verify,
+        cert=cert,
+    )
+    if new_url:
+        return new_url
 
     hints = []
     if "/" in parsed_url.path or not parsed_url.scheme:
@@ -855,11 +892,13 @@ def _get_media_mime_type_for_content_base(content: bytes) -> Optional[str]:
     if content[0:4] == b"\211PNG":
         return "image/png"
 
-    # JPEG, JFIF or Exif
-    if (
-        content[0:4] == b"\xff\xd8\xff\xdb"
-        or content[6:10] in (b"JFIF", b"Exif")
-    ):
+    # JPEG
+    # - [0:2] is constant b"\xff\xd8"
+    #   (ref. https://www.file-recovery.com/jpg-signature-format.htm)
+    # - [2:4] Marker identifier b"\xff{?}"
+    #   (ref. https://www.disktuna.com/list-of-jpeg-markers/)
+    # NOTE: File ends with b"\xff\xd9"
+    if content[0:3] == b"\xff\xd8\xff":
         return "image/jpeg"
 
     # Webp

{ayon-python-api-1.0.12 → ayon-python-api-1.1.1}/ayon_api/version.py

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

{ayon-python-api-1.0.12 → ayon-python-api-1.1.1}/ayon_python_api.egg-info/PKG-INFO

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

{ayon-python-api-1.0.12 → ayon-python-api-1.1.1}/ayon_python_api.egg-info/requires.txt

@@ -1,3 +1,2 @@
 requests>=2.27.1
 Unidecode>=1.3.0
-appdirs<2,>=1

{ayon-python-api-1.0.12 → ayon-python-api-1.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ayon-python-api"
-version = "1.0.12"
+version = "1.1.1"
 description = "AYON Python API"
 license = {file = "LICENSE"}
 readme = {file = "README.md", content-type = "text/markdown"}
@@ -16,7 +16,6 @@ classifiers = [
 dependencies = [
     "requests >= 2.27.1",
     "Unidecode >= 1.3.0",
-    "appdirs >=1, <2",
 ]
 
 [project.urls]
@@ -29,7 +28,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "ayon-python-api"
-version = "1.0.12"
+version = "1.1.1"
 description = "AYON Python API"
 authors = [
     "ynput.io <info@ynput.io>"
@@ -42,7 +41,6 @@ packages = [
 python = ">=3.6.5"
 requests = "^2.27"
 Unidecode = "^1.3"
-appdirs = "^1.4"
 
 [tool.poetry.group.dev.dependencies]
 sphinx = "*"