ayon-python-api 1.2.4__tar.gz → 1.2.5__tar.gz

{ayon_python_api-1.2.4 → ayon_python_api-1.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: ayon_python_api
-Version: 1.2.4
+Version: 1.2.5
 Summary: AYON Python API
 Home-page: https://github.com/ynput/ayon-python-api
 Author: ynput.io
@@ -215,6 +215,11 @@ Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: requests>=2.27.1
+Requires-Dist: Unidecode>=1.3.0
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
 
 # AYON server API
 Python client for connection server. The client is using REST and GraphQl to communicate with server with `requests` module.

{ayon_python_api-1.2.4 → ayon_python_api-1.2.5}/ayon_api/__init__.py

@@ -54,6 +54,7 @@ from ._api import (
     get_info,
     get_server_version,
     get_server_version_tuple,
+    is_product_base_type_supported,
     get_users,
     get_user_by_name,
     get_user,
@@ -152,6 +153,7 @@ from ._api import (
     get_build_in_anatomy_preset,
     get_rest_project,
     get_rest_projects,
+    get_rest_projects_list,
     get_project_names,
     get_projects,
     get_project,
@@ -331,6 +333,7 @@ __all__ = (
     "get_info",
     "get_server_version",
     "get_server_version_tuple",
+    "is_product_base_type_supported",
     "get_users",
     "get_user_by_name",
     "get_user",
@@ -429,6 +432,7 @@ __all__ = (
     "get_build_in_anatomy_preset",
     "get_rest_project",
     "get_rest_projects",
+    "get_rest_projects_list",
     "get_project_names",
     "get_projects",
     "get_project",

{ayon_python_api-1.2.4 → ayon_python_api-1.2.5}/ayon_api/_api.py

@@ -64,6 +64,7 @@ if typing.TYPE_CHECKING:
         BundlesInfoDict,
         AnatomyPresetDict,
         SecretDict,
+        ProjectListDict,
         AnyEntityDict,
         ProjectDict,
         FolderDict,
@@ -720,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,
@@ -3573,6 +3581,31 @@ def get_rest_projects(
     )
 
 
+def get_rest_projects_list(
+    active: Optional[bool] = True,
+    library: Optional[bool] = None,
+) -> list[ProjectListDict]:
+    """Receive available projects.
+
+    User must be logged in.
+
+    Args:
+        active (Optional[bool]): Filter active/inactive projects. Both
+            are returned if 'None' is passed.
+        library (Optional[bool]): Filter standard/library projects. Both
+            are returned if 'None' is passed.
+
+    Returns:
+        list[ProjectListDict]: List of available projects.
+
+    """
+    con = get_server_api_connection()
+    return con.get_rest_projects_list(
+        active=active,
+        library=library,
+    )
+
+
 def get_project_names(
     active: Optional[bool] = True,
     library: Optional[bool] = None,
@@ -4874,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,
@@ -4926,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,
@@ -5084,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.
@@ -5098,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.
 
@@ -5116,6 +5153,7 @@ def create_product(
         tags=tags,
         status=status,
         active=active,
+        product_base_type=product_base_type,
         product_id=product_id,
     )
 
@@ -5126,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,
@@ -5145,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.
@@ -5159,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_python_api-1.2.4 → ayon_python_api-1.2.5}/ayon_api/_api_helpers/base.py

@@ -14,6 +14,7 @@ if typing.TYPE_CHECKING:
         ServerVersion,
         ProjectDict,
         StreamType,
+        AttributeScope,
     )
 
 _PLACEHOLDER = object()
@@ -24,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()
 
@@ -125,6 +129,11 @@ class BaseServerAPI:
     ) -> Optional[dict[str, Any]]:
         raise NotImplementedError()
 
+    def get_attributes_fields_for_type(
+        self, entity_type: AttributeScope
+    ) -> set[str]:
+        raise NotImplementedError()
+
     def _prepare_fields(
         self,
         entity_type: str,

{ayon_python_api-1.2.4 → ayon_python_api-1.2.5}/ayon_api/_api_helpers/products.py

@@ -5,6 +5,7 @@ import warnings
 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 @@ class ProductsAPI(BaseServerAPI):
         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 @@ class ProductsAPI(BaseServerAPI):
                 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 @@ class ProductsAPI(BaseServerAPI):
         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 @@ class ProductsAPI(BaseServerAPI):
             filters,
             ("productIds", product_ids),
             ("productTypes", product_types),
+            ("productBaseTypes", product_base_types),
             ("productStatuses", statuses),
             ("productTags", tags),
         ):
@@ -378,6 +388,7 @@ class ProductsAPI(BaseServerAPI):
         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,6 +403,7 @@ class ProductsAPI(BaseServerAPI):
             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.
 
@@ -399,6 +411,14 @@ class ProductsAPI(BaseServerAPI):
             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 @@ class ProductsAPI(BaseServerAPI):
             "folderId": folder_id,
         }
         for key, value in (
+            ("productBaseType", product_base_type),
             ("attrib", attrib),
             ("data", data),
             ("tags", tags),
@@ -431,6 +452,7 @@ class ProductsAPI(BaseServerAPI):
         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,6 +472,7 @@ class ProductsAPI(BaseServerAPI):
             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.
@@ -457,10 +480,19 @@ class ProductsAPI(BaseServerAPI):
             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_python_api-1.2.4 → ayon_python_api-1.2.5}/ayon_api/_api_helpers/projects.py

@@ -3,17 +3,50 @@ from __future__ import annotations
 import json
 import platform
 import warnings
+from enum import Enum
 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
 
 from .base import BaseServerAPI
 
 if typing.TYPE_CHECKING:
-    from ayon_api.typing import ProjectDict, AnatomyPresetDict
+    from ayon_api.typing import (
+        ProjectDict,
+        AnatomyPresetDict,
+        ProjectListDict,
+    )
+
+
+class ProjectFetchType(Enum):
+    """How a project has to be fetched to get all requested data.
+
+    Some project data can be received only from GraphQl, and some can be
+        received only with REST. That is based on requested fields.
+
+    There is also a dedicated endpoint to get information about all projects
+        but returns very limited information about the project.
+
+    Enums:
+        GraphQl: Requested project data can be received with GraphQl.
+        REST: Requested project data can be received with /projects/{project}.
+        RESTList: Requested project data can be received with /projects.
+            Can be considered as a subset of 'REST'.
+        GraphQlAndREST: It is necessary to use GraphQl and REST to get all
+            requested data.
+
+    """
+    GraphQl = "GraphQl"
+    REST = "REST"
+    RESTList = "RESTList"
+    GraphQlAndREST = "GraphQlAndREST"
 
 
 class ProjectsAPI(BaseServerAPI):
@@ -156,12 +189,12 @@ class ProjectsAPI(BaseServerAPI):
             if project:
                 yield project
 
-    def get_project_names(
+    def get_rest_projects_list(
         self,
         active: Optional[bool] = True,
         library: Optional[bool] = None,
-    ) -> list[str]:
-        """Receive available project names.
+    ) -> list[ProjectListDict]:
+        """Receive available projects.
 
         User must be logged in.
 
@@ -172,7 +205,7 @@ class ProjectsAPI(BaseServerAPI):
                 are returned if 'None' is passed.
 
         Returns:
-            list[str]: List of available project names.
+            list[ProjectListDict]: List of available projects.
 
         """
         if active is not None:
@@ -181,16 +214,38 @@ class ProjectsAPI(BaseServerAPI):
         if library is not None:
             library = "true" if library else "false"
 
-        query = prepare_query_string({"active": active, "library": library})
-
+        query = prepare_query_string({
+            "active": active,
+            "library": library,
+        })
         response = self.get(f"projects{query}")
         response.raise_for_status()
         data = response.data
-        project_names = []
-        if data:
-            for project in data["projects"]:
-                project_names.append(project["name"])
-        return project_names
+        return data["projects"]
+
+    def get_project_names(
+        self,
+        active: Optional[bool] = True,
+        library: Optional[bool] = None,
+    ) -> list[str]:
+        """Receive available project names.
+
+        User must be logged in.
+
+        Args:
+            active (Optional[bool]): Filter active/inactive projects. Both
+                are returned if 'None' is passed.
+            library (Optional[bool]): Filter standard/library projects. Both
+                are returned if 'None' is passed.
+
+        Returns:
+            list[str]: List of available project names.
+
+        """
+        return [
+            project["name"]
+            for project in self.get_rest_projects_list(active, library)
+        ]
 
     def get_projects(
         self,
@@ -218,7 +273,11 @@ class ProjectsAPI(BaseServerAPI):
         if fields is not None:
             fields = set(fields)
 
-        graphql_fields, use_rest = self._get_project_graphql_fields(fields)
+        graphql_fields, fetch_type = self._get_project_graphql_fields(fields)
+        if fetch_type == ProjectFetchType.RESTList:
+            yield from self.get_rest_projects_list(active, library)
+            return
+
         projects_by_name = {}
         if graphql_fields:
             projects = list(self._get_graphql_projects(
@@ -227,7 +286,7 @@ class ProjectsAPI(BaseServerAPI):
                 fields=graphql_fields,
                 own_attributes=own_attributes,
             ))
-            if not use_rest:
+            if fetch_type == ProjectFetchType.GraphQl:
                 yield from projects
                 return
             projects_by_name = {p["name"]: p for p in projects}
@@ -236,7 +295,12 @@ class ProjectsAPI(BaseServerAPI):
             name = project["name"]
             graphql_p = projects_by_name.get(name)
             if graphql_p:
-                project["productTypes"] = graphql_p["productTypes"]
+                for key in (
+                    "productTypes",
+                    "usedTags",
+                ):
+                    if key in graphql_p:
+                        project[key] = graphql_p[key]
             yield project
 
     def get_project(
@@ -262,7 +326,7 @@ class ProjectsAPI(BaseServerAPI):
         if fields is not None:
             fields = set(fields)
 
-        graphql_fields, use_rest = self._get_project_graphql_fields(fields)
+        graphql_fields, fetch_type = self._get_project_graphql_fields(fields)
         graphql_project = None
         if graphql_fields:
             graphql_project = next(self._get_graphql_projects(
@@ -271,14 +335,19 @@ class ProjectsAPI(BaseServerAPI):
                 fields=graphql_fields,
                 own_attributes=own_attributes,
             ), None)
-            if not graphql_project or not use_rest:
+            if not graphql_project or fetch_type == fetch_type.GraphQl:
                 return graphql_project
 
         project = self.get_rest_project(project_name)
         if own_attributes:
             fill_own_attribs(project)
         if graphql_project:
-            project["productTypes"] = graphql_project["productTypes"]
+            for key in (
+                "productTypes",
+                "usedTags",
+            ):
+                if key in graphql_project:
+                    project[key] = graphql_project[key]
         return project
 
     def create_project(
@@ -585,34 +654,86 @@ class ProjectsAPI(BaseServerAPI):
 
     def _get_project_graphql_fields(
         self, fields: Optional[set[str]]
-    ) -> tuple[set[str], bool]:
-        """Fetch of project must be done using REST endpoint.
+    ) -> tuple[set[str], ProjectFetchType]:
+        """Find out if project can be fetched with GraphQl, REST or both.
 
         Returns:
             set[str]: GraphQl fields.
 
         """
         if fields is None:
-            return set(), True
-
-        has_product_types = False
+            return set(), ProjectFetchType.REST
+
+        rest_list_fields = {
+            "name",
+            "code",
+            "active",
+            "createdAt",
+            "updatedAt",
+        }
         graphql_fields = set()
-        for field in fields:
+        if len(fields - rest_list_fields) == 0:
+            return graphql_fields, ProjectFetchType.RESTList
+
+        must_use_graphql = False
+        for field in tuple(fields):
             # Product types are available only in GraphQl
-            if field.startswith("productTypes"):
-                has_product_types = True
+            if field == "usedTags":
+                graphql_fields.add("usedTags")
+            elif field == "productTypes":
+                must_use_graphql = True
+                fields.discard(field)
+                for f_name in DEFAULT_PRODUCT_TYPE_FIELDS:
+                    fields.add(f"{field}.{f_name}")
+
+            elif field.startswith("productTypes"):
+                must_use_graphql = True
+                graphql_fields.add(field)
+
+            elif field == "productBaseTypes":
+                must_use_graphql = True
+                fields.discard(field)
+                for f_name in DEFAULT_PRODUCT_BASE_TYPE_FIELDS:
+                    fields.add(f"{field}.{f_name}")
+
+            elif field.startswith("productBaseTypes"):
+                must_use_graphql = True
                 graphql_fields.add(field)
 
-        if not has_product_types:
-            return set(), True
+            elif field == "bundle" or field == "bundles":
+                fields.discard(field)
+                graphql_fields.add("bundle.production")
+                graphql_fields.add("bundle.staging")
+
+            elif field.startswith("bundle"):
+                graphql_fields.add(field)
 
-        inters = fields & {"name", "code", "active", "library"}
+            elif field == "attrib":
+                fields.discard("attrib")
+                graphql_fields |= self.get_attributes_fields_for_type(
+                    "project"
+                )
+
+        # NOTE 'config' in GraphQl is NOT the same as from REST api.
+        # - At the moment of this comment there is missing 'productBaseTypes'.
+        inters = fields & {
+            "name",
+            "code",
+            "active",
+            "library",
+            "usedTags",
+            "data",
+        }
         remainders = fields - (inters | graphql_fields)
-        if remainders:
+        if not remainders:
+            graphql_fields |= inters
+            return graphql_fields, ProjectFetchType.GraphQl
+
+        if must_use_graphql:
             graphql_fields.add("name")
-            return graphql_fields, True
-        graphql_fields |= inters
-        return graphql_fields, False
+            return graphql_fields, ProjectFetchType.GraphQlAndREST
+
+        return set(), ProjectFetchType.REST
 
     def _fill_project_entity_data(self, project: dict[str, Any]) -> None:
         # Add fake scope to statuses if not available
@@ -632,13 +753,15 @@ class ProjectsAPI(BaseServerAPI):
         # Convert 'data' from string to dict if needed
         if "data" in project:
             project_data = project["data"]
-            if isinstance(project_data, str):
+            if project_data is None:
+                project["data"] = {}
+            elif isinstance(project_data, str):
                 project_data = json.loads(project_data)
                 project["data"] = project_data
 
             # Fill 'bundle' from data if is not filled
             if "bundle" not in project:
-                bundle_data = project["data"].get("bundle", {})
+                bundle_data = project["data"].get("bundle") or {}
                 prod_bundle = bundle_data.get("production")
                 staging_bundle = bundle_data.get("staging")
                 project["bundle"] = {
@@ -647,9 +770,12 @@ class ProjectsAPI(BaseServerAPI):
                 }
 
         # Convert 'config' from string to dict if needed
-        config = project.get("config")
-        if isinstance(config, str):
-            project["config"] = json.loads(config)
+        if "config" in project:
+            config = project["config"]
+            if config is None:
+                project["config"] = {}
+            elif isinstance(config, str):
+                project["config"] = json.loads(config)
 
         # Unifiy 'linkTypes' data structure from REST and GraphQL
         if "linkTypes" in project:

{ayon_python_api-1.2.4 → ayon_python_api-1.2.5}/ayon_api/constants.py

@@ -82,6 +82,13 @@ DEFAULT_PRODUCT_TYPE_FIELDS = {
     "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",