Ayon-Python-Api 0.3.4__tar.gz → 0.3.6__tar.gz

{ayon-python-api-0.3.4 → ayon-python-api-0.3.6}/PKG-INFO

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

{ayon-python-api-0.3.4 → ayon-python-api-0.3.6}/ayon_api/__init__.py

@@ -30,6 +30,8 @@ from ._api import (
     set_client_version,
     get_default_settings_variant,
     set_default_settings_variant,
+    get_sender,
+    set_sender,
 
     get_base_url,
     get_rest_url,
@@ -46,6 +48,11 @@ from ._api import (
     patch,
     delete,
 
+    get_timeout,
+    set_timeout,
+    get_max_retries,
+    set_max_retries,
+
     get_event,
     get_events,
     dispatch_event,
@@ -92,6 +99,7 @@ from ._api import (
     get_users,
 
     get_attributes_for_type,
+    get_attributes_fields_for_type,
     get_default_fields_for_type,
 
     get_project_anatomy_preset,
@@ -110,6 +118,11 @@ from ._api import (
     get_addons_project_settings,
     get_addons_settings,
 
+    get_secrets,
+    get_secret,
+    save_secret,
+    delete_secret,
+
     get_project_names,
     get_projects,
     get_project,
@@ -124,6 +137,8 @@ from ._api import (
     get_folders_hierarchy,
 
     get_tasks,
+    get_task_by_id,
+    get_task_by_name,
 
     get_folder_ids_with_products,
     get_product_by_id,
@@ -154,6 +169,7 @@ from ._api import (
     get_workfile_info,
     get_workfile_info_by_id,
 
+    get_thumbnail_by_id,
     get_thumbnail,
     get_folder_thumbnail,
     get_version_thumbnail,
@@ -216,6 +232,8 @@ __all__ = (
     "set_client_version",
     "get_default_settings_variant",
     "set_default_settings_variant",
+    "get_sender",
+    "set_sender",
 
     "get_base_url",
     "get_rest_url",
@@ -232,6 +250,11 @@ __all__ = (
     "patch",
     "delete",
 
+    "get_timeout",
+    "set_timeout",
+    "get_max_retries",
+    "set_max_retries",
+
     "get_event",
     "get_events",
     "dispatch_event",
@@ -278,6 +301,7 @@ __all__ = (
     "get_users",
 
     "get_attributes_for_type",
+    "get_attributes_fields_for_type",
     "get_default_fields_for_type",
 
     "get_project_anatomy_preset",
@@ -295,6 +319,11 @@ __all__ = (
     "get_addons_project_settings",
     "get_addons_settings",
 
+    "get_secrets",
+    "get_secret",
+    "save_secret",
+    "delete_secret",
+
     "get_project_names",
     "get_projects",
     "get_project",
@@ -308,6 +337,8 @@ __all__ = (
     "get_folders",
 
     "get_tasks",
+    "get_task_by_id",
+    "get_task_by_name",
 
     "get_folder_ids_with_products",
     "get_product_by_id",
@@ -338,6 +369,7 @@ __all__ = (
     "get_workfile_info",
     "get_workfile_info_by_id",
 
+    "get_thumbnail_by_id",
     "get_thumbnail",
     "get_folder_thumbnail",
     "get_version_thumbnail",

{ayon-python-api-0.3.4 → ayon-python-api-0.3.6}/ayon_api/_api.py

@@ -392,6 +392,28 @@ def set_default_settings_variant(variant):
     return con.set_default_settings_variant(variant)
 
 
+def get_sender():
+    """Sender used to send requests.
+
+    Returns:
+        Union[str, None]: Sender name or None.
+    """
+
+    con = get_server_api_connection()
+    return con.get_sender()
+
+
+def set_sender(sender):
+    """Change sender used for requests.
+
+    Args:
+        sender (Union[str, None]): Sender name or None.
+    """
+
+    con = get_server_api_connection()
+    return con.set_sender(sender)
+
+
 def get_base_url():
     con = get_server_api_connection()
     return con.get_base_url()
@@ -452,6 +474,26 @@ def delete(*args, **kwargs):
     return con.delete(*args, **kwargs)
 
 
+def get_timeout(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_timeout(*args, **kwargs)
+
+
+def set_timeout(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.set_timeout(*args, **kwargs)
+
+
+def get_max_retries(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_max_retries(*args, **kwargs)
+
+
+def set_max_retries(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.set_max_retries(*args, **kwargs)
+
+
 def get_event(*args, **kwargs):
     con = get_server_api_connection()
     return con.get_event(*args, **kwargs)
@@ -704,6 +746,26 @@ def get_addons_settings(*args, **kwargs):
     return con.get_addons_settings(*args, **kwargs)
 
 
+def get_secrets(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_secrets(*args, **kwargs)
+
+
+def get_secret(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.delete_secret(*args, **kwargs)
+
+
+def save_secret(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.delete_secret(*args, **kwargs)
+
+
+def delete_secret(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.delete_secret(*args, **kwargs)
+
+
 def get_project_names(*args, **kwargs):
     con = get_server_api_connection()
     return con.get_project_names(*args, **kwargs)
@@ -734,6 +796,16 @@ def get_tasks(*args, **kwargs):
     return con.get_tasks(*args, **kwargs)
 
 
+def get_task_by_id(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_task_by_id(*args, **kwargs)
+
+
+def get_task_by_name(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_task_by_name(*args, **kwargs)
+
+
 def get_folder_by_id(*args, **kwargs):
     con = get_server_api_connection()
     return con.get_folder_by_id(*args, **kwargs)
@@ -904,6 +976,11 @@ def delete_project(project_name):
     return con.delete_project(project_name)
 
 
+def get_thumbnail_by_id(project_name, thumbnail_id):
+    con = get_server_api_connection()
+    con.get_thumbnail_by_id(project_name, thumbnail_id)
+
+
 def get_thumbnail(project_name, entity_type, entity_id, thumbnail_id=None):
     con = get_server_api_connection()
     con.get_thumbnail(project_name, entity_type, entity_id, thumbnail_id)
@@ -934,6 +1011,11 @@ def update_thumbnail(project_name, thumbnail_id, src_filepath):
     return con.update_thumbnail(project_name, thumbnail_id, src_filepath)
 
 
+def get_attributes_fields_for_type(entity_type):
+    con = get_server_api_connection()
+    return con.get_attributes_fields_for_type(entity_type)
+
+
 def get_default_fields_for_type(entity_type):
     con = get_server_api_connection()
     return con.get_default_fields_for_type(entity_type)

{ayon-python-api-0.3.4 → ayon-python-api-0.3.6}/ayon_api/constants.py

@@ -1,9 +1,31 @@
 # Environments where server url and api key are stored for global connection
 SERVER_URL_ENV_KEY = "AYON_SERVER_URL"
 SERVER_API_ENV_KEY = "AYON_API_KEY"
+SERVER_TIMEOUT_ENV_KEY = "AYON_SERVER_TIMEOUT"
+SERVER_RETRIES_ENV_KEY = "AYON_SERVER_RETRIES"
+
 # Backwards compatibility
 SERVER_TOKEN_ENV_KEY = SERVER_API_ENV_KEY
 
+# --- User ---
+DEFAULT_USER_FIELDS = {
+    "roles",
+    "name",
+    "isService",
+    "isManager",
+    "isGuest",
+    "isAdmin",
+    "defaultRoles",
+    "createdAt",
+    "active",
+    "hasPassword",
+    "updatedAt",
+    "apiKeyPreview",
+    "attrib.avatarUrl",
+    "attrib.email",
+    "attrib.fullName",
+}
+
 # --- Product types ---
 DEFAULT_PRODUCT_TYPE_FIELDS = {
     "name",

{ayon-python-api-0.3.4 → ayon-python-api-0.3.6}/ayon_api/graphql_queries.py

@@ -247,9 +247,11 @@ def products_graphql_query(fields):
     query = GraphQlQuery("ProductsQuery")
 
     project_name_var = query.add_variable("projectName", "String!")
-    folder_ids_var = query.add_variable("folderIds", "[String!]")
     product_ids_var = query.add_variable("productIds", "[String!]")
     product_names_var = query.add_variable("productNames", "[String!]")
+    folder_ids_var = query.add_variable("folderIds", "[String!]")
+    product_types_var = query.add_variable("productTypes", "[String!]")
+    statuses_var = query.add_variable("statuses", "[String!]")
 
     project_field = query.add_field("project")
     project_field.set_filter("name", project_name_var)
@@ -258,6 +260,8 @@ def products_graphql_query(fields):
     products_field.set_filter("ids", product_ids_var)
     products_field.set_filter("names", product_names_var)
     products_field.set_filter("folderIds", folder_ids_var)
+    products_field.set_filter("productTypes", product_types_var)
+    products_field.set_filter("statuses", statuses_var)
 
     nested_fields = fields_to_dict(set(fields))
     add_links_fields(products_field, nested_fields)
@@ -462,3 +466,28 @@ def events_graphql_query(fields):
         for k, v in value.items():
             query_queue.append((k, v, field))
     return query
+
+
+def users_graphql_query(fields):
+    query = GraphQlQuery("Users")
+    names_var = query.add_variable("userNames", "[String!]")
+
+    users_field = query.add_field_with_edges("users")
+    users_field.set_filter("names", names_var)
+
+    nested_fields = fields_to_dict(set(fields))
+
+    query_queue = collections.deque()
+    for key, value in nested_fields.items():
+        query_queue.append((key, value, users_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

{ayon-python-api-0.3.4 → ayon-python-api-0.3.6}/ayon_api/operations.py

@@ -1,3 +1,4 @@
+import os
 import copy
 import collections
 import uuid
@@ -22,6 +23,8 @@ def new_folder_entity(
     name,
     folder_type,
     parent_id=None,
+    status=None,
+    tags=None,
     attribs=None,
     data=None,
     thumbnail_id=None,
@@ -32,12 +35,14 @@ def new_folder_entity(
     Args:
         name (str): Is considered as unique identifier of folder in project.
         folder_type (str): Type of folder.
-        parent_id (Optional[str]]): Id of parent folder.
+        parent_id (Optional[str]): Parent folder id.
+        status (Optional[str]): Product status.
+        tags (Optional[List[str]]): List of tags.
         attribs (Optional[Dict[str, Any]]): Explicitly set attributes
             of folder.
         data (Optional[Dict[str, Any]]): Custom folder data. Empty dictionary
             is used if not passed.
-        thumbnail_id (Optional[str]): Id of thumbnail related to folder.
+        thumbnail_id (Optional[str]): Thumbnail id related to folder.
         entity_id (Optional[str]): Predefined id of entity. New id is
             created if not passed.
 
@@ -54,7 +59,7 @@ def new_folder_entity(
     if parent_id is not None:
         parent_id = _create_or_convert_to_id(parent_id)
 
-    return {
+    output = {
         "id": _create_or_convert_to_id(entity_id),
         "name": name,
         # This will be ignored
@@ -64,6 +69,11 @@ def new_folder_entity(
         "attrib": attribs,
         "thumbnailId": thumbnail_id
     }
+    if status:
+        output["status"] = status
+    if tags:
+        output["tags"] = tags
+    return output
 
 
 def new_product_entity(
@@ -71,6 +81,7 @@ def new_product_entity(
     product_type,
     folder_id,
     status=None,
+    tags=None,
     attribs=None,
     data=None,
     entity_id=None
@@ -81,8 +92,9 @@ def new_product_entity(
         name (str): Is considered as unique identifier of
             product under folder.
         product_type (str): Product type.
-        folder_id (str): Id of parent folder.
+        folder_id (str): Parent folder id.
         status (Optional[str]): Product status.
+        tags (Optional[List[str]]): List of tags.
         attribs (Optional[Dict[str, Any]]): Explicitly set attributes
             of product.
         data (Optional[Dict[str, Any]]): product entity data. Empty dictionary
@@ -110,6 +122,8 @@ def new_product_entity(
     }
     if status:
         output["status"] = status
+    if tags:
+        output["tags"] = tags
     return output
 
 
@@ -119,6 +133,8 @@ def new_version_entity(
     task_id=None,
     thumbnail_id=None,
     author=None,
+    status=None,
+    tags=None,
     attribs=None,
     data=None,
     entity_id=None
@@ -128,10 +144,12 @@ def new_version_entity(
     Args:
         version (int): Is considered as unique identifier of version
             under product.
-        product_id (str): Id of parent product.
-        task_id (Optional[str]]): Id of task under which product was created.
-        thumbnail_id (Optional[str]]): Thumbnail related to version.
-        author (Optional[str]]): Name of version author.
+        product_id (str): Parent product id.
+        task_id (Optional[str]): Task id under which product was created.
+        thumbnail_id (Optional[str]): Thumbnail related to version.
+        author (Optional[str]): Name of version author.
+        status (Optional[str]): Version status.
+        tags (Optional[List[str]]): List of tags.
         attribs (Optional[Dict[str, Any]]): Explicitly set attributes
             of version.
         data (Optional[Dict[str, Any]]): Version entity custom data.
@@ -164,6 +182,10 @@ def new_version_entity(
         output["thumbnailId"] = thumbnail_id
     if author:
         output["author"] = author
+    if tags:
+        output["tags"] = tags
+    if status:
+        output["status"] = status
     return output
 
 
@@ -173,6 +195,8 @@ def new_hero_version_entity(
     task_id=None,
     thumbnail_id=None,
     author=None,
+    status=None,
+    tags=None,
     attribs=None,
     data=None,
     entity_id=None
@@ -182,10 +206,12 @@ def new_hero_version_entity(
     Args:
         version (int): Is considered as unique identifier of version
             under product. Should be same as standard version if there is any.
-        product_id (str): Id of parent product.
-        task_id (Optional[str]): Id of task under which product was created.
+        product_id (str): Parent product id.
+        task_id (Optional[str]): Task id under which product was created.
         thumbnail_id (Optional[str]): Thumbnail related to version.
         author (Optional[str]): Name of version author.
+        status (Optional[str]): Version status.
+        tags (Optional[List[str]]): List of tags.
         attribs (Optional[Dict[str, Any]]): Explicitly set attributes
             of version.
         data (Optional[Dict[str, Any]]): Version entity data.
@@ -215,18 +241,32 @@ def new_hero_version_entity(
         output["thumbnailId"] = thumbnail_id
     if author:
         output["author"] = author
+    if tags:
+        output["tags"] = tags
+    if status:
+        output["status"] = status
     return output
 
 
 def new_representation_entity(
-    name, version_id, attribs=None, data=None, entity_id=None
+    name,
+    version_id,
+    files,
+    status=None,
+    tags=None,
+    attribs=None,
+    data=None,
+    entity_id=None
 ):
     """Create skeleton data of representation entity.
 
     Args:
         name (str): Representation name considered as unique identifier
             of representation under version.
-        version_id (str): Id of parent version.
+        version_id (str): Parent version id.
+        files (list[dict[str, str]]): List of files in representation.
+        status (Optional[str]): Representation status.
+        tags (Optional[List[str]]): List of tags.
         attribs (Optional[Dict[str, Any]]): Explicitly set attributes
             of representation.
         data (Optional[Dict[str, Any]]): Representation entity data.
@@ -243,27 +283,42 @@ def new_representation_entity(
     if data is None:
         data = {}
 
-    return {
+    output = {
         "id": _create_or_convert_to_id(entity_id),
         "versionId": _create_or_convert_to_id(version_id),
+        "files": files,
         "name": name,
         "data": data,
         "attrib": attribs
     }
+    if tags:
+        output["tags"] = tags
+    if status:
+        output["status"] = status
+    return output
 
 
-def new_workfile_info_doc(
-    filename, folder_id, task_name, files, data=None, entity_id=None
+def new_workfile_info(
+    filepath,
+    task_id,
+    status=None,
+    tags=None,
+    attribs=None,
+    description=None,
+    data=None,
+    entity_id=None
 ):
     """Create skeleton data of workfile info entity.
 
     Workfile entity is at this moment used primarily for artist notes.
 
     Args:
-        filename (str): Filename of workfile.
-        folder_id (str): Id of folder under which workfile live.
-        task_name (str): Task under which was workfile created.
-        files (List[str]): List of rootless filepaths related to workfile.
+        filepath (str): Rootless workfile filepath.
+        task_id (str): Task under which was workfile created.
+        status (Optional[str]): Workfile status.
+        tags (Optional[List[str]]): Workfile tags.
+        attribs (Options[dic[str, Any]]): Explicitly set attributes.
+        description (Optional[str]): Workfile description.
         data (Optional[Dict[str, Any]]): Additional metadata.
         entity_id (Optional[str]): Predefined id of entity. New id is created
             if not passed.
@@ -272,17 +327,31 @@ def new_workfile_info_doc(
         Dict[str, Any]: Skeleton of workfile info entity.
     """
 
+    if attribs is None:
+        attribs = {}
+
+    if "extension" not in attribs:
+        attribs["extension"] = os.path.splitext(filepath)[-1]
+
+    if description:
+        attribs["description"] = description
+
     if not data:
         data = {}
 
-    return {
+    output = {
         "id": _create_or_convert_to_id(entity_id),
-        "parent": _create_or_convert_to_id(folder_id),
-        "task_name": task_name,
-        "filename": filename,
+        "taskId": task_id,
+        "path": filepath,
         "data": data,
-        "files": files
+        "attrib": attribs
     }
+    if status:
+        output["status"] = status
+
+    if tags:
+        output["tags"] = tags
+    return output
 
 
 @six.add_metaclass(ABCMeta)