ayon-python-api 1.2.11__tar.gz → 1.2.13__tar.gz

{ayon_python_api-1.2.11 → ayon_python_api-1.2.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ayon_python_api
-Version: 1.2.11
+Version: 1.2.13
 Summary: AYON Python API
 Home-page: https://github.com/ynput/ayon-python-api
 Author: ynput.io

{ayon_python_api-1.2.11 → ayon_python_api-1.2.13}/ayon_api/__init__.py

@@ -55,6 +55,7 @@ from ._api import (
     get_server_version,
     get_server_version_tuple,
     is_product_base_type_supported,
+    links_graphql_support_data,
     get_users,
     get_user_by_name,
     get_user,
@@ -70,8 +71,11 @@ from ._api import (
     delete,
     download_file_to_stream,
     download_file,
+    upload_project_file,
+    upload_project_file_from_stream,
     download_project_file,
     download_project_file_to_stream,
+    delete_project_file,
     upload_file_from_stream,
     upload_file,
     upload_reviewable,
@@ -336,6 +340,7 @@ __all__ = (
     "get_server_version",
     "get_server_version_tuple",
     "is_product_base_type_supported",
+    "links_graphql_support_data",
     "get_users",
     "get_user_by_name",
     "get_user",
@@ -351,8 +356,11 @@ __all__ = (
     "delete",
     "download_file_to_stream",
     "download_file",
+    "upload_project_file",
+    "upload_project_file_from_stream",
     "download_project_file",
     "download_project_file_to_stream",
+    "delete_project_file",
     "upload_file_from_stream",
     "upload_file",
     "upload_reviewable",

{ayon_python_api-1.2.11 → ayon_python_api-1.2.13}/ayon_api/_api.py

@@ -729,6 +729,13 @@ def is_product_base_type_supported() -> bool:
     return con.is_product_base_type_supported()
 
 
+def links_graphql_support_data() -> bool:
+    """Links data can be received by GraphQl.
+    """
+    con = get_server_api_connection()
+    return con.links_graphql_support_data()
+
+
 def get_users(
     project_name: Optional[str] = None,
     usernames: Optional[Iterable[str]] = None,
@@ -993,6 +1000,99 @@ def download_file(
     )
 
 
+def upload_project_file(
+    project_name: str,
+    filepath: str,
+    *,
+    content_type: Optional[str] = None,
+    filename: Optional[str] = None,
+    file_id: Optional[str] = None,
+    activity_id: Optional[str] = None,
+    chunk_size: Optional[int] = None,
+    progress: Optional[TransferProgress] = None,
+) -> requests.Response:
+    """Upload project file from a filepath.
+
+    Project files are usually binary files, such as images, videos,
+        or other media files that can be accessed via api endpoint
+        '{server url}/api/projects/{project_name}/files/{file_id}'.
+
+    Args:
+        project_name (str): Project name.
+        filepath (str): Path where file will be downloaded.
+        content_type (Optional[str]): MIME type of file.
+        filename (Optional[str]): Server filename, filename from filepath
+            is used if not passed.
+        file_id (Optional[str]): File id.
+        activity_id (Optional[str]): To which activity is file related.
+        chunk_size (Optional[int]): Size of chunks that are received
+            in single loop.
+        progress (Optional[TransferProgress]): Object that gives ability
+            to track download progress.
+
+    Returns:
+        requests.Response: Requests response.
+
+    """
+    con = get_server_api_connection()
+    return con.upload_project_file(
+        project_name=project_name,
+        filepath=filepath,
+        content_type=content_type,
+        filename=filename,
+        file_id=file_id,
+        activity_id=activity_id,
+        chunk_size=chunk_size,
+        progress=progress,
+    )
+
+
+def upload_project_file_from_stream(
+    project_name: str,
+    stream: StreamType,
+    filename: str,
+    *,
+    content_type: Optional[str] = None,
+    file_id: Optional[str] = None,
+    activity_id: Optional[str] = None,
+    chunk_size: Optional[int] = None,
+    progress: Optional[TransferProgress] = None,
+) -> requests.Response:
+    """Upload project file from a filepath.
+
+    Project files are usually binary files, such as images, videos,
+        or other media files that can be accessed via api endpoint
+        '{server url}/api/projects/{project_name}/files/{file_id}'.
+
+    Args:
+        project_name (str): Project name.
+        stream (StreamType): Stream used as source for upload.
+        filename (str): Name of file on server.
+        content_type (Optional[str]): MIME type of file.
+        file_id (Optional[str]): File id.
+        activity_id (Optional[str]): To which activity is file related.
+        chunk_size (Optional[int]): Size of chunks that are received
+            in single loop.
+        progress (Optional[TransferProgress]): Object that gives ability
+            to track download progress.
+
+    Returns:
+        requests.Response: Requests response.
+
+    """
+    con = get_server_api_connection()
+    return con.upload_project_file_from_stream(
+        project_name=project_name,
+        stream=stream,
+        filename=filename,
+        content_type=content_type,
+        file_id=file_id,
+        activity_id=activity_id,
+        chunk_size=chunk_size,
+        progress=progress,
+    )
+
+
 def download_project_file(
     project_name: str,
     file_id: str,
@@ -1067,11 +1167,27 @@ def download_project_file_to_stream(
     )
 
 
+def delete_project_file(
+    project_name: str,
+    file_id: str,
+) -> None:
+    """Delete project file.
+    """
+    con = get_server_api_connection()
+    return con.delete_project_file(
+        project_name=project_name,
+        file_id=file_id,
+    )
+
+
 def upload_file_from_stream(
     endpoint: str,
     stream: StreamType,
     progress: Optional[TransferProgress] = None,
     request_type: Optional[RequestType] = None,
+    *,
+    content_type: Optional[str] = None,
+    filename: Optional[str] = None,
     **kwargs,
 ) -> requests.Response:
     """Upload file to server from bytes.
@@ -1087,6 +1203,8 @@ def upload_file_from_stream(
             to track upload progress.
         request_type (Optional[RequestType]): Type of request that will
             be used to upload file.
+        content_type (Optional[str]): MIME type of the file.
+        filename (Optional[str]): Filename of file on server.
         **kwargs (Any): Additional arguments that will be passed
             to request function.
 
@@ -1100,6 +1218,8 @@ def upload_file_from_stream(
         stream=stream,
         progress=progress,
         request_type=request_type,
+        content_type=content_type,
+        filename=filename,
         **kwargs,
     )
 
@@ -1109,6 +1229,9 @@ def upload_file(
     filepath: str,
     progress: Optional[TransferProgress] = None,
     request_type: Optional[RequestType] = None,
+    *,
+    content_type: Optional[str] = None,
+    filename: Optional[str] = None,
     **kwargs,
 ) -> requests.Response:
     """Upload file to server.
@@ -1124,6 +1247,8 @@ def upload_file(
             to track upload progress.
         request_type (Optional[RequestType]): Type of request that will
             be used to upload file.
+        content_type (Optional[str]): MIME type of the file.
+        filename (Optional[str]): Filename of file on server.
         **kwargs (Any): Additional arguments that will be passed
             to request function.
 
@@ -1137,6 +1262,8 @@ def upload_file(
         filepath=filepath,
         progress=progress,
         request_type=request_type,
+        content_type=content_type,
+        filename=filename,
         **kwargs,
     )
 
@@ -2889,6 +3016,7 @@ def get_addon_site_settings(
 def get_bundle_settings(
     bundle_name: Optional[str] = None,
     project_name: Optional[str] = None,
+    project_bundle_name: Optional[str] = None,
     variant: Optional[str] = None,
     site_id: Optional[str] = None,
     use_site: bool = True,
@@ -2928,6 +3056,7 @@ def get_bundle_settings(
     return con.get_bundle_settings(
         bundle_name=bundle_name,
         project_name=project_name,
+        project_bundle_name=project_bundle_name,
         variant=variant,
         site_id=site_id,
         use_site=use_site,
@@ -2936,6 +3065,7 @@ def get_bundle_settings(
 
 def get_addons_studio_settings(
     bundle_name: Optional[str] = None,
+    project_bundle_name: Optional[str] = None,
     variant: Optional[str] = None,
     site_id: Optional[str] = None,
     use_site: bool = True,
@@ -2951,6 +3081,8 @@ def get_addons_studio_settings(
     Args:
         bundle_name (Optional[str]): Name of bundle for which should be
             settings received.
+        project_bundle_name (Optional[str]): Project bundle name for
+            which should be settings received.
         variant (Optional[Literal['production', 'staging']]): Name of
             settings variant. Used 'default_settings_variant' by default.
         site_id (Optional[str]): Site id for which want to receive
@@ -2968,6 +3100,7 @@ def get_addons_studio_settings(
     con = get_server_api_connection()
     return con.get_addons_studio_settings(
         bundle_name=bundle_name,
+        project_bundle_name=project_bundle_name,
         variant=variant,
         site_id=site_id,
         use_site=use_site,
@@ -2978,6 +3111,7 @@ def get_addons_studio_settings(
 def get_addons_project_settings(
     project_name: str,
     bundle_name: Optional[str] = None,
+    project_bundle_name: Optional[str] = None,
     variant: Optional[str] = None,
     site_id: Optional[str] = None,
     use_site: bool = True,
@@ -3009,6 +3143,8 @@ def get_addons_project_settings(
             received.
         bundle_name (Optional[str]): Name of bundle for which should be
             settings received.
+        project_bundle_name (Optional[str]): Project bundle name for which
+            should be settings received.
         variant (Optional[Literal['production', 'staging']]): Name of
             settings variant. Used 'default_settings_variant' by default.
         site_id (Optional[str]): Site id for which want to receive
@@ -3028,6 +3164,7 @@ def get_addons_project_settings(
     return con.get_addons_project_settings(
         project_name=project_name,
         bundle_name=bundle_name,
+        project_bundle_name=project_bundle_name,
         variant=variant,
         site_id=site_id,
         use_site=use_site,
@@ -3037,6 +3174,7 @@ def get_addons_project_settings(
 
 def get_addons_settings(
     bundle_name: Optional[str] = None,
+    project_bundle_name: Optional[str] = None,
     project_name: Optional[str] = None,
     variant: Optional[str] = None,
     site_id: Optional[str] = None,
@@ -3056,6 +3194,8 @@ def get_addons_settings(
     Args:
         bundle_name (Optional[str]): Name of bundle for which should be
             settings received.
+        project_bundle_name (Optional[str]): Name of project bundle
+            for which should be settings received.
         project_name (Optional[str]): Name of project for which should be
             settings received.
         variant (Optional[Literal['production', 'staging']]): Name of
@@ -3072,6 +3212,7 @@ def get_addons_settings(
     con = get_server_api_connection()
     return con.get_addons_settings(
         bundle_name=bundle_name,
+        project_bundle_name=project_bundle_name,
         project_name=project_name,
         variant=variant,
         site_id=site_id,
@@ -6887,6 +7028,7 @@ def create_link(
     output_id: str,
     output_type: str,
     link_name: Optional[str] = None,
+    data: Optional[dict[str, Any]] = None,
 ) -> CreateLinkData:
     """Create link between 2 entities.
 
@@ -6906,7 +7048,8 @@ def create_link(
         output_id (str): Output entity id.
         output_type (str): Entity type of output entity.
         link_name (Optional[str]): Name of link.
-            Available from server version '1.0.0-rc.6'.
+        data (Optional[dict[str, Any]]): Additional data to be stored
+            with the link.
 
     Returns:
         CreateLinkData: Information about link.
@@ -6924,6 +7067,7 @@ def create_link(
         output_id=output_id,
         output_type=output_type,
         link_name=link_name,
+        data=data,
     )
 
 

{ayon_python_api-1.2.11 → ayon_python_api-1.2.13}/ayon_api/_api_helpers/base.py

@@ -28,6 +28,9 @@ class BaseServerAPI:
     def is_product_base_type_supported(self) -> bool:
         raise NotImplementedError()
 
+    def links_graphql_support_data(self) -> bool:
+        raise NotImplementedError()
+
     def get_server_version(self) -> str:
         raise NotImplementedError()
 
@@ -142,6 +145,9 @@ class BaseServerAPI:
     ):
         raise NotImplementedError()
 
+    def _prepare_link_fields(self, fields: set[str]) -> None:
+        raise NotImplementedError()
+
     def _prepare_advanced_filters(
         self, filters: Union[str, dict[str, Any], None]
     ) -> Optional[str]:

{ayon_python_api-1.2.11 → ayon_python_api-1.2.13}/ayon_api/_api_helpers/bundles_addons.py

@@ -671,6 +671,7 @@ class BundlesAddonsAPI(BaseServerAPI):
         self,
         bundle_name: Optional[str] = None,
         project_name: Optional[str] = None,
+        project_bundle_name: Optional[str] = None,
         variant: Optional[str] = None,
         site_id: Optional[str] = None,
         use_site: bool = True,
@@ -714,6 +715,7 @@ class BundlesAddonsAPI(BaseServerAPI):
         query = prepare_query_string({
             "project_name": project_name or None,
             "bundle_name": bundle_name or None,
+            "project_bundle_name": project_bundle_name or None,
             "variant": variant or self.get_default_settings_variant() or None,
             "site_id": site_id,
         })
@@ -724,6 +726,7 @@ class BundlesAddonsAPI(BaseServerAPI):
     def get_addons_studio_settings(
         self,
         bundle_name: Optional[str] = None,
+        project_bundle_name: Optional[str] = None,
         variant: Optional[str] = None,
         site_id: Optional[str] = None,
         use_site: bool = True,
@@ -739,6 +742,8 @@ class BundlesAddonsAPI(BaseServerAPI):
         Args:
             bundle_name (Optional[str]): Name of bundle for which should be
                 settings received.
+            project_bundle_name (Optional[str]): Project bundle name for
+                which should be settings received.
             variant (Optional[Literal['production', 'staging']]): Name of
                 settings variant. Used 'default_settings_variant' by default.
             site_id (Optional[str]): Site id for which want to receive
@@ -755,6 +760,7 @@ class BundlesAddonsAPI(BaseServerAPI):
         """
         output = self.get_bundle_settings(
             bundle_name=bundle_name,
+            project_bundle_name=project_bundle_name,
             variant=variant,
             site_id=site_id,
             use_site=use_site
@@ -770,6 +776,7 @@ class BundlesAddonsAPI(BaseServerAPI):
         self,
         project_name: str,
         bundle_name: Optional[str] = None,
+        project_bundle_name: Optional[str] = None,
         variant: Optional[str] = None,
         site_id: Optional[str] = None,
         use_site: bool = True,
@@ -801,6 +808,8 @@ class BundlesAddonsAPI(BaseServerAPI):
                 received.
             bundle_name (Optional[str]): Name of bundle for which should be
                 settings received.
+            project_bundle_name (Optional[str]): Project bundle name for which
+                should be settings received.
             variant (Optional[Literal['production', 'staging']]): Name of
                 settings variant. Used 'default_settings_variant' by default.
             site_id (Optional[str]): Site id for which want to receive
@@ -822,6 +831,7 @@ class BundlesAddonsAPI(BaseServerAPI):
         output = self.get_bundle_settings(
             project_name=project_name,
             bundle_name=bundle_name,
+            project_bundle_name=project_bundle_name,
             variant=variant,
             site_id=site_id,
             use_site=use_site
@@ -836,6 +846,7 @@ class BundlesAddonsAPI(BaseServerAPI):
     def get_addons_settings(
         self,
         bundle_name: Optional[str] = None,
+        project_bundle_name: Optional[str] = None,
         project_name: Optional[str] = None,
         variant: Optional[str] = None,
         site_id: Optional[str] = None,
@@ -855,6 +866,8 @@ class BundlesAddonsAPI(BaseServerAPI):
         Args:
             bundle_name (Optional[str]): Name of bundle for which should be
                 settings received.
+            project_bundle_name (Optional[str]): Name of project bundle
+                for which should be settings received.
             project_name (Optional[str]): Name of project for which should be
                 settings received.
             variant (Optional[Literal['production', 'staging']]): Name of
@@ -871,6 +884,7 @@ class BundlesAddonsAPI(BaseServerAPI):
         if project_name is None:
             return self.get_addons_studio_settings(
                 bundle_name=bundle_name,
+                project_bundle_name=project_bundle_name,
                 variant=variant,
                 site_id=site_id,
                 use_site=use_site,
@@ -880,6 +894,7 @@ class BundlesAddonsAPI(BaseServerAPI):
         return self.get_addons_project_settings(
             project_name=project_name,
             bundle_name=bundle_name,
+            project_bundle_name=project_bundle_name,
             variant=variant,
             site_id=site_id,
             use_site=use_site,

{ayon_python_api-1.2.11 → ayon_python_api-1.2.13}/ayon_api/_api_helpers/folders.py

@@ -331,6 +331,8 @@ class FoldersAPI(BaseServerAPI):
         if own_attributes:
             fields.add("ownAttrib")
 
+        self._prepare_link_fields(fields)
+
         query = folders_graphql_query(fields)
         for attr, filter_value in graphql_filters.items():
             query.set_variable_value(attr, filter_value)

{ayon_python_api-1.2.11 → ayon_python_api-1.2.13}/ayon_api/_api_helpers/links.py

@@ -362,6 +362,7 @@ class LinksAPI(BaseServerAPI):
             return output
 
         link_fields = {"id", "links"}
+        self._prepare_link_fields(link_fields)
         query = query_func(link_fields)
         for attr, filter_value in filters.items():
             query.set_variable_value(attr, filter_value)

{ayon_python_api-1.2.11 → ayon_python_api-1.2.13}/ayon_api/_api_helpers/products.py

@@ -179,6 +179,8 @@ class ProductsAPI(BaseServerAPI):
             if filter_value:
                 graphql_filters[filter_key] = filter_value
 
+        self._prepare_link_fields(fields)
+
         query = products_graphql_query(fields)
         for attr, filter_value in graphql_filters.items():
             query.set_variable_value(attr, filter_value)

{ayon_python_api-1.2.11 → ayon_python_api-1.2.13}/ayon_api/_api_helpers/representations.py

@@ -108,6 +108,8 @@ class RepresentationsAPI(BaseServerAPI):
             fields.discard("files")
             fields |= REPRESENTATION_FILES_FIELDS
 
+        self._prepare_link_fields(fields)
+
         graphql_filters = {
             "projectName": project_name
         }

{ayon_python_api-1.2.11 → ayon_python_api-1.2.13}/ayon_api/_api_helpers/tasks.py

@@ -106,6 +106,8 @@ class TasksAPI(BaseServerAPI):
         if active is not None:
             fields.add("active")
 
+        self._prepare_link_fields(fields)
+
         query = tasks_graphql_query(fields)
         for attr, filter_value in graphql_filters.items():
             query.set_variable_value(attr, filter_value)
@@ -267,6 +269,8 @@ class TasksAPI(BaseServerAPI):
         if active is not None:
             fields.add("active")
 
+        self._prepare_link_fields(fields)
+
         query = tasks_by_folder_paths_graphql_query(fields)
         for attr, filter_value in graphql_filters.items():
             query.set_variable_value(attr, filter_value)

{ayon_python_api-1.2.11 → ayon_python_api-1.2.13}/ayon_api/_api_helpers/versions.py

@@ -87,6 +87,8 @@ class VersionsAPI(BaseServerAPI):
         if active is not None:
             fields.add("active")
 
+        self._prepare_link_fields(fields)
+
         if own_attributes is not _PLACEHOLDER:
             warnings.warn(
                 (
@@ -116,7 +118,6 @@ class VersionsAPI(BaseServerAPI):
         ):
             return
 
-
         filters = self._prepare_advanced_filters(filters)
         if filters:
             graphql_filters["filter"] = filters

{ayon_python_api-1.2.11 → ayon_python_api-1.2.13}/ayon_api/_api_helpers/workfiles.py

@@ -93,6 +93,8 @@ class WorkfilesAPI(BaseServerAPI):
             fields = set(fields)
             self._prepare_fields("workfile", fields)
 
+        self._prepare_link_fields(fields)
+
         query = workfiles_info_graphql_query(fields)
 
         for attr, filter_value in filters.items():

{ayon_python_api-1.2.11 → ayon_python_api-1.2.13}/ayon_api/graphql_queries.py

@@ -1,18 +1,31 @@
+from __future__ import annotations
+
 import collections
+import typing
 
 from .constants import DEFAULT_LINK_FIELDS
 from .graphql import FIELD_VALUE, GraphQlQuery, fields_to_dict
 
+if typing.TYPE_CHECKING:
+    from .graphql import (
+        GraphQlQueryEdgeField,
+    )
+
 
-def add_links_fields(entity_field, nested_fields):
+def add_links_fields(
+    entity_field: GraphQlQueryEdgeField,
+    nested_fields: dict | None,
+) -> None:
     if "links" not in nested_fields:
         return
     links_fields = nested_fields.pop("links")
-
     link_edge_fields = set(DEFAULT_LINK_FIELDS)
+
     if isinstance(links_fields, dict):
         simple_fields = set(links_fields)
-        simple_variant = len(simple_fields - link_edge_fields) == 0
+        diff = simple_fields - link_edge_fields
+        diff.discard("data")
+        simple_variant = len(diff) == 0
     else:
         simple_variant = True
         simple_fields = link_edge_fields
@@ -121,7 +134,7 @@ def product_types_query(fields):
     return query
 
 
-def folders_graphql_query(fields):
+def folders_graphql_query(fields: set[str]) -> GraphQlQuery:
     query = GraphQlQuery("FoldersQuery")
     project_name_var = query.add_variable("projectName", "String!")
     folder_ids_var = query.add_variable("folderIds", "[String!]")
@@ -161,6 +174,7 @@ def folders_graphql_query(fields):
     folders_field.set_filter("filter", filter_var)
 
     nested_fields = fields_to_dict(fields)
+
     add_links_fields(folders_field, nested_fields)
 
     query_queue = collections.deque()
@@ -179,7 +193,7 @@ def folders_graphql_query(fields):
     return query
 
 
-def tasks_graphql_query(fields):
+def tasks_graphql_query(fields: set[str]) -> GraphQlQuery:
     query = GraphQlQuery("TasksQuery")
     project_name_var = query.add_variable("projectName", "String!")
     task_ids_var = query.add_variable("taskIds", "[String!]")
@@ -227,7 +241,7 @@ def tasks_graphql_query(fields):
     return query
 
 
-def tasks_by_folder_paths_graphql_query(fields):
+def tasks_by_folder_paths_graphql_query(fields: set[str]) -> GraphQlQuery:
     query = GraphQlQuery("TasksByFolderPathQuery")
     project_name_var = query.add_variable("projectName", "String!")
     task_names_var = query.add_variable("taskNames", "[String!]")
@@ -258,6 +272,7 @@ def tasks_by_folder_paths_graphql_query(fields):
     tasks_field.set_filter("filter", filter_var)
 
     nested_fields = fields_to_dict(fields)
+
     add_links_fields(tasks_field, nested_fields)
 
     query_queue = collections.deque()
@@ -276,7 +291,7 @@ def tasks_by_folder_paths_graphql_query(fields):
     return query
 
 
-def products_graphql_query(fields):
+def products_graphql_query(fields: set[str]) -> GraphQlQuery:
     query = GraphQlQuery("ProductsQuery")
 
     project_name_var = query.add_variable("projectName", "String!")
@@ -326,7 +341,7 @@ def products_graphql_query(fields):
     return query
 
 
-def versions_graphql_query(fields):
+def versions_graphql_query(fields: set[str]) -> GraphQlQuery:
     query = GraphQlQuery("VersionsQuery")
 
     project_name_var = query.add_variable("projectName", "String!")
@@ -377,7 +392,7 @@ def versions_graphql_query(fields):
     return query
 
 
-def representations_graphql_query(fields):
+def representations_graphql_query(fields: set[str]) -> GraphQlQuery:
     query = GraphQlQuery("RepresentationsQuery")
 
     project_name_var = query.add_variable("projectName", "String!")
@@ -525,7 +540,7 @@ def representations_hierarchy_qraphql_query(
     return query
 
 
-def workfiles_info_graphql_query(fields):
+def workfiles_info_graphql_query(fields: set[str]) -> GraphQlQuery:
     query = GraphQlQuery("WorkfilesInfo")
     project_name_var = query.add_variable("projectName", "String!")
     workfiles_info_ids = query.add_variable("workfileIds", "[String!]")

{ayon_python_api-1.2.11 → ayon_python_api-1.2.13}/ayon_api/operations.py

@@ -834,8 +834,8 @@ class OperationsSession(object):
                 if body is not None:
                     operations_body.append(body)
 
-            self._con.send_batch_operations(
-                project_name, operations_body, can_fail=False
+            self._con.send_background_batch_operations(
+                project_name, operations_body, wait=True, can_fail=False
             )
 
     def create_entity(

{ayon_python_api-1.2.11 → ayon_python_api-1.2.13}/ayon_api/server_api.py

@@ -38,6 +38,7 @@ from .constants import (
     DEFAULT_ACTIVITY_FIELDS,
     DEFAULT_USER_FIELDS,
     DEFAULT_ENTITY_LIST_FIELDS,
+    DEFAULT_LINK_FIELDS,
 )
 from .graphql import INTROSPECTION_QUERY
 from .graphql_queries import users_graphql_query
@@ -62,6 +63,7 @@ from .utils import (
     get_default_site_id,
     NOT_SET,
     get_media_mime_type,
+    get_media_mime_type_for_stream,
     get_machine_name,
     fill_own_attribs,
 )
@@ -328,6 +330,7 @@ class ServerAPI(
 
         self._graphql_allows_traits_in_representations: Optional[bool] = None
         self._product_base_type_supported = None
+        self._links_graphql_support_data = None
 
         self._session = None
 
@@ -921,6 +924,15 @@ class ServerAPI(
             )
         return self._product_base_type_supported
 
+    def links_graphql_support_data(self) -> bool:
+        """Links data can be received by GraphQl."""
+        if self._links_graphql_support_data is None:
+            major, minor, patch, _, _ = self.server_version_tuple
+            self._links_graphql_support_data = (
+                (major, minor, patch) >= (1, 14, 2)
+            )
+        return self._links_graphql_support_data
+
     def _get_user_info(self) -> Optional[dict[str, Any]]:
         if self._access_token is None:
             return None
@@ -1414,7 +1426,7 @@ class ServerAPI(
         if api_prepended:
             self.log.warning(
                 f"Auto-fixed endpoint '{endpoint}' -> 'api/{endpoint}'."
-                " Please fix the endpoit passed to the function."
+                " Please fix the endpoint passed to the function."
             )
 
     def download_file_to_stream(
@@ -1517,6 +1529,117 @@ class ServerAPI(
 
         return progress
 
+    def upload_project_file(
+        self,
+        project_name: str,
+        filepath: str,
+        *,
+        content_type: Optional[str] = None,
+        filename: Optional[str] = None,
+        file_id: Optional[str] = None,
+        activity_id: Optional[str] = None,
+        chunk_size: Optional[int] = None,
+        progress: Optional[TransferProgress] = None,
+    ) -> requests.Response:
+        """Upload project file from a filepath.
+
+        Project files are usually binary files, such as images, videos,
+            or other media files that can be accessed via api endpoint
+            '{server url}/api/projects/{project_name}/files/{file_id}'.
+
+        Args:
+            project_name (str): Project name.
+            filepath (str): Path where file will be downloaded.
+            content_type (Optional[str]): MIME type of file.
+            filename (Optional[str]): Server filename, filename from filepath
+                is used if not passed.
+            file_id (Optional[str]): File id.
+            activity_id (Optional[str]): To which activity is file related.
+            chunk_size (Optional[int]): Size of chunks that are received
+                in single loop.
+            progress (Optional[TransferProgress]): Object that gives ability
+                to track download progress.
+
+        Returns:
+            requests.Response: Requests response.
+
+        """
+        if not filename:
+            filename = os.path.basename(filepath)
+
+        if not content_type:
+            content_type = get_media_mime_type(filepath)
+            if not content_type:
+                content_type = "application/octet-stream"
+
+        query = prepare_query_string({
+            "x_file_id": file_id,
+            "x_activity_id": activity_id,
+        })
+        return self.upload_file(
+            f"api/projects/{project_name}/files{query}",
+            filepath,
+            content_type=content_type,
+            filename=filename,
+            chunk_size=chunk_size,
+            progress=progress,
+            request_type=RequestTypes.post,
+        )
+
+    def upload_project_file_from_stream(
+        self,
+        project_name: str,
+        stream: StreamType,
+        filename: str,
+        *,
+        content_type: Optional[str] = None,
+        file_id: Optional[str] = None,
+        activity_id: Optional[str] = None,
+        chunk_size: Optional[int] = None,
+        progress: Optional[TransferProgress] = None,
+    ) -> requests.Response:
+        """Upload project file from a filepath.
+
+        Project files are usually binary files, such as images, videos,
+            or other media files that can be accessed via api endpoint
+            '{server url}/api/projects/{project_name}/files/{file_id}'.
+
+        Args:
+            project_name (str): Project name.
+            stream (StreamType): Stream used as source for upload.
+            filename (str): Name of file on server.
+            content_type (Optional[str]): MIME type of file.
+            file_id (Optional[str]): File id.
+            activity_id (Optional[str]): To which activity is file related.
+            chunk_size (Optional[int]): Size of chunks that are received
+                in single loop.
+            progress (Optional[TransferProgress]): Object that gives ability
+                to track download progress.
+
+        Returns:
+            requests.Response: Requests response.
+
+        """
+        if not content_type:
+            stream.seek(0)
+            content_type = get_media_mime_type_for_stream(stream)
+            if not content_type:
+                content_type = "application/octet-stream"
+
+        query = prepare_query_string({
+            "x_file_id": file_id,
+            "x_activity_id": activity_id,
+        })
+        return self.upload_file_from_stream(
+            f"api/projects/{project_name}/files{query}",
+            stream,
+            content_type=content_type,
+            filename=filename,
+            chunk_size=chunk_size,
+            progress=progress,
+            request_type=RequestTypes.post,
+        )
+
     def download_project_file(
         self,
         project_name: str,
@@ -1587,6 +1710,11 @@ class ServerAPI(
             progress=progress,
         )
 
+    def delete_project_file(self, project_name: str, file_id: str) -> None:
+        """Delete project file."""
+        response = self.delete(f"projects/{project_name}/files/{file_id}")
+        response.raise_for_status()
+
     @staticmethod
     def _upload_chunks_iter(
         file_stream: StreamType,
@@ -1619,6 +1747,9 @@ class ServerAPI(
         progress: TransferProgress,
         request_type: Optional[RequestType] = None,
         chunk_size: Optional[int] = None,
+        *,
+        content_type: Optional[str] = None,
+        filename: Optional[str] = None,
         **kwargs
     ) -> requests.Response:
         """Upload file to server.
@@ -1646,11 +1777,14 @@ class ServerAPI(
         url = self._endpoint_to_url(endpoint, use_rest=False)
         progress.set_destination_url(url)
 
+        headers = kwargs.setdefault("headers", {})
+        headers_keys_by_low_key = {key.lower(): key for key in headers}
         if self._session is None:
-            headers = kwargs.setdefault("headers", {})
             for key, value in self.get_headers().items():
-                if key not in headers:
+                orig_key = headers_keys_by_low_key.get(key)
+                if not orig_key:
                     headers[key] = value
+
             post_func = self._base_functions_mapping[request_type]
         else:
             post_func = self._session_functions_mapping[request_type]
@@ -1658,6 +1792,17 @@ class ServerAPI(
         if not chunk_size:
             chunk_size = self.default_upload_chunk_size
 
+        for key, value in (
+            ("x-file-name", filename),
+            ("Content-Type", content_type),
+        ):
+            if not value:
+                continue
+            orig_key = headers_keys_by_low_key.get(key.lower())
+            if orig_key:
+                headers.pop(orig_key)
+            headers[key] = value
+
         retries = self.get_default_max_retries()
         response = None
 
@@ -1702,7 +1847,7 @@ class ServerAPI(
         if api_prepended:
             self.log.warning(
                 f"Auto-fixed endpoint '{endpoint}' -> 'api/{endpoint}'."
-                " Please fix the endpoit passed to the function."
+                " Please fix the endpoint passed to the function."
             )
         return response
 
@@ -1712,6 +1857,9 @@ class ServerAPI(
         stream: StreamType,
         progress: Optional[TransferProgress] = None,
         request_type: Optional[RequestType] = None,
+        *,
+        content_type: Optional[str] = None,
+        filename: Optional[str] = None,
         **kwargs
     ) -> requests.Response:
         """Upload file to server from bytes.
@@ -1727,6 +1875,8 @@ class ServerAPI(
                 to track upload progress.
             request_type (Optional[RequestType]): Type of request that will
                 be used to upload file.
+            content_type (Optional[str]): MIME type of the file.
+            filename (Optional[str]): Filename of file on server.
             **kwargs (Any): Additional arguments that will be passed
                 to request function.
 
@@ -1747,6 +1897,8 @@ class ServerAPI(
                 stream,
                 progress,
                 request_type,
+                content_type=content_type,
+                filename=filename,
                 **kwargs
             )
 
@@ -1763,6 +1915,9 @@ class ServerAPI(
         filepath: str,
         progress: Optional[TransferProgress] = None,
         request_type: Optional[RequestType] = None,
+        *,
+        content_type: Optional[str] = None,
+        filename: Optional[str] = None,
         **kwargs
     ) -> requests.Response:
         """Upload file to server.
@@ -1778,6 +1933,8 @@ class ServerAPI(
                 to track upload progress.
             request_type (Optional[RequestType]): Type of request that will
                 be used to upload file.
+            content_type (Optional[str]): MIME type of the file.
+            filename (Optional[str]): Filename of file on server.
             **kwargs (Any): Additional arguments that will be passed
                 to request function.
 
@@ -1796,6 +1953,8 @@ class ServerAPI(
                 stream,
                 progress,
                 request_type,
+                content_type=content_type,
+                filename=filename,
                 **kwargs
             )
 
@@ -1837,24 +1996,9 @@ class ServerAPI(
                 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 = prepare_query_string({"label": label or None})
         endpoint = (
@@ -1865,6 +2009,8 @@ class ServerAPI(
             endpoint,
             filepath,
             progress=progress,
+            content_type=content_type,
+            filename=filename,
             headers=headers,
             request_type=RequestTypes.post,
             **kwargs
@@ -2310,6 +2456,17 @@ class ServerAPI(
                 )
             }
 
+    def _prepare_link_fields(self, fields: set[str]) -> None:
+        if "links" not in fields:
+            return
+
+        fields.discard("links")
+        for field in DEFAULT_LINK_FIELDS:
+            fields.add(f"links.{field}")
+
+        if self.links_graphql_support_data():
+            fields.add("links.data")
+
     def _prepare_advanced_filters(
         self, filters: Union[str, dict[str, Any], None]
     ) -> Optional[str]:

{ayon_python_api-1.2.11 → ayon_python_api-1.2.13}/ayon_api/utils.py

@@ -1118,12 +1118,12 @@ def _get_media_mime_type_for_content_base(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:
+    if content_len < 4:
         return None
 
-    # FTYP
-    if content[4:8] == b"ftyp":
-        return _get_media_mime_type_from_ftyp(content)
+    # PDF
+    if content[0:4] == b"%PDF":
+        return "application/pdf"
 
     # BMP
     if content[0:2] == b"BM":
@@ -1162,6 +1162,14 @@ def _get_media_mime_type_for_content_base(content: bytes) -> Optional[str]:
     #   with this header
     if content[0:4] == b"\x00\x00\x01\x00":
         return "image/x-icon"
+
+    if content_len < 8:
+        return None
+
+    # FTYP
+    if content[4:8] == b"ftyp":
+        return _get_media_mime_type_from_ftyp(content)
+
     return None
 
 
@@ -1172,23 +1180,32 @@ def _get_svg_mime_type(content: bytes) -> Optional[str]:
     return None
 
 
+def _get_json_mime_type(content: bytes) -> Optional[str]:
+    # json
+    try:
+        json.loads(content.decode("utf-8"))
+        return "application/json"
+    except (UnicodeDecodeError, ValueError):
+        pass
+    return None
+
+
 def get_media_mime_type_for_content(content: bytes) -> Optional[str]:
     mime_type = _get_media_mime_type_for_content_base(content)
     if mime_type is not None:
         return mime_type
-    return _get_svg_mime_type(content)
+    return _get_svg_mime_type(content) or _get_json_mime_type(content)
 
 
 def get_media_mime_type_for_stream(stream: StreamType) -> Optional[str]:
     # Read only 12 bytes to determine mime type
     content = stream.read(12)
-    if len(content) < 12:
-        return None
     mime_type = _get_media_mime_type_for_content_base(content)
-    if mime_type is None:
-        content += stream.read()
-        mime_type = _get_svg_mime_type(content)
-    return mime_type
+    if mime_type is not None:
+        return mime_type
+
+    content += stream.read()
+    return _get_svg_mime_type(content) or _get_json_mime_type(content)
 
 
 def get_media_mime_type(filepath: str) -> Optional[str]:

{ayon_python_api-1.2.11 → ayon_python_api-1.2.13}/ayon_api/version.py

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

{ayon_python_api-1.2.11 → ayon_python_api-1.2.13}/ayon_python_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ayon_python_api
-Version: 1.2.11
+Version: 1.2.13
 Summary: AYON Python API
 Home-page: https://github.com/ynput/ayon-python-api
 Author: ynput.io

{ayon_python_api-1.2.11 → ayon_python_api-1.2.13}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ayon_python_api"
-version = "1.2.11"
+version = "1.2.13"
 description = "AYON Python API"
 license = {file = "LICENSE"}
 readme = {file = "README.md", content-type = "text/markdown"}
@@ -28,7 +28,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "ayon_python_api"
-version = "1.2.2"
+version = "1.2.13"
 description = "AYON Python API"
 authors = [
     "ynput.io <info@ynput.io>"
@@ -49,4 +49,4 @@ mock = "*"
 sphinx-autoapi = "*"
 revitron-sphinx-theme = { git = "https://github.com/revitron/revitron-sphinx-theme.git", branch = "master" }
 pytest = "^6.2.5"
-pydocstyle = "^6.3.0"
+pydocstyle = "^6.3.0"