Ayon-Python-Api 0.1.10__tar.gz → 0.1.11__tar.gz

{ayon-python-api-0.1.10/ayon_python_api.egg-info → ayon-python-api-0.1.11}/PKG-INFO

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

{ayon-python-api-0.1.10 → ayon-python-api-0.1.11}/ayon_api/__init__.py

@@ -2,21 +2,27 @@ from .utils import (
     TransferProgress,
     slugify_string,
 )
-from .server import (
-    ServerAPIBase,
-)
-
 from .server_api import (
     ServerAPI,
+)
+
+from ._api import (
+    GlobalServerAPI,
     ServiceContext,
 
     init_service,
+    get_service_addon_name,
+    get_service_addon_version,
+    get_service_addon_settings,
 
     is_connection_created,
+    create_connection,
     close_connection,
     change_token,
     set_environments,
     get_server_api_connection,
+    set_site_id,
+    set_client_version,
 
     get_base_url,
     get_rest_url,
@@ -115,17 +121,24 @@ __all__ = (
     "TransferProgress",
     "slugify_string",
 
-    "ServerAPIBase",
-
     "ServerAPI",
+
+    "GlobalServerAPI",
     "ServiceContext",
+
     "init_service",
+    "get_service_addon_name",
+    "get_service_addon_version",
+    "get_service_addon_settings",
 
     "is_connection_created",
+    "create_connection",
     "close_connection",
     "change_token",
     "set_environments",
     "get_server_api_connection",
+    "set_site_id",
+    "set_client_version",
 
     "get_base_url",
     "get_rest_url",

ayon-python-api-0.1.10/ayon_api/server_api.py → ayon-python-api-0.1.11/ayon_api/_api.py

@@ -1,3 +1,11 @@
+"""Singleton based server api for direct access.
+
+This implementation will be probably the most used part of package. Gives
+option to have singleton connection to Server URL based on environment variable
+values. All public functions and classes are imported in '__init__.py' so
+they're available directly in top module import.
+"""
+
 import os
 import socket
 
@@ -5,11 +13,11 @@ from .constants import (
     SERVER_URL_ENV_KEY,
     SERVER_TOKEN_ENV_KEY,
 )
-from .server import ServerAPIBase
+from .server_api import ServerAPI
 from .exceptions import FailedServiceInit
 
 
-class ServerAPI(ServerAPIBase):
+class GlobalServerAPI(ServerAPI):
     """Extended server api which also handles storing tokens and url.
 
     Created object expect to have set environment variables
@@ -17,11 +25,11 @@ class ServerAPI(ServerAPIBase):
     but that can be filled afterwards with calling 'login' method.
     """
 
-    def __init__(self):
+    def __init__(self, site_id=None, client_version=None):
         url = self.get_url()
         token = self.get_token()
 
-        super(ServerAPI, self).__init__(url, token)
+        super(GlobalServerAPI, self).__init__(url, token, site_id, client_version)
 
         self.validate_server_availability()
         self.create_session()
@@ -34,7 +42,7 @@ class ServerAPI(ServerAPIBase):
         """
 
         previous_token = self._access_token
-        super(ServerAPI, self).login(username, password)
+        super(GlobalServerAPI, self).login(username, password)
         if self.has_valid_token and previous_token != self._access_token:
             os.environ[SERVER_TOKEN_ENV_KEY] = self._access_token
 
@@ -74,7 +82,7 @@ class GlobalContext:
 
     @classmethod
     def change_token(cls, url, token):
-        ServerAPI.set_environments(url, token)
+        GlobalServerAPI.set_environments(url, token)
         if cls._connection is None:
             return
 
@@ -89,10 +97,17 @@ class GlobalContext:
             cls._connection.close_session()
         cls._connection = None
 
+    @classmethod
+    def create_connection(cls, *args, **kwargs):
+        if cls._connection is not None:
+            cls.close_connection()
+        cls._connection = GlobalServerAPI(*args, **kwargs)
+        return cls._connection
+
     @classmethod
     def get_server_api_connection(cls):
         if cls._connection is None:
-            cls._connection = ServerAPI()
+            cls.create_connection()
         return cls._connection
 
 
@@ -170,8 +185,8 @@ class ServiceContext:
         cls.addon_version = addon_version
         cls.service_name = service_name or socket.gethostname()
 
-        # Make sure required environments for ServerAPI are set
-        ServerAPI.set_environments(cls.server_url, cls.token)
+        # Make sure required environments for GlobalServerAPI are set
+        GlobalServerAPI.set_environments(cls.server_url, cls.token)
 
         if connect:
             print("Connecting to server \"{}\"".format(server_url))
@@ -181,9 +196,52 @@ class ServiceContext:
 
 
 def init_service(*args, **kwargs):
+    """Initialize current connection from service.
+
+    The service expect specific environment variables. The variables must all
+    be set to make the connection work as a service.
+    """
+
     ServiceContext.init_service(*args, **kwargs)
 
 
+def get_service_addon_name():
+    """Name of addon which initialized service connection.
+
+    Returns:
+        Union[str, None]: Name of addon or None.
+    """
+
+    return ServiceContext.addon_name
+
+
+def get_service_addon_version():
+    """Version of addon which initialized service connection.
+
+    Returns:
+        Union[str, None]: Version of addon or None.
+    """
+
+    return ServiceContext.addon_version
+
+
+def get_service_addon_settings():
+    """Addon settings of service which initialized service.
+
+    Returns:
+        Dict[str, Any]: Addon settings.
+
+    Raises:
+        ValueError: When service was not initialized.
+    """
+
+    addon_name = get_service_addon_name()
+    addon_version = get_service_addon_version()
+    if addon_name is None or addon_version is None:
+        raise ValueError("Service is not initialized")
+    return get_addon_settings(addon_name, addon_version)
+
+
 def is_connection_created():
     """Is global connection created.
 
@@ -194,6 +252,20 @@ def is_connection_created():
     return GlobalContext.is_connection_created()
 
 
+def create_connection(site_id=None, client_version=None):
+    """Create global connection.
+
+    Args:
+        site_id (str): Machine site id/name.
+        client_version (str): Desktop app version.
+
+    Returns:
+        GlobalServerAPI: Created connection.
+    """
+
+    return GlobalContext.create_connection(site_id, client_version)
+
+
 def close_connection():
     """Close global connection if is connected."""
 
@@ -221,22 +293,48 @@ def set_environments(url, token):
         token (Union[str, None]): API key token to be used for connection.
     """
 
-    ServerAPI.set_environments(url, token)
+    GlobalServerAPI.set_environments(url, token)
 
 
 def get_server_api_connection():
-    """Access to global scope object of ServerAPI.
+    """Access to global scope object of GlobalServerAPI.
 
     This access expect to have set environment variables 'AYON_SERVER_URL'
     and 'AYON_TOKEN'.
 
     Returns:
-        ServerAPI: Object of connection to server.
+        GlobalServerAPI: Object of connection to server.
     """
 
     return GlobalContext.get_server_api_connection()
 
 
+def set_site_id(site_id):
+    """Set site id of already connected client connection.
+
+    Site id is human-readable machine id used in AYON desktop application.
+
+    Args:
+        site_id (Union[str, None]): Site id used in connection.
+    """
+
+    con = get_server_api_connection()
+    con.set_site_id(site_id)
+
+
+def set_client_version(client_version):
+    """Set version of already connected client connection.
+
+    Client version is version of AYON desktop application.
+
+    Args:
+        client_version (Union[str, None]): Client version string.
+    """
+
+    con = get_server_api_connection()
+    con.set_client_version(client_version)
+
+
 def get_base_url():
     con = get_server_api_connection()
     return con.get_base_url()

{ayon-python-api-0.1.10 → ayon-python-api-0.1.11}/ayon_api/entity_hub.py

@@ -3,7 +3,7 @@ import collections
 from abc import ABCMeta, abstractmethod, abstractproperty
 
 import six
-from .server_api import get_server_api_connection
+from ._api import get_server_api_connection
 from .utils import create_entity_id, convert_entity_id
 
 UNKNOWN_VALUE = object()
@@ -27,7 +27,7 @@ class EntityHub(object):
 
     Args:
         project_name (str): Name of project where changes will happen.
-        connection (ServerAPIBase): Connection to server with logged user.
+        connection (ServerAPI): Connection to server with logged user.
         allow_data_changes (bool): This option gives ability to change 'data'
             key on entities. This is not recommended as 'data' may be use for
             secure information and would also slow down server queries. Content

ayon-python-api-0.1.11/ayon_api/events.py

@@ -0,0 +1,52 @@
+import copy
+
+
+class ServerEvent(object):
+    def __init__(
+        self,
+        topic,
+        sender=None,
+        event_hash=None,
+        project_name=None,
+        username=None,
+        dependencies=None,
+        description=None,
+        summary=None,
+        payload=None,
+        finished=True,
+        store=True,
+    ):
+        if dependencies is None:
+            dependencies = []
+        if payload is None:
+            payload = {}
+        if summary is None:
+            summary = {}
+
+        self.topic = topic
+        self.sender = sender
+        self.event_hash = event_hash
+        self.project_name = project_name
+        self.username = username
+        self.dependencies = dependencies
+        self.description = description
+        self.summary = summary
+        self.payload = payload
+        self.finished = finished
+        self.store = store
+
+    def to_data(self):
+        return {
+            "topic": self.topic,
+            "sender": self.sender,
+            "hash": self.event_hash,
+            "project": self.project_name,
+            "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,
+            "store": self.store
+        }

{ayon-python-api-0.1.10 → ayon-python-api-0.1.11}/ayon_api/operations.py

@@ -6,7 +6,7 @@ from abc import ABCMeta, abstractproperty
 
 import six
 
-from .server_api import get_server_api_connection
+from ._api import get_server_api_connection
 from .utils import create_entity_id, REMOVED_VALUE
 
 

ayon-python-api-0.1.10/ayon_api/server.py → ayon-python-api-0.1.11/ayon_api/server_api.py

@@ -6,6 +6,8 @@ import logging
 import collections
 import platform
 import copy
+import uuid
+from contextlib import contextmanager
 try:
     from http import HTTPStatus
 except ImportError:
@@ -186,7 +188,91 @@ def fill_own_attribs(entity):
             own_attrib[key] = copy.deepcopy(value)
 
 
-class ServerAPIBase(object):
+class _AsUserStack:
+    """Handle stack of users used over server api connection in service mode.
+
+    ServerAPI can behave as other users if it is using special API key.
+
+    Examples:
+        >>> stack = _AsUserStack()
+        >>> stack.set_default_username("DefaultName")
+        >>> print(stack.username)
+        DefaultName
+        >>> with stack.as_user("Other1"):
+        ...     print(stack.username)
+        ...     with stack.as_user("Other2"):
+        ...         print(stack.username)
+        ...     print(stack.username)
+        ...     stack.clear()
+        ...     print(stack.username)
+        Other1
+        Other2
+        Other1
+        None
+        >>> print(stack.username)
+        None
+        >>> stack.set_default_username("DefaultName")
+        >>> print(stack.username)
+        DefaultName
+    """
+
+    def __init__(self):
+        self._users_by_id = {}
+        self._user_ids = []
+        self._last_user = None
+        self._default_user = None
+
+    def clear(self):
+        self._users_by_id = {}
+        self._user_ids = []
+        self._last_user = None
+        self._default_user = None
+
+    @property
+    def username(self):
+        # Use '_user_ids' for boolean check to have ability "unset"
+        #   default user
+        if self._user_ids:
+            return self._last_user
+        return self._default_user
+
+    def get_default_username(self):
+        return self._default_user
+
+    def set_default_username(self, username=None):
+        self._default_user = username
+
+    default_username = property(get_default_username, set_default_username)
+
+    @contextmanager
+    def as_user(self, username):
+        self._last_user = username
+        user_id = uuid.uuid4().hex
+        self._user_ids.append(user_id)
+        self._users_by_id[user_id] = username
+        try:
+            yield
+        finally:
+            self._users_by_id.pop(user_id, None)
+            if not self._user_ids:
+                return
+
+            # First check if is the user id the last one
+            was_last = self._user_ids[-1] == user_id
+            # Remove id from variables
+            if user_id in self._user_ids:
+                self._user_ids.remove(user_id)
+
+            if not was_last:
+                return
+
+            new_last_user = None
+            if self._user_ids:
+                new_last_user = self._users_by_id.get(self._user_ids[-1])
+            self._last_user = new_last_user
+
+
+class ServerAPI(object):
     """Base handler of connection to server.
 
     Requires url to server which is used as base for api and graphql calls.
@@ -239,8 +325,15 @@ class ServerAPIBase(object):
         self._attributes_schema = None
         self._entity_type_attributes_cache = {}
 
+        self._as_user_stack = _AsUserStack()
         self._thumbnail_cache = ThumbnailCache(True)
 
+    @property
+    def log(self):
+        if self._log is None:
+            self._log = logging.getLogger(self.__class__.__name__)
+        return self._log
+
     def get_base_url(self):
         return self._base_url
 
@@ -262,12 +355,111 @@ class ServerAPIBase(object):
             return
         self._site_id = site_id
         # Recreate session on machine id change
-        if self._session is not None:
-            self.close_session()
-            self.create_session()
+        self._update_session_headers()
 
     site_id = property(get_site_id, set_site_id)
 
+    def get_client_version(self):
+        """Version of client used to connect to server.
+
+        Client version is AYON client build desktop application.
+
+        Returns:
+            str: Client version string used in connection.
+        """
+
+        return self._client_version
+
+    def set_client_version(self, client_version):
+        """Set version of client used to connect to server.
+
+        Client version is AYON client build desktop application.
+
+        Args:
+            client_version (Union[str, None]): Client version string.
+        """
+
+        if self._client_version == client_version:
+            return
+
+        self._client_version = client_version
+        self._update_session_headers()
+
+    client_version = property(get_client_version, set_client_version)
+
+    def get_default_service_username(self):
+        """Default username used for callbacks when used with service API key.
+
+        Returns:
+            Union[str, None]: Username if any was filled.
+        """
+
+        return self._as_user_stack.get_default_username()
+
+    def set_default_service_username(self, username=None):
+        """Service API will work as other user.
+
+        Service API keys can work as other user. It can be temporary using
+        context manager 'as_user' or it is possible to set default username if
+        'as_user' context manager is not entered.
+
+        Args:
+            username (Union[str, None]): Username to work as when service.
+
+        Raises:
+            ValueError: When connection is not yet authenticated or api key
+                is not service token.
+        """
+
+        current_username = self._as_user_stack.get_default_username()
+        if current_username == username:
+            return
+
+        if not self.has_valid_token:
+            raise ValueError(
+                "Authentication of connection did not happen yet."
+            )
+
+        if not self._access_token_is_service:
+            raise ValueError(
+                "Can't set service username. API key is not a service token."
+            )
+
+        self._as_user_stack.set_default_username(username)
+        if self._as_user_stack.username == username:
+            self._update_session_headers()
+
+    @contextmanager
+    def as_username(self, username):
+        """Service API will temporarily work as other user.
+
+        This method can be used only if service API key is logged in.
+
+        Args:
+            username (Union[str, None]): Username to work as when service.
+
+        Raises:
+            ValueError: When connection is not yet authenticated or api key
+                is not service token.
+        """
+
+        if not self.has_valid_token:
+            raise ValueError(
+                "Authentication of connection did not happen yet."
+            )
+
+        if not self._access_token_is_service:
+            raise ValueError(
+                "Can't set service username. API key is not a service token."
+            )
+
+        with self._as_user_stack.as_user(username) as o:
+            self._update_session_headers()
+            try:
+                yield o
+            finally:
+                self._update_session_headers()
+
     @property
     def is_server_available(self):
         if self._server_available is None:
@@ -317,6 +509,7 @@ class ServerAPIBase(object):
         if self._session is not None:
             raise ValueError("Session is already created.")
 
+        self._as_user_stack.clear()
         # Validate token before session creation
         self.validate_token()
 
@@ -341,6 +534,21 @@ class ServerAPIBase(object):
         self._session_functions_mapping = {}
         session.close()
 
+    def _update_session_headers(self):
+        if self._session is None:
+            return
+
+        # Header keys that may change over time
+        for key, value in (
+            ("X-as-user", self._as_user_stack.username),
+            ("x-ayon-version", self._client_version),
+            ("x-ayon-site-id", self._site_id),
+        ):
+            if value is not None:
+                self._session.headers[key] = value
+            elif key in self._session.headers:
+                self._session.headers.pop(key)
+
     def get_info(self):
         """Get information about current used api key.
 
@@ -397,12 +605,6 @@ class ServerAPIBase(object):
             raise UnauthorizedError("User is not authorized.")
         return output
 
-    @property
-    def log(self):
-        if self._log is None:
-            self._log = logging.getLogger(self.__class__.__name__)
-        return self._log
-
     def get_headers(self, content_type=None):
         if content_type is None:
             content_type = "application/json"
@@ -421,6 +623,9 @@ class ServerAPIBase(object):
         if self._access_token:
             if self._access_token_is_service:
                 headers["X-Api-Key"] = self._access_token
+                username = self._as_user_stack.username
+                if username:
+                    headers["X-as-user"] = username
             else:
                 headers["Authorization"] = "Bearer {}".format(
                     self._access_token)
@@ -709,6 +914,25 @@ class ServerAPIBase(object):
         finished=True,
         store=True,
     ):
+        """Dispatch event to server.
+
+        Arg:
+            topic (str): Event topic used for filtering of listeners.
+            sender (Optional[str]): Sender of event.
+            hash (Optional[str]): Event hash.
+            project_name (Optional[str]): Project name.
+            username (Optional[str]): Username which triggered event.
+            dependencies (Optional[list[str]]): List of event id deprendencies.
+            description (Optional[str]): Description of event.
+            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 (bool): Mark event as finished on dispatch.
+            store (bool): Store event in event queue for possible future processing
+                otherwise is event send only to active listeners.
+        """
+
         if summary is None:
             summary = {}
         if payload is None:

{ayon-python-api-0.1.10 → ayon-python-api-0.1.11}/ayon_api/version.py

@@ -1,2 +1,2 @@
 """Package declaring Python API for Ayon server."""
-__version__ = "0.1.10"
+__version__ = "0.1.11"

{ayon-python-api-0.1.10 → ayon-python-api-0.1.11/ayon_python_api.egg-info}/PKG-INFO

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

{ayon-python-api-0.1.10 → ayon-python-api-0.1.11}/ayon_python_api.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ README.md
 pyproject.toml
 setup.py
 ayon_api/__init__.py
+ayon_api/_api.py
 ayon_api/constants.py
 ayon_api/entity_hub.py
 ayon_api/events.py
@@ -10,7 +11,6 @@ ayon_api/exceptions.py
 ayon_api/graphql.py
 ayon_api/graphql_queries.py
 ayon_api/operations.py
-ayon_api/server.py
 ayon_api/server_api.py
 ayon_api/thumbnails.py
 ayon_api/utils.py

{ayon-python-api-0.1.10 → ayon-python-api-0.1.11}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ayon_api"
-version = "0.1.10"
+version = "0.1.11"
 description = "Python api for AYON server"
 authors = ["ynput.io <info@ynput.io>"]
 

ayon-python-api-0.1.10/ayon_api/events.py

@@ -1,105 +0,0 @@
-import copy
-
-from .server_api import get_server_api_connection
-
-
-class ServerEvent(object):
-    def __init__(
-        self,
-        topic,
-        sender=None,
-        hash=None,
-        project_name=None,
-        username=None,
-        dependencies=None,
-        description=None,
-        summary=None,
-        payload=None,
-        finished=True,
-        store=True,
-    ):
-        if dependencies is None:
-            dependencies = []
-        if payload is None:
-            payload = {}
-        if summary is None:
-            summary = {}
-
-        self.topic = topic
-        self.sender = sender
-        self.hash = hash
-        self.project_name = project_name
-        self.username = username
-        self.dependencies = dependencies
-        self.summary = summary
-        self.payload = payload
-        self.finished = finished
-        self.store = store
-
-    def to_data(self):
-        return {
-            "topic": self.topic,
-            "sender": self.sender,
-            "hash": self.hash,
-            "project": self.project_name,
-            "user": self.username,
-            "dependencies": copy.deepcopy(self.dependencies),
-            "description": self.description,
-            "summary": copy.deepcopy(self.summary),
-            "payload": self.payload,
-            "finished": self.finished,
-            "store": self.store
-        }
-
-
-def dispatch_event(
-    topic,
-    sender=None,
-    hash=None,
-    project_name=None,
-    username=None,
-    dependencies=None,
-    description=None,
-    summary=None,
-    payload=None,
-    finished=True,
-    store=True,
-):
-    """Dispatch event to server.
-
-    Arg:
-        topic (str): Event topic used for filtering of listeners.
-        sender (Optional[str]): Sender of event.
-        hash (Optional[str]): Event hash.
-        project_name (Optional[str]): Project name.
-        username (Optional[str]): Username which triggered event.
-        dependencies (Optional[list[str]]): List of event id deprendencies.
-        description (Optional[str]): Description of event.
-        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 (bool): Mark event as finished on dispatch.
-        store (bool): Store event in event queue for possible future processing
-            otherwise is event send only to active listeners.
-    """
-
-    event = ServerEvent(
-        topic,
-        sender,
-        hash,
-        project_name,
-        username,
-        dependencies,
-        description,
-        summary,
-        payload,
-        finished,
-        store
-    )
-    con = get_server_api_connection()
-    response = con.post("events", json=event.to_data())
-    if response:
-        print(response, response.data)
-        return event
-    return None