Ayon-Python-Api 0.1.13__tar.gz → 0.1.14__tar.gz

{ayon-python-api-0.1.13 → ayon-python-api-0.1.14}/PKG-INFO

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

{ayon-python-api-0.1.13 → ayon-python-api-0.1.14}/ayon_api/__init__.py

@@ -119,6 +119,7 @@ from ._api import (
     get_representations,
     get_representations_parents,
     get_representation_parents,
+    get_repre_ids_by_context_filters,
 
     create_thumbnail,
     get_thumbnail,
@@ -245,6 +246,7 @@ __all__ = (
     "get_representations",
     "get_representations_parents",
     "get_representation_parents",
+    "get_repre_ids_by_context_filters",
 
     "create_thumbnail",
     "get_thumbnail",

{ayon-python-api-0.1.13 → ayon-python-api-0.1.14}/ayon_api/_api.py

@@ -751,6 +751,11 @@ def get_representations_parents(*args, **kwargs):
     return con.get_representations_parents(*args, **kwargs)
 
 
+def get_repre_ids_by_context_filters(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_repre_ids_by_context_filters(*args, **kwargs)
+
+
 def create_project(
     project_name,
     project_code,

{ayon-python-api-0.1.13 → ayon-python-api-0.1.14}/ayon_api/constants.py

@@ -67,7 +67,7 @@ DEFAULT_REPRESENTATION_FIELDS = {
 }
 
 REPRESENTATION_FILES_FIELDS = {
-    "files.baseName",
+    "files.name",
     "files.hash",
     "files.id",
     "files.path",

{ayon-python-api-0.1.13 → ayon-python-api-0.1.14}/ayon_api/server_api.py

@@ -56,6 +56,7 @@ from .utils import (
     TransferProgress,
 )
 
+PatternType = type(re.compile(""))
 JSONDecodeError = getattr(json, "JSONDecodeError", ValueError)
 # This should be collected from server schema
 PROJECT_NAME_ALLOWED_SYMBOLS = "a-zA-Z0-9_"
@@ -1182,6 +1183,7 @@ class ServerAPI(object):
             self._graphl_url,
             json=data
         )
+        response.raise_for_status()
         return GraphQlResponse(response)
 
     def get_graphql_schema(self):
@@ -3129,6 +3131,92 @@ class ServerAPI(object):
 
         return output
 
+    def get_repre_ids_by_context_filters(
+        self,
+        project_name,
+        context_filters,
+        representation_names=None,
+        version_ids=None
+    ):
+        """Find representation ids which match passed context filters.
+
+        Each representation has context integrated on representation entity in
+        database. The context may contain project, folder, task name or subset,
+        family and many more. This implementation gives option to quickly
+        filter representation based on representation data in database.
+
+        Context filters have defined structure. To define filter of nested
+            subfield use dot '.' as delimiter (For example 'task.name').
+        Filter values can be regex filters. String or 're.Pattern' can be used.
+
+        Args:
+            project_name (str): Project where to look for representations.
+            context_filters (dict[str, list[str]]): Filters of context fields.
+            representation_names (Iterable[str]): Representation names, can be
+                used as additional filter for representations by their names.
+            version_ids (Iterable[str]): Version ids, can be used as additional
+                filter for representations by their parent ids.
+
+        Returns:
+            list[str]: Representation ids that match passed filters.
+
+        Example:
+            The function returns just representation ids so if entities are
+                required for funtionality they must be queried afterwards by
+                their ids.
+            >>> project_name = "testProject"
+            >>> filters = {
+            ...     "task.name": ["[aA]nimation"],
+            ...     "subset": [".*[Mm]ain"]
+            ... }
+            >>> repre_ids = get_repre_ids_by_context_filters(
+            ...     project_name, filters)
+            >>> repres = get_representations(project_name, repre_ids)
+        """
+
+        if not isinstance(context_filters, dict):
+            raise TypeError(
+                "Expected 'dict' got {}".format(str(type(context_filters)))
+            )
+
+        filter_body = {}
+        if representation_names is not None:
+            if not representation_names:
+                return []
+            filter_body["names"] = list(set(representation_names))
+
+        if version_ids is not None:
+            if not version_ids:
+                return []
+            filter_body["versionIds"] = list(set(version_ids))
+
+        body_context_filters = []
+        for key, filters in context_filters.items():
+            if not isinstance(filters, (set, list, tuple)):
+                raise TypeError(
+                    "Expected 'set', 'list', 'tuple' got {}".format(
+                        str(type(filters))))
+
+
+            new_filters = set()
+            for filter_value in filters:
+                if isinstance(filter_value, PatternType):
+                    filter_value = filter_value.pattern
+                new_filters.add(filter_value)
+
+            body_context_filters.append({
+                "key": key,
+                "values": list(new_filters)
+            })
+
+        response = self.post(
+            "projects/{}/repreContextFilter".format(project_name),
+            context=body_context_filters,
+            **filter_body
+        )
+        response.raise_for_status()
+        return response.data["ids"]
+
     def get_workfiles_info(
         self,
         project_name,

{ayon-python-api-0.1.13 → ayon-python-api-0.1.14}/ayon_api/utils.py

@@ -340,7 +340,7 @@ def validate_url(url):
         )
 
     raise UrlError(
-        "Couldn't connect to server on \"{}\"".format(),
+        "Couldn't connect to server on \"{}\"".format(url),
         title="Couldn't connect to server",
         hints=hints + universal_hints
     )

{ayon-python-api-0.1.13 → ayon-python-api-0.1.14}/ayon_api/version.py

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

{ayon-python-api-0.1.13 → ayon-python-api-0.1.14}/ayon_python_api.egg-info/PKG-INFO

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

{ayon-python-api-0.1.13 → ayon-python-api-0.1.14}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ayon_api"
-version = "0.1.13"
+version = "0.1.14"
 description = "Python api for AYON server"
 authors = ["ynput.io <info@ynput.io>"]