ayon-python-api 1.0.5__tar.gz → 1.0.6__tar.gz

{ayon-python-api-1.0.5 → ayon-python-api-1.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ayon-python-api
-Version: 1.0.5
+Version: 1.0.6
 Summary: AYON Python API
 Home-page: https://github.com/ynput/ayon-python-api
 Author: ynput.io
@@ -212,13 +212,12 @@ Project-URL: Changelog, https://github.com/ynput/ayon-python-api/releases
 Keywords: AYON,ynput,OpenPype,vfx
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 2
 Classifier: Programming Language :: Python :: 3
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
 # AYON server API
-Python client for connection server. Client must be (at least for some time) Python 2 compatible because will be used in DCC that are "older".
+Python client for connection server. The client is using REST and GraphQl to communicate with server with `requests` module.
 
 AYON Python api should support connection to server with raw REST functions and prepared functionality for work with entities. Must not contain only functionality that can be used with core server functionality.
 

{ayon-python-api-1.0.5 → ayon-python-api-1.0.6}/README.md

@@ -1,5 +1,5 @@
 # AYON server API
-Python client for connection server. Client must be (at least for some time) Python 2 compatible because will be used in DCC that are "older".
+Python client for connection server. The client is using REST and GraphQl to communicate with server with `requests` module.
 
 AYON Python api should support connection to server with raw REST functions and prepared functionality for work with entities. Must not contain only functionality that can be used with core server functionality.
 

{ayon-python-api-1.0.5 → ayon-python-api-1.0.6}/ayon_api/__init__.py

@@ -5,6 +5,7 @@ from .utils import (
     create_dependency_package_basename,
 )
 from .server_api import (
+    RequestTypes,
     ServerAPI,
 )
 
@@ -32,6 +33,7 @@ from ._api import (
     set_timeout,
     get_max_retries,
     set_max_retries,
+    is_service_user,
     get_site_id,
     set_site_id,
     get_client_version,
@@ -60,7 +62,9 @@ from ._api import (
     update_event,
     dispatch_event,
     enroll_event_job,
+    download_file_to_stream,
     download_file,
+    upload_file_from_stream,
     upload_file,
     trigger_server_restart,
     query_graphql,
@@ -98,8 +102,12 @@ from ._api import (
     get_default_anatomy_preset_name,
     get_project_anatomy_preset,
     get_build_in_anatomy_preset,
+    get_project_root_overrides,
     get_project_roots_by_site,
+    get_project_root_overrides_by_site_id,
     get_project_roots_for_site,
+    get_project_roots_by_site_id,
+    get_project_roots_by_platform,
     get_addon_settings_schema,
     get_addon_site_settings_schema,
     get_addon_studio_settings,
@@ -170,6 +178,8 @@ from ._api import (
     get_representations,
     get_representation_by_id,
     get_representation_by_name,
+    get_representations_hierarchy,
+    get_representation_hierarchy,
     get_representations_parents,
     get_representation_parents,
     get_repre_ids_by_context_filters,
@@ -219,6 +229,7 @@ __all__ = (
     "slugify_string",
     "create_dependency_package_basename",
 
+    "RequestTypes",
     "ServerAPI",
 
     "GlobalServerAPI",
@@ -244,6 +255,7 @@ __all__ = (
     "set_timeout",
     "get_max_retries",
     "set_max_retries",
+    "is_service_user",
     "get_site_id",
     "set_site_id",
     "get_client_version",
@@ -272,7 +284,9 @@ __all__ = (
     "update_event",
     "dispatch_event",
     "enroll_event_job",
+    "download_file_to_stream",
     "download_file",
+    "upload_file_from_stream",
     "upload_file",
     "trigger_server_restart",
     "query_graphql",
@@ -310,8 +324,12 @@ __all__ = (
     "get_default_anatomy_preset_name",
     "get_project_anatomy_preset",
     "get_build_in_anatomy_preset",
+    "get_project_root_overrides",
     "get_project_roots_by_site",
+    "get_project_root_overrides_by_site_id",
     "get_project_roots_for_site",
+    "get_project_roots_by_site_id",
+    "get_project_roots_by_platform",
     "get_addon_settings_schema",
     "get_addon_site_settings_schema",
     "get_addon_studio_settings",
@@ -382,6 +400,8 @@ __all__ = (
     "get_representations",
     "get_representation_by_id",
     "get_representation_by_name",
+    "get_representations_hierarchy",
+    "get_representation_hierarchy",
     "get_representations_parents",
     "get_representation_parents",
     "get_repre_ids_by_context_filters",

{ayon-python-api-1.0.5 → ayon-python-api-1.0.6}/ayon_api/_api.py

@@ -328,7 +328,9 @@ def get_server_api_connection():
     """
     return GlobalContext.get_server_api_connection()
 
-
+# ------------------------------------------------
+#     This content is generated automatically.
+# ------------------------------------------------
 def get_base_url():
     con = get_server_api_connection()
     return con.get_base_url()
@@ -428,6 +430,17 @@ def set_max_retries(*args, **kwargs):
     return con.set_max_retries(*args, **kwargs)
 
 
+def is_service_user():
+    """Check if connection is using service API key.
+
+    Returns:
+        bool: Used api key belongs to service user.
+
+    """
+    con = get_server_api_connection()
+    return con.is_service_user()
+
+
 def get_site_id():
     """Site id used for connection.
 
@@ -788,6 +801,32 @@ def enroll_event_job(*args, **kwargs):
     return con.enroll_event_job(*args, **kwargs)
 
 
+def download_file_to_stream(*args, **kwargs):
+    """Download file from AYON server to IOStream.
+
+    Endpoint can be full url (must start with 'base_url' of api object).
+
+    Progress object can be used to track download. Can be used when
+    download happens in thread and other thread want to catch changes over
+    time.
+
+    Todos:
+        Use retries and timeout.
+        Return RestApiResponse.
+
+    Args:
+        endpoint (str): Endpoint or URL to file that should be downloaded.
+        stream (Union[io.BytesIO, BinaryIO]): Stream where output will be stored.
+        chunk_size (Optional[int]): Size of chunks that are received
+            in single loop.
+        progress (Optional[TransferProgress]): Object that gives ability
+            to track download progress.
+
+    """
+    con = get_server_api_connection()
+    return con.download_file_to_stream(*args, **kwargs)
+
+
 def download_file(*args, **kwargs):
     """Download file from AYON server.
 
@@ -814,6 +853,31 @@ def download_file(*args, **kwargs):
     return con.download_file(*args, **kwargs)
 
 
+def upload_file_from_stream(*args, **kwargs):
+    """Upload file to server from bytes.
+
+    Todos:
+        Use retries and timeout.
+        Return RestApiResponse.
+
+    Args:
+        endpoint (str): Endpoint or url where file will be uploaded.
+        stream (Union[io.BytesIO, BinaryIO]): File content stream.
+        progress (Optional[TransferProgress]): Object that gives ability
+            to track upload progress.
+        request_type (Optional[RequestType]): Type of request that will
+            be used to upload file.
+        **kwargs (Any): Additional arguments that will be passed
+            to request function.
+
+    Returns:
+        requests.Response: Response object
+
+    """
+    con = get_server_api_connection()
+    return con.upload_file_from_stream(*args, **kwargs)
+
+
 def upload_file(*args, **kwargs):
     """Upload file to server.
 
@@ -1475,6 +1539,25 @@ def get_build_in_anatomy_preset():
     return con.get_build_in_anatomy_preset()
 
 
+def get_project_root_overrides(*args, **kwargs):
+    """Root overrides per site name.
+
+    Method is based on logged user and can't be received for any other
+        user on server.
+
+    Output will contain only roots per site id used by logged user.
+
+    Args:
+        project_name (str): Name of project.
+
+    Returns:
+         dict[str, dict[str, str]]: Root values by root name by site id.
+
+    """
+    con = get_server_api_connection()
+    return con.get_project_root_overrides(*args, **kwargs)
+
+
 def get_project_roots_by_site(*args, **kwargs):
     """Root overrides per site name.
 
@@ -1483,6 +1566,10 @@ def get_project_roots_by_site(*args, **kwargs):
 
     Output will contain only roots per site id used by logged user.
 
+    Deprecated:
+        Use 'get_project_root_overrides' instead. Function
+            deprecated since 1.0.6
+
     Args:
         project_name (str): Name of project.
 
@@ -1494,7 +1581,7 @@ def get_project_roots_by_site(*args, **kwargs):
     return con.get_project_roots_by_site(*args, **kwargs)
 
 
-def get_project_roots_for_site(*args, **kwargs):
+def get_project_root_overrides_by_site_id(*args, **kwargs):
     """Root overrides for site.
 
     If site id is not passed a site set in current api object is used
@@ -1509,11 +1596,76 @@ def get_project_roots_for_site(*args, **kwargs):
         dict[str, str]: Root values by root name or None if
             site does not have overrides.
 
+    """
+    con = get_server_api_connection()
+    return con.get_project_root_overrides_by_site_id(*args, **kwargs)
+
+
+def get_project_roots_for_site(*args, **kwargs):
+    """Root overrides for site.
+
+    If site id is not passed a site set in current api object is used
+    instead.
+
+    Deprecated:
+        Use 'get_project_root_overrides_by_site_id' instead. Function
+            deprecated since 1.0.6
+    Args:
+        project_name (str): Name of project.
+        site_id (Optional[str]): Site id for which want to receive
+            site overrides.
+
+    Returns:
+        dict[str, str]: Root values by root name, root name is not
+            available if it does not have overrides.
+
     """
     con = get_server_api_connection()
     return con.get_project_roots_for_site(*args, **kwargs)
 
 
+def get_project_roots_by_site_id(*args, **kwargs):
+    """Root values for a site.
+
+    If site id is not passed a site set in current api object is used
+    instead. If site id is not available, default roots are returned
+    for current platform.
+
+    Args:
+        project_name (str): Name of project.
+        site_id (Optional[str]): Site id for which want to receive
+            root values.
+
+    Returns:
+        dict[str, str]: Root values.
+
+    """
+    con = get_server_api_connection()
+    return con.get_project_roots_by_site_id(*args, **kwargs)
+
+
+def get_project_roots_by_platform(*args, **kwargs):
+    """Root values for a site.
+
+    If platform name is not passed current platform name is used instead.
+
+    This function does return root values without site overrides. It is
+        possible to use the function to receive default root values.
+
+    Args:
+        project_name (str): Name of project.
+        platform_name (Optional[Literal["windows", "linux", "darwin"]]):
+            Platform name for which want to receive root values. Current
+            platform name is used if not passed.
+
+    Returns:
+        dict[str, str]: Root values.
+
+    """
+    con = get_server_api_connection()
+    return con.get_project_roots_by_platform(*args, **kwargs)
+
+
 def get_addon_settings_schema(*args, **kwargs):
     """Sudio/Project settings schema of an addon.
 
@@ -2604,8 +2756,8 @@ def get_products(*args, **kwargs):
         fields (Optional[Iterable[str]]): Fields to be queried for
             folder. All possible folder fields are returned
             if 'None' is passed.
-        own_attributes (Optional[bool]): Attribute values that are
-            not explicitly set on entity will have 'None' value.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            products.
 
     Returns:
         Generator[dict[str, Any]]: Queried product entities.
@@ -2624,8 +2776,8 @@ def get_product_by_id(*args, **kwargs):
         product_id (str): Product id.
         fields (Optional[Iterable[str]]): Fields that should be returned.
             All fields are returned if 'None' is passed.
-        own_attributes (Optional[bool]): Attribute values that are
-            not explicitly set on entity will have 'None' value.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            products.
 
     Returns:
         Union[dict, None]: Product entity data or None if was not found.
@@ -2645,8 +2797,8 @@ def get_product_by_name(*args, **kwargs):
         folder_id (str): Folder id (Folder is a parent of products).
         fields (Optional[Iterable[str]]): Fields that should be returned.
             All fields are returned if 'None' is passed.
-        own_attributes (Optional[bool]): Attribute values that are
-            not explicitly set on entity will have 'None' value.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            products.
 
     Returns:
         Union[dict, None]: Product entity data or None if was not found.
@@ -2798,8 +2950,8 @@ def get_versions(*args, **kwargs):
         fields (Optional[Iterable[str]]): Fields to be queried
             for version. All possible folder fields are returned
             if 'None' is passed.
-        own_attributes (Optional[bool]): Attribute values that are
-            not explicitly set on entity will have 'None' value.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            versions.
 
     Returns:
         Generator[dict[str, Any]]: Queried version entities.
@@ -2818,8 +2970,8 @@ def get_version_by_id(*args, **kwargs):
         version_id (str): Version id.
         fields (Optional[Iterable[str]]): Fields that should be returned.
             All fields are returned if 'None' is passed.
-        own_attributes (Optional[bool]): Attribute values that are
-            not explicitly set on entity will have 'None' value.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            versions.
 
     Returns:
         Union[dict, None]: Version entity data or None if was not found.
@@ -2839,8 +2991,8 @@ def get_version_by_name(*args, **kwargs):
         product_id (str): Product id. Product is a parent of version.
         fields (Optional[Iterable[str]]): Fields that should be returned.
             All fields are returned if 'None' is passed.
-        own_attributes (Optional[bool]): Attribute values that are
-            not explicitly set on entity will have 'None' value.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            versions.
 
     Returns:
         Union[dict, None]: Version entity data or None if was not found.
@@ -2859,8 +3011,8 @@ def get_hero_version_by_id(*args, **kwargs):
         version_id (int): Hero version id.
         fields (Optional[Iterable[str]]): Fields that should be returned.
             All fields are returned if 'None' is passed.
-        own_attributes (Optional[bool]): Attribute values that are
-            not explicitly set on entity will have 'None' value.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            versions.
 
     Returns:
         Union[dict, None]: Version entity data or None if was not found.
@@ -2881,8 +3033,8 @@ def get_hero_version_by_product_id(*args, **kwargs):
         product_id (int): Product id.
         fields (Optional[Iterable[str]]): Fields that should be returned.
             All fields are returned if 'None' is passed.
-        own_attributes (Optional[bool]): Attribute values that are
-            not explicitly set on entity will have 'None' value.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            versions.
 
     Returns:
         Union[dict, None]: Version entity data or None if was not found.
@@ -2906,8 +3058,8 @@ def get_hero_versions(*args, **kwargs):
             Both are returned when 'None' is passed.
         fields (Optional[Iterable[str]]): Fields that should be returned.
             All fields are returned if 'None' is passed.
-        own_attributes (Optional[bool]): Attribute values that are
-            not explicitly set on entity will have 'None' value.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            versions.
 
     Returns:
         Union[dict, None]: Version entity data or None if was not found.
@@ -2927,8 +3079,8 @@ def get_last_versions(*args, **kwargs):
             Both are returned when 'None' is passed.
         fields (Optional[Iterable[str]]): fields to be queried
             for representations.
-        own_attributes (Optional[bool]): Attribute values that are
-            not explicitly set on entity will have 'None' value.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            versions.
 
     Returns:
         dict[str, dict[str, Any]]: Last versions by product id.
@@ -2948,8 +3100,8 @@ def get_last_version_by_product_id(*args, **kwargs):
             Both are returned when 'None' is passed.
         fields (Optional[Iterable[str]]): fields to be queried
             for representations.
-        own_attributes (Optional[bool]): Attribute values that are
-            not explicitly set on entity will have 'None' value.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            versions.
 
     Returns:
         Union[dict[str, Any], None]: Queried version entity or None.
@@ -2970,8 +3122,8 @@ def get_last_version_by_product_name(*args, **kwargs):
             Both are returned when 'None' is passed.
         fields (Optional[Iterable[str]]): fields to be queried
             for representations.
-        own_attributes (Optional[bool]): Attribute values that are
-            not explicitly set on entity will have 'None' value.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            representations.
 
     Returns:
         Union[dict[str, Any], None]: Queried version entity or None.
@@ -3094,8 +3246,8 @@ def get_representations(*args, **kwargs):
         fields (Optional[Iterable[str]]): Fields to be queried for
             representation. All possible fields are returned if 'None' is
             passed.
-        own_attributes (Optional[bool]): Attribute values that are
-            not explicitly set on entity will have 'None' value.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            representations.
 
     Returns:
         Generator[dict[str, Any]]: Queried representation entities.
@@ -3113,8 +3265,8 @@ def get_representation_by_id(*args, **kwargs):
         representation_id (str): Id of representation.
         fields (Optional[Iterable[str]]): fields to be queried
             for representations.
-        own_attributes (Optional[bool]): Attribute values that are
-            not explicitly set on entity will have 'None' value.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            representations.
 
     Returns:
         Union[dict[str, Any], None]: Queried representation entity or None.
@@ -3133,8 +3285,8 @@ def get_representation_by_name(*args, **kwargs):
         version_id (str): Version id.
         fields (Optional[Iterable[str]]): fields to be queried
             for representations.
-        own_attributes (Optional[bool]): Attribute values that are
-            not explicitly set on entity will have 'None' value.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            representations.
 
     Returns:
         Union[dict[str, Any], None]: Queried representation entity or None.
@@ -3144,14 +3296,69 @@ def get_representation_by_name(*args, **kwargs):
     return con.get_representation_by_name(*args, **kwargs)
 
 
+def get_representations_hierarchy(*args, **kwargs):
+    """Find representation with parents by representation id.
+
+    Representation entity with parent entities up to project.
+
+    Default fields are used when any fields are set to `None`. But it is
+        possible to pass in empty iterable (list, set, tuple) to skip
+        entity.
+
+    Args:
+        project_name (str): Project where to look for entities.
+        representation_ids (Iterable[str]): Representation ids.
+        project_fields (Optional[Iterable[str]]): Project fields.
+        folder_fields (Optional[Iterable[str]]): Folder fields.
+        product_fields (Optional[Iterable[str]]): Product fields.
+        version_fields (Optional[Iterable[str]]): Version fields.
+        representation_fields (Optional[Iterable[str]]): Representation
+            fields.
+
+    Returns:
+        dict[str, RepresentationHierarchy]: Parent entities by
+            representation id.
+
+    """
+    con = get_server_api_connection()
+    return con.get_representations_hierarchy(*args, **kwargs)
+
+
+def get_representation_hierarchy(*args, **kwargs):
+    """Find representation parents by representation id.
+
+    Representation parent entities up to project.
+
+    Args:
+        project_name (str): Project where to look for entities.
+        representation_id (str): Representation id.
+        project_fields (Optional[Iterable[str]]): Project fields.
+        folder_fields (Optional[Iterable[str]]): Folder fields.
+        product_fields (Optional[Iterable[str]]): Product fields.
+        version_fields (Optional[Iterable[str]]): Version fields.
+        representation_fields (Optional[Iterable[str]]): Representation
+            fields.
+
+    Returns:
+        RepresentationHierarchy: Representation hierarchy entities.
+
+    """
+    con = get_server_api_connection()
+    return con.get_representation_hierarchy(*args, **kwargs)
+
+
 def get_representations_parents(*args, **kwargs):
     """Find representations parents by representation id.
 
     Representation parent entities up to project.
 
     Args:
-         project_name (str): Project where to look for entities.
-         representation_ids (Iterable[str]): Representation ids.
+        project_name (str): Project where to look for entities.
+        representation_ids (Iterable[str]): Representation ids.
+        project_fields (Optional[Iterable[str]]): Project fields.
+        folder_fields (Optional[Iterable[str]]): Folder fields.
+        product_fields (Optional[Iterable[str]]): Product fields.
+        version_fields (Optional[Iterable[str]]): Version fields.
 
     Returns:
         dict[str, RepresentationParents]: Parent entities by
@@ -3168,8 +3375,12 @@ def get_representation_parents(*args, **kwargs):
     Representation parent entities up to project.
 
     Args:
-         project_name (str): Project where to look for entities.
-         representation_id (str): Representation id.
+        project_name (str): Project where to look for entities.
+        representation_id (str): Representation id.
+        project_fields (Optional[Iterable[str]]): Project fields.
+        folder_fields (Optional[Iterable[str]]): Folder fields.
+        product_fields (Optional[Iterable[str]]): Product fields.
+        version_fields (Optional[Iterable[str]]): Version fields.
 
     Returns:
         RepresentationParents: Representation parent entities.
@@ -3303,8 +3514,8 @@ def get_workfiles_info(*args, **kwargs):
         fields (Optional[Iterable[str]]): Fields to be queried for
             representation. All possible fields are returned if 'None' is
             passed.
-        own_attributes (Optional[bool]): Attribute values that are
-            not explicitly set on entity will have 'None' value.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            workfiles.
 
     Returns:
         Generator[dict[str, Any]]: Queried workfile info entites.
@@ -3324,8 +3535,8 @@ def get_workfile_info(*args, **kwargs):
         fields (Optional[Iterable[str]]): Fields to be queried for
             representation. All possible fields are returned if 'None' is
             passed.
-        own_attributes (Optional[bool]): Attribute values that are
-            not explicitly set on entity will have 'None' value.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            workfiles.
 
     Returns:
         Union[dict[str, Any], None]: Workfile info entity or None.
@@ -3344,8 +3555,8 @@ def get_workfile_info_by_id(*args, **kwargs):
         fields (Optional[Iterable[str]]): Fields to be queried for
             representation. All possible fields are returned if 'None' is
             passed.
-        own_attributes (Optional[bool]): Attribute values that are
-            not explicitly set on entity will have 'None' value.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            workfiles.
 
     Returns:
         Union[dict[str, Any], None]: Workfile info entity or None.