benchling-sdk 1.10.0a6__py3-none-any.whl → 1.10.0a7__py3-none-any.whl

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/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/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/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.dist-info → benchling_sdk-1.10.0a7.dist-info}/METADATA

@@ -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.dist-info → benchling_sdk-1.10.0a7.dist-info}/RECORD

@@ -3,7 +3,7 @@ benchling_sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 benchling_sdk/apps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 benchling_sdk/apps/canvas/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 benchling_sdk/apps/canvas/errors.py,sha256=5YTZOhSV-O0WqURjB1a676BIO429drCKfz5aQjsezms,358
-benchling_sdk/apps/canvas/framework.py,sha256=99Ox8V-CvPjxWNyJQ0eaJmP-O8wABVBumjmfw7UMH5U,22971
+benchling_sdk/apps/canvas/framework.py,sha256=a6XbCZIUsz4VmOCtu6kZnBQoQiLJtBk2Ndw94J0s4kM,24381
 benchling_sdk/apps/canvas/types.py,sha256=tmuU0kpzd1pXqxs3X6x5kjWpCZJrJMb6hnfN1CbtFG4,3613
 benchling_sdk/apps/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 benchling_sdk/apps/config/cryptography_helpers.py,sha256=VCzgQURLAitYjcjdwFzMPSKZ7MOD6ghxFdbPGA_6RbY,1778
@@ -11,8 +11,8 @@ benchling_sdk/apps/config/decryption_provider.py,sha256=-HgjkBto8mYlooV0LXFenfai
 benchling_sdk/apps/config/errors.py,sha256=-qkfLdcUTuuRD-V4L2l7nzQWnWTRuifDtkNDv8tfHoo,800
 benchling_sdk/apps/config/framework.py,sha256=a2cIkPugEVUfBNtHm2cbE3Qu326xb-SpMuM0Gi6U-3Q,13337
 benchling_sdk/apps/config/helpers.py,sha256=LTLDR0GCDoo_8Sx4kepQnMmgVEQT7MHfKAxIoAvV9TM,7077
-benchling_sdk/apps/config/mock_config.py,sha256=kMSKL5P5upxGW4O0R7CY9F3FvWjE5fH6bymmpuQ4k98,26931
-benchling_sdk/apps/config/types.py,sha256=loVMi9RshnP3dGmdTRm6ckkI3Hm-ZeMx0fAZdAMFJ9E,1038
+benchling_sdk/apps/config/mock_config.py,sha256=EPUCxWiUSsWxWilnHAJIq-_f1q6ckZkXoIFv1S25hnM,26967
+benchling_sdk/apps/config/types.py,sha256=XKfSGv-75CU-j1XwfXBGq8zbtnkF-PQnuY6Z2U47-Tg,953
 benchling_sdk/apps/framework.py,sha256=H51rAzwH4PQHMGTxx2MdYgHMW1oKa_FLnozzY8XGL2g,3308
 benchling_sdk/apps/helpers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 benchling_sdk/apps/helpers/manifest_helpers.py,sha256=yidiKA5mwWdAFR1ZSUu40QoG0Us-bc6V8tYHYqheEtM,945
@@ -22,6 +22,7 @@ benchling_sdk/apps/status/errors.py,sha256=E9PugMd0YwZQWweTztIZyqycECBuVvH6PcLfi
 benchling_sdk/apps/status/framework.py,sha256=CWPIlj8WhRZeIImCLka9LmhXvzbK0be9ekdLxiUKKJk,26358
 benchling_sdk/apps/status/helpers.py,sha256=o8jdgdxUYdGh2j0Gb3AYoeXI9Bu-ubyIkgWBuCGLKgE,705
 benchling_sdk/apps/status/types.py,sha256=vE7-_7ns3mvPRJoVv-GQxc3389dIIH4mcG0VDNWpVhQ,746
+benchling_sdk/apps/types.py,sha256=TBTfAB3IOoZjZqzTOK25kN3b6RTU9Z7tOMdBbq6u8lA,110
 benchling_sdk/auth/__init__.py,sha256=N4pJYVUnTLzg5HO9ZldHaI-Am97i6AOCdQS0M5QcVpA,120
 benchling_sdk/auth/api_key_auth.py,sha256=Ui-cnvGMjcwVPV_b2GdBaoTjEyHJIu9CjtZScVBEUvU,641
 benchling_sdk/auth/bearer_token_auth.py,sha256=nymI8V91evcnK-TWKkBXZwck8U1qSh4WaseyQbvF-Cg,1268
@@ -114,7 +115,7 @@ benchling_sdk/services/v2/v2_alpha_service.py,sha256=vNfYK0Dheml9ozR_0tzTlA3blPD
 benchling_sdk/services/v2/v2_beta_service.py,sha256=7v9ngWH_XTinkVC7bIxxbaA1UeFQqkzR4ANGtQQN-fA,11521
 benchling_sdk/services/v2/v2_stable_service.py,sha256=YIc-_0p6x1NQqj7awnWgCTHxbxYO7ZOolePZyW90whc,35246
 benchling_sdk/services/v2_service.py,sha256=3eoIjYEmGLPdWCpBN0pl7q7_HNWCsUvfvTn3Hcz0wSM,2860
-benchling_sdk-1.10.0a6.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-benchling_sdk-1.10.0a6.dist-info/METADATA,sha256=qh_k4Rt0UQn_8-6_wadg9SPAsbr04LhJP4jlWhaTMYQ,2126
-benchling_sdk-1.10.0a6.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-benchling_sdk-1.10.0a6.dist-info/RECORD,,
+benchling_sdk-1.10.0a7.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+benchling_sdk-1.10.0a7.dist-info/METADATA,sha256=GKfUuppZ9cw6GIv2w-jZQ_I4B5sm1I-2jXS2h_ccb4Q,2126
+benchling_sdk-1.10.0a7.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
+benchling_sdk-1.10.0a7.dist-info/RECORD,,