ayon-python-api 1.0.6__tar.gz → 1.0.7__tar.gz

{ayon-python-api-1.0.6 → ayon-python-api-1.0.7}/PKG-INFO

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

{ayon-python-api-1.0.6 → ayon-python-api-1.0.7}/ayon_api/__init__.py

@@ -46,6 +46,7 @@ from ._api import (
     get_server_version,
     get_server_version_tuple,
     get_users,
+    get_user_by_name,
     get_user,
     raw_post,
     raw_put,
@@ -268,6 +269,7 @@ __all__ = (
     "get_server_version",
     "get_server_version_tuple",
     "get_users",
+    "get_user_by_name",
     "get_user",
     "raw_post",
     "raw_put",

{ayon-python-api-1.0.6 → ayon-python-api-1.0.7}/ayon_api/_api.py

@@ -594,9 +594,13 @@ def get_server_version_tuple():
 def get_users(*args, **kwargs):
     """Get Users.
 
+    Only administrators and managers can fetch all users. For other users
+        it is required to pass in 'project_name' filter.
+
     Args:
+        project_name (Optional[str]): Project name.
         usernames (Optional[Iterable[str]]): Filter by usernames.
-        fields (Optional[Iterable[str]]): fields to be queried
+        fields (Optional[Iterable[str]]): Fields to be queried
             for users.
 
     Returns:
@@ -607,7 +611,38 @@ def get_users(*args, **kwargs):
     return con.get_users(*args, **kwargs)
 
 
+def get_user_by_name(*args, **kwargs):
+    """Get user by name using GraphQl.
+
+    Only administrators and managers can fetch all users. For other users
+        it is required to pass in 'project_name' filter.
+
+    Args:
+        username (str): Username.
+        project_name (Optional[str]): Define scope of project.
+        fields (Optional[Iterable[str]]): Fields to be queried
+            for users.
+
+    Returns:
+        Union[dict[str, Any], None]: User info or None if user is not
+            found.
+
+    """
+    con = get_server_api_connection()
+    return con.get_user_by_name(*args, **kwargs)
+
+
 def get_user(*args, **kwargs):
+    """Get user info using REST endpoit.
+
+    Args:
+        username (Optional[str]): Username.
+
+    Returns:
+        Union[dict[str, Any], None]: User info or None if user is not
+            found.
+
+    """
     con = get_server_api_connection()
     return con.get_user(*args, **kwargs)
 
@@ -3310,6 +3345,7 @@ def get_representations_hierarchy(*args, **kwargs):
         representation_ids (Iterable[str]): Representation ids.
         project_fields (Optional[Iterable[str]]): Project fields.
         folder_fields (Optional[Iterable[str]]): Folder fields.
+        task_fields (Optional[Iterable[str]]): Task fields.
         product_fields (Optional[Iterable[str]]): Product fields.
         version_fields (Optional[Iterable[str]]): Version fields.
         representation_fields (Optional[Iterable[str]]): Representation
@@ -3334,6 +3370,7 @@ def get_representation_hierarchy(*args, **kwargs):
         representation_id (str): Representation id.
         project_fields (Optional[Iterable[str]]): Project fields.
         folder_fields (Optional[Iterable[str]]): Folder fields.
+        task_fields (Optional[Iterable[str]]): Task fields.
         product_fields (Optional[Iterable[str]]): Product fields.
         version_fields (Optional[Iterable[str]]): Version fields.
         representation_fields (Optional[Iterable[str]]): Representation

{ayon-python-api-1.0.6 → ayon-python-api-1.0.7}/ayon_api/graphql_queries.py

@@ -466,6 +466,7 @@ def representations_parents_qraphql_query(
 
 def representations_hierarchy_qraphql_query(
     folder_fields,
+    task_fields,
     product_fields,
     version_fields,
     representation_fields,
@@ -486,12 +487,17 @@ def representations_hierarchy_qraphql_query(
 
     repres_field.set_filter("ids", repre_ids_var)
     version_field = None
-    if folder_fields or product_fields or version_fields:
+    if folder_fields or task_fields or product_fields or version_fields:
         version_field = repres_field.add_field("version")
         if version_fields:
             for key, value in fields_to_dict(version_fields).items():
                 fields_queue.append((key, value, version_field))
 
+    if task_fields:
+        task_field = version_field.add_field("task")
+        for key, value in fields_to_dict(task_fields).items():
+            fields_queue.append((key, value, task_field))
+
     product_field = None
     if folder_fields or product_fields:
         product_field = version_field.add_field("product")
@@ -600,9 +606,11 @@ def events_graphql_query(fields):
 def users_graphql_query(fields):
     query = GraphQlQuery("Users")
     names_var = query.add_variable("userNames", "[String!]")
+    project_name_var = query.add_variable("projectName", "String!")
 
     users_field = query.add_field_with_edges("users")
     users_field.set_filter("names", names_var)
+    users_field.set_filter("projectName", project_name_var)
 
     nested_fields = fields_to_dict(set(fields))
 

{ayon-python-api-1.0.6 → ayon-python-api-1.0.7}/ayon_api/server_api.py

@@ -1028,12 +1028,16 @@ class ServerAPI(object):
         self._access_token_is_service = None
         return None
 
-    def get_users(self, usernames=None, fields=None):
+    def get_users(self, project_name=None, usernames=None, fields=None):
         """Get Users.
 
+        Only administrators and managers can fetch all users. For other users
+            it is required to pass in 'project_name' filter.
+
         Args:
+            project_name (Optional[str]): Project name.
             usernames (Optional[Iterable[str]]): Filter by usernames.
-            fields (Optional[Iterable[str]]): fields to be queried
+            fields (Optional[Iterable[str]]): Fields to be queried
                 for users.
 
         Returns:
@@ -1047,6 +1051,9 @@ class ServerAPI(object):
                 return
             filters["userNames"] = list(usernames)
 
+        if project_name is not None:
+            filters["projectName"] = project_name
+
         if not fields:
             fields = self.get_default_fields_for_type("user")
 
@@ -1060,7 +1067,45 @@ class ServerAPI(object):
                     user["accessGroups"])
                 yield user
 
+    def get_user_by_name(self, username, project_name=None, fields=None):
+        """Get user by name using GraphQl.
+
+        Only administrators and managers can fetch all users. For other users
+            it is required to pass in 'project_name' filter.
+
+        Args:
+            username (str): Username.
+            project_name (Optional[str]): Define scope of project.
+            fields (Optional[Iterable[str]]): Fields to be queried
+                for users.
+
+        Returns:
+            Union[dict[str, Any], None]: User info or None if user is not
+                found.
+
+        """
+        if not username:
+            return None
+
+        for user in self.get_users(
+            project_name=project_name,
+            usernames={username},
+            fields=fields,
+        ):
+            return user
+        return None
+
     def get_user(self, username=None):
+        """Get user info using REST endpoit.
+
+        Args:
+            username (Optional[str]): Username.
+
+        Returns:
+            Union[dict[str, Any], None]: User info or None if user is not
+                found.
+
+        """
         if username is None:
             output = self._get_user_info()
             if output is None:
@@ -6336,6 +6381,7 @@ class ServerAPI(object):
         representation_ids,
         project_fields=None,
         folder_fields=None,
+        task_fields=None,
         product_fields=None,
         version_fields=None,
         representation_fields=None,
@@ -6353,6 +6399,7 @@ class ServerAPI(object):
             representation_ids (Iterable[str]): Representation ids.
             project_fields (Optional[Iterable[str]]): Project fields.
             folder_fields (Optional[Iterable[str]]): Folder fields.
+            task_fields (Optional[Iterable[str]]): Task fields.
             product_fields (Optional[Iterable[str]]): Product fields.
             version_fields (Optional[Iterable[str]]): Version fields.
             representation_fields (Optional[Iterable[str]]): Representation
@@ -6383,7 +6430,7 @@ class ServerAPI(object):
         repre_ids = set(representation_ids)
         output = {
             repre_id: RepresentationHierarchy(
-                project, None, None, None, None
+                project, None, None, None, None, None
             )
             for repre_id in representation_ids
         }
@@ -6393,6 +6440,11 @@ class ServerAPI(object):
         else:
             folder_fields = set(folder_fields)
 
+        if task_fields is None:
+            task_fields = self.get_default_fields_for_type("task")
+        else:
+            task_fields = set(task_fields)
+
         if product_fields is None:
             product_fields = self.get_default_fields_for_type("product")
         else:
@@ -6414,6 +6466,7 @@ class ServerAPI(object):
 
         query = representations_hierarchy_qraphql_query(
             folder_fields,
+            task_fields,
             product_fields,
             version_fields,
             representation_fields,
@@ -6426,12 +6479,16 @@ class ServerAPI(object):
             repre_id = repre["id"]
             version = repre.pop("version", {})
             product = version.pop("product", {})
+            task = version.pop("task", None)
             folder = product.pop("folder", {})
             self._convert_entity_data(version)
             self._convert_entity_data(product)
             self._convert_entity_data(folder)
+            if task:
+                self._convert_entity_data(task)
+
             output[repre_id] = RepresentationHierarchy(
-                project, folder, product, version, repre
+                project, folder, task, product, version, repre
             )
 
         return output
@@ -6442,6 +6499,7 @@ class ServerAPI(object):
         representation_id,
         project_fields=None,
         folder_fields=None,
+        task_fields=None,
         product_fields=None,
         version_fields=None,
         representation_fields=None,
@@ -6455,6 +6513,7 @@ class ServerAPI(object):
             representation_id (str): Representation id.
             project_fields (Optional[Iterable[str]]): Project fields.
             folder_fields (Optional[Iterable[str]]): Folder fields.
+            task_fields (Optional[Iterable[str]]): Task fields.
             product_fields (Optional[Iterable[str]]): Product fields.
             version_fields (Optional[Iterable[str]]): Version fields.
             representation_fields (Optional[Iterable[str]]): Representation
@@ -6472,6 +6531,7 @@ class ServerAPI(object):
             [representation_id],
             project_fields=project_fields,
             folder_fields=folder_fields,
+            task_fields=task_fields,
             product_fields=product_fields,
             version_fields=version_fields,
             representation_fields=representation_fields,
@@ -6509,6 +6569,7 @@ class ServerAPI(object):
             representation_ids,
             project_fields=project_fields,
             folder_fields=folder_fields,
+            task_fields=set(),
             product_fields=product_fields,
             version_fields=version_fields,
             representation_fields={"id"},

{ayon-python-api-1.0.6 → ayon-python-api-1.0.7}/ayon_api/utils.py

@@ -29,7 +29,14 @@ RepresentationParents = collections.namedtuple(
 
 RepresentationHierarchy = collections.namedtuple(
     "RepresentationHierarchy",
-    ("project", "folder", "product", "version", "representation")
+    (
+        "project",
+        "folder",
+        "task",
+        "product",
+        "version",
+        "representation",
+    )
 )
 
 

{ayon-python-api-1.0.6 → ayon-python-api-1.0.7}/ayon_api/version.py

@@ -1,2 +1,2 @@
 """Package declaring Python API for AYON server."""
-__version__ = "1.0.6"
+__version__ = "1.0.7"

{ayon-python-api-1.0.6 → ayon-python-api-1.0.7}/ayon_python_api.egg-info/PKG-INFO

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

{ayon-python-api-1.0.6 → ayon-python-api-1.0.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ayon-python-api"
-version = "1.0.6"
+version = "1.0.7"
 description = "AYON Python API"
 license = {file = "LICENSE"}
 readme = {file = "README.md", content-type = "text/markdown"}
@@ -29,7 +29,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "ayon-python-api"
-version = "1.0.6"
+version = "1.0.7"
 description = "AYON Python API"
 authors = [
     "ynput.io <info@ynput.io>"