ayon-python-api 1.2.3__tar.gz → 1.2.5__tar.gz

{ayon_python_api-1.2.3 → ayon_python_api-1.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: ayon_python_api
-Version: 1.2.3
+Version: 1.2.5
 Summary: AYON Python API
 Home-page: https://github.com/ynput/ayon-python-api
 Author: ynput.io
@@ -215,6 +215,11 @@ Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: requests>=2.27.1
+Requires-Dist: Unidecode>=1.3.0
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
 
 # AYON server API
 Python client for connection server. The client is using REST and GraphQl to communicate with server with `requests` module.

{ayon_python_api-1.2.3 → ayon_python_api-1.2.5}/ayon_api/__init__.py

@@ -54,6 +54,7 @@ from ._api import (
     get_info,
     get_server_version,
     get_server_version_tuple,
+    is_product_base_type_supported,
     get_users,
     get_user_by_name,
     get_user,
@@ -152,6 +153,7 @@ from ._api import (
     get_build_in_anatomy_preset,
     get_rest_project,
     get_rest_projects,
+    get_rest_projects_list,
     get_project_names,
     get_projects,
     get_project,
@@ -271,7 +273,9 @@ from ._api import (
     get_version_thumbnail,
     get_workfile_thumbnail,
     create_thumbnail,
+    create_thumbnail_with_stream,
     update_thumbnail,
+    update_thumbnail_from_stream,
 )
 
 
@@ -329,6 +333,7 @@ __all__ = (
     "get_info",
     "get_server_version",
     "get_server_version_tuple",
+    "is_product_base_type_supported",
     "get_users",
     "get_user_by_name",
     "get_user",
@@ -427,6 +432,7 @@ __all__ = (
     "get_build_in_anatomy_preset",
     "get_rest_project",
     "get_rest_projects",
+    "get_rest_projects_list",
     "get_project_names",
     "get_projects",
     "get_project",
@@ -546,5 +552,7 @@ __all__ = (
     "get_version_thumbnail",
     "get_workfile_thumbnail",
     "create_thumbnail",
+    "create_thumbnail_with_stream",
     "update_thumbnail",
+    "update_thumbnail_from_stream",
 )

{ayon_python_api-1.2.3 → ayon_python_api-1.2.5}/ayon_api/_api.py

@@ -64,6 +64,7 @@ if typing.TYPE_CHECKING:
         BundlesInfoDict,
         AnatomyPresetDict,
         SecretDict,
+        ProjectListDict,
         AnyEntityDict,
         ProjectDict,
         FolderDict,
@@ -720,6 +721,13 @@ def get_server_version_tuple() -> ServerVersion:
     return con.get_server_version_tuple()
 
 
+def is_product_base_type_supported() -> bool:
+    """Product base types are available on server.
+    """
+    con = get_server_api_connection()
+    return con.is_product_base_type_supported()
+
+
 def get_users(
     project_name: Optional[str] = None,
     usernames: Optional[Iterable[str]] = None,
@@ -3573,6 +3581,31 @@ def get_rest_projects(
     )
 
 
+def get_rest_projects_list(
+    active: Optional[bool] = True,
+    library: Optional[bool] = None,
+) -> list[ProjectListDict]:
+    """Receive available projects.
+
+    User must be logged in.
+
+    Args:
+        active (Optional[bool]): Filter active/inactive projects. Both
+            are returned if 'None' is passed.
+        library (Optional[bool]): Filter standard/library projects. Both
+            are returned if 'None' is passed.
+
+    Returns:
+        list[ProjectListDict]: List of available projects.
+
+    """
+    con = get_server_api_connection()
+    return con.get_rest_projects_list(
+        active=active,
+        library=library,
+    )
+
+
 def get_project_names(
     active: Optional[bool] = True,
     library: Optional[bool] = None,
@@ -4874,6 +4907,7 @@ def get_products(
     product_names: Optional[Iterable[str]] = None,
     folder_ids: Optional[Iterable[str]] = None,
     product_types: Optional[Iterable[str]] = None,
+    product_base_types: Optional[Iterable[str]] = None,
     product_name_regex: Optional[str] = None,
     product_path_regex: Optional[str] = None,
     names_by_folder_ids: Optional[dict[str, Iterable[str]]] = None,
@@ -4926,6 +4960,7 @@ def get_products(
         product_names=product_names,
         folder_ids=folder_ids,
         product_types=product_types,
+        product_base_types=product_base_types,
         product_name_regex=product_name_regex,
         product_path_regex=product_path_regex,
         names_by_folder_ids=names_by_folder_ids,
@@ -5084,6 +5119,7 @@ def create_product(
     tags: Optional[Iterable[str]] = None,
     status: Optional[str] = None,
     active: Optional[bool] = None,
+    product_base_type: Optional[str] = None,
     product_id: Optional[str] = None,
 ) -> str:
     """Create new product.
@@ -5098,6 +5134,7 @@ def create_product(
         tags (Optional[Iterable[str]]): Product tags.
         status (Optional[str]): Product status.
         active (Optional[bool]): Product active state.
+        product_base_type (Optional[str]): Product base type.
         product_id (Optional[str]): Product id. If not passed new id is
             generated.
 
@@ -5116,6 +5153,7 @@ def create_product(
         tags=tags,
         status=status,
         active=active,
+        product_base_type=product_base_type,
         product_id=product_id,
     )
 
@@ -5126,6 +5164,7 @@ def update_product(
     name: Optional[str] = None,
     folder_id: Optional[str] = None,
     product_type: Optional[str] = None,
+    product_base_type: Optional[str] = None,
     attrib: Optional[dict[str, Any]] = None,
     data: Optional[dict[str, Any]] = None,
     tags: Optional[Iterable[str]] = None,
@@ -5145,6 +5184,7 @@ def update_product(
         name (Optional[str]): New product name.
         folder_id (Optional[str]): New product id.
         product_type (Optional[str]): New product type.
+        product_base_type (Optional[str]): New product base type.
         attrib (Optional[dict[str, Any]]): New product attributes.
         data (Optional[dict[str, Any]]): New product data.
         tags (Optional[Iterable[str]]): New product tags.
@@ -5159,6 +5199,7 @@ def update_product(
         name=name,
         folder_id=folder_id,
         product_type=product_type,
+        product_base_type=product_base_type,
         attrib=attrib,
         data=data,
         tags=tags,
@@ -7726,6 +7767,34 @@ def create_thumbnail(
     )
 
 
+def create_thumbnail_with_stream(
+    project_name: str,
+    stream: StreamType,
+    thumbnail_id: Optional[str] = None,
+) -> str:
+    """Create new thumbnail on server from byte stream.
+
+    Args:
+        project_name (str): Project where the thumbnail will be created
+            and can be used.
+        stream (StreamType): Thumbnail content stream.
+        thumbnail_id (Optional[str]): Prepared if of thumbnail.
+
+    Returns:
+        str: Created thumbnail id.
+
+    Raises:
+        ValueError: When a thumbnail source cannot be processed.
+
+    """
+    con = get_server_api_connection()
+    return con.create_thumbnail_with_stream(
+        project_name=project_name,
+        stream=stream,
+        thumbnail_id=thumbnail_id,
+    )
+
+
 def update_thumbnail(
     project_name: str,
     thumbnail_id: str,
@@ -7751,3 +7820,27 @@ def update_thumbnail(
         thumbnail_id=thumbnail_id,
         src_filepath=src_filepath,
     )
+
+
+def update_thumbnail_from_stream(
+    project_name: str,
+    thumbnail_id: str,
+    stream: StreamType,
+) -> None:
+    """Change thumbnail content by id.
+
+    Update can be also used to create new thumbnail.
+
+    Args:
+        project_name (str): Project where the thumbnail will be created
+            and can be used.
+        thumbnail_id (str): Thumbnail id to update.
+        stream (StreamType): Thumbnail content stream.
+
+    """
+    con = get_server_api_connection()
+    return con.update_thumbnail_from_stream(
+        project_name=project_name,
+        thumbnail_id=thumbnail_id,
+        stream=stream,
+    )

{ayon_python_api-1.2.3 → ayon_python_api-1.2.5}/ayon_api/_api_helpers/base.py

@@ -13,6 +13,8 @@ if typing.TYPE_CHECKING:
         AnyEntityDict,
         ServerVersion,
         ProjectDict,
+        StreamType,
+        AttributeScope,
     )
 
 _PLACEHOLDER = object()
@@ -23,6 +25,9 @@ class BaseServerAPI:
     def log(self) -> logging.Logger:
         raise NotImplementedError()
 
+    def is_product_base_type_supported(self) -> bool:
+        raise NotImplementedError()
+
     def get_server_version(self) -> str:
         raise NotImplementedError()
 
@@ -84,6 +89,16 @@ class BaseServerAPI:
     ) -> requests.Response:
         raise NotImplementedError()
 
+    def upload_file_from_stream(
+        self,
+        endpoint: str,
+        stream: StreamType,
+        progress: Optional[TransferProgress] = None,
+        request_type: Optional[RequestType] = None,
+        **kwargs
+    ) -> requests.Response:
+        raise NotImplementedError()
+
     def download_file(
         self,
         endpoint: str,
@@ -114,6 +129,11 @@ class BaseServerAPI:
     ) -> Optional[dict[str, Any]]:
         raise NotImplementedError()
 
+    def get_attributes_fields_for_type(
+        self, entity_type: AttributeScope
+    ) -> set[str]:
+        raise NotImplementedError()
+
     def _prepare_fields(
         self,
         entity_type: str,

{ayon_python_api-1.2.3 → ayon_python_api-1.2.5}/ayon_api/_api_helpers/products.py

@@ -5,6 +5,7 @@ import warnings
 import typing
 from typing import Optional, Iterable, Generator, Any
 
+from ayon_api.exceptions import UnsupportedServerVersion
 from ayon_api.utils import (
     prepare_list_filters,
     create_entity_id,
@@ -32,9 +33,10 @@ class ProductsAPI(BaseServerAPI):
         self,
         project_name: str,
         product_ids: Optional[Iterable[str]] = None,
-        product_names: Optional[Iterable[str]]=None,
-        folder_ids: Optional[Iterable[str]]=None,
-        product_types: Optional[Iterable[str]]=None,
+        product_names: Optional[Iterable[str]] = None,
+        folder_ids: Optional[Iterable[str]] = None,
+        product_types: Optional[Iterable[str]] = None,
+        product_base_types: Optional[Iterable[str]] = None,
         product_name_regex: Optional[str] = None,
         product_path_regex: Optional[str] = None,
         names_by_folder_ids: Optional[dict[str, Iterable[str]]] = None,
@@ -59,6 +61,8 @@ class ProductsAPI(BaseServerAPI):
                 Use 'None' if folder is direct child of project.
             product_types (Optional[Iterable[str]]): Product types used for
                 filtering.
+            product_base_types (Optional[Iterable[str]]): Product base types
+                used for filtering.
             product_name_regex (Optional[str]): Filter products by name regex.
             product_path_regex (Optional[str]): Filter products by path regex.
                 Path starts with folder path and ends with product name.
@@ -83,6 +87,11 @@ class ProductsAPI(BaseServerAPI):
         if not project_name:
             return
 
+        if product_base_types and not self.is_product_base_type_supported():
+            raise UnsupportedServerVersion(
+                "Product base type is not supported for your server version."
+            )
+
         # Prepare these filters before 'name_by_filter_ids' filter
         filter_product_names = None
         if product_names is not None:
@@ -150,6 +159,7 @@ class ProductsAPI(BaseServerAPI):
             filters,
             ("productIds", product_ids),
             ("productTypes", product_types),
+            ("productBaseTypes", product_base_types),
             ("productStatuses", statuses),
             ("productTags", tags),
         ):
@@ -378,6 +388,7 @@ class ProductsAPI(BaseServerAPI):
         tags: Optional[Iterable[str]] =None,
         status: Optional[str] = None,
         active: Optional[bool] = None,
+        product_base_type: Optional[str] = None,
         product_id: Optional[str] = None,
     ) -> str:
         """Create new product.
@@ -392,6 +403,7 @@ class ProductsAPI(BaseServerAPI):
             tags (Optional[Iterable[str]]): Product tags.
             status (Optional[str]): Product status.
             active (Optional[bool]): Product active state.
+            product_base_type (Optional[str]): Product base type.
             product_id (Optional[str]): Product id. If not passed new id is
                 generated.
 
@@ -399,6 +411,14 @@ class ProductsAPI(BaseServerAPI):
             str: Product id.
 
         """
+        if (
+            product_base_type is not None
+            and not self.is_product_base_type_supported()
+        ):
+            raise UnsupportedServerVersion(
+                "Product base type is not supported for your server version."
+            )
+
         if not product_id:
             product_id = create_entity_id()
         create_data = {
@@ -408,6 +428,7 @@ class ProductsAPI(BaseServerAPI):
             "folderId": folder_id,
         }
         for key, value in (
+            ("productBaseType", product_base_type),
             ("attrib", attrib),
             ("data", data),
             ("tags", tags),
@@ -431,6 +452,7 @@ class ProductsAPI(BaseServerAPI):
         name: Optional[str] = None,
         folder_id: Optional[str] = None,
         product_type: Optional[str] = None,
+        product_base_type: Optional[str] = None,
         attrib: Optional[dict[str, Any]] = None,
         data: Optional[dict[str, Any]] = None,
         tags: Optional[Iterable[str]] = None,
@@ -450,6 +472,7 @@ class ProductsAPI(BaseServerAPI):
             name (Optional[str]): New product name.
             folder_id (Optional[str]): New product id.
             product_type (Optional[str]): New product type.
+            product_base_type (Optional[str]): New product base type.
             attrib (Optional[dict[str, Any]]): New product attributes.
             data (Optional[dict[str, Any]]): New product data.
             tags (Optional[Iterable[str]]): New product tags.
@@ -457,10 +480,19 @@ class ProductsAPI(BaseServerAPI):
             active (Optional[bool]): New product active state.
 
         """
+        if (
+            product_base_type is not None
+            and not self.is_product_base_type_supported()
+        ):
+            raise UnsupportedServerVersion(
+                "Product base type is not supported for your server version."
+            )
+
         update_data = {}
         for key, value in (
             ("name", name),
             ("productType", product_type),
+            ("productBaseType", product_base_type),
             ("folderId", folder_id),
             ("attrib", attrib),
             ("data", data),