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

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

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

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

@@ -1,3 +1,6 @@
+from .utils import (
+    TransferProgress,
+)
 from .server import (
     ServerAPIBase,
 )
@@ -7,6 +10,9 @@ from .server_api import (
 
     get_server_api_connection,
 
+    get_base_url,
+    get_rest_url,
+
     raw_get,
     raw_post,
     raw_put,
@@ -25,6 +31,7 @@ from .server_api import (
     query_graphql,
 
     get_addons_info,
+    download_addon_private_file,
 
     get_dependencies_info,
     update_dependency_info,
@@ -91,12 +98,17 @@ from .server_api import (
 
 
 __all__ = (
+    "TransferProgress",
+
     "ServerAPIBase",
 
     "ServerAPI",
 
     "get_server_api_connection",
 
+    "get_base_url",
+    "get_rest_url",
+
     "raw_get",
     "raw_post",
     "raw_put",
@@ -115,6 +127,7 @@ __all__ = (
     "query_graphql",
 
     "get_addons_info",
+    "download_addon_private_file",
 
     "get_dependencies_info",
     "update_dependency_info",

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

@@ -1,5 +1,6 @@
 import os
 import re
+import io
 import json
 import logging
 import collections
@@ -43,7 +44,8 @@ from .utils import (
     logout_from_server,
     create_entity_id,
     entity_data_json_default,
-    failed_json_default
+    failed_json_default,
+    TransferProgress,
 )
 
 JSONDecodeError = getattr(json, "JSONDecodeError", ValueError)
@@ -200,6 +202,15 @@ class ServerAPIBase(object):
 
         self._thumbnail_cache = ThumbnailCache(True)
 
+    def get_base_url(self):
+        return self._base_url
+
+    def get_rest_url(self):
+        return self._rest_url
+
+    base_url = property(get_base_url)
+    rest_url = property(get_rest_url)
+
     @property
     def access_token(self):
         return self._access_token
@@ -544,22 +555,125 @@ class ServerAPIBase(object):
     def delete(self, entrypoint, **kwargs):
         return self.raw_delete(entrypoint, params=kwargs)
 
-    def download_file(self, endpoint, filepath, chunk_size=None):
-        if not chunk_size:
-            # 1 MB chunk by default
-            chunk_size = 1024 * 1024
+    def _download_file(self, url, filepath, chunk_size, progress):
         dst_directory = os.path.dirname(filepath)
         if not os.path.exists(dst_directory):
             os.makedirs(dst_directory)
 
+        kwargs = {"stream": True}
+        if self._session is None:
+            kwargs["headers"] = self.get_headers()
+            get_func = self._base_functions_mapping[RequestTypes.get]
+        else:
+            get_func = self._session_functions_mapping[RequestTypes.get]
+
         with open(filepath, "wb") as f_stream:
-            with self.raw_get(endpoint, stream=True) as response:
+            with get_func(url, **kwargs) as response:
+                response.raise_for_status()
+                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))
+
+    def download_file(self, endpoint, filepath, chunk_size=None, progress=None):
+        """Download file from AYON server.
+
+        Endpoint can be full url (must start with 'base_url' of api object).
+
+        Progress object can be used to track download. Can be used when
+        download happens in thread and other thread want to catch changes over
+        time.
+
+        Args:
+            endpoint (str): Endpoint or URL to file that should be downloaded.
+            filepath (str): Path where file will be downloaded.
+            chunk_size (int): Size of chunks that are received in single loop.
+            progress (TransferProgress): Object that gives ability to track
+                download progress.
+        """
+
+        if not chunk_size:
+            # 1 MB chunk by default
+            chunk_size = 1024 * 1024
+
+        if endpoint.startswith(self._base_url):
+            url = endpoint
+        else:
+            endpoint = endpoint.lstrip("/").rstrip("/")
+            url = "{}/{}".format(self._rest_url, endpoint)
+
+        # Create dummy object so the function does not have to check
+        #   'progress' variable everywhere
+        if progress is None:
+            progress = TransferProgress()
+
+        progress.set_source_url(url)
+        progress.set_destination_url(filepath)
+        progress.set_started()
+        try:
+            self._download_file(url, filepath, chunk_size, progress)
+
+        except Exception as exc:
+            progress.set_failed(str(exc))
+            raise
+
+        finally:
+            progress.set_done()
+
+    def _upload_file(self, url, filepath, progress):
+        kwargs = {}
+        if self._session is None:
+            kwargs["headers"] = self.get_headers()
+            post_func = self._base_functions_mapping[RequestTypes.post]
+        else:
+            post_func = self._session_functions_mapping[RequestTypes.post]
 
-    def upload_file(self, endpoint, filepath):
         with open(filepath, "rb") as stream:
-            self.raw_post(endpoint, data=stream)
+            stream.seek(0, io.SEEK_END)
+            size = stream.tell()
+            stream.seek(0)
+            progress.set_content_size(size)
+            response = post_func(url, data=stream, **kwargs)
+        response.raise_for_status()
+        progress.set_downloaded_size(size)
+
+    def upload_file(self, endpoint, filepath, progress=None):
+        """Upload file to server.
+
+        Todos:
+            Uploading with more detailed progress.
+
+        Args:
+            endpoint (str): Endpoint or url where file will be uploaded.
+            filepath (str): Source filepath.
+            progress (TransferProgress): Object that gives ability to track
+                upload progress.
+        """
+
+        if endpoint.startswith(self._base_url):
+            url = endpoint
+        else:
+            endpoint = endpoint.lstrip("/").rstrip("/")
+            url = "{}/{}".format(self._rest_url, endpoint)
+
+        # Create dummy object so the function does not have to check
+        #   'progress' variable everywhere
+        if progress is None:
+            progress = TransferProgress()
+
+        progress.set_source_url(filepath)
+        progress.set_destination_url(url)
+        progress.set_started()
+
+        try:
+            self._upload_file(url, filepath, progress)
+
+        except Exception as exc:
+            progress.set_failed(str(exc))
+            raise
+
+        finally:
+            progress.set_done()
 
     def trigger_server_restart(self):
         result = self.post("system/restart")
@@ -779,6 +893,55 @@ class ServerAPIBase(object):
             raise ServerError(response.text)
         return response.data
 
+    def download_addon_private_file(
+        self,
+        addon_name,
+        addon_version,
+        filename,
+        destination_dir,
+        destination_filename=None,
+        chunk_size=None,
+        progress=None,
+    ):
+        """Download a file from addon private files.
+
+        This method requires to have authorized token available. Private files
+        are not under '/api' restpoint.
+
+        Args:
+            addon_name (str): Addon name.
+            addon_version (str): Addon version.
+            filename (str): Filename in private folder on server.
+            destination_dir (str): Where the file should be downloaded.
+            destination_filename (str): Name of destination filename. Source
+                filename is used if not passed.
+            chunk_size (int): Download chunk size.
+            progress (TransferProgress): Object that gives ability to track
+                download progress.
+
+        Returns:
+            str: Filepath to downloaded file.
+        """
+
+        if not destination_filename:
+            destination_filename = filename
+        dst_filepath = os.path.join(destination_dir, destination_filename)
+        # Filename can contain "subfolders"
+        dst_dirpath = os.path.dirname(dst_filepath)
+        if not os.path.exists(dst_dirpath):
+            os.makedirs(dst_dirpath)
+
+        url = "{}/addons/{}/{}/private/{}".format(
+            self._base_url,
+            addon_name,
+            addon_version,
+            filename
+        )
+        self.download_file(
+            url, dst_filepath, chunk_size=chunk_size, progress=progress
+        )
+        return dst_filepath
+
     def get_dependencies_info(self):
         result = self.get("dependencies")
         return result.data
@@ -839,29 +1002,53 @@ class ServerAPIBase(object):
 
     def download_dependency_package(
         self,
-        dst_directory,
         package_name,
-        platform_name=None
+        dst_directory,
+        filename,
+        platform_name=None,
+        chunk_size=None,
+        progress=None,
     ):
+        """Download dependency package from server.
+
+        This method requires to have authorized token available. The package is
+        only downloaded.
+
+        Args:
+            package_name (str): Name of package to download.
+            dst_directory (str): Where the file should be downloaded.
+            filename (str): Name of destination filename.
+            platform_name (str): Name of platform for which the dependency
+                package is targetter. Default value is current platform.
+            chunk_size (int): Download chunk size.
+            progress (TransferProgress): Object that gives ability to track
+                download progress.
+
+        Returns:
+            str: Filepath to downloaded file.
+       """
         if platform_name is None:
             platform_name = platform.system().lower()
 
-        package_filepath = os.path.join(dst_directory, package_name + ".zip")
+        package_filepath = os.path.join(dst_directory, filename)
         self.download_file(
             "dependencies/{}/{}".format(package_name, platform_name),
-            package_filepath
+            package_filepath,
+            chunk_size=chunk_size,
+            progress=progress
         )
         return package_filepath
 
     def upload_dependency_package(
-        self, filepath, package_name, platform_name=None
+        self, filepath, package_name, platform_name=None, progress=None
     ):
         if platform_name is None:
             platform_name = platform.system().lower()
 
         self.upload_file(
             "dependencies/{}/{}".format(package_name, platform_name),
-            filepath
+            filepath,
+            progress=progress
         )
 
     def delete_dependency_package(self, package_name, platform_name=None):

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

@@ -85,6 +85,16 @@ def get_server_api_connection():
     return GlobalContext.get_server_api_connection()
 
 
+def get_base_url():
+    con = get_server_api_connection()
+    return con.get_base_url()
+
+
+def get_rest_url():
+    con = get_server_api_connection()
+    return con.get_rest_url()
+
+
 def raw_get(*args, **kwargs):
     con = get_server_api_connection()
     return con.raw_get(*args, **kwargs)
@@ -170,6 +180,11 @@ def get_addons_info(*args, **kwargs):
     return con.get_addons_info(*args, **kwargs)
 
 
+def download_addon_private_file(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.download_addon_private_file(*args, **kwargs)
+
+
 def get_dependencies_info(*args, **kwargs):
     con = get_server_api_connection()
     return con.get_dependencies_info(*args, **kwargs)

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

@@ -265,3 +265,102 @@ def validate_url(url):
         title="Couldn't connect to server",
         hints=hints + universal_hints
     )
+
+
+class TransferProgress:
+    """Object to store progress of download/upload from/to server."""
+
+    def __init__(self):
+        self._started = False
+        self._done = False
+        self._downloaded = 0
+        self._content_size = None
+
+        self._failed = False
+        self._fail_reason = None
+
+        self._source_url = "N/A"
+        self._destination_url = "N/A"
+
+    def get_content_size(self):
+        return self._content_size
+
+    def set_content_size(self, content_size):
+        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):
+        return self._started
+
+    def set_started(self):
+        if self._started:
+            raise ValueError("Progress already started")
+        self._started = True
+
+    def get_done(self):
+        return self._done
+
+    def set_done(self):
+        if self._done:
+            raise ValueError("Progress was already marked as done")
+        if not self._started:
+            raise ValueError("Progress didn't start yet")
+        self._done = True
+
+    def get_failed(self):
+        return self._failed
+
+    def get_fail_reason(self):
+        return self._fail_reason
+
+    def set_failed(self, reason):
+        self._fail_reason = reason
+        self._failed = True
+
+    def get_downloaded_size(self):
+        return self._downloaded
+
+    def set_downloaded_size(self, downloaded_size):
+        self._downloaded = downloaded_size
+
+    def add_downloaded_chunk(self, chunk_size):
+        self._downloaded += chunk_size
+
+    def get_source_url(self):
+        return self._source_url
+
+    def set_source_url(self, url):
+        self._source_url = url
+
+    def get_destination_url(self):
+        return self._destination_url
+
+    def set_destination_url(self, url):
+        self._destination_url = url
+
+    @property
+    def is_running(self):
+        if (
+            not self.started
+            or self.done
+            or self.failed
+        ):
+            return False
+        return True
+
+    @property
+    def progress(self):
+        if self._content_size is None:
+            return None
+        return (self._downloaded * 100.0) / float(self._content_size)
+
+    content_size = property(get_content_size, set_content_size)
+    started = property(get_started)
+    done = property(get_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)

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

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

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

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

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

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