Ayon-Python-Api 0.3.2__tar.gz → 0.3.3__tar.gz

{ayon-python-api-0.3.2 → ayon-python-api-0.3.3}/PKG-INFO

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

{ayon-python-api-0.3.2 → ayon-python-api-0.3.3}/ayon_api/__init__.py

@@ -78,6 +78,8 @@ from ._api import (
     download_dependency_package,
     upload_dependency_package,
 
+    upload_addon_zip,
+
     get_bundles,
     create_bundle,
     update_bundle,
@@ -262,6 +264,8 @@ __all__ = (
     "download_dependency_package",
     "upload_dependency_package",
 
+    "upload_addon_zip",
+
     "get_bundles",
     "create_bundle",
     "update_bundle",

{ayon-python-api-0.3.2 → ayon-python-api-0.3.3}/ayon_api/_api.py

@@ -25,12 +25,29 @@ class GlobalServerAPI(ServerAPI):
     but that can be filled afterwards with calling 'login' method.
     """
 
-    def __init__(self, site_id=None, client_version=None):
+    def __init__(
+        self,
+        site_id=None,
+        client_version=None,
+        default_settings_variant=None,
+        ssl_verify=None,
+        cert=None,
+    ):
         url = self.get_url()
         token = self.get_token()
 
-        super(GlobalServerAPI, self).__init__(url, token, site_id, client_version)
-
+        super(GlobalServerAPI, self).__init__(
+            url,
+            token,
+            site_id,
+            client_version,
+            default_settings_variant,
+            ssl_verify,
+            cert,
+            # We want to make sure that server and api key validation
+            #   happens all the time in 'GlobalServerAPI'.
+            create_session=False,
+        )
         self.validate_server_availability()
         self.create_session()
 
@@ -129,17 +146,6 @@ class ServiceContext:
     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,
@@ -150,14 +156,8 @@ class ServiceContext:
         service_name=None,
         connect=True
     ):
-        token = cls.get_value_from_envs(
-            ("AY_API_KEY", "AYON_API_KEY"),
-            token
-        )
-        server_url = cls.get_value_from_envs(
-            ("AY_SERVER_URL", "AYON_SERVER_URL"),
-            server_url
-        )
+        token = token or os.environ.get("AYON_API_KEY")
+        server_url = server_url or os.environ.get("AYON_SERVER_URL")
         if not server_url:
             raise FailedServiceInit("URL to server is not set")
 
@@ -166,18 +166,9 @@ class ServiceContext:
                 "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
-        )
+        addon_name = addon_name or os.environ.get("AYON_ADDON_NAME")
+        addon_version = addon_version or os.environ.get("AYON_ADDON_VERSION")
+        service_name = service_name or os.environ.get("AYON_SERVICE_NAME")
 
         cls.token = token
         cls.server_url = server_url
@@ -618,6 +609,11 @@ def delete_dependency_package(*args, **kwargs):
     return con.delete_dependency_package(*args, **kwargs)
 
 
+def upload_addon_zip(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.upload_addon_zip(*args, **kwargs)
+
+
 def get_project_anatomy_presets(*args, **kwargs):
     con = get_server_api_connection()
     return con.get_project_anatomy_presets(*args, **kwargs)

{ayon-python-api-0.3.2 → ayon-python-api-0.3.3}/ayon_api/server_api.py

@@ -4,7 +4,6 @@ import io
 import json
 import logging
 import collections
-import datetime
 import platform
 import copy
 import uuid
@@ -325,6 +324,8 @@ class ServerAPI(object):
             available then 'True' is used.
         cert (Optional[str]): Path to certificate file. Looks for env
             variable value 'AYON_CERT_FILE' by default.
+        create_session (Optional[bool]): Create session for connection if
+            token is available. Default is True.
     """
 
     def __init__(
@@ -336,6 +337,7 @@ class ServerAPI(object):
         default_settings_variant=None,
         ssl_verify=None,
         cert=None,
+        create_session=True,
     ):
         if not base_url:
             raise ValueError("Invalid server URL {}".format(str(base_url)))
@@ -367,6 +369,7 @@ class ServerAPI(object):
 
         self._access_token_is_service = None
         self._token_is_valid = None
+        self._token_validation_started = False
         self._server_available = None
         self._server_version = None
         self._server_version_tuple = None
@@ -389,6 +392,11 @@ class ServerAPI(object):
         self._as_user_stack = _AsUserStack()
         self._thumbnail_cache = ThumbnailCache(True)
 
+        # Create session
+        if self._access_token and create_session:
+            self.validate_server_availability()
+            self.create_session()
+
     @property
     def log(self):
         if self._log is None:
@@ -652,6 +660,7 @@ class ServerAPI(object):
 
     def validate_token(self):
         try:
+            self._token_validation_started = True
             # TODO add other possible validations
             # - existence of 'user' key in info
             # - validate that 'site_id' is in 'sites' in info
@@ -661,6 +670,9 @@ class ServerAPI(object):
 
         except UnauthorizedError:
             self._token_is_valid = False
+
+        finally:
+            self._token_validation_started = False
         return self._token_is_valid
 
     def set_token(self, token):
@@ -673,8 +685,25 @@ class ServerAPI(object):
         self._token_is_valid = None
         self.close_session()
 
-    def create_session(self):
+    def create_session(self, ignore_existing=True, force=False):
+        """Create a connection session.
+
+        Session helps to keep connection with server without
+            need to reconnect on each call.
+
+        Args:
+            ignore_existing (bool): If session already exists,
+                ignore creation.
+            force (bool): If session already exists, close it and
+                create new.
+        """
+
+        if force and self._session is not None:
+            self.close_session()
+
         if self._session is not None:
+            if ignore_existing:
+                return
             raise ValueError("Session is already created.")
 
         self._as_user_stack.clear()
@@ -841,7 +870,19 @@ class ServerAPI(object):
                     self._access_token)
         return headers
 
-    def login(self, username, password):
+    def login(self, username, password, create_session=True):
+        """Login to server.
+
+        Args:
+            username (str): Username.
+            password (str): Password.
+            create_session (Optional[bool]): Create session after login.
+                Default: True.
+
+        Raises:
+            AuthenticationError: Login failed.
+        """
+
         if self.has_valid_token:
             try:
                 user_info = self.get_user()
@@ -851,7 +892,8 @@ class ServerAPI(object):
             current_username = user_info.get("name")
             if current_username == username:
                 self.close_session()
-                self.create_session()
+                if create_session:
+                    self.create_session()
                 return
 
         self.reset_token()
@@ -875,7 +917,9 @@ class ServerAPI(object):
 
         if not self.has_valid_token:
             raise AuthenticationError("Invalid credentials")
-        self.create_session()
+
+        if create_session:
+            self.create_session()
 
     def logout(self, soft=False):
         if self._access_token:
@@ -888,6 +932,15 @@ class ServerAPI(object):
 
     def _do_rest_request(self, function, url, **kwargs):
         if self._session is None:
+            # Validate token if was not yet validated
+            #    - ignore validation if we're in middle of
+            #       validation
+            if (
+                self._token_is_valid is None
+                and not self._token_validation_started
+            ):
+                self.validate_token()
+
             if "headers" not in kwargs:
                 kwargs["headers"] = self.get_headers()
 
@@ -1328,6 +1381,7 @@ class ServerAPI(object):
             response = post_func(url, data=stream, **kwargs)
         response.raise_for_status()
         progress.set_transferred_size(size)
+        return response
 
     def upload_file(
         self, endpoint, filepath, progress=None, request_type=None
@@ -1344,6 +1398,9 @@ class ServerAPI(object):
                 to track upload progress.
             request_type (Optional[RequestType]): Type of request that will
                 be used to upload file.
+
+        Returns:
+            requests.Response: Response object.
         """
 
         if endpoint.startswith(self._base_url):
@@ -1362,7 +1419,7 @@ class ServerAPI(object):
         progress.set_started()
 
         try:
-            self._upload_file(url, filepath, progress, request_type)
+            return self._upload_file(url, filepath, progress, request_type)
 
         except Exception as exc:
             progress.set_failed(str(exc))
@@ -1640,7 +1697,7 @@ class ServerAPI(object):
         Args:
             addon_name (str): Name of addon.
             addon_version (str): Version of addon.
-            subpaths (tuple[str]): Any amount of subpaths that are added to
+            *subpaths (str): Any amount of subpaths that are added to
                 addon url.
 
         Returns:
@@ -1848,9 +1905,12 @@ class ServerAPI(object):
             dst_filename (str): Destination filename.
             progress (Optional[TransferProgress]): Object that gives ability
                 to track download progress.
+
+        Returns:
+            requests.Response: Response object.
         """
 
-        self.upload_file(
+        return self.upload_file(
             "desktop/installers/{}".format(dst_filename),
             src_filepath,
             progress=progress
@@ -2162,6 +2222,33 @@ class ServerAPI(object):
 
         return create_dependency_package_basename(platform_name)
 
+    def upload_addon_zip(self, src_filepath, progress=None):
+        """Upload addon zip file to server.
+
+        File is validated on server. If it is valid, it is installed. It will
+            create an event job which can be tracked (tracking part is not
+            implemented yet).
+
+        Example output:
+            {'eventId': 'a1bfbdee27c611eea7580242ac120003'}
+
+        Args:
+            src_filepath (str): Path to a zip file.
+            progress (Optional[TransferProgress]): Object to keep track about
+                upload state.
+
+        Returns:
+            dict[str, Any]: Response data from server.
+        """
+
+        response = self.upload_file(
+            "addons/install",
+            src_filepath,
+            progress=progress,
+            request_type=RequestTypes.post,
+        )
+        return response.json()
+
     def _get_bundles_route(self):
         major, minor, patch, _, _ = self.server_version_tuple
         # Backwards compatibility for AYON server 0.3.0
@@ -3051,6 +3138,65 @@ class ServerAPI(object):
                 fill_own_attribs(project)
         return project
 
+    def get_folders_hierarchy(
+        self,
+        project_name,
+        search_string=None,
+        folder_types=None
+    ):
+        """Get project hierarchy.
+
+        All folders in project in hierarchy data structure.
+
+        Example output:
+            {
+                "hierarchy": [
+                    {
+                        "id": "...",
+                        "name": "...",
+                        "label": "...",
+                        "status": "...",
+                        "folderType": "...",
+                        "hasTasks": False,
+                        "taskNames": [],
+                        "parents": [],
+                        "parentId": None,
+                        "children": [...children folders...]
+                    },
+                    ...
+                ]
+            }
+
+        Args:
+            project_name (str): Project where to look for folders.
+            search_string (Optional[str]): Search string to filter folders.
+            folder_types (Optional[Iterable[str]]): Folder types to filter.
+
+        Returns:
+            dict[str, Any]: Response data from server.
+        """
+
+        if folder_types:
+            folder_types = ",".join(folder_types)
+
+        query_fields = [
+            "{}={}".format(key, value)
+            for key, value in (
+                ("search", search_string),
+                ("types", folder_types),
+            )
+            if value
+        ]
+        query = ""
+        if query_fields:
+            query = "?{}".format(",".join(query_fields))
+
+        response = self.get(
+            "projects/{}/hierarchy{}".format(project_name, query)
+        )
+        response.raise_for_status()
+        return response.data
+
     def get_folders(
         self,
         project_name,
@@ -3622,7 +3768,6 @@ class ServerAPI(object):
                 if filtered_product is not None:
                     yield filtered_product
 
-
     def get_product_by_id(
         self,
         project_name,

{ayon-python-api-0.3.2 → ayon-python-api-0.3.3}/ayon_api/utils.py

@@ -359,7 +359,7 @@ class TransferProgress:
     def __init__(self):
         self._started = False
         self._transfer_done = False
-        self._transfered = 0
+        self._transferred = 0
         self._content_size = None
 
         self._failed = False
@@ -369,25 +369,66 @@ class TransferProgress:
         self._destination_url = "N/A"
 
     def get_content_size(self):
+        """Content size in bytes.
+
+        Returns:
+            Union[int, None]: Content size in bytes or None
+                if is unknown.
+        """
+
         return self._content_size
 
     def set_content_size(self, content_size):
+        """Set content size in bytes.
+
+        Args:
+            content_size (int): Content size in bytes.
+
+        Raises:
+            ValueError: If content size was already set.
+        """
+
         if self._content_size is not None:
             raise ValueError("Content size was set more then once")
         self._content_size = content_size
 
     def get_started(self):
+        """Transfer was started.
+
+        Returns:
+            bool: True if transfer started.
+        """
+
         return self._started
 
     def set_started(self):
+        """Mark that transfer started.
+
+        Raises:
+            ValueError: If transfer was already started.
+        """
+
         if self._started:
             raise ValueError("Progress already started")
         self._started = True
 
     def get_transfer_done(self):
+        """Transfer finished.
+
+        Returns:
+            bool: Transfer finished.
+        """
+
         return self._transfer_done
 
     def set_transfer_done(self):
+        """Mark progress as transfer finished.
+
+        Raises:
+            ValueError: If progress was already marked as done
+                or wasn't started yet.
+        """
+
         if self._transfer_done:
             raise ValueError("Progress was already marked as done")
         if not self._started:
@@ -395,41 +436,117 @@ class TransferProgress:
         self._transfer_done = True
 
     def get_failed(self):
+        """Transfer failed.
+
+        Returns:
+            bool: True if transfer failed.
+        """
+
         return self._failed
 
     def get_fail_reason(self):
+        """Get reason why transfer failed.
+
+        Returns:
+            Union[str, None]: Reason why transfer
+                failed or None.
+        """
+
         return self._fail_reason
 
     def set_failed(self, reason):
+        """Mark progress as failed.
+
+        Args:
+            reason (str): Reason why transfer failed.
+        """
+
         self._fail_reason = reason
         self._failed = True
 
     def get_transferred_size(self):
-        return self._transfered
+        """Already transferred size in bytes.
+
+        Returns:
+            int: Already transferred size in bytes.
+        """
 
-    def set_transferred_size(self, transfered):
-        self._transfered = transfered
+        return self._transferred
+
+    def set_transferred_size(self, transferred):
+        """Set already transferred size in bytes.
+
+        Args:
+            transferred (int): Already transferred size in bytes.
+        """
+
+        self._transferred = transferred
 
     def add_transferred_chunk(self, chunk_size):
-        self._transfered += chunk_size
+        """Add transferred chunk size in bytes.
+
+        Args:
+            chunk_size (int): Add transferred chunk size
+                in bytes.
+        """
+        
+        self._transferred += chunk_size
 
     def get_source_url(self):
+        """Source url from where transfer happens.
+
+        Note:
+            Consider this as title. Must be set using
+                'set_source_url' or 'N/A' will be returned.
+
+        Returns:
+            str: Source url from where transfer happens.
+        """
+
         return self._source_url
 
     def set_source_url(self, url):
+        """Set source url from where transfer happens.
+
+        Args:
+            url (str): Source url from where transfer happens.
+        """
+
         self._source_url = url
 
     def get_destination_url(self):
+        """Destination url where transfer happens.
+
+        Note:
+            Consider this as title. Must be set using
+                'set_source_url' or 'N/A' will be returned.
+
+        Returns:
+            str: Destination url where transfer happens.
+        """
+
         return self._destination_url
 
     def set_destination_url(self, url):
+        """Set destination url where transfer happens.
+
+        Args:
+            url (str): Destination url where transfer happens.
+        """
+
         self._destination_url = url
 
     @property
     def is_running(self):
+        """Check if transfer is running.
+
+        Returns:
+            bool: True if transfer is running.
+        """
+
         if (
             not self.started
-            or self.done
+            or self.transfer_done
             or self.failed
         ):
             return False
@@ -437,9 +554,16 @@ class TransferProgress:
 
     @property
     def transfer_progress(self):
+        """Get transfer progress in percents.
+
+        Returns:
+            Union[float, None]: Transfer progress in percents or 'None'
+                if content size is unknown.
+        """
+
         if self._content_size is None:
             return None
-        return (self._transfered * 100.0) / float(self._content_size)
+        return (self._transferred * 100.0) / float(self._content_size)
 
     content_size = property(get_content_size, set_content_size)
     started = property(get_started)
@@ -448,7 +572,6 @@ class TransferProgress:
     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)
     transferred_size = property(get_transferred_size, set_transferred_size)
 
 

{ayon-python-api-0.3.2 → ayon-python-api-0.3.3}/ayon_api/version.py

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

{ayon-python-api-0.3.2 → ayon-python-api-0.3.3}/ayon_python_api.egg-info/PKG-INFO

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

{ayon-python-api-0.3.2 → ayon-python-api-0.3.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ayon-python-api"
-version = "0.3.2"
+version = "0.3.3"
 description = "AYON Python API"
 license = {file = "LICENSE"}
 readme = {file = "README.md", content-type = "text/markdown"}