benchling-sdk 1.19.0__tar.gz → 1.20__tar.gz

{benchling_sdk-1.19.0 → benchling_sdk-1.20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: benchling-sdk
-Version: 1.19.0
+Version: 1.20
 Summary: SDK for interacting with the Benchling Platform.
 License: Apache-2.0
 Author: Benchling Support

{benchling_sdk-1.19.0 → benchling_sdk-1.20}/benchling_sdk/apps/canvas/errors.py

@@ -12,3 +12,9 @@ class NoMatchingBlocksError(Exception):
     """
 
     pass
+
+
+class MissingResourceIdError(Exception):
+    """Error indicating that a resource ID was expected to be present for the operation."""
+
+    pass

{benchling_sdk-1.19.0 → benchling_sdk-1.20}/benchling_sdk/apps/canvas/framework.py

@@ -4,8 +4,13 @@ import json
 from typing import cast, Dict, Generic, List, Optional, Protocol, Set, Type, TypeVar, Union
 
 from benchling_api_client.v2.extensions import UnknownType
+from benchling_api_client.v2.stable.types import UNSET, Unset
 
-from benchling_sdk.apps.canvas.errors import DuplicateBlockIdError, NoMatchingBlocksError
+from benchling_sdk.apps.canvas.errors import (
+    DuplicateBlockIdError,
+    MissingResourceIdError,
+    NoMatchingBlocksError,
+)
 from benchling_sdk.apps.canvas.types import (
     _UI_BLOCK_MAPPINGS_CREATE,
     _UI_BLOCK_MAPPINGS_UPDATE,
@@ -359,12 +364,13 @@ class CanvasBuilder:
     """
 
     _source_canvas: AppCanvas
+    _resource_id: str | Unset
 
     def __init__(
         self,
         app_id: str,
         feature_id: str,
-        resource_id: str,
+        resource_id: Optional[str] = None,
         enabled: bool = True,
         session_id: Optional[str] = None,
         blocks: Optional[List[UiBlock]] = None,
@@ -378,12 +384,17 @@ class CanvasBuilder:
         self._source_canvas = AppCanvas(
             app=AppCanvasApp(id=app_id),
             feature_id=feature_id,
-            resource_id=resource_id,
             enabled=enabled,
             session_id=session_id,
             blocks=blocks if blocks else [],
             data=json.dumps(data) if data is not None else None,
         )
+        self._resource_id = resource_id if resource_id is not None else UNSET
+
+    @property
+    def resource_id(self):
+        """Returns the underlying resource_id of this CanvasBuilder."""
+        return self._resource_id if self._resource_id is not UNSET else None
 
     @classmethod
     def from_canvas(cls, canvas: AppCanvas) -> CanvasBuilder:
@@ -407,7 +418,7 @@ class CanvasBuilder:
         return CanvasBuilder(
             app_id=self._source_canvas.app.id,
             feature_id=self._source_canvas.feature_id,
-            resource_id=self._source_canvas.resource_id,
+            resource_id=self.resource_id,
             enabled=value,
             session_id=self._source_canvas.session_id,
             blocks=self._source_canvas.blocks,
@@ -432,7 +443,7 @@ class CanvasBuilder:
         return CanvasBuilder(
             app_id=self._source_canvas.app.id,
             feature_id=self._source_canvas.feature_id,
-            resource_id=self._source_canvas.resource_id,
+            resource_id=self.resource_id,
             enabled=self._source_canvas.enabled,
             session_id=self._source_canvas.session_id,
             blocks=new_blocks,
@@ -448,7 +459,7 @@ class CanvasBuilder:
         return CanvasBuilder(
             app_id=self._source_canvas.app.id,
             feature_id=self._source_canvas.feature_id,
-            resource_id=self._source_canvas.resource_id,
+            resource_id=self.resource_id,
             enabled=self._source_canvas.enabled,
             session_id=self._source_canvas.session_id,
             blocks=self._source_canvas.blocks,
@@ -464,7 +475,7 @@ class CanvasBuilder:
         return CanvasBuilder(
             app_id=self._source_canvas.app.id,
             feature_id=self._source_canvas.feature_id,
-            resource_id=self._source_canvas.resource_id,
+            resource_id=self.resource_id,
             enabled=self._source_canvas.enabled,
             session_id=session_id,
             blocks=self._source_canvas.blocks,
@@ -594,7 +605,7 @@ class CanvasBuilder:
         """Return an AppCanvasUpdate API model from the current state of the canvas managed by CanvasBuilder."""
         return AppCanvasUpdate(
             feature_id=self._source_canvas.feature_id,
-            resource_id=self._source_canvas.resource_id,
+            resource_id=self._resource_id,
             enabled=self._source_canvas.enabled,
             session_id=self._source_canvas.session_id,
             blocks=[_ui_block_to_update(block) for block in self._source_canvas.blocks],
@@ -602,11 +613,20 @@ class CanvasBuilder:
         )
 
     def to_create(self) -> AppCanvasCreate:
-        """Return an AppCanvasCreate API model from the current state of the canvas managed by CanvasBuilder."""
+        """
+        Return an AppCanvasCreate API model from the current state of the canvas managed by CanvasBuilder.
+
+        Raise MissingResourceIdError if the current state of the canvas managed by CanvasBuilder does not include
+        a resource ID. Without a resource ID indicating the Benchling object on which to place the new canvas,
+        canvas creation is underspecified and cannot be completed successfully.
+        """
+        if self.resource_id is None:
+            raise MissingResourceIdError
+
         return AppCanvasCreate(
             app_id=self._source_canvas.app.id,
             feature_id=self._source_canvas.feature_id,
-            resource_id=self._source_canvas.resource_id,
+            resource_id=self.resource_id,
             enabled=self._source_canvas.enabled,
             session_id=self._source_canvas.session_id,
             blocks=[_ui_block_to_create(block) for block in self._source_canvas.blocks],

{benchling_sdk-1.19.0 → benchling_sdk-1.20}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "benchling-sdk"
-version = "1.19.0"   # NOTE: This version number is ignored and does not correspond to releases (see README)
+version = "1.20"   # NOTE: This version number is ignored and does not correspond to releases (see README)
 description = "SDK for interacting with the Benchling Platform."
 authors = ["Benchling Support <support@benchling.com>"]
 packages = [{include = "benchling_sdk"}]