ayon-python-api 1.2.19__py3-none-any.whl → 1.2.21__py3-none-any.whl

ayon_api/__init__.py

@@ -298,6 +298,13 @@ from ._api import (
     update_entity_list_items,
     update_entity_list_item,
     delete_entity_list_item,
+    get_entity_list_entities,
+    get_entity_list_folders_raw,
+    get_entity_list_folders,
+    create_entity_list_folder,
+    update_entity_list_folder,
+    delete_entity_list_folder,
+    set_entity_list_folders_order,
     get_thumbnail_by_id,
     get_thumbnail,
     get_folder_thumbnail,
@@ -609,6 +616,13 @@ __all__ = (
     "update_entity_list_items",
     "update_entity_list_item",
     "delete_entity_list_item",
+    "get_entity_list_entities",
+    "get_entity_list_folders_raw",
+    "get_entity_list_folders",
+    "create_entity_list_folder",
+    "update_entity_list_folder",
+    "delete_entity_list_folder",
+    "set_entity_list_folders_order",
     "get_thumbnail_by_id",
     "get_thumbnail",
     "get_folder_thumbnail",

ayon_api/_api.py

@@ -48,8 +48,10 @@ if typing.TYPE_CHECKING:
         ActivityReferenceType,
         EntityListEntityType,
         EntityListItemMode,
+        EntityListScope,
         BackgroundOperationTask,
         LinkDirection,
+        CreateLinkData,
         EventFilter,
         EventStatus,
         EnrollEventData,
@@ -85,7 +87,6 @@ if typing.TYPE_CHECKING:
         EntityListAttributeDefinitionDict,
         AdvancedFilterDict,
     )
-    from ._api_helpers.links import CreateLinkData
 
 
 class GlobalServerAPI(ServerAPI):
@@ -129,10 +130,10 @@ class GlobalServerAPI(ServerAPI):
         login is skipped.
 
         """
-        previous_token = self._access_token
+        previous_token = self._token_info.token
         super().login(username, password)
-        if self.has_valid_token and previous_token != self._access_token:
-            os.environ[SERVER_API_ENV_KEY] = self._access_token
+        if self.has_valid_token and previous_token != self._token_info.token:
+            os.environ[SERVER_API_ENV_KEY] = self._token_info.token
 
     @staticmethod
     def get_url():
@@ -7981,6 +7982,7 @@ def create_entity_list(
     data: Optional[list[dict[str, Any]]] = None,
     tags: Optional[list[str]] = None,
     template: Optional[dict[str, Any]] = None,
+    entity_list_folder_id: Optional[str] = None,
     owner: Optional[str] = None,
     active: Optional[bool] = None,
     items: Optional[list[dict[str, Any]]] = None,
@@ -8000,6 +8002,7 @@ def create_entity_list(
         data (Optional[dict[str, Any]]): Custom data of entity list.
         tags (Optional[list[str]]): Entity list tags.
         template (Optional[dict[str, Any]]): Dynamic list template.
+        entity_list_folder_id (Optional[str]): Entity list folder id.
         owner (Optional[str]): New owner of the list.
         active (Optional[bool]): Change active state of entity list.
         items (Optional[list[dict[str, Any]]]): Initial items in
@@ -8018,6 +8021,7 @@ def create_entity_list(
         data=data,
         tags=tags,
         template=template,
+        entity_list_folder_id=entity_list_folder_id,
         owner=owner,
         active=active,
         items=items,
@@ -8034,6 +8038,7 @@ def update_entity_list(
     attrib: Optional[list[dict[str, Any]]] = None,
     data: Optional[list[dict[str, Any]]] = None,
     tags: Optional[list[str]] = None,
+    entity_list_folder_id: str | None | type[NOT_SET] = NOT_SET,
     owner: Optional[str] = None,
     active: Optional[bool] = None,
 ) -> None:
@@ -8048,6 +8053,9 @@ def update_entity_list(
             entity list.
         data (Optional[dict[str, Any]]): Custom data of entity list.
         tags (Optional[list[str]]): Entity list tags.
+        entity_list_folder_id (str | None | type[NOT_SET]): New entity
+            list folder id. Use ``None`` to move entity list to root.
+            Use 'NOT_SET' to keep current folder.
         owner (Optional[str]): New owner of the list.
         active (Optional[bool]): Change active state of entity list.
 
@@ -8061,6 +8069,7 @@ def update_entity_list(
         attrib=attrib,
         data=data,
         tags=tags,
+        entity_list_folder_id=entity_list_folder_id,
         owner=owner,
         active=active,
     )
@@ -8259,6 +8268,183 @@ def delete_entity_list_item(
     )
 
 
+def get_entity_list_entities(
+    project_name: str,
+    entity_list_id: str,
+) -> dict[str, Any]:
+    """Get entity list items using REST API.
+
+    Args:
+        project_name (str): Project name.
+        entity_list_id (str): Entity list id.
+
+    Returns:
+        dict[str, Any]: Information about entities on the list.
+
+    """
+    con = get_server_api_connection()
+    return con.get_entity_list_entities(
+        project_name=project_name,
+        entity_list_id=entity_list_id,
+    )
+
+
+def get_entity_list_folders_raw(
+    project_name: str,
+) -> dict[str, Any]:
+    """Get entity list folders.
+
+    Args:
+        project_name (str): Project name.
+
+    Returns:
+        dict[str, Any]: Raw output of entity list folders output. At this
+            moment contains only "folders" key with list of folders,
+            but it can be extended in the future.
+
+    """
+    con = get_server_api_connection()
+    return con.get_entity_list_folders_raw(
+        project_name=project_name,
+    )
+
+
+def get_entity_list_folders(
+    project_name: str,
+) -> list[dict[str, Any]]:
+    """Get entity list folders.
+
+    Returns:
+        list[dict[str, Any]]: List of entity list folders.
+
+    """
+    con = get_server_api_connection()
+    return con.get_entity_list_folders(
+        project_name=project_name,
+    )
+
+
+def create_entity_list_folder(
+    project_name: str,
+    label: str,
+    *,
+    parent_id: str | None = None,
+    color: str | None = None,
+    icon: str | None = None,
+    scope: list[EntityListScope] | None = None,
+    data: dict[str, Any] | None = None,
+    access: dict[str, Any] | None = None,
+    entity_list_folder_id: str | None = None,
+) -> str:
+    """Create entity list folder.
+
+    Args:
+        project_name (str): Project name.
+        label (str): Folder label.
+        parent_id (str | None): Parent folder id. If None, the folder will
+            be created in root.
+        color (str | None): Folder color.
+        icon (str | None): Folder icon.
+        scope (list[EntityListScope] | None): Folder scope. Empty list can
+            be used to scope folder for all views.
+        data (dict[str, Any] | None): Custom data of entity list folder.
+        access (dict[str, Any] | None): Access control for
+            entity list folder.
+        entity_list_folder_id (str | None): Id of folder that will be
+            created. If None, a new id will be generated.
+
+    Returns:
+        str: Created entity list folder id.
+
+    """
+    con = get_server_api_connection()
+    return con.create_entity_list_folder(
+        project_name=project_name,
+        label=label,
+        parent_id=parent_id,
+        color=color,
+        icon=icon,
+        scope=scope,
+        data=data,
+        access=access,
+        entity_list_folder_id=entity_list_folder_id,
+    )
+
+
+def update_entity_list_folder(
+    project_name: str,
+    entity_list_folder_id: str,
+    *,
+    label: str | None = None,
+    parent_id: str | None | type[NOT_SET] = NOT_SET,
+    color: str | None = None,
+    icon: str | None = None,
+    scope: list[EntityListScope] | None = None,
+    data: dict[str, Any] | None = None,
+    access: dict[str, Any] | None = None,
+) -> None:
+    """Update entity list folder.
+
+    Args:
+        project_name (str): Project name.
+        entity_list_folder_id (str): Folder id that will be updated.
+        label (str | None): New label of entity list folder.
+        parent_id (str | None | type[NOT_SET]): New parent id of entity
+            list folder. If None, the folder will be moved to root.
+        color (str | None): New color of entity list folder.
+        icon (str | None): New icon of entity list folder.
+        scope (list[EntityListScope] | None): New scope of entity list
+            folder. Empty list can be used to scope folder for all views.
+        data (dict[str, Any] | None): Custom data of entity list folder.
+        access (dict[str, Any] | None): Access control for
+            entity list folder.
+
+    """
+    con = get_server_api_connection()
+    return con.update_entity_list_folder(
+        project_name=project_name,
+        entity_list_folder_id=entity_list_folder_id,
+        label=label,
+        parent_id=parent_id,
+        color=color,
+        icon=icon,
+        scope=scope,
+        data=data,
+        access=access,
+    )
+
+
+def delete_entity_list_folder(
+    project_name: str,
+    entity_list_folder_id: str,
+) -> None:
+    """Delete entity list folder.
+    """
+    con = get_server_api_connection()
+    return con.delete_entity_list_folder(
+        project_name=project_name,
+        entity_list_folder_id=entity_list_folder_id,
+    )
+
+
+def set_entity_list_folders_order(
+    project_name: str,
+    order: list[str],
+) -> None:
+    """Change order of entity list folders.
+
+    Args:
+        project_name (str): Project name.
+        order (list[str]): List of folder ids in desired order.
+
+    """
+    con = get_server_api_connection()
+    return con.set_entity_list_folders_order(
+        project_name=project_name,
+        order=order,
+    )
+
+
 def get_thumbnail_by_id(
     project_name: str,
     thumbnail_id: str,

ayon_api/_api_helpers/links.py

@@ -15,11 +15,7 @@ from ayon_api.graphql_queries import (
 from .base import BaseServerAPI
 
 if typing.TYPE_CHECKING:
-    from typing import TypedDict
-    from ayon_api.typing import LinkDirection
-
-    class CreateLinkData(TypedDict):
-        id: str
+    from ayon_api.typing import LinkDirection, CreateLinkData
 
 
 class LinksAPI(BaseServerAPI):

ayon_api/_api_helpers/lists.py

@@ -4,16 +4,18 @@ import json
 import typing
 from typing import Optional, Iterable, Any, Generator
 
-from ayon_api.utils import create_entity_id
+from ayon_api.utils import NOT_SET, create_entity_id
 from ayon_api.graphql_queries import entity_lists_graphql_query
 
 from .base import BaseServerAPI
 
+
 if typing.TYPE_CHECKING:
     from ayon_api.typing import (
         EntityListEntityType,
         EntityListAttributeDefinitionDict,
         EntityListItemMode,
+        EntityListScope,
     )
 
 
@@ -159,6 +161,7 @@ class ListsAPI(BaseServerAPI):
         data: Optional[list[dict[str, Any]]] = None,
         tags: Optional[list[str]] = None,
         template: Optional[dict[str, Any]] = None,
+        entity_list_folder_id: Optional[str] = None,
         owner: Optional[str] = None,
         active: Optional[bool] = None,
         items: Optional[list[dict[str, Any]]] = None,
@@ -178,6 +181,7 @@ class ListsAPI(BaseServerAPI):
             data (Optional[dict[str, Any]]): Custom data of entity list.
             tags (Optional[list[str]]): Entity list tags.
             template (Optional[dict[str, Any]]): Dynamic list template.
+            entity_list_folder_id (Optional[str]): Entity list folder id.
             owner (Optional[str]): New owner of the list.
             active (Optional[bool]): Change active state of entity list.
             items (Optional[list[dict[str, Any]]]): Initial items in
@@ -199,6 +203,7 @@ class ListsAPI(BaseServerAPI):
             ("template", template),
             ("tags", tags),
             ("owner", owner),
+            ("entityListFolderId", entity_list_folder_id),
             ("data", data),
             ("active", active),
             ("items", items),
@@ -223,6 +228,7 @@ class ListsAPI(BaseServerAPI):
         attrib: Optional[list[dict[str, Any]]] = None,
         data: Optional[list[dict[str, Any]]] = None,
         tags: Optional[list[str]] = None,
+        entity_list_folder_id: str | None | type[NOT_SET] = NOT_SET,
         owner: Optional[str] = None,
         active: Optional[bool] = None,
     ) -> None:
@@ -237,6 +243,9 @@ class ListsAPI(BaseServerAPI):
                 entity list.
             data (Optional[dict[str, Any]]): Custom data of entity list.
             tags (Optional[list[str]]): Entity list tags.
+            entity_list_folder_id (str | None | type[NOT_SET]): New entity
+                list folder id. Use ``None`` to move entity list to root.
+                Use 'NOT_SET' to keep current folder.
             owner (Optional[str]): New owner of the list.
             active (Optional[bool]): Change active state of entity list.
 
@@ -254,6 +263,9 @@ class ListsAPI(BaseServerAPI):
             )
             if value is not None
         }
+        if entity_list_folder_id is not NOT_SET:
+            kwargs["entityListFolderId"] = entity_list_folder_id
+
         response = self.patch(
             f"projects/{project_name}/lists/{list_id}",
             **kwargs
@@ -454,3 +466,212 @@ class ListsAPI(BaseServerAPI):
             f"projects/{project_name}/lists/{list_id}/items/{item_id}",
         )
         response.raise_for_status()
+
+    def get_entity_list_entities(
+        self, project_name: str, entity_list_id: str
+    ) -> dict[str, Any]:
+        """Get entity list items using REST API.
+
+        Args:
+            project_name (str): Project name.
+            entity_list_id (str): Entity list id.
+
+        Returns:
+            dict[str, Any]: Information about entities on the list.
+
+        """
+        response = self.get(
+            f"projects/{project_name}/lists/{entity_list_id}/entities"
+        )
+        response.raise_for_status()
+        return response.data
+
+    def get_entity_list_folders_raw(
+        self, project_name: str
+    ) -> dict[str, Any]:
+        """Get entity list folders.
+
+        Args:
+            project_name (str): Project name.
+
+        Returns:
+            dict[str, Any]: Raw output of entity list folders output. At this
+                moment contains only "folders" key with list of folders,
+                but it can be extended in the future.
+
+        """
+        response = self.get(f"projects/{project_name}/entityListFolders")
+        response.raise_for_status()
+        return response.data
+
+    def get_entity_list_folders(
+        self, project_name: str
+    ) -> list[dict[str, Any]]:
+        """Get entity list folders.
+
+        Returns:
+            list[dict[str, Any]]: List of entity list folders.
+
+        """
+        data = self.get_entity_list_folders_raw(project_name)
+        return data["folders"]
+
+    def create_entity_list_folder(
+        self,
+        project_name: str,
+        label: str,
+        *,
+        parent_id: str | None = None,
+        color: str | None = None,
+        icon: str | None = None,
+        scope: list[EntityListScope] | None = None,
+        data: dict[str, Any] | None = None,
+        access: dict[str, Any] | None = None,
+        entity_list_folder_id: str | None = None,
+    ) -> str:
+        """Create entity list folder.
+
+        Args:
+            project_name (str): Project name.
+            label (str): Folder label.
+            parent_id (str | None): Parent folder id. If None, the folder will
+                be created in root.
+            color (str | None): Folder color.
+            icon (str | None): Folder icon.
+            scope (list[EntityListScope] | None): Folder scope. Empty list can
+                be used to scope folder for all views.
+            data (dict[str, Any] | None): Custom data of entity list folder.
+            access (dict[str, Any] | None): Access control for
+                entity list folder.
+            entity_list_folder_id (str | None): Id of folder that will be
+                created. If None, a new id will be generated.
+
+        Returns:
+            str: Created entity list folder id.
+
+        """
+        if data is None:
+            data = {}
+
+        for key, value in (
+            ("color", color),
+            ("icon", icon),
+            ("scope", scope),
+        ):
+            if value:
+                data[key] = value
+
+        if not entity_list_folder_id:
+            entity_list_folder_id = create_entity_id()
+        body = {
+            "id": entity_list_folder_id,
+            "label": label,
+        }
+        if parent_id:
+            body["parentId"] = parent_id
+
+        if data:
+            body["data"] = data
+
+        if access:
+            body["access"] = access
+
+        response = self.post(
+            f"projects/{project_name}/entityListFolders",
+            **body
+        )
+        response.raise_for_status()
+        return entity_list_folder_id
+
+    def update_entity_list_folder(
+        self,
+        project_name: str,
+        entity_list_folder_id: str,
+        *,
+        label: str | None = None,
+        parent_id: str | None | type[NOT_SET] = NOT_SET,
+        color: str | None = None,
+        icon: str | None = None,
+        scope: list[EntityListScope] | None = None,
+        data: dict[str, Any] | None = None,
+        access: dict[str, Any] | None = None,
+    ) -> None:
+        """Update entity list folder.
+
+        Args:
+            project_name (str): Project name.
+            entity_list_folder_id (str): Folder id that will be updated.
+            label (str | None): New label of entity list folder.
+            parent_id (str | None | type[NOT_SET]): New parent id of entity
+                list folder. If None, the folder will be moved to root.
+            color (str | None): New color of entity list folder.
+            icon (str | None): New icon of entity list folder.
+            scope (list[EntityListScope] | None): New scope of entity list
+                folder. Empty list can be used to scope folder for all views.
+            data (dict[str, Any] | None): Custom data of entity list folder.
+            access (dict[str, Any] | None): Access control for
+                entity list folder.
+
+        """
+        if data is None:
+            data = {}
+
+        for key, value in (
+            ("color", color),
+            ("icon", icon),
+        ):
+            if value:
+                data[key] = value
+
+        if scope is not None:
+            data["scope"] = scope
+
+        body = {}
+        if data:
+            body["data"] = data
+        if label:
+            body["label"] = label
+        if access is not None:
+            body["access"] = access
+        if parent_id is not NOT_SET:
+            body["parentId"] = parent_id
+
+        if not body:
+            return
+
+        response = self.patch(
+            (
+                f"projects/{project_name}/"
+                f"entityListFolders/{entity_list_folder_id}"
+            ),
+            **body
+        )
+        response.raise_for_status()
+
+    def delete_entity_list_folder(
+        self,
+        project_name: str,
+        entity_list_folder_id: str,
+    ) -> None:
+        """Delete entity list folder."""
+        response = self.delete(
+            f"projects/{project_name}/"
+            f"entityListFolders/{entity_list_folder_id}"
+        )
+        response.raise_for_status()
+
+    def set_entity_list_folders_order(
+        self, project_name: str, order: list[str]
+    ) -> None:
+        """Change order of entity list folders.
+
+        Args:
+            project_name (str): Project name.
+            order (list[str]): List of folder ids in desired order.
+
+        """
+        response = self.post(
+            f"projects/{project_name}/entityListFolders/order",
+            order=order,
+        )
+        response.raise_for_status()

ayon_api/_api_helpers/projects.py

@@ -9,7 +9,6 @@ from typing import Optional, Generator, Iterable, Any
 
 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
@@ -50,6 +49,8 @@ class ProjectFetchType(Enum):
 
 
 class ProjectsAPI(BaseServerAPI):
+    _project_product_base_type_fields = None
+
     def get_project_anatomy_presets(self) -> list[AnatomyPresetDict]:
         """Anatomy presets available on server.
 
@@ -364,6 +365,7 @@ class ProjectsAPI(BaseServerAPI):
             graphql_project = next(self._get_graphql_projects(
                 None,
                 None,
+                include_skeleton=True,
                 project_name=project_name,
                 fields=graphql_fields,
                 own_attributes=own_attributes,
@@ -801,7 +803,8 @@ class ProjectsAPI(BaseServerAPI):
             elif field == "productBaseTypes":
                 must_use_graphql = True
                 fields.discard(field)
-                for f_name in DEFAULT_PRODUCT_BASE_TYPE_FIELDS:
+                # for f_name in DEFAULT_PRODUCT_BASE_TYPE_FIELDS:
+                for f_name in self._get_project_product_base_type_fields():
                     graphql_fields.add(f"{field}.{f_name}")
 
             elif field.startswith("productBaseTypes"):
@@ -1016,3 +1019,17 @@ class ProjectsAPI(BaseServerAPI):
         )
         response.raise_for_status()
         return response.data
+
+    def _get_project_product_base_type_fields(self) -> set[str]:
+        if self._project_product_base_type_fields is not None:
+            return self._project_product_base_type_fields
+
+        graphql_schema = self.get_graphql_schema()
+
+        field_names = {"name"}
+        for type_def in graphql_schema["__schema"]["types"]:
+            if type_def["name"] == "ProductBaseType":
+                field_names = {field["name"] for field in type_def["fields"]}
+                break
+        self._project_product_base_type_fields = field_names
+        return field_names

ayon_api/constants.py

@@ -75,15 +75,14 @@ DEFAULT_PROJECT_LINK_TYPES_FIELDS = {
 # --- Product types ---
 DEFAULT_PRODUCT_TYPE_FIELDS = {
     "name",
-    "icon",
-    "color",
 }
 
 # --- Product base type ---
 DEFAULT_PRODUCT_BASE_TYPE_FIELDS = {
-    # Ignore 'icon' and 'color'
-    # - current server implementation always returns 'null'
+    # TODO add 'icon' and 'color' when server supports it
     "name",
+    # "icon",
+    # "color",
 }
 
 # --- Project ---