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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ayon-python-api
-Version: 0.1.18
+Version: 0.2.0
 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.0}/ayon_api/__init__.py

@@ -99,22 +99,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 +124,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 +149,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,
@@ -251,22 +257,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 +282,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 +307,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.0}/ayon_api/_api.py

@@ -656,29 +656,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_subsets(*args, **kwargs)
+    return con.get_folder_ids_with_products(*args, **kwargs)
 
 
-def get_subsets(*args, **kwargs):
+def get_product_types(*args, **kwargs):
     con = get_server_api_connection()
-    return con.get_subsets(*args, **kwargs)
+    return con.get_product_types(*args, **kwargs)
 
 
-def get_subset_by_id(*args, **kwargs):
+def get_project_product_types(*args, **kwargs):
     con = get_server_api_connection()
-    return con.get_subset_by_id(*args, **kwargs)
+    return con.get_project_product_types(*args, **kwargs)
 
 
-def get_subset_by_name(*args, **kwargs):
+def get_product_type_names(*args, **kwargs):
     con = get_server_api_connection()
-    return con.get_subset_by_name(*args, **kwargs)
+    return con.get_product_type_names(*args, **kwargs)
 
 
-def get_subset_families(*args, **kwargs):
+def get_products(*args, **kwargs):
     con = get_server_api_connection()
-    return con.get_subset_families(*args, **kwargs)
+    return con.get_products(*args, **kwargs)
+
+
+def get_product_by_id(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_product_by_id(*args, **kwargs)
+
+
+def get_product_by_name(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_product_by_name(*args, **kwargs)
 
 
 def get_versions(*args, **kwargs):
@@ -701,9 +711,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 +726,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 +771,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,
@@ -954,31 +979,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.0}/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.0}/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]:
@@ -1564,7 +1564,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

{ayon-python-api-0.1.18 → ayon-python-api-0.2.0}/ayon_api/graphql_queries.py

@@ -123,6 +123,51 @@ def projects_graphql_query(fields):
     return query
 
 
+def product_types_query(fields):
+    query = GraphQlQuery("ProductTypes")
+    product_types_field = query.add_field("productTypes")
+
+    nested_fields = fields_to_dict(fields)
+
+    query_queue = collections.deque()
+    for key, value in nested_fields.items():
+        query_queue.append((key, value, product_types_field))
+
+    while query_queue:
+        item = query_queue.popleft()
+        key, value, parent = item
+        field = parent.add_field(key)
+        if value is FIELD_VALUE:
+            continue
+
+        for k, v in value.items():
+            query_queue.append((k, v, field))
+    return query
+
+def project_product_types_query(fields):
+    query = GraphQlQuery("ProjectProductTypes")
+    project_query = query.add_field("project")
+    project_name_var = query.add_variable("projectName", "String!")
+    project_query.set_filter("name", project_name_var)
+    product_types_field = project_query.add_field("productTypes")
+    nested_fields = fields_to_dict(fields)
+
+    query_queue = collections.deque()
+    for key, value in nested_fields.items():
+        query_queue.append((key, value, product_types_field))
+
+    while query_queue:
+        item = query_queue.popleft()
+        key, value, parent = item
+        field = parent.add_field(key)
+        if value is FIELD_VALUE:
+            continue
+
+        for k, v in value.items():
+            query_queue.append((k, v, field))
+    return query
+
+
 def folders_graphql_query(fields):
     query = GraphQlQuery("FoldersQuery")
     project_name_var = query.add_variable("projectName", "String!")
@@ -130,7 +175,7 @@ def folders_graphql_query(fields):
     parent_folder_ids_var = query.add_variable("parentFolderIds", "[String!]")
     folder_paths_var = query.add_variable("folderPaths", "[String!]")
     folder_names_var = query.add_variable("folderNames", "[String!]")
-    has_subsets_var = query.add_variable("folderHasSubsets", "Boolean!")
+    has_products_var = query.add_variable("folderHasProducts", "Boolean!")
 
     project_field = query.add_field("project")
     project_field.set_filter("name", project_name_var)
@@ -140,7 +185,7 @@ def folders_graphql_query(fields):
     folders_field.set_filter("parentIds", parent_folder_ids_var)
     folders_field.set_filter("names", folder_names_var)
     folders_field.set_filter("paths", folder_paths_var)
-    folders_field.set_filter("hasSubsets", has_subsets_var)
+    folders_field.set_filter("hasProducts", has_products_var)
 
     nested_fields = fields_to_dict(fields)
     add_links_fields(folders_field, nested_fields)
@@ -198,28 +243,28 @@ def tasks_graphql_query(fields):
     return query
 
 
-def subsets_graphql_query(fields):
-    query = GraphQlQuery("SubsetsQuery")
+def products_graphql_query(fields):
+    query = GraphQlQuery("ProductsQuery")
 
     project_name_var = query.add_variable("projectName", "String!")
     folder_ids_var = query.add_variable("folderIds", "[String!]")
-    subset_ids_var = query.add_variable("subsetIds", "[String!]")
-    subset_names_var = query.add_variable("subsetNames", "[String!]")
+    product_ids_var = query.add_variable("productIds", "[String!]")
+    product_names_var = query.add_variable("productNames", "[String!]")
 
     project_field = query.add_field("project")
     project_field.set_filter("name", project_name_var)
 
-    subsets_field = project_field.add_field_with_edges("subsets")
-    subsets_field.set_filter("ids", subset_ids_var)
-    subsets_field.set_filter("names", subset_names_var)
-    subsets_field.set_filter("folderIds", folder_ids_var)
+    products_field = project_field.add_field_with_edges("products")
+    products_field.set_filter("ids", product_ids_var)
+    products_field.set_filter("names", product_names_var)
+    products_field.set_filter("folderIds", folder_ids_var)
 
     nested_fields = fields_to_dict(set(fields))
-    add_links_fields(subsets_field, nested_fields)
+    add_links_fields(products_field, nested_fields)
 
     query_queue = collections.deque()
     for key, value in nested_fields.items():
-        query_queue.append((key, value, subsets_field))
+        query_queue.append((key, value, products_field))
 
     while query_queue:
         item = query_queue.popleft()
@@ -237,7 +282,7 @@ def versions_graphql_query(fields):
     query = GraphQlQuery("VersionsQuery")
 
     project_name_var = query.add_variable("projectName", "String!")
-    subset_ids_var = query.add_variable("subsetIds", "[String!]")
+    product_ids_var = query.add_variable("productIds", "[String!]")
     version_ids_var = query.add_variable("versionIds", "[String!]")
     versions_var = query.add_variable("versions", "[Int!]")
     hero_only_var = query.add_variable("heroOnly", "Boolean")
@@ -249,20 +294,20 @@ def versions_graphql_query(fields):
     project_field = query.add_field("project")
     project_field.set_filter("name", project_name_var)
 
-    subsets_field = project_field.add_field_with_edges("versions")
-    subsets_field.set_filter("ids", version_ids_var)
-    subsets_field.set_filter("subsetIds", subset_ids_var)
-    subsets_field.set_filter("versions", versions_var)
-    subsets_field.set_filter("heroOnly", hero_only_var)
-    subsets_field.set_filter("latestOnly", latest_only_var)
-    subsets_field.set_filter("heroOrLatestOnly", hero_or_latest_only_var)
+    products_field = project_field.add_field_with_edges("versions")
+    products_field.set_filter("ids", version_ids_var)
+    products_field.set_filter("productIds", product_ids_var)
+    products_field.set_filter("versions", versions_var)
+    products_field.set_filter("heroOnly", hero_only_var)
+    products_field.set_filter("latestOnly", latest_only_var)
+    products_field.set_filter("heroOrLatestOnly", hero_or_latest_only_var)
 
     nested_fields = fields_to_dict(set(fields))
-    add_links_fields(subsets_field, nested_fields)
+    add_links_fields(products_field, nested_fields)
 
     query_queue = collections.deque()
     for key, value in nested_fields.items():
-        query_queue.append((key, value, subsets_field))
+        query_queue.append((key, value, products_field))
 
     while query_queue:
         item = query_queue.popleft()
@@ -312,7 +357,7 @@ def representations_graphql_query(fields):
 
 
 def representations_parents_qraphql_query(
-    version_fields, subset_fields, folder_fields
+    version_fields, product_fields, folder_fields
 ):
     query = GraphQlQuery("RepresentationsParentsQuery")
 
@@ -331,11 +376,11 @@ def representations_parents_qraphql_query(
     for key, value in fields_to_dict(version_fields).items():
         fields_queue.append((key, value, version_field))
 
-    subset_field = version_field.add_field("subset")
-    for key, value in fields_to_dict(subset_fields).items():
-        fields_queue.append((key, value, subset_field))
+    product_field = version_field.add_field("product")
+    for key, value in fields_to_dict(product_fields).items():
+        fields_queue.append((key, value, product_field))
 
-    folder_field = subset_field.add_field("folder")
+    folder_field = product_field.add_field("folder")
     for key, value in fields_to_dict(folder_fields).items():
         fields_queue.append((key, value, folder_field))