Ayon-Python-Api 0.4.2__tar.gz → 0.5.0__tar.gz

{ayon-python-api-0.4.2 → ayon-python-api-0.5.0}/PKG-INFO

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

{ayon-python-api-0.4.2 → ayon-python-api-0.5.0}/ayon_api/_api.py

@@ -602,12 +602,12 @@ def delete_installer(*args, **kwargs):
 
 def download_installer(*args, **kwargs):
     con = get_server_api_connection()
-    con.download_installer(*args, **kwargs)
+    return con.download_installer(*args, **kwargs)
 
 
 def upload_installer(*args, **kwargs):
     con = get_server_api_connection()
-    con.upload_installer(*args, **kwargs)
+    return con.upload_installer(*args, **kwargs)
 
 
 # Dependency packages
@@ -978,12 +978,14 @@ def delete_project(project_name):
 
 def get_thumbnail_by_id(project_name, thumbnail_id):
     con = get_server_api_connection()
-    con.get_thumbnail_by_id(project_name, thumbnail_id)
+    return con.get_thumbnail_by_id(project_name, thumbnail_id)
 
 
 def get_thumbnail(project_name, entity_type, entity_id, thumbnail_id=None):
     con = get_server_api_connection()
-    con.get_thumbnail(project_name, entity_type, entity_id, thumbnail_id)
+    return con.get_thumbnail(
+        project_name, entity_type, entity_id, thumbnail_id
+    )
 
 
 def get_folder_thumbnail(project_name, folder_id, thumbnail_id=None):

{ayon-python-api-0.4.2 → ayon-python-api-0.5.0}/ayon_api/graphql_queries.py

@@ -144,6 +144,7 @@ def product_types_query(fields):
             query_queue.append((k, v, field))
     return query
 
+
 def project_product_types_query(fields):
     query = GraphQlQuery("ProjectProductTypes")
     project_query = query.add_field("project")

{ayon-python-api-0.4.2 → ayon-python-api-0.5.0}/ayon_api/server_api.py

@@ -931,8 +931,8 @@ class ServerAPI(object):
                 int(re_match.group("major")),
                 int(re_match.group("minor")),
                 int(re_match.group("patch")),
-                re_match.group("prerelease"),
-                re_match.group("buildmetadata")
+                re_match.group("prerelease") or "",
+                re_match.group("buildmetadata") or "",
             )
         return self._server_version_tuple
 
@@ -1133,31 +1133,41 @@ class ServerAPI(object):
 
         response = None
         new_response = None
-        for _ in range(max_retries):
+        for retry_idx in reversed(range(max_retries)):
             try:
                 response = function(url, **kwargs)
                 break
 
             except ConnectionRefusedError:
+                if retry_idx == 0:
+                    self.log.warning(
+                        "Connection error happened.", exc_info=True
+                    )
+
                 # Server may be restarting
                 new_response = RestApiResponse(
                     None,
                     {"detail": "Unable to connect the server. Connection refused"}
                 )
+
             except requests.exceptions.Timeout:
                 # Connection timed out
                 new_response = RestApiResponse(
                     None,
                     {"detail": "Connection timed out."}
                 )
+
             except requests.exceptions.ConnectionError:
-                # Other connection error (ssl, etc) - does not make sense to
-                #   try call server again
+                # Log warning only on last attempt
+                if retry_idx == 0:
+                    self.log.warning(
+                        "Connection error happened.", exc_info=True
+                    )
+
                 new_response = RestApiResponse(
                     None,
                     {"detail": "Unable to connect the server. Connection error"}
                 )
-                break
 
             time.sleep(0.1)
 
@@ -1342,7 +1352,9 @@ class ServerAPI(object):
         status=None,
         description=None,
         summary=None,
-        payload=None
+        payload=None,
+        progress=None,
+        retries=None
     ):
         kwargs = {
             key: value
@@ -1353,9 +1365,27 @@ class ServerAPI(object):
                 ("description", description),
                 ("summary", summary),
                 ("payload", payload),
+                ("progress", progress),
+                ("retries", retries),
             )
             if value is not None
         }
+        # 'progress' and 'retries' are available since 0.5.x server version
+        major, minor, _, _, _ = self.server_version_tuple
+        if (major, minor) < (0, 5):
+            args = []
+            if progress is not None:
+                args.append("progress")
+            if retries is not None:
+                args.append("retries")
+            fields = ", ".join("'{}'".format(f) for f in args)
+            ending = "s" if len(args) > 1 else ""
+            raise ValueError((
+                 "Your server version '{}' does not support update"
+                 " of {} field{} on event. The fields are supported since"
+                 " server version '0.5'."
+            ).format(self.get_server_version(), fields, ending))
+
         response = self.patch(
             "events/{}".format(event_id),
             **kwargs
@@ -1427,6 +1457,7 @@ class ServerAPI(object):
         description=None,
         sequential=None,
         events_filter=None,
+        max_retries=None,
     ):
         """Enroll job based on events.
 
@@ -1468,8 +1499,12 @@ class ServerAPI(object):
                 in target event.
             sequential (Optional[bool]): The source topic must be processed
                 in sequence.
-            events_filter (Optional[ayon_server.sqlfilter.Filter]): A dict-like
-                with conditions to filter the source event.
+            events_filter (Optional[dict[str, Any]]): Filtering conditions
+                to filter the source event. For more technical specifications
+                look to server backed 'ayon_server.sqlfilter.Filter'.
+                TODO: Add example of filters.
+            max_retries (Optional[int]): How many times can be event retried.
+                Default value is based on server (3 at the time of this PR).
 
         Returns:
             Union[None, dict[str, Any]]: None if there is no event matching
@@ -1480,6 +1515,7 @@ class ServerAPI(object):
             "sourceTopic": source_topic,
             "targetTopic": target_topic,
             "sender": sender,
+            "maxRetries": max_retries,
         }
         if sequential is not None:
             kwargs["sequential"] = sequential
@@ -2229,6 +2265,34 @@ class ServerAPI(object):
         response.raise_for_status("Failed to create/update dependency")
         return response.data
 
+    def _get_dependency_package_route(
+        self, filename=None, platform_name=None
+    ):
+        major, minor, patch, _, _ = self.server_version_tuple
+        if (major, minor, patch) <= (0, 2, 0):
+            # Backwards compatibility for AYON server 0.2.0 and lower
+            self.log.warning((
+                "Using deprecated dependency package route."
+                " Please update your AYON server to version 0.2.1 or higher."
+                " Backwards compatibility for this route will be removed"
+                " in future releases of ayon-python-api."
+            ))
+            if platform_name is None:
+                platform_name = platform.system().lower()
+            base = "dependencies"
+            if not filename:
+                return base
+            return "{}/{}/{}".format(base, filename, platform_name)
+
+        if (major, minor) <= (0, 3):
+            endpoint = "desktop/dependency_packages"
+        else:
+            endpoint = "desktop/dependencyPackages"
+
+        if filename:
+            return "{}/{}".format(endpoint, filename)
+        return endpoint
+
     def get_dependency_packages(self):
         """Information about dependency packages on server.
 
@@ -2256,33 +2320,11 @@ class ServerAPI(object):
                 server.
         """
 
-        endpoint = "desktop/dependencyPackages"
-        major, minor, _, _, _ = self.server_version_tuple
-        if major == 0 and minor <= 3:
-            endpoint = "desktop/dependency_packages"
-
+        endpoint = self._get_dependency_package_route()
         result = self.get(endpoint)
         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,
@@ -4323,9 +4365,6 @@ class ServerAPI(object):
                 fields.remove("attrib")
                 fields |= self.get_attributes_fields_for_type("version")
 
-        if active is not None:
-            fields.add("active")
-
         # Make sure fields have minimum required fields
         fields |= {"id", "version"}
 
@@ -4334,6 +4373,9 @@ class ServerAPI(object):
             use_rest = True
             fields = {"id"}
 
+        if active is not None:
+            fields.add("active")
+
         if own_attributes:
             fields.add("ownAttrib")
 

{ayon-python-api-0.4.2 → ayon-python-api-0.5.0}/ayon_api/utils.py

@@ -263,19 +263,23 @@ def _try_connect_to_server(url, timeout=None):
     return True
 
 
-def login_to_server(url, username, password):
+def login_to_server(url, username, password, timeout=None):
     """Use login to the server to receive token.
 
     Args:
         url (str): Server url.
         username (str): User's username.
         password (str): User's password.
+        timeout (Optional[float]): Timeout for request. Value from
+            'get_default_timeout' is used if not specified.
 
     Returns:
         Union[str, None]: User's token if login was successfull.
             Otherwise 'None'.
     """
 
+    if timeout is None:
+        timeout = get_default_timeout()
     headers = {"Content-Type": "application/json"}
     response = requests.post(
         "{}/api/auth/login".format(url),
@@ -283,7 +287,8 @@ def login_to_server(url, username, password):
         json={
             "name": username,
             "password": password
-        }
+        },
+        timeout=timeout,
     )
     token = None
     # 200 - success
@@ -294,44 +299,64 @@ def login_to_server(url, username, password):
     return token
 
 
-def logout_from_server(url, token):
+def logout_from_server(url, token, timeout=None):
     """Logout from server and throw token away.
 
     Args:
         url (str): Url from which should be logged out.
         token (str): Token which should be used to log out.
+        timeout (Optional[float]): Timeout for request. Value from
+            'get_default_timeout' is used if not specified.
     """
 
+    if timeout is None:
+        timeout = get_default_timeout()
     headers = {
         "Content-Type": "application/json",
         "Authorization": "Bearer {}".format(token)
     }
     requests.post(
         url + "/api/auth/logout",
-        headers=headers
+        headers=headers,
+        timeout=timeout,
     )
 
 
-def is_token_valid(url, token):
+def is_token_valid(url, token, timeout=None):
     """Check if token is valid.
 
+    Token can be a user token or service api key.
+
     Args:
         url (str): Server url.
         token (str): User's token.
+        timeout (Optional[float]): Timeout for request. Value from
+            'get_default_timeout' is used if not specified.
 
     Returns:
         bool: True if token is valid.
     """
 
-    headers = {
+    if timeout is None:
+        timeout = get_default_timeout()
+
+    base_headers = {
         "Content-Type": "application/json",
-        "Authorization": "Bearer {}".format(token)
     }
-    response = requests.get(
-        "{}/api/users/me".format(url),
-        headers=headers
-    )
-    return response.status_code == 200
+    for header_value in (
+        {"Authorization": "Bearer {}".format(token)},
+        {"X-Api-Key": token},
+    ):
+        headers = base_headers.copy()
+        headers.update(header_value)
+        response = requests.get(
+            "{}/api/users/me".format(url),
+            headers=headers,
+            timeout=timeout,
+        )
+        if response.status_code == 200:
+            return True
+    return False
 
 
 def validate_url(url, timeout=None):

{ayon-python-api-0.4.2 → ayon-python-api-0.5.0}/ayon_api/version.py

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

{ayon-python-api-0.4.2 → ayon-python-api-0.5.0}/ayon_python_api.egg-info/PKG-INFO

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

{ayon-python-api-0.4.2 → ayon-python-api-0.5.0}/pyproject.toml

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