Ayon-Python-Api 1.0.9__tar.gz → 1.0.10__tar.gz

{ayon-python-api-1.0.9 → ayon-python-api-1.0.10}/PKG-INFO

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

{ayon-python-api-1.0.9 → ayon-python-api-1.0.10}/ayon_api/__init__.py

@@ -7,6 +7,8 @@ from .utils import (
     is_token_valid,
     validate_url,
     login_to_server,
+    take_web_action_event,
+    abort_web_action_event,
 )
 from .server_api import (
     RequestTypes,
@@ -85,6 +87,7 @@ from ._api import (
     get_attributes_fields_for_type,
     get_default_fields_for_type,
     get_addons_info,
+    get_addon_endpoint,
     get_addon_url,
     download_addon_private_file,
     get_installers,
@@ -103,6 +106,7 @@ from ._api import (
     get_bundles,
     create_bundle,
     update_bundle,
+    check_bundle_compatibility,
     delete_bundle,
     get_project_anatomy_presets,
     get_default_anatomy_preset_name,
@@ -238,6 +242,8 @@ __all__ = (
     "is_token_valid",
     "validate_url",
     "login_to_server",
+    "take_web_action_event",
+    "abort_web_action_event",
 
     "RequestTypes",
     "ServerAPI",
@@ -313,6 +319,7 @@ __all__ = (
     "get_attributes_fields_for_type",
     "get_default_fields_for_type",
     "get_addons_info",
+    "get_addon_endpoint",
     "get_addon_url",
     "download_addon_private_file",
     "get_installers",
@@ -331,6 +338,7 @@ __all__ = (
     "get_bundles",
     "create_bundle",
     "update_bundle",
+    "check_bundle_compatibility",
     "delete_bundle",
     "get_project_anatomy_presets",
     "get_default_anatomy_preset_name",

{ayon-python-api-1.0.9 → ayon-python-api-1.0.10}/ayon_api/_api.py

@@ -780,11 +780,11 @@ def dispatch_event(*args, **kwargs):
         sender (Optional[str]): Sender of event.
         event_hash (Optional[str]): Event hash.
         project_name (Optional[str]): Project name.
-        username (Optional[str]): Username which triggered event.
         depends_on (Optional[str]): Add dependency to another event.
+        username (Optional[str]): Username which triggered event.
         description (Optional[str]): Description of event.
-        summary (Optional[dict[str, Any]]): Summary of event that can be used
-            for simple filtering on listeners.
+        summary (Optional[dict[str, Any]]): Summary of event that can
+            be used for simple filtering on listeners.
         payload (Optional[dict[str, Any]]): Full payload of event data with
             all details.
         finished (Optional[bool]): Mark event as finished on dispatch.
@@ -875,7 +875,8 @@ def download_file_to_stream(*args, **kwargs):
 
     Args:
         endpoint (str): Endpoint or URL to file that should be downloaded.
-        stream (Union[io.BytesIO, BinaryIO]): Stream where output will be stored.
+        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
@@ -1155,6 +1156,30 @@ def get_addons_info(*args, **kwargs):
     return con.get_addons_info(*args, **kwargs)
 
 
+def get_addon_endpoint(*args, **kwargs):
+    """Calculate endpoint to addon route.
+
+    Examples:
+
+        >>> api = ServerAPI("https://your.url.com")
+        >>> api.get_addon_url(
+        ...     "example", "1.0.0", "private", "my.zip")
+        'addons/example/1.0.0/private/my.zip'
+
+    Args:
+        addon_name (str): Name of addon.
+        addon_version (str): Version of addon.
+        *subpaths (str): Any amount of subpaths that are added to
+            addon url.
+
+    Returns:
+        str: Final url.
+
+    """
+    con = get_server_api_connection()
+    return con.get_addon_endpoint(*args, **kwargs)
+
+
 def get_addon_url(*args, **kwargs):
     """Calculate url to addon route.
 
@@ -1163,13 +1188,14 @@ def get_addon_url(*args, **kwargs):
         >>> api = ServerAPI("https://your.url.com")
         >>> api.get_addon_url(
         ...     "example", "1.0.0", "private", "my.zip")
-        'https://your.url.com/addons/example/1.0.0/private/my.zip'
+        'https://your.url.com/api/addons/example/1.0.0/private/my.zip'
 
     Args:
         addon_name (str): Name of addon.
         addon_version (str): Version of addon.
         *subpaths (str): Any amount of subpaths that are added to
             addon url.
+        use_rest (Optional[bool]): Use rest endpoint.
 
     Returns:
         str: Final url.
@@ -1504,7 +1530,23 @@ def create_bundle(*args, **kwargs):
     """Create bundle on server.
 
     Bundle cannot be changed once is created. Only isProduction, isStaging
-    and dependency packages can change after creation.
+    and dependency packages can change after creation. In case dev bundle
+    is created, it is possible to change anything, but it is not possible
+    to mark bundle as dev and production or staging at the same time.
+
+    Development addon config can define custom path to client code. It is
+    used only for dev bundles.
+
+    Example of 'dev_addons_config'::
+
+        ```json
+        {
+            "core": {
+                "enabled": true,
+                "path": "/path/to/ayon-core/client"
+            }
+        }
+        ```
 
     Args:
         name (str): Name of bundle.
@@ -1516,6 +1558,11 @@ def create_bundle(*args, **kwargs):
         is_production (Optional[bool]): Bundle will be marked as
             production.
         is_staging (Optional[bool]): Bundle will be marked as staging.
+        is_dev (Optional[bool]): Bundle will be marked as dev.
+        dev_active_user (Optional[str]): Username that will be assigned
+            to dev bundle. Can be used only if 'is_dev' is set to 'True'.
+        dev_addons_config (Optional[dict[str, Any]]): Configuration for
+            dev addons. Can be used only if 'is_dev' is set to 'True'.
 
     """
     con = get_server_api_connection()
@@ -1531,17 +1578,55 @@ def update_bundle(*args, **kwargs):
 
     Args:
         bundle_name (str): Name of bundle.
+        addon_versions (Optional[dict[str, str]]): Addon versions,
+            possible only for dev bundles.
+        installer_version (Optional[str]): Installer version, possible
+            only for dev bundles.
         dependency_packages (Optional[dict[str, str]]): Dependency pacakge
             names that should be used with the bundle.
         is_production (Optional[bool]): Bundle will be marked as
             production.
         is_staging (Optional[bool]): Bundle will be marked as staging.
+        is_dev (Optional[bool]): Bundle will be marked as dev.
+        dev_active_user (Optional[str]): Username that will be assigned
+            to dev bundle. Can be used only for dev bundles.
+        dev_addons_config (Optional[dict[str, Any]]): Configuration for
+            dev addons. Can be used only for dev bundles.
 
     """
     con = get_server_api_connection()
     return con.update_bundle(*args, **kwargs)
 
 
+def check_bundle_compatibility(*args, **kwargs):
+    """Check bundle compatibility.
+
+    Can be used as per-flight validation before creating bundle.
+
+    Args:
+        name (str): Name of bundle.
+        addon_versions (dict[str, str]): Addon versions.
+        installer_version (Union[str, None]): Installer version.
+        dependency_packages (Optional[dict[str, str]]): Dependency
+            package names. Keys are platform names and values are name of
+            packages.
+        is_production (Optional[bool]): Bundle will be marked as
+            production.
+        is_staging (Optional[bool]): Bundle will be marked as staging.
+        is_dev (Optional[bool]): Bundle will be marked as dev.
+        dev_active_user (Optional[str]): Username that will be assigned
+            to dev bundle. Can be used only if 'is_dev' is set to 'True'.
+        dev_addons_config (Optional[dict[str, Any]]): Configuration for
+            dev addons. Can be used only if 'is_dev' is set to 'True'.
+
+    Returns:
+        Dict[str, Any]: Server response, with 'success' and 'issues'.
+
+    """
+    con = get_server_api_connection()
+    return con.check_bundle_compatibility(*args, **kwargs)
+
+
 def delete_bundle(*args, **kwargs):
     """Delete bundle from server.
 
@@ -2367,8 +2452,8 @@ def get_folders(*args, **kwargs):
     """Query folders from server.
 
     Todos:
-        Folder name won't be unique identifier, so we should add folder path
-            filtering.
+        Folder name won't be unique identifier, so we should add
+            folder path filtering.
 
     Notes:
         Filter 'active' don't have direct filter in GraphQl.

{ayon-python-api-1.0.9 → ayon-python-api-1.0.10}/ayon_api/entity_hub.py

@@ -2,10 +2,17 @@ import re
 import copy
 import collections
 from abc import ABC, abstractmethod
+import typing
 
 from ._api import get_server_api_connection
 from .utils import create_entity_id, convert_entity_id, slugify_string
 
+if typing.TYPE_CHECKING:
+    from typing import Literal
+
+    StatusState = Literal["not_started", "in_progress", "done", "blocked"]
+    EntityType = Literal["project", "folder", "task"]
+
 
 class _CustomNone(object):
     def __init__(self, name=None):
@@ -44,7 +51,7 @@ class EntityHub(object):
             key on entities. This is not recommended as 'data' may be use for
             secure information and would also slow down server queries. Content
             of 'data' key can't be received only GraphQl.
-            
+
     """
 
     def __init__(
@@ -129,8 +136,8 @@ class EntityHub(object):
             Use attribute schema to validate values on entities.
 
         Args:
-            entity_type (Literal["project", "folder", "task"]): Entity type
-                for which should be attributes received.
+            entity_type (EntityType): Entity type for which should
+                be attributes received.
 
         Returns:
             Dict[str, Dict[str, Any]]: Attribute schemas that are available
@@ -259,8 +266,8 @@ class EntityHub(object):
         Args:
             folder_type (str): Type of folder. Folder type must be available in
                 config of project folder types.
-            entity_id (Union[str, None]): Id of the entity. New id is created if
-                not passed.
+            entity_id (Union[str, None]): Id of the entity. New id is created
+                if not passed.
             parent_id (Union[str, None]): Id of parent entity.
             name (str): Name of entity.
             label (Optional[str]): Folder label.
@@ -289,8 +296,8 @@ class EntityHub(object):
         Args:
             task_type (str): Type of task. Task type must be available in
                 config of project folder types.
-            entity_id (Union[str, None]): Id of the entity. New id is created if
-                not passed.
+            entity_id (Union[str, None]): Id of the entity. New id is created
+                if not passed.
             parent_id (Union[str, None]): Id of parent entity.
             name (str): Name of entity.
             label (Optional[str]): Folder label.
@@ -579,10 +586,16 @@ class EntityHub(object):
             raise ValueError(
                 "Project \"{}\" was not found.".format(project_name)
             )
-
+        major, minor, _, _, _ = self._connection.get_server_version_tuple()
+        status_scope_supported = True
+        if (major, minor) < (1, 5):
+            status_scope_supported = False
         self._project_entity = ProjectEntity.from_entity_data(
             project, self
         )
+        self._project_entity.set_status_scope_supported(
+            status_scope_supported
+        )
 
         self.add_entity(self._project_entity)
         return self._project_entity
@@ -734,8 +747,8 @@ class EntityHub(object):
         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.
+            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.
 
@@ -1247,7 +1260,7 @@ class BaseEntity(ABC):
         """Entity type coresponding to server.
 
         Returns:
-            Literal[project, folder, task]: Entity type.
+            EntityType: Entity type.
 
         """
         pass
@@ -1473,7 +1486,7 @@ class BaseEntity(ABC):
 
         Raises:
             TypeError: If validation of parent does not pass.
-            
+
         """
         parent_id = None
         if parent is not None:
@@ -1604,16 +1617,19 @@ class ProjectStatus:
     Args:
         name (str): Name of the status. e.g. 'In progress'
         short_name (Optional[str]): Short name of the status. e.g. 'IP'
-        state (Optional[Literal[not_started, in_progress, done, blocked]]): A
-            state of the status.
+        state (Optional[StatusState]): A state of the status.
         icon (Optional[str]): Icon of the status. e.g. 'play_arrow'.
         color (Optional[str]): Color of the status. e.g. '#eeeeee'.
+        scope (Optional[Iterable[str]]): Scope of the status. e.g. ['folder'].
         index (Optional[int]): Index of the status.
         project_statuses (Optional[_ProjectStatuses]): Project statuses
             wrapper.
 
     """
-    valid_states = ("not_started", "in_progress", "done", "blocked")
+    valid_states = {"not_started", "in_progress", "done", "blocked"}
+    valid_scope = {
+        "folder", "task", "product", "version", "representation", "workfile"
+    }
     color_regex = re.compile(r"#([a-f0-9]{6})$")
     default_state = "in_progress"
     default_color = "#eeeeee"
@@ -1625,6 +1641,7 @@ class ProjectStatus:
         state=None,
         icon=None,
         color=None,
+        scope=None,
         index=None,
         project_statuses=None,
         is_new=None,
@@ -1633,12 +1650,16 @@ class ProjectStatus:
         icon = icon or ""
         state = state or self.default_state
         color = color or self.default_color
+        if scope is None:
+            scope = self.valid_scope
+        scope = set(scope)
         self._name = name
         self._short_name = short_name
         self._icon = icon
         self._slugified_name = None
         self._state = None
         self._color = None
+        self._scope = scope
         self.set_state(state)
         self.set_color(color)
 
@@ -1647,6 +1668,7 @@ class ProjectStatus:
         self._original_icon = icon
         self._original_state = state
         self._original_color = color
+        self._original_scope = set(scope)
         self._original_index = index
 
         self._index = index
@@ -1690,8 +1712,14 @@ class ProjectStatus:
         self._original_icon = self.icon
         self._original_state = self.state
         self._original_color = self.color
+        self._original_scope = self.scope
         self._original_index = self.index
 
+    def is_available_for_entity_type(self, entity_type):
+        if self._scope is None:
+            return True
+        return entity_type in self._scope
+
     @staticmethod
     def slugify_name(name):
         """Slugify status name for name comparison.
@@ -1750,6 +1778,7 @@ class ProjectStatus:
             or self._original_state != self._state
             or self._original_icon != self._icon
             or self._original_color != self._color
+            or self._original_scope != self._scope
         )
 
     def delete(self):
@@ -1864,8 +1893,7 @@ class ProjectStatus:
         """Get state of project status.
 
         Return:
-            Literal[not_started, in_progress, done, blocked]: General
-                state of status.
+            StatusState: General state of status.
 
         """
         return self._state
@@ -1874,8 +1902,7 @@ class ProjectStatus:
         """Set color of project status.
 
         Args:
-            state (Literal[not_started, in_progress, done, blocked]): General
-                state of status.
+            state (StatusState): General state of status.
 
         """
         if state not in self.valid_states:
@@ -1906,6 +1933,36 @@ class ProjectStatus:
             raise ValueError("Invalid color value '{}'".format(color))
         self._color = color
 
+    def get_scope(self):
+        """Get scope of the status.
+
+        Returns:
+            Set[str]: Scope of the status.
+
+        """
+        return set(self._scope)
+
+    def set_scope(self, scope):
+        """Get scope of the status.
+
+        Returns:
+            scope (Iterable[str]): Scope of the status.
+
+        """
+        if not isinstance(scope, (list, set, tuple)):
+            raise TypeError(
+                f"Scope must be a list, set, tuple. Got '{type(scope)}'."
+            )
+
+        scope = set(scope)
+        invalid_entity_types = scope - self.valid_scope
+        if invalid_entity_types:
+            raise ValueError("Invalid scope values '{}'".format(
+                ", ".join(invalid_entity_types)
+            ))
+
+        self._scope = scope
+
     name = property(get_name, set_name)
     short_name = property(get_short_name, set_short_name)
     project_statuses = property(get_project_statuses, set_project_statuses)
@@ -1913,6 +1970,7 @@ class ProjectStatus:
     state = property(get_state, set_state)
     color = property(get_color, set_color)
     icon = property(get_icon, set_icon)
+    scope = property(get_scope, set_scope)
 
     def _validate_other_p_statuses(self, other):
         """Validate if other status can be used for move.
@@ -1977,6 +2035,7 @@ class ProjectStatus:
             "state": self.state,
             "icon": self.icon,
             "color": self.color,
+            "scope": list(self._scope),
         }
         if (
             not self._is_new
@@ -2003,6 +2062,7 @@ class ProjectStatus:
             data.get("state"),
             data.get("icon"),
             data.get("color"),
+            data.get("scope"),
             index=index,
             project_statuses=project_statuses
         )
@@ -2026,6 +2086,7 @@ class _ProjectStatuses:
             ProjectStatus.from_data(status, idx, self)
             for idx, status in enumerate(statuses)
         ]
+        self._scope_supported = False
         self._orig_status_length = len(self._statuses)
         self._set_called = False
 
@@ -2049,27 +2110,31 @@ class _ProjectStatuses:
         state=None,
         icon=None,
         color=None,
+        scope=None,
     ):
         """Create project status.
 
         Args:
             name (str): Name of the status. e.g. 'In progress'
             short_name (Optional[str]): Short name of the status. e.g. 'IP'
-            state (Optional[Literal[not_started, in_progress, done, blocked]]): A
-                state of the status.
+            state (Optional[StatusState]): A state of the status.
             icon (Optional[str]): Icon of the status. e.g. 'play_arrow'.
             color (Optional[str]): Color of the status. e.g. '#eeeeee'.
+            scope (Optional[List[str]]): Scope of the status. e.g. ['folder'].
 
         Returns:
             ProjectStatus: Created project status.
 
         """
         status = ProjectStatus(
-            name, short_name, state, icon, color, is_new=True
+            name, short_name, state, icon, color, scope, is_new=True
         )
         self.append(status)
         return status
 
+    def set_status_scope_supported(self, supported: bool):
+        self._scope_supported = supported
+
     def lock(self):
         """Lock statuses.
 
@@ -2083,10 +2148,15 @@ class _ProjectStatuses:
 
     def to_data(self):
         """Convert to project statuses data."""
-        return [
+        output = [
             status.to_data()
             for status in self._statuses
         ]
+        # Remove scope if is not supported
+        if not self._scope_supported:
+            for item in output:
+                item.pop("scope")
+        return output
 
     def set(self, statuses):
         """Explicitly override statuses.
@@ -2348,9 +2418,9 @@ class ProjectEntity(BaseEntity):
         task_types,
         statuses,
         *args,
-        **kwargs
+        **kwargs,
     ):
-        super(ProjectEntity, self).__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs)
 
         self._project_code = project_code
         self._library_project = library
@@ -2379,6 +2449,9 @@ class ProjectEntity(BaseEntity):
             "Parent of project cannot be set to {}".format(parent)
         )
 
+    def set_status_scope_supported(self, supported: bool):
+        self._statuses_obj.set_status_scope_supported(supported)
+
     parent = property(get_parent, set_parent)
 
     def get_orig_folder_types(self):
@@ -2436,7 +2509,7 @@ class ProjectEntity(BaseEntity):
         return self._statuses_obj.get_status_by_slugified_name(name)
 
     def lock(self):
-        super(ProjectEntity, self).lock()
+        super().lock()
         self._orig_folder_types = copy.deepcopy(self._folder_types)
         self._orig_task_types = copy.deepcopy(self._task_types)
         self._statuses_obj.lock()
@@ -2469,7 +2542,7 @@ class ProjectEntity(BaseEntity):
             attribs=project["ownAttrib"],
             data=project["data"],
             active=project["active"],
-            entity_hub=entity_hub
+            entity_hub=entity_hub,
         )
 
     def to_create_body_data(self):
@@ -2577,6 +2650,12 @@ class FolderEntity(BaseEntity):
             raise ValueError(
                 f"Status {status_name} is not available on project."
             )
+
+        if not status.is_available_for_entity_type("folder"):
+            raise ValueError(
+                f"Status {status_name} is not available for folder."
+            )
+
         self._status = status_name
 
     status = property(get_status, set_status)
@@ -2795,7 +2874,7 @@ class TaskEntity(BaseEntity):
             tags = []
         else:
             tags = list(tags)
-        
+
         if assignees is None:
             assignees = []
         else:
@@ -2861,6 +2940,12 @@ class TaskEntity(BaseEntity):
             raise ValueError(
                 f"Status {status_name} is not available on project."
             )
+
+        if not status.is_available_for_entity_type("task"):
+            raise ValueError(
+                f"Status {status_name} is not available for task."
+            )
+
         self._status = status_name
 
     status = property(get_status, set_status)

{ayon-python-api-1.0.9 → ayon-python-api-1.0.10}/ayon_api/events.py

@@ -44,7 +44,6 @@ class ServerEvent(object):
             "user": self.username,
             "dependencies": copy.deepcopy(self.dependencies),
             "description": self.description,
-            "description": self.description,
             "summary": copy.deepcopy(self.summary),
             "payload": self.payload,
             "finished": self.finished,

{ayon-python-api-1.0.9 → ayon-python-api-1.0.10}/ayon_api/graphql.py

@@ -72,7 +72,7 @@ class GraphQlQuery:
 
     Args:
         name (str): Name of query.
-        
+
     """
     offset = 2
 

{ayon-python-api-1.0.9 → ayon-python-api-1.0.10}/ayon_api/graphql_queries.py

@@ -389,7 +389,9 @@ def representations_graphql_query(fields):
     repre_ids_var = query.add_variable("representationIds", "[String!]")
     repre_names_var = query.add_variable("representationNames", "[String!]")
     version_ids_var = query.add_variable("versionIds", "[String!]")
-    has_links_var = query.add_variable("representationHasLinks", "HasLinksFilter")
+    has_links_var = query.add_variable(
+        "representationHasLinks", "HasLinksFilter"
+    )
     statuses_var = query.add_variable(
         "representationStatuses", "[String!]"
     )

{ayon-python-api-1.0.9 → ayon-python-api-1.0.10}/ayon_api/server_api.py

@@ -16,6 +16,7 @@ import uuid
 import warnings
 import itertools
 from contextlib import contextmanager
+from typing import Optional
 
 try:
     from http import HTTPStatus
@@ -1276,7 +1277,11 @@ class ServerAPI(object):
                 # Server may be restarting
                 new_response = RestApiResponse(
                     None,
-                    {"detail": "Unable to connect the server. Connection refused"}
+                    {
+                        "detail": (
+                            "Unable to connect the server. Connection refused"
+                        )
+                    }
                 )
 
             except requests.exceptions.Timeout:
@@ -1295,7 +1300,11 @@ class ServerAPI(object):
 
                 new_response = RestApiResponse(
                     None,
-                    {"detail": "Unable to connect the server. Connection error"}
+                    {
+                        "detail": (
+                            "Unable to connect the server. Connection error"
+                        )
+                    }
                 )
 
             time.sleep(0.1)
@@ -1323,9 +1332,8 @@ class ServerAPI(object):
         return new_response
 
     def raw_post(self, entrypoint, **kwargs):
-        entrypoint = entrypoint.lstrip("/").rstrip("/")
-        self.log.debug("Executing [POST] {}".format(entrypoint))
-        url = "{}/{}".format(self._rest_url, entrypoint)
+        url = self._endpoint_to_url(entrypoint)
+        self.log.debug("Executing [POST] {}".format(url))
         return self._do_rest_request(
             RequestTypes.post,
             url,
@@ -1333,9 +1341,8 @@ class ServerAPI(object):
         )
 
     def raw_put(self, entrypoint, **kwargs):
-        entrypoint = entrypoint.lstrip("/").rstrip("/")
-        self.log.debug("Executing [PUT] {}".format(entrypoint))
-        url = "{}/{}".format(self._rest_url, entrypoint)
+        url = self._endpoint_to_url(entrypoint)
+        self.log.debug("Executing [PUT] {}".format(url))
         return self._do_rest_request(
             RequestTypes.put,
             url,
@@ -1343,9 +1350,8 @@ class ServerAPI(object):
         )
 
     def raw_patch(self, entrypoint, **kwargs):
-        entrypoint = entrypoint.lstrip("/").rstrip("/")
-        self.log.debug("Executing [PATCH] {}".format(entrypoint))
-        url = "{}/{}".format(self._rest_url, entrypoint)
+        url = self._endpoint_to_url(entrypoint)
+        self.log.debug("Executing [PATCH] {}".format(url))
         return self._do_rest_request(
             RequestTypes.patch,
             url,
@@ -1353,9 +1359,8 @@ class ServerAPI(object):
         )
 
     def raw_get(self, entrypoint, **kwargs):
-        entrypoint = entrypoint.lstrip("/").rstrip("/")
-        self.log.debug("Executing [GET] {}".format(entrypoint))
-        url = "{}/{}".format(self._rest_url, entrypoint)
+        url = self._endpoint_to_url(entrypoint)
+        self.log.debug("Executing [GET] {}".format(url))
         return self._do_rest_request(
             RequestTypes.get,
             url,
@@ -1363,9 +1368,8 @@ class ServerAPI(object):
         )
 
     def raw_delete(self, entrypoint, **kwargs):
-        entrypoint = entrypoint.lstrip("/").rstrip("/")
-        self.log.debug("Executing [DELETE] {}".format(entrypoint))
-        url = "{}/{}".format(self._rest_url, entrypoint)
+        url = self._endpoint_to_url(entrypoint)
+        self.log.debug("Executing [DELETE] {}".format(url))
         return self._do_rest_request(
             RequestTypes.delete,
             url,
@@ -1569,8 +1573,8 @@ class ServerAPI(object):
             depends_on (Optional[str]): Add dependency to another event.
             username (Optional[str]): Username which triggered event.
             description (Optional[str]): Description of event.
-            summary (Optional[dict[str, Any]]): Summary of event that can be used
-                for simple filtering on listeners.
+            summary (Optional[dict[str, Any]]): Summary of event that can
+                be used for simple filtering on listeners.
             payload (Optional[dict[str, Any]]): Full payload of event data with
                 all details.
             finished (Optional[bool]): Mark event as finished on dispatch.
@@ -1637,7 +1641,7 @@ class ServerAPI(object):
         at least one unfinished event with target topic, when set to 'True'.
         This helps when order of events matter and more than one process using
         the same target is running at the same time.
-        
+
         Make sure the new event has updated status to '"finished"' status
         when you're done with logic
 
@@ -1708,6 +1712,30 @@ class ServerAPI(object):
 
         return response.data
 
+    def _endpoint_to_url(
+        self,
+        endpoint: str,
+        use_rest: Optional[bool] = True
+    ):
+        """Cleanup endpoint and return full url to AYON server.
+
+        If endpoint already starts with server url only slashes are removed.
+
+        Args:
+            endpoint (str): Endpoint to be cleaned.
+            use_rest (Optional[bool]): Use only base server url if set to
+                False, otherwise REST endpoint is used.
+
+        Returns:
+            str: Full url to AYON server.
+
+        """
+        endpoint = endpoint.lstrip("/").rstrip("/")
+        if endpoint.startswith(self._base_url):
+            return endpoint
+        base_url = self._rest_url if use_rest else self._graphql_url
+        return f"{base_url}/{endpoint}"
+
     def _download_file_to_stream(self, url, stream, chunk_size, progress):
         kwargs = {"stream": True}
         if self._session is None:
@@ -1740,7 +1768,8 @@ class ServerAPI(object):
 
         Args:
             endpoint (str): Endpoint or URL to file that should be downloaded.
-            stream (Union[io.BytesIO, BinaryIO]): Stream where output will be stored.
+            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
@@ -1752,9 +1781,8 @@ class ServerAPI(object):
 
         if endpoint.startswith(self._base_url):
             url = endpoint
-        else:
-            endpoint = endpoint.lstrip("/").rstrip("/")
-            url = "{}/{}".format(self._rest_url, endpoint)
+
+        url = self._endpoint_to_url(endpoint)
 
         if progress is None:
             progress = TransferProgress()
@@ -1832,7 +1860,7 @@ class ServerAPI(object):
 
         Yields:
             bytes: Chunk of file.
-    
+
         """
         # Get size of file
         file_stream.seek(0, io.SEEK_END)
@@ -1922,11 +1950,7 @@ class ServerAPI(object):
             requests.Response: Response object
 
         """
-        if endpoint.startswith(self._base_url):
-            url = endpoint
-        else:
-            endpoint = endpoint.lstrip("/").rstrip("/")
-            url = "{}/{}".format(self._rest_url, endpoint)
+        url = self._endpoint_to_url(endpoint)
 
         # Create dummy object so the function does not have to check
         #   'progress' variable everywhere
@@ -1969,7 +1993,7 @@ class ServerAPI(object):
 
         Returns:
             requests.Response: Response object
-        
+
         """
         if progress is None:
             progress = TransferProgress()
@@ -2189,7 +2213,7 @@ class ServerAPI(object):
         """Get attribute schemas available for an entity type.
 
         Example::
-        
+
             ```
             # Example attribute schema
             {
@@ -2337,15 +2361,15 @@ class ServerAPI(object):
         response.raise_for_status()
         return response.data
 
-    def get_addon_url(self, addon_name, addon_version, *subpaths):
-        """Calculate url to addon route.
+    def get_addon_endpoint(self, addon_name, addon_version, *subpaths):
+        """Calculate endpoint to addon route.
 
         Examples:
 
             >>> api = ServerAPI("https://your.url.com")
             >>> api.get_addon_url(
             ...     "example", "1.0.0", "private", "my.zip")
-            'https://your.url.com/addons/example/1.0.0/private/my.zip'
+            'addons/example/1.0.0/private/my.zip'
 
         Args:
             addon_name (str): Name of addon.
@@ -2360,13 +2384,41 @@ class ServerAPI(object):
         ending = ""
         if subpaths:
             ending = "/{}".format("/".join(subpaths))
-        return "{}/addons/{}/{}{}".format(
-            self._base_url,
+        return "addons/{}/{}{}".format(
             addon_name,
             addon_version,
             ending
         )
 
+    def get_addon_url(
+        self, addon_name, addon_version, *subpaths, use_rest=True
+    ):
+        """Calculate url to addon route.
+
+        Examples:
+
+            >>> api = ServerAPI("https://your.url.com")
+            >>> api.get_addon_url(
+            ...     "example", "1.0.0", "private", "my.zip")
+            'https://your.url.com/api/addons/example/1.0.0/private/my.zip'
+
+        Args:
+            addon_name (str): Name of addon.
+            addon_version (str): Version of addon.
+            *subpaths (str): Any amount of subpaths that are added to
+                addon url.
+            use_rest (Optional[bool]): Use rest endpoint.
+
+        Returns:
+            str: Final url.
+
+        """
+        endpoint = self.get_addon_endpoint(
+            addon_name, addon_version, *subpaths
+        )
+        url_base = self._base_url if use_rest else self._rest_url
+        return f"{url_base}/{endpoint}"
+
     def download_addon_private_file(
         self,
         addon_name,
@@ -2404,12 +2456,13 @@ class ServerAPI(object):
         dst_dirpath = os.path.dirname(dst_filepath)
         os.makedirs(dst_dirpath, exist_ok=True)
 
-        url = self.get_addon_url(
+        endpoint = self.get_addon_endpoint(
             addon_name,
             addon_version,
             "private",
             filename
         )
+        url = f"{self._base_url}/{endpoint}"
         self.download_file(
             url, dst_filepath, chunk_size=chunk_size, progress=progress
         )
@@ -2811,7 +2864,7 @@ class ServerAPI(object):
         """Server bundles with basic information.
 
         This is example output::
-        
+
             {
                 "bundles": [
                     {
@@ -2849,12 +2902,31 @@ class ServerAPI(object):
         installer_version,
         dependency_packages=None,
         is_production=None,
-        is_staging=None
+        is_staging=None,
+        is_dev=None,
+        dev_active_user=None,
+        dev_addons_config=None,
     ):
         """Create bundle on server.
 
         Bundle cannot be changed once is created. Only isProduction, isStaging
-        and dependency packages can change after creation.
+        and dependency packages can change after creation. In case dev bundle
+        is created, it is possible to change anything, but it is not possible
+        to mark bundle as dev and production or staging at the same time.
+
+        Development addon config can define custom path to client code. It is
+        used only for dev bundles.
+
+        Example of 'dev_addons_config'::
+
+            ```json
+            {
+                "core": {
+                    "enabled": true,
+                    "path": "/path/to/ayon-core/client"
+                }
+            }
+            ```
 
         Args:
             name (str): Name of bundle.
@@ -2866,6 +2938,11 @@ class ServerAPI(object):
             is_production (Optional[bool]): Bundle will be marked as
                 production.
             is_staging (Optional[bool]): Bundle will be marked as staging.
+            is_dev (Optional[bool]): Bundle will be marked as dev.
+            dev_active_user (Optional[str]): Username that will be assigned
+                to dev bundle. Can be used only if 'is_dev' is set to 'True'.
+            dev_addons_config (Optional[dict[str, Any]]): Configuration for
+                dev addons. Can be used only if 'is_dev' is set to 'True'.
 
         """
         body = {
@@ -2873,10 +2950,14 @@ class ServerAPI(object):
             "installerVersion": installer_version,
             "addons": addon_versions,
         }
+
         for key, value in (
             ("dependencyPackages", dependency_packages),
             ("isProduction", is_production),
             ("isStaging", is_staging),
+            ("isDev", is_dev),
+            ("activeUser", dev_active_user),
+            ("addonDevelopment", dev_addons_config),
         ):
             if value is not None:
                 body[key] = value
@@ -2887,9 +2968,14 @@ class ServerAPI(object):
     def update_bundle(
         self,
         bundle_name,
+        addon_versions=None,
+        installer_version=None,
         dependency_packages=None,
         is_production=None,
-        is_staging=None
+        is_staging=None,
+        is_dev=None,
+        dev_active_user=None,
+        dev_addons_config=None,
     ):
         """Update bundle on server.
 
@@ -2899,19 +2985,33 @@ class ServerAPI(object):
 
         Args:
             bundle_name (str): Name of bundle.
+            addon_versions (Optional[dict[str, str]]): Addon versions,
+                possible only for dev bundles.
+            installer_version (Optional[str]): Installer version, possible
+                only for dev bundles.
             dependency_packages (Optional[dict[str, str]]): Dependency pacakge
                 names that should be used with the bundle.
             is_production (Optional[bool]): Bundle will be marked as
                 production.
             is_staging (Optional[bool]): Bundle will be marked as staging.
+            is_dev (Optional[bool]): Bundle will be marked as dev.
+            dev_active_user (Optional[str]): Username that will be assigned
+                to dev bundle. Can be used only for dev bundles.
+            dev_addons_config (Optional[dict[str, Any]]): Configuration for
+                dev addons. Can be used only for dev bundles.
 
         """
         body = {
             key: value
             for key, value in (
+                ("installerVersion", installer_version),
+                ("addons", addon_versions),
                 ("dependencyPackages", dependency_packages),
                 ("isProduction", is_production),
                 ("isStaging", is_staging),
+                ("isDev", is_dev),
+                ("activeUser", dev_active_user),
+                ("addonDevelopment", dev_addons_config),
             )
             if value is not None
         }
@@ -2921,6 +3021,63 @@ class ServerAPI(object):
         )
         response.raise_for_status()
 
+    def check_bundle_compatibility(
+        self,
+        name,
+        addon_versions,
+        installer_version,
+        dependency_packages=None,
+        is_production=None,
+        is_staging=None,
+        is_dev=None,
+        dev_active_user=None,
+        dev_addons_config=None,
+    ):
+        """Check bundle compatibility.
+
+        Can be used as per-flight validation before creating bundle.
+
+        Args:
+            name (str): Name of bundle.
+            addon_versions (dict[str, str]): Addon versions.
+            installer_version (Union[str, None]): Installer version.
+            dependency_packages (Optional[dict[str, str]]): Dependency
+                package names. Keys are platform names and values are name of
+                packages.
+            is_production (Optional[bool]): Bundle will be marked as
+                production.
+            is_staging (Optional[bool]): Bundle will be marked as staging.
+            is_dev (Optional[bool]): Bundle will be marked as dev.
+            dev_active_user (Optional[str]): Username that will be assigned
+                to dev bundle. Can be used only if 'is_dev' is set to 'True'.
+            dev_addons_config (Optional[dict[str, Any]]): Configuration for
+                dev addons. Can be used only if 'is_dev' is set to 'True'.
+
+        Returns:
+            Dict[str, Any]: Server response, with 'success' and 'issues'.
+
+        """
+        body = {
+            "name": name,
+            "installerVersion": installer_version,
+            "addons": addon_versions,
+        }
+
+        for key, value in (
+            ("dependencyPackages", dependency_packages),
+            ("isProduction", is_production),
+            ("isStaging", is_staging),
+            ("isDev", is_dev),
+            ("activeUser", dev_active_user),
+            ("addonDevelopment", dev_addons_config),
+        ):
+            if value is not None:
+                body[key] = value
+
+        response = self.post("bundles/check", **body)
+        response.raise_for_status()
+        return response.data
+
     def delete_bundle(self, bundle_name):
         """Delete bundle from server.
 
@@ -3222,7 +3379,7 @@ class ServerAPI(object):
         if project_name:
             args = (project_name, )
 
-        endpoint = self.get_addon_url(
+        endpoint = self.get_addon_endpoint(
             addon_name, addon_version, "schema", *args
         )
         result = self.get(endpoint)
@@ -3726,9 +3883,23 @@ class ServerAPI(object):
             return None
 
         response = self.get("projects/{}".format(project_name))
-        if response.status == 200:
-            return response.data
-        return None
+        # TODO ignore only error about not existing project
+        if response.status != 200:
+            return None
+        project = response.data
+        # Add fake scope to statuses if not available
+        for status in project["statuses"]:
+            scope = status.get("scope")
+            if scope is None:
+                status["scope"] = [
+                    "folder",
+                    "task",
+                    "product",
+                    "version",
+                    "representation",
+                    "workfile"
+                ]
+        return project
 
     def get_rest_projects(self, active=True, library=None):
         """Query available project entities.
@@ -4144,8 +4315,8 @@ class ServerAPI(object):
         """Query folders from server.
 
         Todos:
-            Folder name won't be unique identifier, so we should add folder path
-                filtering.
+            Folder name won't be unique identifier, so we should add
+                folder path filtering.
 
         Notes:
             Filter 'active' don't have direct filter in GraphQl.
@@ -6504,6 +6675,8 @@ class ServerAPI(object):
             product = version.pop("product", {})
             task = version.pop("task", None)
             folder = product.pop("folder", {})
+            self._convert_entity_data(repre)
+            self._representation_conversion(repre)
             self._convert_entity_data(version)
             self._convert_entity_data(product)
             self._convert_entity_data(folder)
@@ -6609,7 +6782,7 @@ class ServerAPI(object):
 
     def get_representation_parents(
         self,
-        project_name, 
+        project_name,
         representation_id,
         project_fields=None,
         folder_fields=None,
@@ -6945,7 +7118,7 @@ class ServerAPI(object):
                 "attrib.{}".format(attr)
                 for attr in self.get_attributes_for_type("workfile")
             }
-        
+
         if own_attributes is not _PLACEHOLDER:
             warnings.warn(
                 (
@@ -6963,6 +7136,7 @@ class ServerAPI(object):
 
         for parsed_data in query.continuous_query(self):
             for workfile_info in parsed_data["project"]["workfiles"]:
+                self._convert_entity_data(workfile_info)
                 yield workfile_info
 
     def get_workfile_info(
@@ -8122,7 +8296,7 @@ class ServerAPI(object):
                 body = json.loads(
                     json.dumps(operation, default=entity_data_json_default)
                 )
-            except:
+            except (TypeError, ValueError):
                 raise ValueError("Couldn't json parse body: {}".format(
                     json.dumps(
                         operation, indent=4, default=failed_json_default

{ayon-python-api-1.0.9 → ayon-python-api-1.0.10}/ayon_api/utils.py

@@ -6,7 +6,7 @@ import string
 import platform
 import collections
 from urllib.parse import urlparse, urlencode
-from typing import Optional
+from typing import Optional, Dict, Any
 
 import requests
 import unidecode
@@ -837,3 +837,52 @@ def get_media_mime_type(filepath: str) -> Optional[str]:
         content = stream.read()
 
     return get_media_mime_type_for_content(content)
+
+
+def take_web_action_event(
+    server_url: str,
+    action_token: str
+) -> Dict[str, Any]:
+    """Take web action event using action token.
+
+    Action token is generated by AYON server and passed to AYON launcher.
+
+    Args:
+        server_url (str): AYON server url.
+        action_token (str): Action token.
+
+    Returns:
+        Dict[str, Any]: Web action event.
+
+    """
+    response = requests.get(
+        f"{server_url}/api/actions/take/{action_token}"
+    )
+    response.raise_for_status()
+    return response.json()
+
+
+def abort_web_action_event(
+    server_url: str,
+    action_token: str,
+    reason: str
+):
+    """Abort web action event using action token.
+
+    A web action event could not be processed for some reason.
+
+    Args:
+        server_url (str): AYON server url.
+        action_token (str): Action token.
+        reason (str): Reason why webaction event was aborted.
+
+    Returns:
+        requests.Response: Response from server.
+
+    """
+    response = requests.post(
+        f"{server_url}/api/actions/take/{action_token}",
+        json={"message": reason},
+    )
+    response.raise_for_status()
+    return response

{ayon-python-api-1.0.9 → ayon-python-api-1.0.10}/ayon_api/version.py

@@ -1,2 +1,2 @@
 """Package declaring Python API for AYON server."""
-__version__ = "1.0.9"
+__version__ = "1.0.10"

{ayon-python-api-1.0.9 → ayon-python-api-1.0.10}/ayon_python_api.egg-info/PKG-INFO

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

{ayon-python-api-1.0.9 → ayon-python-api-1.0.10}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ayon-python-api"
-version = "1.0.9"
+version = "1.0.10"
 description = "AYON Python API"
 license = {file = "LICENSE"}
 readme = {file = "README.md", content-type = "text/markdown"}
@@ -29,11 +29,14 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "ayon-python-api"
-version = "1.0.9"
+version = "1.0.10"
 description = "AYON Python API"
 authors = [
     "ynput.io <info@ynput.io>"
 ]
+packages = [
+    { include = "ayon_api" }
+]
 
 [tool.poetry.dependencies]
 python = ">=3.6.5"

{ayon-python-api-1.0.9 → ayon-python-api-1.0.10}/setup.py

@@ -34,4 +34,4 @@ setup(
         "appdirs >=1, <2",
     ],
     keywords=["AYON", "ynput", "OpenPype", "vfx"],
-)
+)