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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ayon-python-api
-Version: 0.1.9
+Version: 0.1.10
 Summary: AYON Python API
 Home-page: https://github.com/ynput/ayon-python-api
 Author: ynput.io
@@ -9,20 +9,18 @@ License: Apache License (2.0)
 Description: # AYON server API
         Python client for connection server. Client must be (at least for some time) Python 2 compatible because will be used in DCC that are "older".
         
-        Client should support connection to server with raw REST functions and prepared functionality for work with entities. Must not contain only functionality that can be used with core server functionality.
+        AYON Python api should support connection to server with raw REST functions and prepared functionality for work with entities. Must not contain only functionality that can be used with core server functionality.
         
+        Module support singleton connection which is using `AYON_SERVER_URL` and `AYON_TOKEN` environment variables as source for connection. The singleton connection is using `ServerAPI` object. There can be created multiple connection to different server at one time, for that purpose use `ServerAPIBase` object. 
         
         ## TODOs
-        - Current implementation contains prepared functions for entity queries which is not using full potential of OpenPype server but is MongoDB compatible.
-            - only functions related to v4 should stay at that place and v3 compatible functions should be moved
-        - Missing settings getter
-        - Missing CRUD operations for entities (Only read is possible)
-        - More clear what is difference in `ServerAPIBase` and `ServerAPI`
+        - More clear what is difference in `ServerAPIBase` and `ServerAPI` (`server.py` and `server_api.py`) and better names
             - `ServerAPI` was added primarily for desktop app which handle login and logout in a different way so the class should be maybe removed and `ServerAPIBase` should be renamed to `ServerAPI`
             - find more suitable names of classes
-            - find more suitable name of objects (right now is used `connection` or `conn`)
+            - find more suitable name of objects (right now is used `connection` or `con`)
         - Add folder and task changes to operations
           - Entity hub should use operations to update folders and tasks 
+          
 Keywords: AYON,ynput,OpenPype,vfx
 Platform: UNKNOWN
 Classifier: Development Status :: 3 - Alpha

{ayon-python-api-0.1.9 → ayon-python-api-0.1.10}/README.md

@@ -1,17 +1,15 @@
 # AYON server API
 Python client for connection server. Client must be (at least for some time) Python 2 compatible because will be used in DCC that are "older".
 
-Client should support connection to server with raw REST functions and prepared functionality for work with entities. Must not contain only functionality that can be used with core server functionality.
+AYON Python api should support connection to server with raw REST functions and prepared functionality for work with entities. Must not contain only functionality that can be used with core server functionality.
 
+Module support singleton connection which is using `AYON_SERVER_URL` and `AYON_TOKEN` environment variables as source for connection. The singleton connection is using `ServerAPI` object. There can be created multiple connection to different server at one time, for that purpose use `ServerAPIBase` object. 
 
 ## TODOs
-- Current implementation contains prepared functions for entity queries which is not using full potential of OpenPype server but is MongoDB compatible.
-    - only functions related to v4 should stay at that place and v3 compatible functions should be moved
-- Missing settings getter
-- Missing CRUD operations for entities (Only read is possible)
-- More clear what is difference in `ServerAPIBase` and `ServerAPI`
+- More clear what is difference in `ServerAPIBase` and `ServerAPI` (`server.py` and `server_api.py`) and better names
     - `ServerAPI` was added primarily for desktop app which handle login and logout in a different way so the class should be maybe removed and `ServerAPIBase` should be renamed to `ServerAPI`
     - find more suitable names of classes
-    - find more suitable name of objects (right now is used `connection` or `conn`)
+    - find more suitable name of objects (right now is used `connection` or `con`)
 - Add folder and task changes to operations
-  - Entity hub should use operations to update folders and tasks 
+  - Entity hub should use operations to update folders and tasks 
+  

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

@@ -34,6 +34,7 @@ from .server_api import (
     delete,
 
     get_event,
+    get_events,
     dispatch_event,
     update_event,
     enroll_event_job,
@@ -142,6 +143,7 @@ __all__ = (
     "delete",
 
     "get_event",
+    "get_events",
     "dispatch_event",
     "update_event",
     "enroll_event_job",

{ayon-python-api-0.1.9 → ayon-python-api-0.1.10}/ayon_api/constants.py

@@ -88,3 +88,18 @@ DEFAULT_WORKFILE_INFO_FIELDS = {
     "updatedAt",
     "updatedBy",
 }
+
+DEFAULT_EVENT_FIELDS = {
+    "id",
+    "hash",
+    "createdAt",
+    "dependsOn",
+    "description",
+    "project",
+    "retries",
+    "sender",
+    "status",
+    "topic",
+    "updatedAt",
+    "user",
+}

{ayon-python-api-0.1.9 → ayon-python-api-0.1.10}/ayon_api/graphql_queries.py

@@ -327,3 +327,36 @@ def workfiles_info_graphql_query(fields):
         for k, v in value.items():
             query_queue.append((k, v, field))
     return query
+
+
+def events_graphql_query(fields):
+    query = GraphQlQuery("WorkfilesInfo")
+    topics_var = query.add_variable("eventTopics", "[String!]")
+    projects_var = query.add_variable("projectNames", "[String!]")
+    states_var = query.add_variable("eventStates", "[String!]")
+    users_var = query.add_variable("eventUsers", "[String!]")
+    include_logs_var = query.add_variable("includeLogsFilter", "Boolean!")
+
+    events_field = query.add_field("events", has_edges=True)
+    events_field.set_filter("topics", topics_var)
+    events_field.set_filter("projects", projects_var)
+    events_field.set_filter("states", states_var)
+    events_field.set_filter("users", users_var)
+    events_field.set_filter("includeLogs", include_logs_var)
+
+    nested_fields = fields_to_dict(set(fields))
+
+    query_queue = collections.deque()
+    for key, value in nested_fields.items():
+        query_queue.append((key, value, events_field))
+
+    while query_queue:
+        item = query_queue.popleft()
+        key, value, parent = item
+        field = parent.add_field(key)
+        if value is FIELD_VALUE:
+            continue
+
+        for k, v in value.items():
+            query_queue.append((k, v, field))
+    return query

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

@@ -6,7 +6,10 @@ import logging
 import collections
 import platform
 import copy
-from http import HTTPStatus
+try:
+    from http import HTTPStatus
+except ImportError:
+    HTTPStatus = None
 
 import requests
 
@@ -19,6 +22,7 @@ from .constants import (
     DEFAULT_REPRESENTATION_FIELDS,
     REPRESENTATION_FILES_FIELDS,
     DEFAULT_WORKFILE_INFO_FIELDS,
+    DEFAULT_EVENT_FIELDS,
 )
 from .thumbnails import ThumbnailCache
 from .graphql import GraphQlQuery, INTROSPECTION_QUERY
@@ -32,6 +36,7 @@ from .graphql_queries import (
     representations_graphql_query,
     representations_parents_qraphql_query,
     workfiles_info_graphql_query,
+    events_graphql_query,
 )
 from .exceptions import (
     FailedOperations,
@@ -56,6 +61,12 @@ PROJECT_NAME_REGEX = re.compile(
 )
 
 
+def _get_description(response):
+    if HTTPStatus is None:
+        return str(response.orig_response)
+    return HTTPStatus(response.status).description
+
+
 class RequestType:
     def __init__(self, name):
         self.name = name
@@ -95,7 +106,10 @@ class RestApiResponse(object):
     @property
     def data(self):
         if self._data is None:
-            self._data = self._response.json()
+            if self.status != 204:
+                self._data = self.orig_response.json()
+            else:
+                self._data = {}
         return self._data
 
     @property
@@ -108,7 +122,7 @@ class RestApiResponse(object):
 
     @property
     def detail(self):
-        return self.get("detail", HTTPStatus(self.status).description)
+        return self.get("detail", _get_description(self))
 
     @property
     def status_code(self):
@@ -586,6 +600,74 @@ class ServerAPIBase(object):
         response.raise_for_status()
         return response.data
 
+    def get_events(
+        self,
+        topics=None,
+        project_names=None,
+        states=None,
+        users=None,
+        include_logs=None,
+        fields=None
+    ):
+        """Get events from server with filtering options.
+
+        Notes:
+            Not all event happen on a project.
+
+        Args:
+            topics (Iterable[str]): Name of topics.
+            project_names (Iterable[str]): Project on which event happened.
+            states (Iterable[str]): Filtering by states.
+            users (Iterable[str]): Filtering by users who created/triggered
+                an event.
+            include_logs (bool): Query also log events.
+            fields (Iterable[str]): Fields that should be received for each
+                event.
+
+        Returns:
+            Generator[Dict[str, Any]]: Available events matching filters.
+        """
+
+        filters = {}
+        if topics is not None:
+            topics = set(topics)
+            if not topics:
+                return
+            filters["eventTopics"] = list(topics)
+
+        if project_names is not None:
+            project_names = set(project_names)
+            if not project_names:
+                return
+            filters["projectName"] = list(project_names)
+
+        if states is not None:
+            states = set(states)
+            if not states:
+                return
+            filters["eventStates"] = list(states)
+
+        if users is not None:
+            users = set(users)
+            if not users:
+                return
+            filters["eventUsers"] = list(users)
+
+        if include_logs is None:
+            include_logs = False
+        filters["includeLogsFilter"] = include_logs
+
+        if not fields:
+            fields = DEFAULT_EVENT_FIELDS
+
+        query = events_graphql_query(set(fields))
+        for attr, filter_value in filters.items():
+            query.set_variable_value(attr, filter_value)
+
+        for parsed_data in query.continuous_query(self):
+            for event in parsed_data["events"]:
+                yield event
+
     def update_event(
         self,
         event_id,

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

@@ -302,6 +302,11 @@ def get_event(*args, **kwargs):
     return con.get_event(*args, **kwargs)
 
 
+def get_events(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_events(*args, **kwargs)
+
+
 def dispatch_event(*args, **kwargs):
     con = get_server_api_connection()
     return con.dispatch_event(*args, **kwargs)

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

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ayon-python-api
-Version: 0.1.9
+Version: 0.1.10
 Summary: AYON Python API
 Home-page: https://github.com/ynput/ayon-python-api
 Author: ynput.io
@@ -9,20 +9,18 @@ License: Apache License (2.0)
 Description: # AYON server API
         Python client for connection server. Client must be (at least for some time) Python 2 compatible because will be used in DCC that are "older".
         
-        Client should support connection to server with raw REST functions and prepared functionality for work with entities. Must not contain only functionality that can be used with core server functionality.
+        AYON Python api should support connection to server with raw REST functions and prepared functionality for work with entities. Must not contain only functionality that can be used with core server functionality.
         
+        Module support singleton connection which is using `AYON_SERVER_URL` and `AYON_TOKEN` environment variables as source for connection. The singleton connection is using `ServerAPI` object. There can be created multiple connection to different server at one time, for that purpose use `ServerAPIBase` object. 
         
         ## TODOs
-        - Current implementation contains prepared functions for entity queries which is not using full potential of OpenPype server but is MongoDB compatible.
-            - only functions related to v4 should stay at that place and v3 compatible functions should be moved
-        - Missing settings getter
-        - Missing CRUD operations for entities (Only read is possible)
-        - More clear what is difference in `ServerAPIBase` and `ServerAPI`
+        - More clear what is difference in `ServerAPIBase` and `ServerAPI` (`server.py` and `server_api.py`) and better names
             - `ServerAPI` was added primarily for desktop app which handle login and logout in a different way so the class should be maybe removed and `ServerAPIBase` should be renamed to `ServerAPI`
             - find more suitable names of classes
-            - find more suitable name of objects (right now is used `connection` or `conn`)
+            - find more suitable name of objects (right now is used `connection` or `con`)
         - Add folder and task changes to operations
           - Entity hub should use operations to update folders and tasks 
+          
 Keywords: AYON,ynput,OpenPype,vfx
 Platform: UNKNOWN
 Classifier: Development Status :: 3 - Alpha

{ayon-python-api-0.1.9 → ayon-python-api-0.1.10}/ayon_python_api.egg-info/requires.txt

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

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

@@ -1,13 +1,13 @@
 [tool.poetry]
 name = "ayon_api"
-version = "0.1.9"
+version = "0.1.10"
 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"
+Unidecode = "^1.2"
 appdirs = "^1.4"
 
 [tool.poetry.dev-dependencies]

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

@@ -30,7 +30,7 @@ setup(
     install_requires=[
         "requests >= 2.27.1",
         "six >= 1.15",
-        "Unidecode >= 1.3.6",
+        "Unidecode >= 1.2.0",
         "appdirs >=1, <2",
     ],
     keywords=["AYON", "ynput", "OpenPype", "vfx"],