Ayon-Python-Api 0.1.18__tar.gz → 0.2.1__tar.gz

{ayon-python-api-0.1.18 → ayon-python-api-0.2.1}/PKG-INFO

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

{ayon-python-api-0.1.18 → ayon-python-api-0.2.1}/ayon_api/__init__.py

@@ -59,13 +59,31 @@ from ._api import (
     get_addon_url,
     download_addon_private_file,
 
+    get_installers,
+    create_installer,
+    update_installer,
+    delete_installer,
+    download_installer,
+    upload_installer,
+
     get_dependencies_info,
     update_dependency_info,
+    get_dependency_packages,
+    create_dependency_package,
+    update_dependency_package,
+    delete_dependency_package,
 
     download_dependency_package,
     upload_dependency_package,
-    delete_dependency_package,
 
+    get_bundles,
+    create_bundle,
+    update_bundle,
+    delete_bundle,
+
+    get_info,
+    get_server_version,
+    get_server_version_tuple,
     get_user,
     get_users,
 
@@ -87,9 +105,11 @@ from ._api import (
     get_addons_project_settings,
     get_addons_settings,
 
+    get_project_names,
     get_projects,
     get_project,
     create_project,
+    update_project,
     delete_project,
 
     get_folder_by_id,
@@ -99,22 +119,24 @@ from ._api import (
 
     get_tasks,
 
-    get_folder_ids_with_subsets,
-    get_subset_by_id,
-    get_subset_by_name,
-    get_subsets,
-    get_subset_families,
+    get_folder_ids_with_products,
+    get_product_by_id,
+    get_product_by_name,
+    get_products,
+    get_product_types,
+    get_project_product_types,
+    get_product_type_names,
 
     get_version_by_id,
     get_version_by_name,
     version_is_latest,
     get_versions,
-    get_hero_version_by_subset_id,
+    get_hero_version_by_product_id,
     get_hero_version_by_id,
     get_hero_versions,
     get_last_versions,
-    get_last_version_by_subset_id,
-    get_last_version_by_subset_name,
+    get_last_version_by_product_id,
+    get_last_version_by_product_name,
     get_representation_by_id,
     get_representation_by_name,
     get_representations,
@@ -122,6 +144,10 @@ from ._api import (
     get_representation_parents,
     get_repre_ids_by_context_filters,
 
+    get_workfiles_info,
+    get_workfile_info,
+    get_workfile_info_by_id,
+
     get_thumbnail,
     get_folder_thumbnail,
     get_version_thumbnail,
@@ -143,8 +169,8 @@ from ._api import (
     get_folders_links,
     get_task_links,
     get_tasks_links,
-    get_subset_links,
-    get_subsets_links,
+    get_product_links,
+    get_products_links,
     get_version_links,
     get_versions_links,
     get_representations_links,
@@ -212,13 +238,31 @@ __all__ = (
     "get_addon_url",
     "download_addon_private_file",
 
+    "get_installers",
+    "create_installer",
+    "update_installer",
+    "delete_installer",
+    "download_installer",
+    "upload_installer",
+
     "get_dependencies_info",
     "update_dependency_info",
+    "get_dependency_packages",
+    "create_dependency_package",
+    "update_dependency_package",
+    "delete_dependency_package",
 
     "download_dependency_package",
     "upload_dependency_package",
-    "delete_dependency_package",
 
+    "get_bundles",
+    "create_bundle",
+    "update_bundle",
+    "delete_bundle",
+
+    "get_info",
+    "get_server_version",
+    "get_server_version_tuple",
     "get_user",
     "get_users",
 
@@ -239,9 +283,11 @@ __all__ = (
     "get_addons_project_settings",
     "get_addons_settings",
 
+    "get_project_names",
     "get_projects",
     "get_project",
     "create_project",
+    "update_project",
     "delete_project",
 
     "get_folder_by_id",
@@ -251,22 +297,24 @@ __all__ = (
 
     "get_tasks",
 
-    "get_folder_ids_with_subsets",
-    "get_subset_by_id",
-    "get_subset_by_name",
-    "get_subsets",
-    "get_subset_families",
+    "get_folder_ids_with_products",
+    "get_product_by_id",
+    "get_product_by_name",
+    "get_products",
+    "get_product_types",
+    "get_project_product_types",
+    "get_product_type_names",
 
     "get_version_by_id",
     "get_version_by_name",
     "version_is_latest",
     "get_versions",
-    "get_hero_version_by_subset_id",
+    "get_hero_version_by_product_id",
     "get_hero_version_by_id",
     "get_hero_versions",
     "get_last_versions",
-    "get_last_version_by_subset_id",
-    "get_last_version_by_subset_name",
+    "get_last_version_by_product_id",
+    "get_last_version_by_product_name",
     "get_representation_by_id",
     "get_representation_by_name",
     "get_representations",
@@ -274,6 +322,10 @@ __all__ = (
     "get_representation_parents",
     "get_repre_ids_by_context_filters",
 
+    "get_workfiles_info",
+    "get_workfile_info",
+    "get_workfile_info_by_id",
+
     "get_thumbnail",
     "get_folder_thumbnail",
     "get_version_thumbnail",
@@ -295,8 +347,8 @@ __all__ = (
     "get_folders_links",
     "get_task_links",
     "get_tasks_links",
-    "get_subset_links",
-    "get_subsets_links",
+    "get_product_links",
+    "get_products_links",
     "get_version_links",
     "get_versions_links",
     "get_representations_links",

{ayon-python-api-0.1.18 → ayon-python-api-0.2.1}/ayon_api/_api.py

@@ -531,6 +531,53 @@ def download_addon_private_file(*args, **kwargs):
     return con.download_addon_private_file(*args, **kwargs)
 
 
+def get_info(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_info(*args, **kwargs)
+
+
+def get_server_version(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_server_version(*args, **kwargs)
+
+
+def get_server_version_tuple(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_server_version_tuple(*args, **kwargs)
+
+
+# Installers
+def get_installers(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_installers(*args, **kwargs)
+
+
+def create_installer(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.create_installer(*args, **kwargs)
+
+
+def update_installer(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.update_installer(*args, **kwargs)
+
+
+def delete_installer(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.delete_installer(*args, **kwargs)
+
+
+def download_installer(*args, **kwargs):
+    con = get_server_api_connection()
+    con.download_installer(*args, **kwargs)
+
+
+def upload_installer(*args, **kwargs):
+    con = get_server_api_connection()
+    con.upload_installer(*args, **kwargs)
+
+
+# Dependency packages
 def get_dependencies_info(*args, **kwargs):
     con = get_server_api_connection()
     return con.get_dependencies_info(*args, **kwargs)
@@ -551,6 +598,21 @@ def upload_dependency_package(*args, **kwargs):
     return con.upload_dependency_package(*args, **kwargs)
 
 
+def get_dependency_packages(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_dependency_packages(*args, **kwargs)
+
+
+def create_dependency_package(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.create_dependency_package(*args, **kwargs)
+
+
+def update_dependency_package(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.update_dependency_package(*args, **kwargs)
+
+
 def delete_dependency_package(*args, **kwargs):
     con = get_server_api_connection()
     return con.delete_dependency_package(*args, **kwargs)
@@ -561,6 +623,26 @@ def get_project_anatomy_presets(*args, **kwargs):
     return con.get_project_anatomy_presets(*args, **kwargs)
 
 
+def get_bundles(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_bundles(*args, **kwargs)
+
+
+def create_bundle(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.create_bundle(*args, **kwargs)
+
+
+def update_bundle(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.update_bundle(*args, **kwargs)
+
+
+def delete_bundle(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.delete_bundle(*args, **kwargs)
+
+
 def get_project_anatomy_preset(*args, **kwargs):
     con = get_server_api_connection()
     return con.get_project_anatomy_preset(*args, **kwargs)
@@ -621,6 +703,11 @@ def get_addons_settings(*args, **kwargs):
     return con.get_addons_settings(*args, **kwargs)
 
 
+def get_project_names(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_project_names(*args, **kwargs)
+
+
 def get_project(*args, **kwargs):
     con = get_server_api_connection()
     return con.get_project(*args, **kwargs)
@@ -656,29 +743,39 @@ def get_folder_by_name(*args, **kwargs):
     return con.get_folder_by_name(*args, **kwargs)
 
 
-def get_folder_ids_with_subsets(*args, **kwargs):
+def get_folder_ids_with_products(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_folder_ids_with_products(*args, **kwargs)
+
+
+def get_product_types(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_product_types(*args, **kwargs)
+
+
+def get_project_product_types(*args, **kwargs):
     con = get_server_api_connection()
-    return con.get_folder_ids_with_subsets(*args, **kwargs)
+    return con.get_project_product_types(*args, **kwargs)
 
 
-def get_subsets(*args, **kwargs):
+def get_product_type_names(*args, **kwargs):
     con = get_server_api_connection()
-    return con.get_subsets(*args, **kwargs)
+    return con.get_product_type_names(*args, **kwargs)
 
 
-def get_subset_by_id(*args, **kwargs):
+def get_products(*args, **kwargs):
     con = get_server_api_connection()
-    return con.get_subset_by_id(*args, **kwargs)
+    return con.get_products(*args, **kwargs)
 
 
-def get_subset_by_name(*args, **kwargs):
+def get_product_by_id(*args, **kwargs):
     con = get_server_api_connection()
-    return con.get_subset_by_name(*args, **kwargs)
+    return con.get_product_by_id(*args, **kwargs)
 
 
-def get_subset_families(*args, **kwargs):
+def get_product_by_name(*args, **kwargs):
     con = get_server_api_connection()
-    return con.get_subset_families(*args, **kwargs)
+    return con.get_product_by_name(*args, **kwargs)
 
 
 def get_versions(*args, **kwargs):
@@ -701,9 +798,9 @@ def get_hero_version_by_id(*args, **kwargs):
     return con.get_hero_version_by_id(*args, **kwargs)
 
 
-def get_hero_version_by_subset_id(*args, **kwargs):
+def get_hero_version_by_product_id(*args, **kwargs):
     con = get_server_api_connection()
-    return con.get_hero_version_by_subset_id(*args, **kwargs)
+    return con.get_hero_version_by_product_id(*args, **kwargs)
 
 
 def get_hero_versions(*args, **kwargs):
@@ -716,14 +813,14 @@ def get_last_versions(*args, **kwargs):
     return con.get_last_versions(*args, **kwargs)
 
 
-def get_last_version_by_subset_id(*args, **kwargs):
+def get_last_version_by_product_id(*args, **kwargs):
     con = get_server_api_connection()
-    return con.get_last_version_by_subset_id(*args, **kwargs)
+    return con.get_last_version_by_product_id(*args, **kwargs)
 
 
-def get_last_version_by_subset_name(*args, **kwargs):
+def get_last_version_by_product_name(*args, **kwargs):
     con = get_server_api_connection()
-    return con.get_last_version_by_subset_name(*args, **kwargs)
+    return con.get_last_version_by_product_name(*args, **kwargs)
 
 
 def version_is_latest(*args, **kwargs):
@@ -761,6 +858,21 @@ def get_repre_ids_by_context_filters(*args, **kwargs):
     return con.get_repre_ids_by_context_filters(*args, **kwargs)
 
 
+def get_workfiles_info(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_workfiles_info(*args, **kwargs)
+
+
+def get_workfile_info(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_workfile_info(*args, **kwargs)
+
+
+def get_workfile_info_by_id(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_workfile_info_by_id(*args, **kwargs)
+
+
 def create_project(
     project_name,
     project_code,
@@ -776,6 +888,11 @@ def create_project(
     )
 
 
+def update_project(project_name, *args, **kwargs):
+    con = get_server_api_connection()
+    return con.update_project(project_name, *args, **kwargs)
+
+
 def delete_project(project_name):
     con = get_server_api_connection()
     return con.delete_project(project_name)
@@ -954,31 +1071,31 @@ def get_task_links(
     )
 
 
-def get_subsets_links(
+def get_products_links(
     project_name,
-    subset_ids=None,
+    product_ids=None,
     link_types=None,
     link_direction=None
 ):
     con = get_server_api_connection()
-    return con.get_subsets_links(
+    return con.get_products_links(
         project_name,
-        subset_ids,
+        product_ids,
         link_types,
         link_direction
     )
 
 
-def get_subset_links(
+def get_product_links(
     project_name,
-    subset_id,
+    product_id,
     link_types=None,
     link_direction=None
 ):
     con = get_server_api_connection()
-    return con.get_subset_links(
+    return con.get_product_links(
         project_name,
-        subset_id,
+        product_id,
         link_types,
         link_direction
     )

{ayon-python-api-0.1.18 → ayon-python-api-0.2.1}/ayon_api/constants.py

@@ -4,6 +4,13 @@ SERVER_API_ENV_KEY = "AYON_API_KEY"
 # Backwards compatibility
 SERVER_TOKEN_ENV_KEY = SERVER_API_ENV_KEY
 
+# --- Product types ---
+DEFAULT_PRODUCT_TYPE_FIELDS = {
+    "name",
+    "icon",
+    "color",
+}
+
 # --- Project ---
 DEFAULT_PROJECT_FIELDS = {
     "active",
@@ -36,13 +43,13 @@ DEFAULT_TASK_FIELDS = {
     "assignees",
 }
 
-# --- Subsets ---
-DEFAULT_SUBSET_FIELDS = {
+# --- Products ---
+DEFAULT_PRODUCT_FIELDS = {
     "id",
     "name",
     "folderId",
     "active",
-    "family",
+    "productType",
 }
 
 # --- Versions ---
@@ -50,7 +57,7 @@ DEFAULT_VERSION_FIELDS = {
     "id",
     "name",
     "version",
-    "subsetId",
+    "productId",
     "taskId",
     "active",
     "author",

{ayon-python-api-0.1.18 → ayon-python-api-0.2.1}/ayon_api/entity_hub.py

@@ -558,7 +558,7 @@ class EntityHub(object):
         folder_fields = set(
             self._connection.get_default_fields_for_type("folder")
         )
-        folder_fields.add("hasSubsets")
+        folder_fields.add("hasProducts")
         if self._allow_data_changes:
             folder_fields.add("data")
         return folder_fields
@@ -602,7 +602,7 @@ class EntityHub(object):
             for folder in folders_by_parent_id[parent_id]:
                 folder_entity = self.add_folder(folder)
                 children_ids.add(folder_entity.id)
-                folder_entity.has_published_content = folder["hasSubsets"]
+                folder_entity.has_published_content = folder["hasProducts"]
                 hierarchy_queue.append((folder_entity.id, folder_entity))
 
             for task in tasks_by_parent_id[parent_id]:
@@ -683,6 +683,82 @@ class EntityHub(object):
             "entityId": entity.id
         }
 
+    def _pre_commit_types_changes(
+        self, project_changes, orig_types, changes_key, post_changes
+    ):
+        """Compare changes of types on a project.
+
+        Compare old and new types. Change project changes content if some old
+        types were removed. In that case the  final change of types will
+        happen when all other entities have changed.
+
+        Args:
+            project_changes (dict[str, Any]): Project changes.
+            orig_types (list[dict[str, Any]]): Original types.
+            changes_key (Literal[folderTypes, taskTypes]): Key of type changes
+                in project changes.
+            post_changes (dict[str, Any]): An object where post changes will
+                be stored.
+        """
+
+        if changes_key not in project_changes:
+            return
+
+        new_types = project_changes[changes_key]
+
+        orig_types_by_name = {
+            type_info["name"]: type_info
+            for type_info in orig_types
+        }
+        new_names = {
+            type_info["name"]
+            for type_info in new_types
+        }
+        diff_names = set(orig_types_by_name) - new_names
+        if not diff_names:
+            return
+
+        # Create copy of folder type changes to post changes
+        #   - post changes will be commited at the end
+        post_changes[changes_key] = copy.deepcopy(new_types)
+
+        for type_name in diff_names:
+            new_types.append(orig_types_by_name[type_name])
+
+    def _pre_commit_project(self):
+        """Some project changes cannot be committed before hierarchy changes.
+
+        It is not possible to change folder types or task types if there are
+        existing hierarchy items using the removed types. For that purposes
+        is first committed union of all old and new types and post changes
+        are prepared when all existing entities are changed.
+
+        Returns:
+            dict[str, Any]: Changes that will be committed after hierarchy
+                changes.
+        """
+
+        project_changes = self.project_entity.changes
+
+        post_changes = {}
+        if not project_changes:
+            return post_changes
+
+        self._pre_commit_types_changes(
+            project_changes,
+            self.project_entity.get_orig_folder_types(),
+            "folderType",
+            post_changes
+        )
+        self._pre_commit_types_changes(
+            project_changes,
+            self.project_entity.get_orig_task_types(),
+            "taskType",
+            post_changes
+        )
+        self._connection.update_project(self.project_name, **project_changes)
+        return post_changes
+
     def commit_changes(self):
         """Commit any changes that happened on entities.
 
@@ -690,6 +766,9 @@ class EntityHub(object):
             Use Operations Session instead of known operations body.
         """
 
+        post_project_changes = self._pre_commit_project()
+        self.project_entity.lock()
+
         project_changes = self.project_entity.changes
         if project_changes:
             response = self._connection.patch(
@@ -760,6 +839,9 @@ class EntityHub(object):
         self._connection.send_batch_operations(
             self.project_name, operations_body
         )
+        if post_project_changes:
+            self._connection.update_project(
+                self.project_name, **post_project_changes)
 
         self.lock()
 
@@ -1463,6 +1545,9 @@ class ProjectEntity(BaseEntity):
 
     parent = property(get_parent, set_parent)
 
+    def get_orig_folder_types(self):
+        return copy.deepcopy(self._orig_folder_types)
+
     def get_folder_types(self):
         return copy.deepcopy(self._folder_types)
 
@@ -1474,6 +1559,9 @@ class ProjectEntity(BaseEntity):
             new_folder_types.append(folder_type)
         self._folder_types = new_folder_types
 
+    def get_orig_task_types(self):
+        return copy.deepcopy(self._orig_task_types)
+
     def get_task_types(self):
         return copy.deepcopy(self._task_types)
 
@@ -1564,7 +1652,7 @@ class FolderEntity(BaseEntity):
 
         self._orig_folder_type = folder_type
         self._orig_label = label
-        # Know if folder has any subsets
+        # Know if folder has any products
         # - is used to know if folder allows hierarchy changes
         self._has_published_content = False
         self._path = path