ayon-python-api 1.2.10__tar.gz → 1.2.12__tar.gz

{ayon_python_api-1.2.10 → ayon_python_api-1.2.12}/PKG-INFO

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

{ayon_python_api-1.2.10 → ayon_python_api-1.2.12}/ayon_api/__init__.py

@@ -70,8 +70,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,
@@ -351,8 +354,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.10 → ayon_python_api-1.2.12}/ayon_api/_api.py

@@ -993,6 +993,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 +1160,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 +1196,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 +1211,8 @@ def upload_file_from_stream(
         stream=stream,
         progress=progress,
         request_type=request_type,
+        content_type=content_type,
+        filename=filename,
         **kwargs,
     )
 
@@ -1109,6 +1222,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 +1240,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 +1255,8 @@ def upload_file(
         filepath=filepath,
         progress=progress,
         request_type=request_type,
+        content_type=content_type,
+        filename=filename,
         **kwargs,
     )
 
@@ -2889,6 +3009,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 +3049,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 +3058,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 +3074,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 +3093,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 +3104,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 +3136,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 +3157,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 +3167,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 +3187,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 +3205,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 +7021,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 +7041,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 +7060,7 @@ def create_link(
         output_id=output_id,
         output_type=output_type,
         link_name=link_name,
+        data=data,
     )
 
 

{ayon_python_api-1.2.10 → ayon_python_api-1.2.12}/ayon_api/_api_helpers/bundles_addons.py

@@ -398,7 +398,7 @@ class BundlesAddonsAPI(BaseServerAPI):
 
         """
         response = self.upload_file(
-            "addons/install",
+            "api/addons/install",
             src_filepath,
             progress=progress,
             request_type=RequestTypes.post,
@@ -448,9 +448,11 @@ class BundlesAddonsAPI(BaseServerAPI):
             "private",
             filename
         )
-        url = f"{self.get_base_url()}/{endpoint}"
         self.download_file(
-            url, dst_filepath, chunk_size=chunk_size, progress=progress
+            endpoint,
+            dst_filepath,
+            chunk_size=chunk_size,
+            progress=progress,
         )
         return dst_filepath
 
@@ -669,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,
@@ -712,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,
         })
@@ -722,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,
@@ -737,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
@@ -753,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
@@ -768,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,
@@ -799,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
@@ -820,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
@@ -834,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,
@@ -853,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
@@ -869,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,
@@ -878,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.10 → ayon_python_api-1.2.12}/ayon_api/_api_helpers/dependency_packages.py

@@ -189,7 +189,7 @@ class DependencyPackagesAPI(BaseServerAPI):
         route = self._get_dependency_package_route(src_filename)
         package_filepath = os.path.join(dst_directory, dst_filename)
         self.download_file(
-            route,
+            f"api/{route}",
             package_filepath,
             chunk_size=chunk_size,
             progress=progress
@@ -225,7 +225,7 @@ class DependencyPackagesAPI(BaseServerAPI):
             )
 
         route = self._get_dependency_package_route(dst_filename)
-        self.upload_file(route, src_filepath, progress=progress)
+        self.upload_file(f"api/{route}", src_filepath, progress=progress)
 
     def _get_dependency_package_route(
         self, filename: Optional[str] = None

{ayon_python_api-1.2.10 → ayon_python_api-1.2.12}/ayon_api/_api_helpers/installers.py

@@ -143,7 +143,7 @@ class InstallersAPI(BaseServerAPI):
 
         """
         return self.download_file(
-            f"desktop/installers/{filename}",
+            f"api/desktop/installers/{filename}",
             dst_filepath,
             chunk_size=chunk_size,
             progress=progress
@@ -168,7 +168,7 @@ class InstallersAPI(BaseServerAPI):
 
         """
         return self.upload_file(
-            f"desktop/installers/{dst_filename}",
+            f"api/desktop/installers/{dst_filename}",
             src_filepath,
             progress=progress
         )

{ayon_python_api-1.2.10 → ayon_python_api-1.2.12}/ayon_api/_api_helpers/thumbnails.py

@@ -256,7 +256,7 @@ class ThumbnailsAPI(BaseServerAPI):
 
         mime_type = get_media_mime_type(src_filepath)
         response = self.upload_file(
-            f"projects/{project_name}/thumbnails",
+            f"api/projects/{project_name}/thumbnails",
             src_filepath,
             request_type=RequestTypes.post,
             headers={"Content-Type": mime_type},
@@ -295,7 +295,7 @@ class ThumbnailsAPI(BaseServerAPI):
 
         mime_type = get_media_mime_type_for_stream(stream)
         response = self.upload_file_from_stream(
-            f"projects/{project_name}/thumbnails",
+            f"api/projects/{project_name}/thumbnails",
             stream,
             request_type=RequestTypes.post,
             headers={"Content-Type": mime_type},
@@ -325,7 +325,7 @@ class ThumbnailsAPI(BaseServerAPI):
 
         mime_type = get_media_mime_type(src_filepath)
         response = self.upload_file(
-            f"projects/{project_name}/thumbnails/{thumbnail_id}",
+            f"api/projects/{project_name}/thumbnails/{thumbnail_id}",
             src_filepath,
             request_type=RequestTypes.put,
             headers={"Content-Type": mime_type},
@@ -351,7 +351,7 @@ class ThumbnailsAPI(BaseServerAPI):
         """
         mime_type = get_media_mime_type_for_stream(stream)
         response = self.upload_file_from_stream(
-            f"projects/{project_name}/thumbnails/{thumbnail_id}",
+            f"api/projects/{project_name}/thumbnails/{thumbnail_id}",
             stream,
             request_type=RequestTypes.put,
             headers={"Content-Type": mime_type},

{ayon_python_api-1.2.10 → ayon_python_api-1.2.12}/ayon_api/server_api.py

@@ -62,6 +62,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,
 )
@@ -1352,7 +1353,7 @@ class ServerAPI(
 
     def _download_file_to_stream(
         self,
-        url: str,
+        endpoint: str,
         stream: StreamType,
         chunk_size: int,
         progress: TransferProgress,
@@ -1367,7 +1368,11 @@ class ServerAPI(
         else:
             get_func = self._session_functions_mapping[RequestTypes.get]
 
+        url = self._endpoint_to_url(endpoint, use_rest=False)
+        progress.set_source_url(url)
+
         retries = self.get_default_max_retries()
+        api_prepended = False
         for attempt in range(retries):
             # Continue in download
             offset = progress.get_transferred_size()
@@ -1376,6 +1381,18 @@ class ServerAPI(
 
             try:
                 with get_func(url, **kwargs) as response:
+                    # Auto-fix missing 'api/'
+                    if response.status_code == 405 and not api_prepended:
+                        api_prepended = True
+                        if (
+                            not endpoint.startswith(self._base_url)
+                            and not endpoint.startswith("api/")
+                        ):
+                            url = self._endpoint_to_url(
+                                endpoint, use_rest=True
+                            )
+                            progress.set_destination_url(url)
+                            continue
                     response.raise_for_status()
                     if progress.get_content_size() is None:
                         progress.set_content_size(
@@ -1395,6 +1412,12 @@ class ServerAPI(
                     raise
                 progress.next_attempt()
 
+        if api_prepended:
+            self.log.warning(
+                f"Auto-fixed endpoint '{endpoint}' -> 'api/{endpoint}'."
+                " Please fix the endpoint passed to the function."
+            )
+
     def download_file_to_stream(
         self,
         endpoint: str,
@@ -1427,17 +1450,14 @@ class ServerAPI(
         if not chunk_size:
             chunk_size = self.default_download_chunk_size
 
-        url = self._endpoint_to_url(endpoint, use_rest=False)
-
         if progress is None:
             progress = TransferProgress()
 
-        progress.set_source_url(url)
         progress.set_started()
 
         try:
             self._download_file_to_stream(
-                url, stream, chunk_size, progress
+                endpoint, stream, chunk_size, progress
             )
 
         except Exception as exc:
@@ -1498,6 +1518,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,
@@ -1568,6 +1699,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,
@@ -1585,13 +1721,7 @@ class ServerAPI(
             bytes: Chunk of file.
 
         """
-        # Get size of file
-        file_stream.seek(0, io.SEEK_END)
-        size = file_stream.tell()
         file_stream.seek(0)
-        # Set content size to progress object
-        progress.set_content_size(size)
-
         while True:
             chunk = file_stream.read(chunk_size)
             if not chunk:
@@ -1601,17 +1731,20 @@ class ServerAPI(
 
     def _upload_file(
         self,
-        url: str,
+        endpoint: str,
         stream: StreamType,
         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.
 
         Args:
-            url (str): Url where file will be uploaded.
+            endpoint (str): Endpoint used to upload.
             stream (StreamType): File stream.
             progress (TransferProgress): Object that gives ability to track
                 progress.
@@ -1629,11 +1762,18 @@ class ServerAPI(
         if request_type is None:
             request_type = RequestTypes.put
 
+        endpoint = endpoint.lstrip("/")
+        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]
@@ -1641,8 +1781,27 @@ 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
+
+        # Get size of file
+        stream.seek(0, io.SEEK_END)
+        size = stream.tell()
+        # Set content size to progress object
+        progress.set_content_size(size)
+
+        api_prepended = False
         for attempt in range(retries):
             try:
                 response = post_func(
@@ -1652,6 +1811,16 @@ class ServerAPI(
                     ),
                     **kwargs
                 )
+                # Auto-fix missing 'api/'
+                if response.status_code == 405 and not api_prepended:
+                    api_prepended = True
+                    if (
+                        not endpoint.startswith(self._base_url)
+                        and not endpoint.startswith("api/")
+                    ):
+                        url = self._endpoint_to_url(endpoint, use_rest=True)
+                        progress.set_destination_url(url)
+                        continue
                 break
 
             except (
@@ -1664,6 +1833,11 @@ class ServerAPI(
                 progress.reset_transferred()
 
         response.raise_for_status()
+        if api_prepended:
+            self.log.warning(
+                f"Auto-fixed endpoint '{endpoint}' -> 'api/{endpoint}'."
+                " Please fix the endpoint passed to the function."
+            )
         return response
 
     def upload_file_from_stream(
@@ -1672,6 +1846,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.
@@ -1687,6 +1864,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.
 
@@ -1694,19 +1873,22 @@ class ServerAPI(
             requests.Response: Response object
 
         """
-        url = self._endpoint_to_url(endpoint)
-
         # Create dummy object so the function does not have to check
         #   'progress' variable everywhere
         if progress is None:
             progress = TransferProgress()
 
-        progress.set_destination_url(url)
         progress.set_started()
 
         try:
             return self._upload_file(
-                url, stream, progress, request_type, **kwargs
+                endpoint,
+                stream,
+                progress,
+                request_type,
+                content_type=content_type,
+                filename=filename,
+                **kwargs
             )
 
         except Exception as exc:
@@ -1722,6 +1904,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.
@@ -1737,6 +1922,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.
 
@@ -1751,7 +1938,13 @@ class ServerAPI(
 
         with open(filepath, "rb") as stream:
             return self.upload_file_from_stream(
-                endpoint, stream, progress, request_type, **kwargs
+                endpoint,
+                stream,
+                progress,
+                request_type,
+                content_type=content_type,
+                filename=filename,
+                **kwargs
             )
 
     def upload_reviewable(
@@ -1792,34 +1985,21 @@ 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 = (
-            f"/projects/{project_name}"
+            f"api/projects/{project_name}"
             f"/versions/{version_id}/reviewables{query}"
         )
         return self.upload_file(
             endpoint,
             filepath,
             progress=progress,
+            content_type=content_type,
+            filename=filename,
             headers=headers,
             request_type=RequestTypes.post,
             **kwargs

{ayon_python_api-1.2.10 → ayon_python_api-1.2.12}/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.10 → ayon_python_api-1.2.12}/ayon_api/version.py

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

{ayon_python_api-1.2.10 → ayon_python_api-1.2.12}/ayon_python_api.egg-info/PKG-INFO

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

{ayon_python_api-1.2.10 → ayon_python_api-1.2.12}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ayon_python_api"
-version = "1.2.10"
+version = "1.2.12"
 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.12"
 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"