Merge pull request #255 from ynput/enhancement/254-product-base-types-add-support

🏛️Product base types: add support for product base types in API

Author: iLLiCiTiT

ayon_api/__init__.py

@@ -54,6 +54,7 @@
     get_info,
     get_server_version,
     get_server_version_tuple,
+    is_product_base_type_supported,
     get_users,
     get_user_by_name,
     get_user,
@@ -332,6 +333,7 @@
     "get_info",
     "get_server_version",
     "get_server_version_tuple",
+    "is_product_base_type_supported",
     "get_users",
     "get_user_by_name",
     "get_user",

ayon_api/_api.py

@@ -721,6 +721,13 @@ def get_server_version_tuple() -> ServerVersion:
     return con.get_server_version_tuple()
 
 
+def is_product_base_type_supported() -> bool:
+    """Product base types are available on server.
+    """
+    con = get_server_api_connection()
+    return con.is_product_base_type_supported()
+
+
 def get_users(
     project_name: Optional[str] = None,
     usernames: Optional[Iterable[str]] = None,
@@ -4900,6 +4907,7 @@ def get_products(
     product_names: Optional[Iterable[str]] = None,
     folder_ids: Optional[Iterable[str]] = None,
     product_types: Optional[Iterable[str]] = None,
+    product_base_types: Optional[Iterable[str]] = None,
     product_name_regex: Optional[str] = None,
     product_path_regex: Optional[str] = None,
     names_by_folder_ids: Optional[dict[str, Iterable[str]]] = None,
@@ -4952,6 +4960,7 @@ def get_products(
         product_names=product_names,
         folder_ids=folder_ids,
         product_types=product_types,
+        product_base_types=product_base_types,
         product_name_regex=product_name_regex,
         product_path_regex=product_path_regex,
         names_by_folder_ids=names_by_folder_ids,
@@ -5110,6 +5119,7 @@ def create_product(
     tags: Optional[Iterable[str]] = None,
     status: Optional[str] = None,
     active: Optional[bool] = None,
+    product_base_type: Optional[str] = None,
     product_id: Optional[str] = None,
 ) -> str:
     """Create new product.
@@ -5124,6 +5134,7 @@ def create_product(
         tags (Optional[Iterable[str]]): Product tags.
         status (Optional[str]): Product status.
         active (Optional[bool]): Product active state.
+        product_base_type (Optional[str]): Product base type.
         product_id (Optional[str]): Product id. If not passed new id is
             generated.
 
@@ -5142,6 +5153,7 @@ def create_product(
         tags=tags,
         status=status,
         active=active,
+        product_base_type=product_base_type,
         product_id=product_id,
     )
 
@@ -5152,6 +5164,7 @@ def update_product(
     name: Optional[str] = None,
     folder_id: Optional[str] = None,
     product_type: Optional[str] = None,
+    product_base_type: Optional[str] = None,
     attrib: Optional[dict[str, Any]] = None,
     data: Optional[dict[str, Any]] = None,
     tags: Optional[Iterable[str]] = None,
@@ -5171,6 +5184,7 @@ def update_product(
         name (Optional[str]): New product name.
         folder_id (Optional[str]): New product id.
         product_type (Optional[str]): New product type.
+        product_base_type (Optional[str]): New product base type.
         attrib (Optional[dict[str, Any]]): New product attributes.
         data (Optional[dict[str, Any]]): New product data.
         tags (Optional[Iterable[str]]): New product tags.
@@ -5185,6 +5199,7 @@ def update_product(
         name=name,
         folder_id=folder_id,
         product_type=product_type,
+        product_base_type=product_base_type,
         attrib=attrib,
         data=data,
         tags=tags,

ayon_api/_api_helpers/base.py

@@ -25,6 +25,9 @@ class BaseServerAPI:
     def log(self) -> logging.Logger:
         raise NotImplementedError()
 
+    def is_product_base_type_supported(self) -> bool:
+        raise NotImplementedError()
+
     def get_server_version(self) -> str:
         raise NotImplementedError()
 

ayon_api/_api_helpers/products.py

@@ -5,6 +5,7 @@
 import typing
 from typing import Optional, Iterable, Generator, Any
 
+from ayon_api.exceptions import UnsupportedServerVersion
 from ayon_api.utils import (
     prepare_list_filters,
     create_entity_id,
@@ -32,9 +33,10 @@ def get_products(
         self,
         project_name: str,
         product_ids: Optional[Iterable[str]] = None,
-        product_names: Optional[Iterable[str]]=None,
-        folder_ids: Optional[Iterable[str]]=None,
-        product_types: Optional[Iterable[str]]=None,
+        product_names: Optional[Iterable[str]] = None,
+        folder_ids: Optional[Iterable[str]] = None,
+        product_types: Optional[Iterable[str]] = None,
+        product_base_types: Optional[Iterable[str]] = None,
         product_name_regex: Optional[str] = None,
         product_path_regex: Optional[str] = None,
         names_by_folder_ids: Optional[dict[str, Iterable[str]]] = None,
@@ -59,6 +61,8 @@ def get_products(
                 Use 'None' if folder is direct child of project.
             product_types (Optional[Iterable[str]]): Product types used for
                 filtering.
+            product_base_types (Optional[Iterable[str]]): Product base types
+                used for filtering.
             product_name_regex (Optional[str]): Filter products by name regex.
             product_path_regex (Optional[str]): Filter products by path regex.
                 Path starts with folder path and ends with product name.
@@ -83,6 +87,11 @@ def get_products(
         if not project_name:
             return
 
+        if product_base_types and not self.is_product_base_type_supported():
+            raise UnsupportedServerVersion(
+                "Product base type is not supported for your server version."
+            )
+
         # Prepare these filters before 'name_by_filter_ids' filter
         filter_product_names = None
         if product_names is not None:
@@ -150,6 +159,7 @@ def get_products(
             filters,
             ("productIds", product_ids),
             ("productTypes", product_types),
+            ("productBaseTypes", product_base_types),
             ("productStatuses", statuses),
             ("productTags", tags),
         ):
@@ -378,6 +388,7 @@ def create_product(
         tags: Optional[Iterable[str]] =None,
         status: Optional[str] = None,
         active: Optional[bool] = None,
+        product_base_type: Optional[str] = None,
         product_id: Optional[str] = None,
     ) -> str:
         """Create new product.
@@ -392,13 +403,22 @@ def create_product(
             tags (Optional[Iterable[str]]): Product tags.
             status (Optional[str]): Product status.
             active (Optional[bool]): Product active state.
+            product_base_type (Optional[str]): Product base type.
             product_id (Optional[str]): Product id. If not passed new id is
                 generated.
 
         Returns:
             str: Product id.
 
         """
+        if (
+            product_base_type is not None
+            and not self.is_product_base_type_supported()
+        ):
+            raise UnsupportedServerVersion(
+                "Product base type is not supported for your server version."
+            )
+
         if not product_id:
             product_id = create_entity_id()
         create_data = {
@@ -408,6 +428,7 @@ def create_product(
             "folderId": folder_id,
         }
         for key, value in (
+            ("productBaseType", product_base_type),
             ("attrib", attrib),
             ("data", data),
             ("tags", tags),
@@ -431,6 +452,7 @@ def update_product(
         name: Optional[str] = None,
         folder_id: Optional[str] = None,
         product_type: Optional[str] = None,
+        product_base_type: Optional[str] = None,
         attrib: Optional[dict[str, Any]] = None,
         data: Optional[dict[str, Any]] = None,
         tags: Optional[Iterable[str]] = None,
@@ -450,17 +472,27 @@ def update_product(
             name (Optional[str]): New product name.
             folder_id (Optional[str]): New product id.
             product_type (Optional[str]): New product type.
+            product_base_type (Optional[str]): New product base type.
             attrib (Optional[dict[str, Any]]): New product attributes.
             data (Optional[dict[str, Any]]): New product data.
             tags (Optional[Iterable[str]]): New product tags.
             status (Optional[str]): New product status.
             active (Optional[bool]): New product active state.
 
         """
+        if (
+            product_base_type is not None
+            and not self.is_product_base_type_supported()
+        ):
+            raise UnsupportedServerVersion(
+                "Product base type is not supported for your server version."
+            )
+
         update_data = {}
         for key, value in (
             ("name", name),
             ("productType", product_type),
+            ("productBaseType", product_base_type),
             ("folderId", folder_id),
             ("attrib", attrib),
             ("data", data),

ayon_api/_api_helpers/projects.py

@@ -7,7 +7,11 @@
 import typing
 from typing import Optional, Generator, Iterable, Any
 
-from ayon_api.constants import PROJECT_NAME_REGEX
+from ayon_api.constants import (
+    PROJECT_NAME_REGEX,
+    DEFAULT_PRODUCT_BASE_TYPE_FIELDS,
+    DEFAULT_PRODUCT_TYPE_FIELDS,
+)
 from ayon_api.utils import prepare_query_string, fill_own_attribs
 from ayon_api.graphql_queries import projects_graphql_query
 
@@ -679,9 +683,8 @@ def _get_project_graphql_fields(
             elif field == "productTypes":
                 must_use_graphql = True
                 fields.discard(field)
-                graphql_fields.add("productTypes.name")
-                graphql_fields.add("productTypes.icon")
-                graphql_fields.add("productTypes.color")
+                for f_name in DEFAULT_PRODUCT_TYPE_FIELDS:
+                    fields.add(f"{field}.{f_name}")
 
             elif field.startswith("productTypes"):
                 must_use_graphql = True
@@ -690,7 +693,8 @@ def _get_project_graphql_fields(
             elif field == "productBaseTypes":
                 must_use_graphql = True
                 fields.discard(field)
-                graphql_fields.add("productBaseTypes.name")
+                for f_name in DEFAULT_PRODUCT_BASE_TYPE_FIELDS:
+                    fields.add(f"{field}.{f_name}")
 
             elif field.startswith("productBaseTypes"):
                 must_use_graphql = True

ayon_api/constants.py

@@ -82,6 +82,13 @@
     "color",
 }
 
+# --- Product base type ---
+DEFAULT_PRODUCT_BASE_TYPE_FIELDS = {
+    # Ignore 'icon' and 'color'
+    # - current server implementation always returns 'null'
+    "name",
+}
+
 # --- Project ---
 DEFAULT_PROJECT_FIELDS = {
     "active",