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

benchling_sdk/apps/canvas/framework.py

@@ -411,7 +411,7 @@ class CanvasBuilder:
             enabled=value,
             session_id=self._source_canvas.session_id,
             blocks=self._source_canvas.blocks,
-            data=self._source_canvas.data,
+            data=self.data_to_json(),
         )
 
     def with_enabled(self, enabled: bool = True) -> CanvasBuilder:
@@ -436,7 +436,7 @@ class CanvasBuilder:
             enabled=self._source_canvas.enabled,
             session_id=self._source_canvas.session_id,
             blocks=new_blocks,
-            data=self._source_canvas.data,
+            data=self.data_to_json(),
         )
 
     def with_data(self, new_data: Optional[JsonType]) -> CanvasBuilder:
@@ -468,7 +468,7 @@ class CanvasBuilder:
             enabled=self._source_canvas.enabled,
             session_id=session_id,
             blocks=self._source_canvas.blocks,
-            data=self._source_canvas.data,
+            data=self.data_to_json(),
         )
 
     def inputs_to_dict(self) -> Dict[str, Union[str, List[str]]]:

benchling_sdk/apps/status/framework.py

@@ -53,7 +53,7 @@ class SessionContextErrorProcessor(ABC):
     process_error() does not assume a context's session is active. If using the session with process_error(),
     this should be checked.
 
-    For user with SessionClosingContextExitHandler or its subclasses.
+    For use with SessionClosingContextExitHandler or its subclasses.
     """
 
     @classmethod
@@ -269,6 +269,7 @@ class SessionClosingContextExitHandler(SessionContextExitHandler):
 
     On error: close the Session with Benchling with SessionStatusUpdate.FAILED.
     If error_messages were specified, those will also be written to the Session when setting the status.
+    If the session has a Canvas attached and enable_attached_canvas_on_error is True, re-enable the AppCanvas.
 
     As a best practice, error messages are not written to the session to avoid leaking
     potentially sensitive information.
@@ -277,6 +278,7 @@ class SessionClosingContextExitHandler(SessionContextExitHandler):
     _success_messages: Optional[Iterable[AppSessionMessageCreate]]
     _error_messages: Optional[Iterable[AppSessionMessageCreate]]
     _error_processors: List[Type[SessionContextErrorProcessor]]
+    _enable_attached_canvas_on_error: bool
 
     def __init__(
         self,
@@ -288,6 +290,7 @@ class SessionClosingContextExitHandler(SessionContextExitHandler):
             AppUserFacingErrorProcessor,
             BenchlingBadRequestErrorProcessor,
         ],
+        enable_attached_canvas_on_error: bool = True,
     ):
         """
         Init Session Closing Context Exit Handler.
@@ -298,6 +301,7 @@ class SessionClosingContextExitHandler(SessionContextExitHandler):
         self._success_messages = success_messages
         self._error_messages = error_messages
         self._error_processors = error_processors
+        self._enable_attached_canvas_on_error = enable_attached_canvas_on_error
 
     def on_success(self, context: SessionContextManager) -> bool:
         """
@@ -354,7 +358,9 @@ class SessionClosingContextExitHandler(SessionContextExitHandler):
             # Pluggable specific error handling
             if optional_error_processor:
                 sdk_logger.debug("Exiting session context with error, matched handler for %s", str(exc_type))
-                return optional_error_processor.process_error(context, exc_type, exc_value, exc_traceback)
+                result = optional_error_processor.process_error(context, exc_type, exc_value, exc_traceback)
+                self._check_and_enable_canvas(context)
+                return result
             # Fallback to general error handling
             sdk_logger.debug(
                 "Exiting session context with error, automatically closing session ID %s as %s",
@@ -368,10 +374,17 @@ class SessionClosingContextExitHandler(SessionContextExitHandler):
                 context.close_session(AppSessionUpdateStatus.FAILED, messages=message_creates)
             else:
                 context.close_session(AppSessionUpdateStatus.FAILED)
+            self._check_and_enable_canvas(context)
         else:
             sdk_logger.debug("Exiting session context, no active session present")
         return False
 
+    def _check_and_enable_canvas(self, context: SessionContextManager) -> None:
+        canvas_id = context.attached_canvas_id()
+        if self._enable_attached_canvas_on_error and canvas_id:
+            context.app.benchling.apps.update_canvas(canvas_id, AppCanvasUpdate(enabled=True))
+            sdk_logger.debug("Re-enabled canvas with ID %s", context.attached_canvas_id())
+
     def _error_processor_type(
         self,
         exc_type: Type[BaseException],
@@ -598,6 +611,14 @@ class SessionContextManager(AbstractContextManager):
         """
         return self._session is not None
 
+    def attached_canvas_id(self) -> Optional[str]:
+        """
+        Attached Canvas Id.
+
+        Returns a canvas_id associated with the active session, if one has been attached via `attach_canvas`.
+        """
+        return self._attached_canvas_id
+
     def attach_canvas(self, canvas_id: str) -> None:
         """
         Attach Canvas.

{benchling_sdk-1.10.0a7.dist-info → benchling_sdk-1.10.0a9.dist-info}/METADATA

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

{benchling_sdk-1.10.0a7.dist-info → benchling_sdk-1.10.0a9.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=a6XbCZIUsz4VmOCtu6kZnBQoQiLJtBk2Ndw94J0s4kM,24381
+benchling_sdk/apps/canvas/framework.py,sha256=CeOmiEg_ufWOwDLgSiMXlhCNXuHhRQzBnuoxhF-oAZ8,24366
 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
@@ -19,7 +19,7 @@ benchling_sdk/apps/helpers/manifest_helpers.py,sha256=yidiKA5mwWdAFR1ZSUu40QoG0U
 benchling_sdk/apps/helpers/webhook_helpers.py,sha256=T-ZJLWb37nzSKMQFAQQ8FJU7al_QFBgNRhTfWDfCfYU,7077
 benchling_sdk/apps/status/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 benchling_sdk/apps/status/errors.py,sha256=E9PugMd0YwZQWweTztIZyqycECBuVvH6PcLfij0Cb3k,2279
-benchling_sdk/apps/status/framework.py,sha256=CWPIlj8WhRZeIImCLka9LmhXvzbK0be9ekdLxiUKKJk,26358
+benchling_sdk/apps/status/framework.py,sha256=go0pyU5qgMCvsrTDXWk3V9FZwbaRHgfhEWtjIZ-JLEE,27418
 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
@@ -115,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.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,,
+benchling_sdk-1.10.0a9.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+benchling_sdk-1.10.0a9.dist-info/METADATA,sha256=sXGs66Z5BBG6tO9A0HCSgc9saaXB7omsobqmehDm76s,2126
+benchling_sdk-1.10.0a9.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
+benchling_sdk-1.10.0a9.dist-info/RECORD,,