Ayon-Python-Api 0.4.1__tar.gz → 0.4.3__tar.gz

{ayon-python-api-0.4.1 → ayon-python-api-0.4.3}/PKG-INFO

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

{ayon-python-api-0.4.1 → ayon-python-api-0.4.3}/ayon_api/_api.py

@@ -753,12 +753,12 @@ def get_secrets(*args, **kwargs):
 
 def get_secret(*args, **kwargs):
     con = get_server_api_connection()
-    return con.delete_secret(*args, **kwargs)
+    return con.get_secret(*args, **kwargs)
 
 
 def save_secret(*args, **kwargs):
     con = get_server_api_connection()
-    return con.delete_secret(*args, **kwargs)
+    return con.save_secret(*args, **kwargs)
 
 
 def delete_secret(*args, **kwargs):

{ayon-python-api-0.4.1 → ayon-python-api-0.4.3}/ayon_api/graphql_queries.py

@@ -175,6 +175,8 @@ def folders_graphql_query(fields):
     parent_folder_ids_var = query.add_variable("parentFolderIds", "[String!]")
     folder_paths_var = query.add_variable("folderPaths", "[String!]")
     folder_names_var = query.add_variable("folderNames", "[String!]")
+    folder_types_var = query.add_variable("folderTypes", "[String!]")
+    statuses_var = query.add_variable("folderStatuses", "[String!]")
     has_products_var = query.add_variable("folderHasProducts", "Boolean!")
 
     project_field = query.add_field("project")
@@ -185,6 +187,8 @@ def folders_graphql_query(fields):
     folders_field.set_filter("parentIds", parent_folder_ids_var)
     folders_field.set_filter("names", folder_names_var)
     folders_field.set_filter("paths", folder_paths_var)
+    folders_field.set_filter("folderTypes", folder_types_var)
+    folders_field.set_filter("statuses", statuses_var)
     folders_field.set_filter("hasProducts", has_products_var)
 
     nested_fields = fields_to_dict(fields)

{ayon-python-api-0.4.1 → ayon-python-api-0.4.3}/ayon_api/server_api.py

@@ -75,6 +75,7 @@ from .utils import (
     TransferProgress,
     create_dependency_package_basename,
     ThumbnailContent,
+    get_default_timeout,
 )
 
 PatternType = type(re.compile(""))
@@ -351,7 +352,6 @@ class ServerAPI(object):
         timeout (Optional[float]): Timeout for requests.
         max_retries (Optional[int]): Number of retries for requests.
     """
-    _default_timeout = 10.0
     _default_max_retries = 3
 
     def __init__(
@@ -500,20 +500,13 @@ class ServerAPI(object):
     def get_default_timeout(cls):
         """Default value for requests timeout.
 
-        First looks for environment variable SERVER_TIMEOUT_ENV_KEY which
-        can affect timeout value. If not available then use class
-        attribute '_default_timeout'.
+        Utils function 'get_default_timeout' is used by default.
 
         Returns:
             float: Timeout value in seconds.
         """
 
-        try:
-            return float(os.environ.get(SERVER_TIMEOUT_ENV_KEY))
-        except (ValueError, TypeError):
-            pass
-
-        return cls._default_timeout
+        return get_default_timeout()
 
     @classmethod
     def get_default_max_retries(cls):
@@ -3515,7 +3508,9 @@ class ServerAPI(object):
         folder_ids=None,
         folder_paths=None,
         folder_names=None,
+        folder_types=None,
         parent_ids=None,
+        statuses=None,
         active=True,
         fields=None,
         own_attributes=False
@@ -3536,8 +3531,12 @@ class ServerAPI(object):
                 for filtering.
             folder_names (Optional[Iterable[str]]): Folder names used
                 for filtering.
+            folder_types (Optional[Iterable[str]]): Folder types used
+                for filtering.
             parent_ids (Optional[Iterable[str]]): Ids of folder parents.
                 Use 'None' if folder is direct child of project.
+            statuses (Optional[Iterable[str]]): Folder statuses used
+                for filtering.
             active (Optional[bool]): Filter active/inactive folders.
                 Both are returned if is set to None.
             fields (Optional[Iterable[str]]): Fields to be queried for
@@ -3574,6 +3573,18 @@ class ServerAPI(object):
                 return
             filters["folderNames"] = list(folder_names)
 
+        if folder_types is not None:
+            folder_types = set(folder_types)
+            if not folder_types:
+                return
+            filters["folderTypes"] = list(folder_types)
+
+        if statuses is not None:
+            statuses = set(statuses)
+            if not statuses:
+                return
+            filters["folderStatuses"] = list(statuses)
+
         if parent_ids is not None:
             parent_ids = set(parent_ids)
             if not parent_ids:
@@ -5845,19 +5856,22 @@ class ServerAPI(object):
         """Helper method to get links from server for entity types.
 
         Example output:
-            [
-                {
-                    "id": "59a212c0d2e211eda0e20242ac120002",
-                    "linkType": "reference",
-                    "description": "reference link between folders",
-                    "projectName": "my_project",
-                    "author": "frantadmin",
-                    "entityId": "b1df109676db11ed8e8c6c9466b19aa8",
-                    "entityType": "folder",
-                    "direction": "out"
-                },
+            {
+                "59a212c0d2e211eda0e20242ac120001": [
+                    {
+                        "id": "59a212c0d2e211eda0e20242ac120002",
+                        "linkType": "reference",
+                        "description": "reference link between folders",
+                        "projectName": "my_project",
+                        "author": "frantadmin",
+                        "entityId": "b1df109676db11ed8e8c6c9466b19aa8",
+                        "entityType": "folder",
+                        "direction": "out"
+                    },
+                    ...
+                ],
                 ...
-            ]
+            }
 
         Args:
             project_name (str): Project where links are.

{ayon-python-api-0.4.1 → ayon-python-api-0.4.3}/ayon_api/utils.py

@@ -1,3 +1,4 @@
+import os
 import re
 import datetime
 import uuid
@@ -15,6 +16,7 @@ except ImportError:
 import requests
 import unidecode
 
+from .constants import SERVER_TIMEOUT_ENV_KEY
 from .exceptions import UrlError
 
 REMOVED_VALUE = object()
@@ -27,6 +29,23 @@ RepresentationParents = collections.namedtuple(
 )
 
 
+def get_default_timeout():
+    """Default value for requests timeout.
+
+    First looks for environment variable SERVER_TIMEOUT_ENV_KEY which
+    can affect timeout value. If not available then use 10.0 s.
+
+    Returns:
+        float: Timeout value in seconds.
+    """
+
+    try:
+        return float(os.environ.get(SERVER_TIMEOUT_ENV_KEY))
+    except (ValueError, TypeError):
+        pass
+    return 10.0
+
+
 class ThumbnailContent:
     """Wrapper for thumbnail content.
 
@@ -231,30 +250,36 @@ def _try_parse_url(url):
         return None
 
 
-def _try_connect_to_server(url):
+def _try_connect_to_server(url, timeout=None):
+    if timeout is None:
+        timeout = get_default_timeout()
     try:
         # TODO add validation if the url lead to Ayon server
-        #   - thiw won't validate if the url lead to 'google.com'
-        requests.get(url)
+        #   - this won't validate if the url lead to 'google.com'
+        requests.get(url, timeout=timeout)
 
     except BaseException:
         return False
     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),
@@ -262,7 +287,8 @@ def login_to_server(url, username, password):
         json={
             "name": username,
             "password": password
-        }
+        },
+        timeout=timeout,
     )
     token = None
     # 200 - success
@@ -273,47 +299,67 @@ 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):
+def validate_url(url, timeout=None):
     """Validate url if is valid and server is available.
 
     Validation checks if can be parsed as url and contains scheme.
@@ -334,6 +380,7 @@ def validate_url(url):
 
     Args:
         url (str): Server url.
+        timeout (Optional[int]): Timeout in seconds for connection to server.
 
     Returns:
         Url which was used to connect to server.
@@ -369,10 +416,10 @@ def validate_url(url):
     # - this will trigger UrlError if both will crash
     if not parsed_url.scheme:
         new_url = "https://" + modified_url
-        if _try_connect_to_server(new_url):
+        if _try_connect_to_server(new_url, timeout=timeout):
             return new_url
 
-    if _try_connect_to_server(modified_url):
+    if _try_connect_to_server(modified_url, timeout=timeout):
         return modified_url
 
     hints = []

{ayon-python-api-0.4.1 → ayon-python-api-0.4.3}/ayon_api/version.py

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

{ayon-python-api-0.4.1 → ayon-python-api-0.4.3}/ayon_python_api.egg-info/PKG-INFO

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

{ayon-python-api-0.4.1 → ayon-python-api-0.4.3}/pyproject.toml

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