Merge pull request #311 from ynput/enhancement/fetch-links-data

Links: Fetch data

Author: iLLiCiTiT

ayon_api/__init__.py

@@ -55,6 +55,7 @@
     get_server_version,
     get_server_version_tuple,
     is_product_base_type_supported,
+    links_graphql_support_data,
     get_users,
     get_user_by_name,
     get_user,
@@ -339,6 +340,7 @@
     "get_server_version",
     "get_server_version_tuple",
     "is_product_base_type_supported",
+    "links_graphql_support_data",
     "get_users",
     "get_user_by_name",
     "get_user",

ayon_api/_api.py

@@ -729,6 +729,13 @@ def is_product_base_type_supported() -> bool:
     return con.is_product_base_type_supported()
 
 
+def links_graphql_support_data() -> bool:
+    """Links data can be received by GraphQl.
+    """
+    con = get_server_api_connection()
+    return con.links_graphql_support_data()
+
+
 def get_users(
     project_name: Optional[str] = None,
     usernames: Optional[Iterable[str]] = None,

ayon_api/_api_helpers/base.py

@@ -28,6 +28,9 @@ def log(self) -> logging.Logger:
     def is_product_base_type_supported(self) -> bool:
         raise NotImplementedError()
 
+    def links_graphql_support_data(self) -> bool:
+        raise NotImplementedError()
+
     def get_server_version(self) -> str:
         raise NotImplementedError()
 
@@ -142,6 +145,9 @@ def _prepare_fields(
     ):
         raise NotImplementedError()
 
+    def _prepare_link_fields(self, fields: set[str]) -> None:
+        raise NotImplementedError()
+
     def _prepare_advanced_filters(
         self, filters: Union[str, dict[str, Any], None]
     ) -> Optional[str]:

ayon_api/_api_helpers/folders.py

@@ -331,6 +331,8 @@ def get_folders(
         if own_attributes:
             fields.add("ownAttrib")
 
+        self._prepare_link_fields(fields)
+
         query = folders_graphql_query(fields)
         for attr, filter_value in graphql_filters.items():
             query.set_variable_value(attr, filter_value)

ayon_api/_api_helpers/links.py

@@ -362,6 +362,7 @@ def get_entities_links(
             return output
 
         link_fields = {"id", "links"}
+        self._prepare_link_fields(link_fields)
         query = query_func(link_fields)
         for attr, filter_value in filters.items():
             query.set_variable_value(attr, filter_value)

ayon_api/_api_helpers/products.py

@@ -179,6 +179,8 @@ def get_products(
             if filter_value:
                 graphql_filters[filter_key] = filter_value
 
+        self._prepare_link_fields(fields)
+
         query = products_graphql_query(fields)
         for attr, filter_value in graphql_filters.items():
             query.set_variable_value(attr, filter_value)

ayon_api/_api_helpers/representations.py

@@ -108,6 +108,8 @@ def get_representations(
             fields.discard("files")
             fields |= REPRESENTATION_FILES_FIELDS
 
+        self._prepare_link_fields(fields)
+
         graphql_filters = {
             "projectName": project_name
         }

ayon_api/_api_helpers/tasks.py

@@ -106,6 +106,8 @@ def get_tasks(
         if active is not None:
             fields.add("active")
 
+        self._prepare_link_fields(fields)
+
         query = tasks_graphql_query(fields)
         for attr, filter_value in graphql_filters.items():
             query.set_variable_value(attr, filter_value)
@@ -267,6 +269,8 @@ def get_tasks_by_folder_paths(
         if active is not None:
             fields.add("active")
 
+        self._prepare_link_fields(fields)
+
         query = tasks_by_folder_paths_graphql_query(fields)
         for attr, filter_value in graphql_filters.items():
             query.set_variable_value(attr, filter_value)

ayon_api/_api_helpers/versions.py

@@ -87,6 +87,8 @@ def get_versions(
         if active is not None:
             fields.add("active")
 
+        self._prepare_link_fields(fields)
+
         if own_attributes is not _PLACEHOLDER:
             warnings.warn(
                 (
@@ -116,7 +118,6 @@ def get_versions(
         ):
             return
 
-
         filters = self._prepare_advanced_filters(filters)
         if filters:
             graphql_filters["filter"] = filters

ayon_api/_api_helpers/workfiles.py

@@ -93,6 +93,8 @@ def get_workfile_entities(
             fields = set(fields)
             self._prepare_fields("workfile", fields)
 
+        self._prepare_link_fields(fields)
+
         query = workfiles_info_graphql_query(fields)
 
         for attr, filter_value in filters.items():