Ayon-Python-Api 0.1.7__tar.gz → 0.1.8__tar.gz

{ayon-python-api-0.1.7/ayon_python_api.egg-info → ayon-python-api-0.1.8}/PKG-INFO

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

{ayon-python-api-0.1.7 → ayon-python-api-0.1.8}/ayon_api/__init__.py

@@ -1,5 +1,6 @@
 from .utils import (
     TransferProgress,
+    slugify_string,
 )
 from .server import (
     ServerAPIBase,
@@ -7,6 +8,9 @@ from .server import (
 
 from .server_api import (
     ServerAPI,
+    ServiceContext,
+
+    init_service,
 
     get_server_api_connection,
 
@@ -25,6 +29,11 @@ from .server_api import (
     patch,
     delete,
 
+    get_event,
+    dispatch_event,
+    update_event,
+    enroll_event_job,
+
     download_file,
     upload_file,
 
@@ -99,10 +108,13 @@ from .server_api import (
 
 __all__ = (
     "TransferProgress",
+    "slugify_string",
 
     "ServerAPIBase",
 
     "ServerAPI",
+    "ServiceContext",
+    "init_service",
 
     "get_server_api_connection",
 
@@ -121,6 +133,11 @@ __all__ = (
     "patch",
     "delete",
 
+    "get_event",
+    "dispatch_event",
+    "update_event",
+    "enroll_event_job",
+
     "download_file",
     "upload_file",
 

{ayon-python-api-0.1.7 → ayon-python-api-0.1.8}/ayon_api/exceptions.py

@@ -90,4 +90,8 @@ class FolderNotFound(MissingEntityError):
 
 
 class FailedOperations(Exception):
+    pass
+
+
+class FailedServiceInit(Exception):
     pass

{ayon-python-api-0.1.7 → ayon-python-api-0.1.8}/ayon_api/server.py

@@ -75,13 +75,32 @@ class RequestTypes:
 class RestApiResponse(object):
     """API Response."""
 
-    def __init__(self, status_code, data=None, content=None, headers=None):
-        if data is None:
-            data = {}
+    def __init__(self, response, data=None):
+        if response is None:
+            status_code = 500
+        else:
+            status_code = response.status_code
+        self._response = response
         self.status = status_code
-        self.data = data
-        self.content = content
-        self.headers = headers or {}
+        self._data = data
+
+    @property
+    def orig_response(self):
+        return self._response
+
+    @property
+    def headers(self):
+        return self._response.headers
+
+    @property
+    def data(self):
+        if self._data is None:
+            self._data = self._response.json()
+        return self._data
+
+    @property
+    def content(self):
+        return self._response.content
 
     @property
     def content_type(self):
@@ -95,6 +114,12 @@ class RestApiResponse(object):
     def status_code(self):
         return self.status
 
+    def raise_for_status(self):
+        self._response.raise_for_status()
+
+    def __enter__(self, *args, **kwargs):
+        return self._response.__enter__(*args, **kwargs)
+
     def __contains__(self, key):
         return key in self.data
 
@@ -448,26 +473,22 @@ class ServerAPIBase(object):
 
         except ConnectionRefusedError:
             new_response = RestApiResponse(
-                500,
+                None,
                 {"detail": "Unable to connect the server. Connection refused"}
             )
         except requests.exceptions.ConnectionError:
             new_response = RestApiResponse(
-                500,
+                None,
                 {"detail": "Unable to connect the server. Connection error"}
             )
         else:
             content_type = response.headers.get("Content-Type")
             if content_type == "application/json":
                 try:
-                    new_response = RestApiResponse(
-                        response.status_code,
-                        response.json(),
-                        headers=response.headers,
-                    )
+                    new_response = RestApiResponse(response)
                 except JSONDecodeError:
                     new_response = RestApiResponse(
-                        500,
+                        None,
                         {
                             "detail": "The response is not a JSON: {}".format(
                                 response.text)
@@ -475,17 +496,10 @@ class ServerAPIBase(object):
                     )
 
             elif content_type in ("image/jpeg", "image/png"):
-                new_response = RestApiResponse(
-                    response.status_code,
-                    headers=response.headers,
-                    content=response.content
-                )
+                new_response = RestApiResponse(response)
 
             else:
-                new_response = RestApiResponse(
-                    response.status_code,
-                    headers=response.headers,
-                )
+                new_response = RestApiResponse(response)
 
         self.log.debug("Response {}".format(str(new_response)))
         return new_response
@@ -555,6 +569,119 @@ class ServerAPIBase(object):
     def delete(self, entrypoint, **kwargs):
         return self.raw_delete(entrypoint, params=kwargs)
 
+    def get_event(self, event_id):
+        """Receive full event data by id.
+
+        Events received using event server do not contain full information. To
+        get the full event information is required to receive it explicitly.
+
+        Args:
+            event_id (str): Id of event.
+
+        Returns:
+            Dict[str, Any]: Full event data.
+        """
+
+        response = self.get("events/{}".format(event_id))
+        response.raise_for_status()
+        return response.data
+
+    def update_event(
+        self,
+        event_id,
+        sender=None,
+        project_name=None,
+        status=None,
+        description=None,
+        summary=None,
+        payload=None
+    ):
+        kwargs = {}
+        for key, value in (
+            ("sender", sender),
+            ("projectName", project_name),
+            ("status", status),
+            ("description", description),
+            ("summary", summary),
+            ("payload", payload),
+        ):
+            if value is not None:
+                kwargs[key] = value
+        response = self.put(
+            "events/{}".format(event_id),
+            **kwargs
+        )
+        response.raise_for_status()
+
+    def dispatch_event(
+        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 summary is None:
+            summary = {}
+        if payload is None:
+            payload = {}
+        event_data = {
+            "topic": topic,
+            "sender": sender,
+            "hash": event_hash,
+            "project": project_name,
+            "user": username,
+            "dependencies": dependencies,
+            "description": description,
+            "summary": summary,
+            "payload": payload,
+            "finished": finished,
+            "store": store,
+        }
+        if self.post("events", **event_data):
+            self.log.debug("Dispatched event {}".format(topic))
+            return True
+        self.log.error("Unable to dispatch event {}".format(topic))
+        return False
+
+    def enroll_event_job(
+        self,
+        source_topic,
+        target_topic,
+        sender,
+        description=None,
+        sequential=None
+    ):
+        """Enroll job based on events.
+
+        Args:
+            source_topic (str): Topic
+        """
+
+        kwargs = {
+            "sourceTopic": source_topic,
+            "targetTopic": target_topic,
+            "sender": sender,
+        }
+        if sequential is not None:
+            kwargs["sequential"] = sequential
+        if description is not None:
+            kwargs["description"] = description
+        response = self.post("enroll", **kwargs)
+        if response.status_code == 204:
+            return None
+        elif response.status_code >= 400:
+            self.log.error(response.text)
+            return None
+
+        return response.data
+
     def _download_file(self, url, filepath, chunk_size, progress):
         dst_directory = os.path.dirname(filepath)
         if not os.path.exists(dst_directory):
@@ -573,7 +700,7 @@ class ServerAPIBase(object):
                 progress.set_content_size(response.headers["Content-length"])
                 for chunk in response.iter_content(chunk_size=chunk_size):
                     f_stream.write(chunk)
-                    progress.add_downloaded_chunk(len(chunk))
+                    progress.add_transferred_chunk(len(chunk))
 
     def download_file(self, endpoint, filepath, chunk_size=None, progress=None):
         """Download file from AYON server.
@@ -618,7 +745,7 @@ class ServerAPIBase(object):
             raise
 
         finally:
-            progress.set_done()
+            progress.set_transfer_done()
 
     def _upload_file(self, url, filepath, progress):
         kwargs = {}
@@ -635,7 +762,7 @@ class ServerAPIBase(object):
             progress.set_content_size(size)
             response = post_func(url, data=stream, **kwargs)
         response.raise_for_status()
-        progress.set_downloaded_size(size)
+        progress.set_transferred_size(size)
 
     def upload_file(self, endpoint, filepath, progress=None):
         """Upload file to server.
@@ -673,7 +800,7 @@ class ServerAPIBase(object):
             raise
 
         finally:
-            progress.set_done()
+            progress.set_transfer_done()
 
     def trigger_server_restart(self):
         result = self.post("system/restart")

{ayon-python-api-0.1.7 → ayon-python-api-0.1.8}/ayon_api/server_api.py

@@ -1,9 +1,12 @@
 import os
+import socket
+
 from .constants import (
     SERVER_URL_ENV_KEY,
     SERVER_TOKEN_ENV_KEY,
 )
 from .server import ServerAPIBase
+from .exceptions import FailedServiceInit
 
 
 class ServerAPI(ServerAPIBase):
@@ -72,6 +75,95 @@ class GlobalContext:
         return cls._connection
 
 
+class ServiceContext:
+    """Helper for services running under server.
+
+    When service is running from server the process receives information about
+    connection from environment variables. This class helps to initialize the
+    values without knowing environment variables (that may change over time).
+
+    All what must be done is to call 'init_service' function/method. The
+    arguments are for cases when the service is running in specific environment
+    and their values are e.g. loaded from private file or for testing purposes.
+    """
+
+    token = None
+    server_url = None
+    addon_name = None
+    addon_version = None
+    service_name = None
+
+    @staticmethod
+    def get_value_from_envs(env_keys, value=None):
+        if value:
+            return value
+
+        for env_key in env_keys:
+            value = os.environ.get(env_key)
+            if value:
+                break
+        return value
+
+    @classmethod
+    def init_service(
+        cls,
+        token=None,
+        server_url=None,
+        addon_name=None,
+        addon_version=None,
+        service_name=None,
+        connect=True
+    ):
+        token = cls.get_value_from_envs(
+            ("AY_API_KEY", "AYON_TOKEN"),
+            token
+        )
+        server_url = cls.get_value_from_envs(
+            ("AY_SERVER_URL", "AYON_SERVER_URL"),
+            server_url
+        )
+        if not server_url:
+            raise FailedServiceInit("URL to server is not set")
+
+        if not token:
+            raise FailedServiceInit(
+                "Token to server {} is not set".format(server_url)
+            )
+
+        addon_name = cls.get_value_from_envs(
+            ("AY_ADDON_NAME", "AYON_ADDON_NAME"),
+            addon_name
+        )
+        addon_version = cls.get_value_from_envs(
+            ("AY_ADDON_VERSION", "AYON_ADDON_VERSION"),
+            addon_version
+        )
+        service_name = cls.get_value_from_envs(
+            ("AY_SERVICE_NAME", "AYON_SERVICE_NAME"),
+            service_name
+        )
+
+        cls.token = token
+        cls.server_url = server_url
+        cls.addon_name = addon_name
+        cls.addon_version = addon_version
+        cls.service_name = service_name or socket.gethostname()
+
+        # Make sure required environments for ServerAPI are set
+        os.environ["AYON_SERVER_URL"] = cls.server_url
+        os.environ["AYON_TOKEN"] = cls.token
+
+        if connect:
+            print("Connecting to server \"{}\"".format(server_url))
+            con = GlobalContext.get_server_api_connection()
+            user = con.get_user()
+            print("Logged in as user \"{}\"".format(user["name"]))
+
+
+def init_service(*args, **kwargs):
+    ServiceContext.init_service(*args, **kwargs)
+
+
 def get_server_api_connection():
     """Access to global scope object of ServerAPI.
 
@@ -145,6 +237,26 @@ def delete(*args, **kwargs):
     return con.delete(*args, **kwargs)
 
 
+def get_event(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_event(*args, **kwargs)
+
+
+def dispatch_event(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_event(*args, **kwargs)
+
+
+def update_event(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.update_event(*args, **kwargs)
+
+
+def enroll_event_job(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.enroll_event_job(*args, **kwargs)
+
+
 def download_file(*args, **kwargs):
     con = get_server_api_connection()
     return con.download_file(*args, **kwargs)

{ayon-python-api-0.1.7 → ayon-python-api-0.1.8}/ayon_api/utils.py

@@ -1,15 +1,21 @@
+import re
 import datetime
 import uuid
+import string
 try:
     from urlparse import urlparse
 except ImportError:
     from urllib.parse import urlparse
 
 import requests
+import unidecode
+
 
 from .exceptions import UrlError
 
 REMOVED_VALUE = object()
+SLUGIFY_WHITELIST = string.ascii_letters + string.digits
+SLUGIFY_SEP_WHITELIST = " ,./\\;:!|*^#@~+-_="
 
 
 def create_entity_id():
@@ -47,6 +53,59 @@ def entity_data_json_default(value):
     )
 
 
+def slugify_string(
+    input_string,
+    separator="_",
+    slug_whitelist=SLUGIFY_WHITELIST,
+    split_chars=SLUGIFY_SEP_WHITELIST,
+    min_length=1,
+    lower=False,
+    make_set=False,
+):
+    """Slugify a text string.
+
+    This function removes transliterates input string to ASCII, removes
+    special characters and use join resulting elements using
+    specified separator.
+
+    Args:
+        input_string (str): Input string to slugify
+        separator (str): A string used to separate returned elements
+            (default: "_")
+        slug_whitelist (str): Characters allowed in the output
+            (default: ascii letters, digits and the separator)
+        split_chars (str): Set of characters used for word splitting
+            (there is a sane default)
+        lower (bool): Convert to lower-case (default: False)
+        make_set (bool): Return "set" object instead of string.
+        min_length (int): Minimal length of an element (word).
+
+    Returns:
+        Union[str, Set[str]]: Based on 'make_set' value returns slugified
+            string.
+    """
+
+    tmp_string = unidecode.unidecode(input_string)
+    if lower:
+        tmp_string = tmp_string.lower()
+
+    parts = [
+        # Remove all characters that are not in whitelist
+        re.sub("[^{}]".format(re.escape(slug_whitelist)), "", part)
+        # Split text into part by split characters
+        for part in re.split("[{}]".format(re.escape(split_chars)), tmp_string)
+    ]
+    # Filter text parts by length
+    filtered_parts = [
+        part
+        for part in parts
+        if len(part) >= min_length
+    ]
+    if make_set:
+        return set(filtered_parts)
+    return separator.join(filtered_parts)
+
+
 def failed_json_default(value):
     return "< Failed value {} > {}".format(type(value), str(value))
 
@@ -272,8 +331,8 @@ class TransferProgress:
 
     def __init__(self):
         self._started = False
-        self._done = False
-        self._downloaded = 0
+        self._transfer_done = False
+        self._transfered = 0
         self._content_size = None
 
         self._failed = False
@@ -298,15 +357,15 @@ class TransferProgress:
             raise ValueError("Progress already started")
         self._started = True
 
-    def get_done(self):
-        return self._done
+    def get_transfer_done(self):
+        return self._transfer_done
 
-    def set_done(self):
-        if self._done:
+    def set_transfer_done(self):
+        if self._transfer_done:
             raise ValueError("Progress was already marked as done")
         if not self._started:
             raise ValueError("Progress didn't start yet")
-        self._done = True
+        self._transfer_done = True
 
     def get_failed(self):
         return self._failed
@@ -318,14 +377,14 @@ class TransferProgress:
         self._fail_reason = reason
         self._failed = True
 
-    def get_downloaded_size(self):
-        return self._downloaded
+    def get_transferred_size(self):
+        return self._transfered
 
-    def set_downloaded_size(self, downloaded_size):
-        self._downloaded = downloaded_size
+    def set_transferred_size(self, transfered):
+        self._transfered = transfered
 
-    def add_downloaded_chunk(self, chunk_size):
-        self._downloaded += chunk_size
+    def add_transferred_chunk(self, chunk_size):
+        self._transfered += chunk_size
 
     def get_source_url(self):
         return self._source_url
@@ -350,17 +409,17 @@ class TransferProgress:
         return True
 
     @property
-    def progress(self):
+    def transfer_progress(self):
         if self._content_size is None:
             return None
-        return (self._downloaded * 100.0) / float(self._content_size)
+        return (self._transfered * 100.0) / float(self._content_size)
 
     content_size = property(get_content_size, set_content_size)
     started = property(get_started)
-    done = property(get_done)
+    transfer_done = property(get_transfer_done)
     failed = property(get_failed)
     fail_reason = property(get_fail_reason)
     source_url = property(get_source_url, set_source_url)
     destination_url = property(get_destination_url, set_destination_url)
     content_size = property(get_content_size, set_content_size)
-    downloaded_size = property(get_downloaded_size, set_downloaded_size)
+    transferred_size = property(get_transferred_size, set_transferred_size)

{ayon-python-api-0.1.7 → ayon-python-api-0.1.8}/ayon_api/version.py

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

{ayon-python-api-0.1.7 → ayon-python-api-0.1.8/ayon_python_api.egg-info}/PKG-INFO

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

{ayon-python-api-0.1.7 → ayon-python-api-0.1.8}/pyproject.toml

@@ -1,12 +1,13 @@
 [tool.poetry]
 name = "ayon_api"
-version = "0.1.7"
+version = "0.1.8"
 description = "Python api for AYON server"
 authors = ["ynput.io <info@ynput.io>"]
 
 [tool.poetry.dependencies]
 requests = "^2.28.1"
 six = "^1.15"
+unidecode = "^1.3"
 appdirs = { git = "https://github.com/ActiveState/appdirs.git", branch = "master" }
 
 [tool.poetry.dev-dependencies]