benchling-sdk 1.10.0a6__tar.gz → 1.10.0a7__tar.gz

{benchling_sdk-1.10.0a6 → benchling_sdk-1.10.0a7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: benchling-sdk
-Version: 1.10.0a6
+Version: 1.10.0a7
 Summary: SDK for interacting with the Benchling Platform.
 License: Apache-2.0
 Author: Benchling Support
@@ -17,7 +17,7 @@ Provides-Extra: python-jose
 Requires-Dist: PyYAML (>=6.0,<7.0)
 Requires-Dist: attrs (>=20.1.0,<23)
 Requires-Dist: backoff (>=1.10.0,<2.0.0)
-Requires-Dist: benchling-api-client (==2.0.241)
+Requires-Dist: benchling-api-client (==2.0.243)
 Requires-Dist: certifi (>=2022.12.7)
 Requires-Dist: cryptography (>=41.0.3,<42.0.0) ; extra == "cryptography"
 Requires-Dist: dataclasses-json (>=0.5.2,<0.6.0)

{benchling_sdk-1.10.0a6 → benchling_sdk-1.10.0a7}/benchling_sdk/apps/canvas/framework.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import json
 from typing import cast, Dict, Generic, List, Optional, Protocol, Set, Type, TypeVar, Union
 
 from benchling_api_client.v2.extensions import UnknownType
@@ -13,6 +14,7 @@ from benchling_sdk.apps.canvas.types import (
     UiBlock,
     UiBlockType,
 )
+from benchling_sdk.apps.types import JsonType
 from benchling_sdk.models import (
     AppCanvas,
     AppCanvasApp,
@@ -366,6 +368,7 @@ class CanvasBuilder:
         enabled: bool = True,
         session_id: Optional[str] = None,
         blocks: Optional[List[UiBlock]] = None,
+        data: Optional[JsonType] = None,
     ):
         """
         Init AppCanvas.
@@ -379,6 +382,7 @@ class CanvasBuilder:
             enabled=enabled,
             session_id=session_id,
             blocks=blocks if blocks else [],
+            data=json.dumps(data) if data is not None else None,
         )
 
     @classmethod
@@ -395,6 +399,7 @@ class CanvasBuilder:
             enabled=canvas.enabled,
             session_id=canvas.session_id,
             blocks=canvas.blocks,
+            data=json.loads(canvas.data) if canvas.data is not None else None,
         )
 
     def _with_enabled(self, value: bool) -> CanvasBuilder:
@@ -406,6 +411,7 @@ class CanvasBuilder:
             enabled=value,
             session_id=self._source_canvas.session_id,
             blocks=self._source_canvas.blocks,
+            data=self._source_canvas.data,
         )
 
     def with_enabled(self, enabled: bool = True) -> CanvasBuilder:
@@ -430,6 +436,23 @@ class CanvasBuilder:
             enabled=self._source_canvas.enabled,
             session_id=self._source_canvas.session_id,
             blocks=new_blocks,
+            data=self._source_canvas.data,
+        )
+
+    def with_data(self, new_data: Optional[JsonType]) -> CanvasBuilder:
+        """
+        Return a new CanvasBuilder with the underlying data replaced.
+
+        This does not call the API, it only assigns state in the CanvasBuilder.
+        """
+        return CanvasBuilder(
+            app_id=self._source_canvas.app.id,
+            feature_id=self._source_canvas.feature_id,
+            resource_id=self._source_canvas.resource_id,
+            enabled=self._source_canvas.enabled,
+            session_id=self._source_canvas.session_id,
+            blocks=self._source_canvas.blocks,
+            data=new_data,
         )
 
     def with_session_id(self, session_id: Optional[str]) -> CanvasBuilder:
@@ -445,6 +468,7 @@ class CanvasBuilder:
             enabled=self._source_canvas.enabled,
             session_id=session_id,
             blocks=self._source_canvas.blocks,
+            data=self._source_canvas.data,
         )
 
     def inputs_to_dict(self) -> Dict[str, Union[str, List[str]]]:
@@ -574,6 +598,7 @@ class CanvasBuilder:
             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],
+            data=self._source_canvas.data,
         )
 
     def to_create(self) -> AppCanvasCreate:
@@ -585,6 +610,7 @@ class CanvasBuilder:
             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],
+            data=self._source_canvas.data,
         )
 
     @property
@@ -597,6 +623,14 @@ class CanvasBuilder:
         """
         return CanvasBuilderBlockStream.from_builder(self)
 
+    def data_to_json(self) -> Optional[JsonType]:
+        """
+        Convert Canvas data to JSON.
+
+        Return a JSON object parsed from the string of the canvas's `data`, if present. Otherwise, return None.
+        """
+        return json.loads(self._source_canvas.data) if self._source_canvas.data is not None else None
+
 
 def _is_included_class(included_classes: Set[Type[UiBlock]], target_class: UiBlock) -> bool:
     return isinstance(target_class, tuple(c for c in included_classes))

{benchling_sdk-1.10.0a6 → benchling_sdk-1.10.0a7}/benchling_sdk/apps/config/mock_config.py

@@ -45,7 +45,8 @@ from benchling_sdk.apps.config.helpers import (
     _workflow_task_schema_output_from_dependency,
     datetime_config_value_to_str,
 )
-from benchling_sdk.apps.config.types import ConfigurationReference, JsonType
+from benchling_sdk.apps.config.types import ConfigurationReference
+from benchling_sdk.apps.types import JsonType
 from benchling_sdk.helpers.logging_helpers import log_stability_warning, StabilityLevel
 from benchling_sdk.models import (
     AppConfigItem,

{benchling_sdk-1.10.0a6 → benchling_sdk-1.10.0a7}/benchling_sdk/apps/config/types.py

@@ -1,5 +1,5 @@
 # Tuple instead of list so it's hashable and preserves order
-from typing import Any, Dict, List, Tuple, Union
+from typing import Tuple, Union
 
 from benchling_sdk.models import (
     ArrayElementAppConfigItem,
@@ -34,5 +34,3 @@ ConfigurationReference = Union[
     SecureTextAppConfigItem,
     TextAppConfigItem,
 ]
-
-JsonType = Union[Dict[str, Any], List[Any], str, int, float, bool]

benchling_sdk-1.10.0a7/benchling_sdk/apps/types.py

@@ -0,0 +1,3 @@
+from typing import Any, Dict, List, Union
+
+JsonType = Union[Dict[str, Any], List[Any], str, int, float, bool]

{benchling_sdk-1.10.0a6 → benchling_sdk-1.10.0a7}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "benchling-sdk"
-version = "1.10.0a6"   # NOTE: This version number is ignored and does not correspond to releases (see README)
+version = "1.10.0a7"   # 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"}]
@@ -28,7 +28,7 @@ PyYAML = "^6.0"
 # See issue: https://github.com/giampaolo/psutil/issues/2165
 psutil = {version = "^5.9.4", python = "^3.11" }
 jwcrypto = "^1.4.2"
-benchling-api-client = "2.0.241"
+benchling-api-client = "2.0.243"
 # Minimum version due to vulnerability in 2022.9.24
 certifi = ">=2022.12.7"
 # Cryptography extras - see ExtrasPackage.CRYPTOGRAPHY