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

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

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

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

@@ -1,6 +1,8 @@
+from .version import __version__
 from .utils import (
     TransferProgress,
     slugify_string,
+    create_dependency_package_basename,
 )
 from .server_api import (
     ServerAPI,
@@ -183,8 +185,11 @@ from ._api import (
 
 
 __all__ = (
+    "__version__",
+
     "TransferProgress",
     "slugify_string",
+    "create_dependency_package_basename",
 
     "ServerAPI",
 

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

@@ -61,6 +61,7 @@ from .utils import (
     entity_data_json_default,
     failed_json_default,
     TransferProgress,
+    create_dependency_package_basename,
 )
 
 PatternType = type(re.compile(""))
@@ -114,6 +115,10 @@ class RestApiResponse(object):
         self.status = status_code
         self._data = data
 
+    @property
+    def text(self):
+        return self._response.text
+
     @property
     def orig_response(self):
         return self._response
@@ -150,11 +155,13 @@ class RestApiResponse(object):
     def status_code(self):
         return self.status
 
-    def raise_for_status(self):
+    def raise_for_status(self, message=None):
         try:
             self._response.raise_for_status()
         except requests.exceptions.HTTPError as exc:
-            raise HTTPRequestError(str(exc), exc.response)
+            if message is None:
+                message = str(exc)
+            raise HTTPRequestError(message, exc.response)
 
     def __enter__(self, *args, **kwargs):
         return self._response.__enter__(*args, **kwargs)
@@ -1303,13 +1310,15 @@ class ServerAPI(object):
             progress.set_transfer_done()
         return progress
 
-    def _upload_file(self, url, filepath, progress):
+    def _upload_file(self, url, filepath, progress, request_type=None):
+        if request_type is None:
+            request_type = RequestTypes.put
         kwargs = {}
         if self._session is None:
             kwargs["headers"] = self.get_headers()
-            post_func = self._base_functions_mapping[RequestTypes.post]
+            post_func = self._base_functions_mapping[request_type]
         else:
-            post_func = self._session_functions_mapping[RequestTypes.post]
+            post_func = self._session_functions_mapping[request_type]
 
         with open(filepath, "rb") as stream:
             stream.seek(0, io.SEEK_END)
@@ -1320,7 +1329,9 @@ class ServerAPI(object):
         response.raise_for_status()
         progress.set_transferred_size(size)
 
-    def upload_file(self, endpoint, filepath, progress=None):
+    def upload_file(
+        self, endpoint, filepath, progress=None, request_type=None
+    ):
         """Upload file to server.
 
         Todos:
@@ -1331,6 +1342,8 @@ class ServerAPI(object):
             filepath (str): Source filepath.
             progress (Optional[TransferProgress]): Object that gives ability
                 to track upload progress.
+            request_type (Optional[RequestType]): Type of request that will
+                be used to upload file.
         """
 
         if endpoint.startswith(self._base_url):
@@ -1349,7 +1362,7 @@ class ServerAPI(object):
         progress.set_started()
 
         try:
-            self._upload_file(url, filepath, progress)
+            self._upload_file(url, filepath, progress, request_type)
 
         except Exception as exc:
             progress.set_failed(str(exc))
@@ -1486,13 +1499,11 @@ class ServerAPI(object):
         """
 
         response = self.delete("attributes/{}".format(attribute_name))
-        if response.status_code != 204:
-            # TODO raise different exception
-            raise ValueError(
-                "Attribute \"{}\" was not created/updated. {}".format(
-                    attribute_name, response.detail
-                )
+        response.raise_for_status(
+            "Attribute \"{}\" was not created/updated. {}".format(
+                attribute_name, response.detail
             )
+        )
 
         self.reset_attributes_schema()
 
@@ -1732,8 +1743,9 @@ class ServerAPI(object):
         python_version,
         platform_name,
         python_modules,
+        runtime_python_modules,
         checksum,
-        checksum_type,
+        checksum_algorithm,
         file_size,
         sources=None,
     ):
@@ -1742,6 +1754,10 @@ class ServerAPI(object):
         This step will create only metadata. Make sure to upload installer
             to the server using 'upload_installer' method.
 
+        Runtime python modules are modules that are required to run AYON
+            desktop application, but are not added to PYTHONPATH for any
+            subprocess.
+
         Args:
             filename (str): Installer filename.
             version (str): Version of installer.
@@ -1749,8 +1765,10 @@ class ServerAPI(object):
             platform_name (str): Name of platform.
             python_modules (dict[str, str]): Python modules that are available
                 in installer.
+            runtime_python_modules (dict[str, str]): Runtime python modules
+                that are available in installer.
             checksum (str): Installer file checksum.
-            checksum_type (str): Type of checksum used to create checksum.
+            checksum_algorithm (str): Type of checksum used to create checksum.
             file_size (int): File size.
             sources (Optional[list[dict[str, Any]]]): List of sources that
                 can be used to download file.
@@ -1762,8 +1780,9 @@ class ServerAPI(object):
             "pythonVersion": python_version,
             "platform": platform_name,
             "pythonModules": python_modules,
+            "runtimePythonModules": runtime_python_modules,
             "checksum": checksum,
-            "checksumType": checksum_type,
+            "checksumAlgorithm": checksum_algorithm,
             "size": file_size,
         }
         if sources:
@@ -1781,7 +1800,7 @@ class ServerAPI(object):
                 can be used to download file. Fully replaces existing sources.
         """
 
-        response = self.post(
+        response = self.patch(
             "desktop/installers/{}".format(filename),
             sources=sources
         )
@@ -1794,7 +1813,7 @@ class ServerAPI(object):
             filename (str): Installer filename.
         """
 
-        response = self.delete("dekstop/installers/{}".format(filename))
+        response = self.delete("desktop/installers/{}".format(filename))
         response.raise_for_status()
 
     def download_installer(
@@ -1929,8 +1948,7 @@ class ServerAPI(object):
             checksum=checksum,
             **kwargs
         )
-        if response.status not in (200, 201, 204):
-            raise ServerError("Failed to create/update dependency")
+        response.raise_for_status("Failed to create/update dependency")
         return response.data
 
     def get_dependency_packages(self):
@@ -1964,6 +1982,24 @@ class ServerAPI(object):
         result.raise_for_status()
         return result.data
 
+    def _get_dependency_package_route(
+        self, filename=None, platform_name=None
+    ):
+        major, minor, patch, _, _ = self.server_version_tuple
+        if major == 0 and (minor > 2 or (minor == 2 and patch >= 1)):
+            base = "desktop/dependency_packages"
+            if not filename:
+                return base
+            return "{}/{}".format(base, filename)
+
+        # Backwards compatibility for AYON server 0.2.0 and lower
+        if platform_name is None:
+            platform_name = platform.system().lower()
+        base = "dependencies"
+        if not filename:
+            return base
+        return "{}/{}/{}".format(base, filename, platform_name)
+
     def create_dependency_package(
         self,
         filename,
@@ -2014,7 +2050,8 @@ class ServerAPI(object):
         if sources:
             post_body["sources"] = sources
 
-        response = self.post("desktop/dependency_packages", **post_body)
+        route = self._get_dependency_package_route()
+        response = self.post(route, **post_body)
         response.raise_for_status()
 
     def update_dependency_package(self, filename, sources):
@@ -2028,7 +2065,7 @@ class ServerAPI(object):
         """
 
         response = self.patch(
-            "desktop/dependency_packages/{}".format(filename),
+            self._get_dependency_package_route(filename),
             sources=sources
         )
         response.raise_for_status()
@@ -2044,18 +2081,9 @@ class ServerAPI(object):
                 Deprecated since version 0.2.1
         """
 
-        major, minor, patch, _, _ = self.server_version_tuple
-        if major == 0 and (minor > 2 or (minor == 2 and patch >= 1)):
-            url = "desktop/dependency_packages/{}".format(filename)
-        else:
-            # Backwards compatibility for AYON server 0.2.0 and lower
-            if platform_name is None:
-                platform_name = platform.system().lower()
-            url = "dependencies/{}/{}".format(filename, platform_name)
-
-        response = self.delete(url)
-        if response.status != 200:
-            raise ServerError("Failed to delete dependency file")
+        route = self._get_dependency_package_route(filename, platform_name)
+        response = self.delete(route)
+        response.raise_for_status("Failed to delete dependency file")
         return response.data
 
     def download_dependency_package(
@@ -2089,18 +2117,10 @@ class ServerAPI(object):
             str: Filepath to downloaded file.
        """
 
-        major, minor, patch, _, _ = self.server_version_tuple
-        if major == 0 and (minor > 2 or (minor == 2 and patch >= 1)):
-            url = "desktop/dependency_packages/{}".format(src_filename)
-        else:
-            # Backwards compatibility for AYON server 0.2.0 and lower
-            if platform_name is None:
-                platform_name = platform.system().lower()
-            url = "dependencies/{}/{}".format(src_filename, platform_name)
-
+        route = self._get_dependency_package_route(src_filename, platform_name)
         package_filepath = os.path.join(dst_directory, dst_filename)
         self.download_file(
-            url,
+            route,
             package_filepath,
             chunk_size=chunk_size,
             progress=progress
@@ -2122,20 +2142,16 @@ class ServerAPI(object):
                 upload state.
         """
 
-        major, minor, patch, _, _ = self.server_version_tuple
-        if major == 0 and (minor > 2 or (minor == 2 and patch >= 1)):
-            url = "desktop/dependency_packages/{}".format(dst_filename)
-        else:
-            # Backwards compatibility for AYON server 0.2.0 and lower
-            if platform_name is None:
-                platform_name = platform.system().lower()
-            url = "dependencies/{}/{}".format(dst_filename, platform_name)
-
-        self.upload_file(url, src_filepath, progress=progress)
+        route = self._get_dependency_package_route(dst_filename, platform_name)
+        self.upload_file(route, src_filepath, progress=progress)
 
     def create_dependency_package_basename(self, platform_name=None):
         """Create basename for dependency package file.
 
+        Deprecated:
+            Use 'create_dependency_package_basename' from `ayon_api` or
+                `ayon_api.utils` instead.
+
         Args:
             platform_name (Optional[str]): Name of platform for which the
                 bundle is targeted. Default value is current platform.
@@ -2144,12 +2160,15 @@ class ServerAPI(object):
             str: Dependency package name with timestamp and platform.
         """
 
-        if platform_name is None:
-            platform_name = platform.system().lower()
+        return create_dependency_package_basename(platform_name)
 
-        now_date = datetime.datetime.now()
-        time_stamp = now_date.strftime("%y%m%d%H%M")
-        return "ayon_{}_{}".format(time_stamp, platform_name)
+    def _get_bundles_route(self):
+        major, minor, patch, _, _ = self.server_version_tuple
+        # Backwards compatibility for AYON server 0.3.0
+        # - first version where bundles were available
+        if major == 0 and minor == 3 and patch == 0:
+            return "desktop/bundles"
+        return "bundles"
 
     def get_bundles(self):
         """Server bundles with basic information.
@@ -2181,7 +2200,7 @@ class ServerAPI(object):
             dict[str, Any]: Server bundles with basic information.
         """
 
-        response = self.get("desktop/bundles")
+        response = self.get(self._get_bundles_route())
         response.raise_for_status()
         return response.data
 
@@ -2224,7 +2243,7 @@ class ServerAPI(object):
             if value is not None:
                 body[key] = value
 
-        response = self.post("desktop/bundles", **body)
+        response = self.post(self._get_bundles_route(), **body)
         response.raise_for_status()
 
     def update_bundle(
@@ -2259,7 +2278,8 @@ class ServerAPI(object):
             if value is not None
         }
         response = self.patch(
-            "desktop/bundles/{}".format(bundle_name), **body
+            "{}/{}".format(self._get_bundles_route(), bundle_name),
+            **body
         )
         response.raise_for_status()
 
@@ -2270,7 +2290,9 @@ class ServerAPI(object):
             bundle_name (str): Name of bundle to delete.
         """
 
-        response = self.delete("desktop/bundles/{}".format(bundle_name))
+        response = self.delete(
+            "{}/{}".format(self._get_bundles_route(), bundle_name)
+        )
         response.raise_for_status()
 
     # Anatomy presets

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

@@ -2,6 +2,7 @@ import re
 import datetime
 import uuid
 import string
+import platform
 import collections
 try:
     # Python 3
@@ -449,3 +450,22 @@ class TransferProgress:
     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)
+
+
+def create_dependency_package_basename(platform_name=None):
+    """Create basename for dependency package file.
+
+    Args:
+        platform_name (Optional[str]): Name of platform for which the
+            bundle is targeted. Default value is current platform.
+
+    Returns:
+        str: Dependency package name with timestamp and platform.
+    """
+
+    if platform_name is None:
+        platform_name = platform.system().lower()
+
+    now_date = datetime.datetime.now()
+    time_stamp = now_date.strftime("%y%m%d%H%M")
+    return "ayon_{}_{}".format(time_stamp, platform_name)

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

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

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

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

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

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