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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ayon-python-api
-Version: 1.0.6
+Version: 1.0.8
 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.8}/ayon_api/__init__.py

@@ -3,6 +3,10 @@ from .utils import (
     TransferProgress,
     slugify_string,
     create_dependency_package_basename,
+    get_user_by_token,
+    is_token_valid,
+    validate_url,
+    login_to_server,
 )
 from .server_api import (
     RequestTypes,
@@ -46,6 +50,7 @@ from ._api import (
     get_server_version,
     get_server_version_tuple,
     get_users,
+    get_user_by_name,
     get_user,
     raw_post,
     raw_put,
@@ -66,6 +71,7 @@ from ._api import (
     download_file,
     upload_file_from_stream,
     upload_file,
+    upload_reviewable,
     trigger_server_restart,
     query_graphql,
     get_graphql_schema,
@@ -228,6 +234,10 @@ __all__ = (
     "TransferProgress",
     "slugify_string",
     "create_dependency_package_basename",
+    "get_user_by_token",
+    "is_token_valid",
+    "validate_url",
+    "login_to_server",
 
     "RequestTypes",
     "ServerAPI",
@@ -268,6 +278,7 @@ __all__ = (
     "get_server_version",
     "get_server_version_tuple",
     "get_users",
+    "get_user_by_name",
     "get_user",
     "raw_post",
     "raw_put",
@@ -288,6 +299,7 @@ __all__ = (
     "download_file",
     "upload_file_from_stream",
     "upload_file",
+    "upload_reviewable",
     "trigger_server_restart",
     "query_graphql",
     "get_graphql_schema",

{ayon-python-api-1.0.6 → ayon-python-api-1.0.8}/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)
 
@@ -903,6 +938,29 @@ def upload_file(*args, **kwargs):
     return con.upload_file(*args, **kwargs)
 
 
+def upload_reviewable(*args, **kwargs):
+    """Upload reviewable file to server.
+
+    Args:
+        project_name (str): Project name.
+        version_id (str): Version id.
+        filepath (str): Reviewable file path to upload.
+        label (Optional[str]): Reviewable label. Filled automatically
+            server side with filename.
+        content_type (Optional[str]): MIME type of the file.
+        filename (Optional[str]): User as original filename. Filename from
+            'filepath' is used when not filled.
+        progress (Optional[TransferProgress]): Progress.
+        headers (Optional[Dict[str, Any]]): Headers.
+
+    Returns:
+        RestApiResponse: Server response.
+
+    """
+    con = get_server_api_connection()
+    return con.upload_reviewable(*args, **kwargs)
+
+
 def trigger_server_restart():
     """Trigger server restart.
 
@@ -3310,6 +3368,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 +3393,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.8}/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.8}/ayon_api/server_api.py

@@ -90,6 +90,7 @@ from .utils import (
     get_default_settings_variant,
     get_default_site_id,
     NOT_SET,
+    get_media_mime_type,
 )
 
 PatternType = type(re.compile(""))
@@ -1028,12 +1029,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 +1052,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 +1068,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:
@@ -1607,7 +1653,13 @@ class ServerAPI(object):
         response = self.post("enroll", **kwargs)
         if response.status_code == 204:
             return None
-        elif response.status_code >= 400:
+
+        if response.status_code == 503:
+            # Server is busy
+            self.log.info("Server is busy. Can't enroll event now.")
+            return None
+
+        if response.status_code >= 400:
             self.log.error(response.text)
             return None
 
@@ -1886,6 +1938,77 @@ class ServerAPI(object):
                 endpoint, stream, progress, request_type, **kwargs
             )
 
+    def upload_reviewable(
+        self,
+        project_name,
+        version_id,
+        filepath,
+        label=None,
+        content_type=None,
+        filename=None,
+        progress=None,
+        headers=None,
+        **kwargs
+    ):
+        """Upload reviewable file to server.
+
+        Args:
+            project_name (str): Project name.
+            version_id (str): Version id.
+            filepath (str): Reviewable file path to upload.
+            label (Optional[str]): Reviewable label. Filled automatically
+                server side with filename.
+            content_type (Optional[str]): MIME type of the file.
+            filename (Optional[str]): User as original filename. Filename from
+                'filepath' is used when not filled.
+            progress (Optional[TransferProgress]): Progress.
+            headers (Optional[Dict[str, Any]]): Headers.
+
+        Returns:
+            RestApiResponse: Server response.
+
+        """
+        if not content_type:
+            content_type = get_media_mime_type(filepath)
+
+        if not content_type:
+            raise ValueError(
+                f"Could not determine MIME type of file '{filepath}'"
+            )
+
+        if headers is None:
+            headers = self.get_headers(content_type)
+        else:
+            # Make sure content-type is filled with file content type
+            content_type_key = next(
+                (
+                    key
+                    for key in headers
+                    if key.lower() == "content-type"
+                ),
+                "Content-Type"
+            )
+            headers[content_type_key] = content_type
+
+        # Fill original filename if not explicitly defined
+        if not filename:
+            filename = os.path.basename(filepath)
+        headers["x-file-name"] = filename
+
+        query = f"?label={label}" if label else ""
+        endpoint = (
+            f"/projects/{project_name}"
+            f"/versions/{version_id}/reviewables{query}"
+        )
+        return self.upload_file(
+            endpoint,
+            filepath,
+            progress=progress,
+            headers=headers,
+            request_type=RequestTypes.post,
+            **kwargs
+        )
+
     def trigger_server_restart(self):
         """Trigger server restart.
 
@@ -6336,6 +6459,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 +6477,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 +6508,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 +6518,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 +6544,7 @@ class ServerAPI(object):
 
         query = representations_hierarchy_qraphql_query(
             folder_fields,
+            task_fields,
             product_fields,
             version_fields,
             representation_fields,
@@ -6426,12 +6557,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 +6577,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 +6591,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 +6609,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 +6647,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"},
@@ -8073,11 +8212,11 @@ class ServerAPI(object):
         return op_results
 
     def _convert_entity_data(self, entity):
-        if not entity:
+        if not entity or "data" not in entity:
             return
-        entity_data = entity.get("data")
-        if (
-            entity_data is not None
-            and isinstance(entity_data, str)
-        ):
-            entity["data"] = json.loads(entity_data)
+
+        entity_data = entity["data"] or {}
+        if isinstance(entity_data, str):
+            entity_data = json.loads(entity_data)
+
+        entity["data"] = entity_data

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

@@ -6,6 +6,7 @@ import string
 import platform
 import collections
 from urllib.parse import urlparse, urlencode
+from typing import Optional
 
 import requests
 import unidecode
@@ -29,7 +30,14 @@ RepresentationParents = collections.namedtuple(
 
 RepresentationHierarchy = collections.namedtuple(
     "RepresentationHierarchy",
-    ("project", "folder", "product", "version", "representation")
+    (
+        "project",
+        "folder",
+        "task",
+        "product",
+        "version",
+        "representation",
+    )
 )
 
 
@@ -341,10 +349,8 @@ def logout_from_server(url, token, timeout=None):
     )
 
 
-def is_token_valid(url, token, timeout=None):
-    """Check if token is valid.
-
-    Token can be a user token or service api key.
+def get_user_by_token(url, token, timeout=None):
+    """Get user information by url and token.
 
     Args:
         url (str): Server url.
@@ -353,7 +359,7 @@ def is_token_valid(url, token, timeout=None):
             'get_default_timeout' is used if not specified.
 
     Returns:
-        bool: True if token is valid.
+        Optional[Dict[str, Any]]: User information if url and token are valid.
 
     """
     if timeout is None:
@@ -374,7 +380,27 @@ def is_token_valid(url, token, timeout=None):
             timeout=timeout,
         )
         if response.status_code == 200:
-            return True
+            return response.json()
+    return None
+
+
+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.
+
+    """
+    if get_user_by_token(url, token, timeout=timeout):
+        return True
     return False
 
 
@@ -697,3 +723,116 @@ def create_dependency_package_basename(platform_name=None):
     now_date = datetime.datetime.now()
     time_stamp = now_date.strftime("%y%m%d%H%M")
     return "ayon_{}_{}".format(time_stamp, platform_name)
+
+
+
+def _get_media_mime_type_from_ftyp(content):
+    if content[8:10] == b"qt" or content[8:12] == b"MSNV":
+        return "video/quicktime"
+
+    if content[8:12] in (b"3g2a", b"3g2b", b"3g2c", b"KDDI"):
+        return "video/3gpp2"
+
+    if content[8:12] in (
+        b"isom", b"iso2", b"avc1", b"F4V", b"F4P", b"F4A", b"F4B", b"mmp4",
+        # These might be "video/mp4v"
+        b"mp41", b"mp42",
+        # Nero
+        b"NDSC", b"NDSH", b"NDSM", b"NDSP", b"NDSS", b"NDXC", b"NDXH",
+        b"NDXM", b"NDXP", b"NDXS",
+    ):
+        return "video/mp4"
+
+    if content[8:12] in (
+        b"3ge6", b"3ge7", b"3gg6",
+        b"3gp1", b"3gp2", b"3gp3", b"3gp4", b"3gp5", b"3gp6", b"3gs7",
+    ):
+        return "video/3gpp"
+
+    if content[8:11] == b"JP2":
+        return "image/jp2"
+
+    if content[8:11] == b"jpm":
+        return "image/jpm"
+
+    if content[8:11] == b"jpx":
+        return "image/jpx"
+
+    if content[8:12] in (b"M4V\x20", b"M4VH", b"M4VP"):
+        return "video/x-m4v"
+
+    if content[8:12] in (b"mj2s", b"mjp2"):
+        return "video/mj2"
+    return None
+
+
+def get_media_mime_type_for_content(content: bytes) -> Optional[str]:
+    content_len = len(content)
+    # Pre-validation (largest definition check)
+    # - hopefully there cannot be media defined in less than 12 bytes
+    if content_len < 12:
+        return None
+
+    # FTYP
+    if content[4:8] == b"ftyp":
+        return _get_media_mime_type_from_ftyp(content)
+
+    # BMP
+    if content[0:2] == b"BM":
+        return "image/bmp"
+
+    # Tiff
+    if content[0:2] in (b"MM", b"II"):
+        return "tiff"
+
+    # PNG
+    if content[0:4] == b"\211PNG":
+        return "image/png"
+
+    # SVG
+    if b'xmlns="http://www.w3.org/2000/svg"' in content:
+        return "image/svg+xml"
+
+    # JPEG, JFIF or Exif
+    if (
+        content[0:4] == b"\xff\xd8\xff\xdb"
+        or content[6:10] in (b"JFIF", b"Exif")
+    ):
+        return "image/jpeg"
+
+    # Webp
+    if content[0:4] == b"RIFF" and content[8:12] == b"WEBP":
+        return "image/webp"
+
+    # Gif
+    if content[0:6] in (b"GIF87a", b"GIF89a"):
+        return "gif"
+
+    # Adobe PhotoShop file (8B > Adobe, PS > PhotoShop)
+    if content[0:4] == b"8BPS":
+        return "image/vnd.adobe.photoshop"
+
+    # Windows ICO > this might be wild guess as multiple files can start
+    #   with this header
+    if content[0:4] == b"\x00\x00\x01\x00":
+        return "image/x-icon"
+    return None
+
+
+def get_media_mime_type(filepath: str) -> Optional[str]:
+    """Determine Mime-Type of a file.
+
+    Args:
+        filepath (str): Path to file.
+
+    Returns:
+        Optional[str]: Mime type or None if is unknown mime type.
+
+    """
+    if not filepath or not os.path.exists(filepath):
+        return None
+
+    with open(filepath, "rb") as stream:
+        content = stream.read()
+
+    return get_media_mime_type_for_content(content)

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

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

{ayon-python-api-1.0.6 → ayon-python-api-1.0.8}/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.8
 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.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ayon-python-api"
-version = "1.0.6"
+version = "1.0.8"
 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.8"
 description = "AYON Python API"
 authors = [
     "ynput.io <info@ynput.io>"