Ayon-Python-Api 0.1.8__tar.gz → 0.1.9__tar.gz

{ayon-python-api-0.1.8/ayon_python_api.egg-info → ayon-python-api-0.1.9}/PKG-INFO

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

{ayon-python-api-0.1.8 → ayon-python-api-0.1.9}/ayon_api/__init__.py

@@ -12,6 +12,10 @@ from .server_api import (
 
     init_service,
 
+    is_connection_created,
+    close_connection,
+    change_token,
+    set_environments,
     get_server_api_connection,
 
     get_base_url,
@@ -116,6 +120,10 @@ __all__ = (
     "ServiceContext",
     "init_service",
 
+    "is_connection_created",
+    "close_connection",
+    "change_token",
+    "set_environments",
     "get_server_api_connection",
 
     "get_base_url",

{ayon-python-api-0.1.8 → ayon-python-api-0.1.9}/ayon_api/server.py

@@ -607,7 +607,7 @@ class ServerAPIBase(object):
         ):
             if value is not None:
                 kwargs[key] = value
-        response = self.put(
+        response = self.patch(
             "events/{}".format(event_id),
             **kwargs
         )
@@ -1016,8 +1016,7 @@ class ServerAPIBase(object):
         if details:
             endpoint += "?details=1"
         response = self.get(endpoint)
-        if response.status != 200:
-            raise ServerError(response.text)
+        response.raise_for_status()
         return response.data
 
     def download_addon_private_file(
@@ -1233,8 +1232,7 @@ class ServerAPIBase(object):
         result = self.get(
             "addons/{}/{}/settings".format(addon_name, addon_version)
         )
-        if result.status != 200:
-            raise ServerError(result.text)
+        result.raise_for_status()
         return result.data
 
     def get_addon_project_settings(
@@ -1245,8 +1243,7 @@ class ServerAPIBase(object):
                 addon_name, addon_version, project_name
             )
         )
-        if result.status != 200:
-            raise ServerError(result.text)
+        result.raise_for_status()
         return result.data
 
     def get_addon_settings(self, addon_name, addon_version, project_name=None):
@@ -1287,7 +1284,7 @@ class ServerAPIBase(object):
                 returned if 'None' is passed.
 
         Returns:
-            List[Dict[str, Any]]: List of available projects.
+            Generator[Dict[str, Any]]: Available projects.
         """
 
         for project_name in self.get_project_names(active, library):
@@ -1350,8 +1347,7 @@ class ServerAPIBase(object):
             ]))
 
         response = self.get("projects{}".format(query), **query_keys)
-        # TODO check status
-        response.status
+        response.raise_for_status()
         data = response.data
         project_names = []
         if data:
@@ -1375,7 +1371,7 @@ class ServerAPIBase(object):
                 on entity will have 'None' value.
 
         Returns:
-            List[Dict[str, Any]]: List of queried projects.
+            Generator[Dict[str, Any]]: Queried projects.
         """
 
         if fields is None:
@@ -1484,11 +1480,11 @@ class ServerAPIBase(object):
                 if 'None' is passed.
 
         Returns:
-            Iterable[dict[str, Any]]: Queried folder entities.
+            Generator[dict[str, Any]]: Queried folder entities.
         """
 
         if not project_name:
-            return []
+            return
 
         filters = {
             "projectName": project_name
@@ -1496,25 +1492,25 @@ class ServerAPIBase(object):
         if folder_ids is not None:
             folder_ids = set(folder_ids)
             if not folder_ids:
-                return []
+                return
             filters["folderIds"] = list(folder_ids)
 
         if folder_paths is not None:
             folder_paths = set(folder_paths)
             if not folder_paths:
-                return []
+                return
             filters["folderPaths"] = list(folder_paths)
 
         if folder_names is not None:
             folder_names = set(folder_names)
             if not folder_names:
-                return []
+                return
             filters["folderNames"] = list(folder_names)
 
         if parent_ids is not None:
             parent_ids = set(parent_ids)
             if not parent_ids:
-                return []
+                return
             if None in parent_ids:
                 # Replace 'None' with '"root"' which is used during GraphQl
                 #   query for parent ids filter for folders without folder
@@ -1575,7 +1571,7 @@ class ServerAPIBase(object):
         own_attributes=False
     ):
         if not project_name:
-            return []
+            return
 
         filters = {
             "projectName": project_name
@@ -1584,25 +1580,25 @@ class ServerAPIBase(object):
         if task_ids is not None:
             task_ids = set(task_ids)
             if not task_ids:
-                return []
+                return
             filters["taskIds"] = list(task_ids)
 
         if task_names is not None:
             task_names = set(task_names)
             if not task_names:
-                return []
+                return
             filters["taskNames"] = list(task_names)
 
         if task_types is not None:
             task_types = set(task_types)
             if not task_types:
-                return []
+                return
             filters["taskTypes"] = list(task_types)
 
         if folder_ids is not None:
             folder_ids = set(folder_ids)
             if not folder_ids:
-                return []
+                return
             filters["folderIds"] = list(folder_ids)
 
         if not fields:
@@ -1760,6 +1756,20 @@ class ServerAPIBase(object):
             for folder in folders
         }
 
+    def _filter_subset(
+        self, project_name, subset, active, own_attributes, use_rest
+    ):
+        if active is not None and subset["active"] is not active:
+            return None
+
+        if use_rest:
+            subset = self.get_rest_subset(project_name, subset["id"])
+
+        if own_attributes:
+            fill_own_attribs(subset)
+
+        return subset
+
     def get_subsets(
         self,
         project_name,
@@ -1772,24 +1782,24 @@ class ServerAPIBase(object):
         own_attributes=False
     ):
         if not project_name:
-            return []
+            return
 
         if subset_ids is not None:
             subset_ids = set(subset_ids)
             if not subset_ids:
-                return []
+                return
 
         filter_subset_names = None
         if subset_names is not None:
             filter_subset_names = set(subset_names)
             if not filter_subset_names:
-                return []
+                return
 
         filter_folder_ids = None
         if folder_ids is not None:
             filter_folder_ids = set(folder_ids)
             if not filter_folder_ids:
-                return []
+                return
 
         # This will disable 'folder_ids' and 'subset_names' filters
         #   - maybe could be enhanced in future?
@@ -1803,7 +1813,7 @@ class ServerAPIBase(object):
                     filter_subset_names |= set(names)
 
             if not filter_subset_names or not filter_folder_ids:
-                return []
+                return
 
         # Convert fields and add minimum required fields
         if fields:
@@ -1847,35 +1857,30 @@ class ServerAPIBase(object):
         parsed_data = query.query(self)
 
         subsets = parsed_data.get("project", {}).get("subsets", [])
-        if active is not None or own_attributes:
-            _subsets = []
-            for subset in subsets:
-                if active is not None and subset["active"] is not active:
-                    continue
-
-                if use_rest:
-                    subset = self.get_rest_subset(project_name, subset["id"])
-
-                if own_attributes:
-                    fill_own_attribs(subset)
-                _subsets.append(subset)
-            subsets = _subsets
-
         # Filter subsets by 'names_by_folder_ids'
         if names_by_folder_ids:
             subsets_by_folder_id = collections.defaultdict(list)
             for subset in subsets:
-                folder_id = subset["folderId"]
-                subsets_by_folder_id[folder_id].append(subset)
+                filtered_subset = self._filter_subset(
+                    project_name, subset, active, own_attributes, use_rest
+                )
+                if filtered_subset is not None:
+                    folder_id = filtered_subset["folderId"]
+                    subsets_by_folder_id[folder_id].append(filtered_subset)
 
-            filtered_subsets = []
             for folder_id, names in names_by_folder_ids.items():
                 for folder_subset in subsets_by_folder_id[folder_id]:
                     if folder_subset["name"] in names:
-                        filtered_subsets.append(subset)
-            subsets = filtered_subsets
+                        yield folder_subset
+
+        else:
+            for subset in subsets:
+                filtered_subset = self._filter_subset(
+                    project_name, subset, active, own_attributes, use_rest
+                )
+                if filtered_subset is not None:
+                    yield filtered_subset
 
-        return list(subsets)
 
     def get_subset_by_id(
         self,
@@ -1972,7 +1977,7 @@ class ServerAPIBase(object):
                 if 'None' is passed.
 
         Returns:
-            List[Dict[str, Any]]: Queried version entities.
+            Generator[Dict[str, Any]]: Queried version entities.
         """
 
         if not fields:
@@ -1999,24 +2004,24 @@ class ServerAPIBase(object):
         if version_ids is not None:
             version_ids = set(version_ids)
             if not version_ids:
-                return []
+                return
             filters["versionIds"] = list(version_ids)
 
         if subset_ids is not None:
             subset_ids = set(subset_ids)
             if not subset_ids:
-                return []
+                return
             filters["subsetIds"] = list(subset_ids)
 
         # TODO versions can't be used as fitler at this moment!
         if versions is not None:
             versions = set(versions)
             if not versions:
-                return []
+                return
             filters["versions"] = list(versions)
 
         if not hero and not standard:
-            return []
+            return
 
         queries = []
         # Add filters based on 'hero' and 'standard'
@@ -2285,7 +2290,7 @@ class ServerAPIBase(object):
                 passed.
 
         Returns:
-            List[Dict[str, Any]]: Queried representation entities.
+            Generator[Dict[str, Any]]: Queried representation entities.
         """
 
         if not fields:
@@ -2310,7 +2315,7 @@ class ServerAPIBase(object):
         if representation_ids is not None:
             representation_ids = set(representation_ids)
             if not representation_ids:
-                return []
+                return
             filters["representationIds"] = list(representation_ids)
 
         version_ids_filter = None
@@ -2323,18 +2328,18 @@ class ServerAPIBase(object):
                 representaion_names_filter |= set(names)
 
             if not version_ids_filter or not representaion_names_filter:
-                return []
+                return
 
         else:
             if representation_names is not None:
                 representaion_names_filter = set(representation_names)
                 if not representaion_names_filter:
-                    return []
+                    return
 
             if version_ids is not None:
                 version_ids_filter = set(version_ids)
                 if not version_ids_filter:
-                    return []
+                    return
 
         if version_ids_filter:
             filters["versionIds"] = list(version_ids_filter)
@@ -2459,19 +2464,19 @@ class ServerAPIBase(object):
         if task_ids is not None:
             task_ids = set(task_ids)
             if not task_ids:
-                return []
+                return
             filters["taskIds"] = list(task_ids)
 
         if paths is not None:
             paths = set(paths)
             if not paths:
-                return []
+                return
             filters["paths"] = list(paths)
 
         if workfile_ids is not None:
             workfile_ids = set(workfile_ids)
             if not workfile_ids:
-                return []
+                return
             filters["workfileIds"] = list(workfile_ids)
 
         if not fields:
@@ -2849,4 +2854,5 @@ class ServerAPIBase(object):
                     operation_id,
                     json.dumps(body_by_id[operation_id], indent=4),
                     op_result["error"],
-                ))
+                ))
+

{ayon-python-api-0.1.8 → ayon-python-api-0.1.9}/ayon_api/server_api.py

@@ -68,6 +68,27 @@ class GlobalContext:
 
     _connection = None
 
+    @classmethod
+    def is_connection_created(cls):
+        return cls._connection is not None
+
+    @classmethod
+    def change_token(cls, url, token):
+        ServerAPI.set_environments(url, token)
+        if cls._connection is None:
+            return
+
+        if cls._connection.get_base_url() == url:
+            cls._connection.set_token(token)
+        else:
+            cls.close_connection()
+
+    @classmethod
+    def close_connection(cls):
+        if cls._connection is not None:
+            cls._connection.close_session()
+        cls._connection = None
+
     @classmethod
     def get_server_api_connection(cls):
         if cls._connection is None:
@@ -150,8 +171,7 @@ class ServiceContext:
         cls.service_name = service_name or socket.gethostname()
 
         # Make sure required environments for ServerAPI are set
-        os.environ["AYON_SERVER_URL"] = cls.server_url
-        os.environ["AYON_TOKEN"] = cls.token
+        ServerAPI.set_environments(cls.server_url, cls.token)
 
         if connect:
             print("Connecting to server \"{}\"".format(server_url))
@@ -164,6 +184,46 @@ def init_service(*args, **kwargs):
     ServiceContext.init_service(*args, **kwargs)
 
 
+def is_connection_created():
+    """Is global connection created.
+
+    Returns:
+        bool: True if connection was connected.
+    """
+
+    return GlobalContext.is_connection_created()
+
+
+def close_connection():
+    """Close global connection if is connected."""
+
+    GlobalContext.close_connection()
+
+
+def change_token(url, token):
+    """Change connection token for url.
+
+    This function can be also used to change url.
+
+    Args:
+        url (str): Server url.
+        token (str): API key token.
+    """
+
+    GlobalContext.change_token(url, token)
+
+
+def set_environments(url, token):
+    """Set global environments for global connection.
+
+    Args:
+        url (Union[str, None]): Url to server or None to unset environments.
+        token (Union[str, None]): API key token to be used for connection.
+    """
+
+    ServerAPI.set_environments(url, token)
+
+
 def get_server_api_connection():
     """Access to global scope object of ServerAPI.
 
@@ -244,7 +304,7 @@ def get_event(*args, **kwargs):
 
 def dispatch_event(*args, **kwargs):
     con = get_server_api_connection()
-    return con.get_event(*args, **kwargs)
+    return con.dispatch_event(*args, **kwargs)
 
 
 def update_event(*args, **kwargs):

{ayon-python-api-0.1.8 → ayon-python-api-0.1.9}/ayon_api/version.py

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

{ayon-python-api-0.1.8 → ayon-python-api-0.1.9/ayon_python_api.egg-info}/PKG-INFO

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

ayon-python-api-0.1.9/ayon_python_api.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ayon-python-api-0.1.9/ayon_python_api.egg-info/requires.txt

@@ -0,0 +1,4 @@
+requests>=2.27.1
+six>=1.15
+Unidecode>=1.3.6
+appdirs<2,>=1

{ayon-python-api-0.1.8 → ayon-python-api-0.1.9}/pyproject.toml

@@ -1,14 +1,14 @@
 [tool.poetry]
 name = "ayon_api"
-version = "0.1.8"
+version = "0.1.9"
 description = "Python api for AYON server"
 authors = ["ynput.io <info@ynput.io>"]
 
 [tool.poetry.dependencies]
 requests = "^2.28.1"
 six = "^1.15"
-unidecode = "^1.3"
-appdirs = { git = "https://github.com/ActiveState/appdirs.git", branch = "master" }
+Unidecode = "^1.3"
+appdirs = "^1.4"
 
 [tool.poetry.dev-dependencies]
 pytest = "^5.2"

{ayon-python-api-0.1.8 → ayon-python-api-0.1.9}/setup.py

@@ -30,9 +30,8 @@ setup(
     install_requires=[
         "requests >= 2.27.1",
         "six >= 1.15",
-    ],
-    dependency_links=[
-        "appdirs @ git+https://github.com/ActiveState/appdirs.git@master"
+        "Unidecode >= 1.3.6",
+        "appdirs >=1, <2",
     ],
     keywords=["AYON", "ynput", "OpenPype", "vfx"],
 )

ayon-python-api-0.1.8/ayon_python_api.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-appdirs @ git+https://github.com/ActiveState/appdirs.git@master

ayon-python-api-0.1.8/ayon_python_api.egg-info/requires.txt

@@ -1,2 +0,0 @@
-requests>=2.27.1
-six>=1.15