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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: benchling-sdk
-Version: 1.10.0a5
+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.232)
+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.0a5 → 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.0a5 → benchling_sdk-1.10.0a7}/benchling_sdk/apps/config/decryption_provider.py

@@ -11,9 +11,6 @@ class BaseDecryptionProvider(ABC):
     Various implementations might use AWS KMS, Azure, etc.
     """
 
-    # TODO BNCH-52772 should we loosen this method to accept None and not attempt decryption,
-    # now that config is no longer type safe?
-
     @abstractmethod
     def decrypt(self, ciphertext: str) -> str:
         """

{benchling_sdk-1.10.0a5 → benchling_sdk-1.10.0a7}/benchling_sdk/apps/config/framework.py

@@ -77,7 +77,8 @@ class BenchlingConfigProvider(ConfigProvider):
 
         # Eager load all config items for now since we don't yet have a way of lazily querying by path
         all_config_pages = list(app_pages)
-        # Punt on UnknownType for now as apps using manifests with new types + older client could lead to unpredictable results
+        # Punt on UnknownType for now as apps using manifests with new types +
+        # older client could lead to unpredictable results
         all_config_items = [
             _supported_config_item(config_item) for page in all_config_pages for config_item in page
         ]
@@ -220,13 +221,13 @@ class ConfigItemStore:
     """
     Dependency Link Store.
 
-    Marshals an app configuration from the configuration provider into an indexable structure.
+    Marshals an app configuration from the configuration provider into an indexed structure.
     Only retrieves app configuration once unless its cache is invalidated.
     """
 
     _configuration_provider: ConfigProvider
     _configuration: Optional[List[ConfigurationReference]] = None
-    _configuration_map: Optional[Dict[ConfigItemPath, ConfigItemWrapper]] = None
+    _configuration_dict: Optional[Dict[ConfigItemPath, ConfigItemWrapper]] = None
     _array_path_row_names: Dict[Tuple[str, ...], OrderedSet[str]] = dict()
 
     def __init__(self, configuration_provider: ConfigProvider):
@@ -252,17 +253,17 @@ class ConfigItemStore:
         return self._configuration
 
     @property
-    def configuration_path_map(self) -> Dict[ConfigItemPath, ConfigItemWrapper]:
+    def configuration_path_dict(self) -> Dict[ConfigItemPath, ConfigItemWrapper]:
         """
         Config links.
 
-        Return a map of configuration item paths to their corresponding configuration items.
+        Return a dict of configuration item paths to their corresponding configuration items.
         """
-        if not self._configuration_map:
-            self._configuration_map = {
+        if not self._configuration_dict:
+            self._configuration_dict = {
                 tuple(item.path): ConfigItemWrapper(item, item.path) for item in self.configuration
             }
-        return self._configuration_map
+        return self._configuration_dict
 
     def config_by_path(self, path: List[str]) -> ConfigItemWrapper:
         """
@@ -272,7 +273,7 @@ class ConfigItemStore:
         """
         # Since we eager load all config now, we know that missing path means it's not configured in Benchling
         # Later if we support lazy loading, we'll need to differentiate what's in our cache versus missing
-        return self.configuration_path_map.get(tuple(path), ConfigItemWrapper(None, path))
+        return self.configuration_path_dict.get(tuple(path), ConfigItemWrapper(None, path))
 
     def config_keys_by_path(self, path: List[str]) -> OrderedSet[str]:
         """
@@ -296,7 +297,7 @@ class ConfigItemStore:
             self._array_path_row_names[path_tuple] = OrderedSet(
                 [
                     config_item.path[len(path)]
-                    # Use the list instead of configuration_map to preserve order
+                    # Use the list instead of configuration_dict to preserve order
                     for config_item in self.configuration
                     # The +1 is the name of the array row
                     if len(config_item.path) >= len(path) + 1
@@ -330,7 +331,7 @@ class ConfigItemStore:
         Will force retrieval of configuration from the ConfigProvider the next time the link store is accessed.
         """
         self._configuration = None
-        self._configuration_map = None
+        self._configuration_dict = None
         self._array_path_row_names = dict()
 
 

benchling_sdk-1.10.0a5/benchling_sdk/apps/helpers/config_helpers.py → benchling_sdk-1.10.0a7/benchling_sdk/apps/config/helpers.py

@@ -1,7 +1,6 @@
-from datetime import date, datetime
+from datetime import datetime
 from typing import List, Optional, Union
 
-from benchling_api_client.v2.beta.models.app_config_field_type import AppConfigFieldType
 from benchling_api_client.v2.beta.models.base_manifest_config import BaseManifestConfig
 from benchling_api_client.v2.beta.models.dropdown_dependency import DropdownDependency
 from benchling_api_client.v2.beta.models.dropdown_dependency_types import DropdownDependencyTypes
@@ -29,92 +28,7 @@ from benchling_api_client.v2.beta.models.workflow_task_schema_dependency_type im
 from benchling_api_client.v2.extensions import UnknownType
 from benchling_api_client.v2.stable.extensions import NotPresentError
 
-from benchling_sdk.apps.config.scalars import JsonType
-from benchling_sdk.models import (
-    AaSequence,
-    AssayResult,
-    AssayRun,
-    Box,
-    Container,
-    CustomEntity,
-    DnaOligo,
-    DnaSequence,
-    Entry,
-    Location,
-    Mixture,
-    Molecule,
-    Plate,
-    Request,
-    RnaOligo,
-    RnaSequence,
-    WorkflowTask,
-)
-
-_MODEL_TYPES_FROM_SCHEMA_TYPE = {
-    SchemaDependencyTypes.CONTAINER_SCHEMA: Container,
-    SchemaDependencyTypes.PLATE_SCHEMA: Plate,
-    SchemaDependencyTypes.BOX_SCHEMA: Box,
-    SchemaDependencyTypes.LOCATION_SCHEMA: Location,
-    SchemaDependencyTypes.ENTRY_SCHEMA: Entry,
-    SchemaDependencyTypes.REQUEST_SCHEMA: Request,
-    SchemaDependencyTypes.RESULT_SCHEMA: AssayResult,
-    SchemaDependencyTypes.RUN_SCHEMA: AssayRun,
-    SchemaDependencyTypes.WORKFLOW_TASK_SCHEMA: WorkflowTask,
-}
-
-
-_SCALAR_TYPES_FROM_CONFIG = {
-    ScalarConfigTypes.BOOLEAN: bool,
-    ScalarConfigTypes.DATE: date,
-    ScalarConfigTypes.DATETIME: datetime,
-    ScalarConfigTypes.FLOAT: float,
-    ScalarConfigTypes.INTEGER: int,
-    ScalarConfigTypes.JSON: JsonType,
-    ScalarConfigTypes.TEXT: str,
-}
-
-
-_FIELD_SCALAR_TYPES_FROM_CONFIG = {
-    AppConfigFieldType.BOOLEAN: bool,
-    AppConfigFieldType.DATE: date,
-    AppConfigFieldType.DATETIME: datetime,
-    AppConfigFieldType.FLOAT: float,
-    AppConfigFieldType.INTEGER: int,
-    AppConfigFieldType.JSON: JsonType,
-    AppConfigFieldType.TEXT: str,
-}
-
-
-ModelType = Union[AssayResult, AssayRun, Box, Container, Entry, Location, Plate, Request]
-
-_INSTANCE_FROM_SCHEMA_SUBTYPE = {
-    SchemaDependencySubtypes.AA_SEQUENCE: AaSequence,
-    SchemaDependencySubtypes.CUSTOM_ENTITY: CustomEntity,
-    SchemaDependencySubtypes.DNA_SEQUENCE: DnaSequence,
-    SchemaDependencySubtypes.DNA_OLIGO: DnaOligo,
-    SchemaDependencySubtypes.MIXTURE: Mixture,
-    SchemaDependencySubtypes.MOLECULE: Molecule,
-    SchemaDependencySubtypes.RNA_OLIGO: RnaOligo,
-    SchemaDependencySubtypes.RNA_SEQUENCE: RnaSequence,
-}
-
-EntitySubtype = Union[
-    AaSequence, CustomEntity, DnaOligo, DnaSequence, Mixture, Molecule, RnaOligo, RnaSequence
-]
-
-AnyDependency = Union[
-    BaseManifestConfig,
-    DropdownDependency,
-    EntitySchemaDependency,
-    FieldDefinitionsManifest,
-    ManifestArrayConfig,
-    ManifestScalarConfig,
-    ResourceDependency,
-    SchemaDependency,
-    WorkflowTaskSchemaDependency,
-]
-
-ArrayElementDependency = Union[
+_ArrayElementDependency = Union[
     SchemaDependency,
     EntitySchemaDependency,
     WorkflowTaskSchemaDependency,
@@ -124,13 +38,13 @@ ArrayElementDependency = Union[
 ]
 
 
-class UnsupportedSubTypeError(Exception):
+class _UnsupportedSubTypeError(Exception):
     """Error when an unsupported subtype is encountered."""
 
     pass
 
 
-def field_definitions_from_dependency(
+def _field_definitions_from_dependency(
     dependency: Union[
         EntitySchemaDependency,
         SchemaDependency,
@@ -148,7 +62,7 @@ def field_definitions_from_dependency(
     return []
 
 
-def element_definition_from_dependency(dependency: ManifestArrayConfig) -> List[ArrayElementDependency]:
+def _element_definition_from_dependency(dependency: ManifestArrayConfig) -> List[_ArrayElementDependency]:
     """Safely return an element definition as a list of dependencies from an array dependency or empty list."""
     try:
         if hasattr(dependency, "element_definition"):
@@ -161,7 +75,7 @@ def element_definition_from_dependency(dependency: ManifestArrayConfig) -> List[
     return []
 
 
-def enum_from_dependency(
+def _enum_from_dependency(
     dependency: Union[
         ManifestFloatScalarConfig,
         ManifestIntegerScalarConfig,
@@ -180,8 +94,8 @@ def enum_from_dependency(
 
 # TODO BNCH-57036 All element definitions currently deserialize to UnknownType. Hack around this temporarily
 def _fix_element_definition_deserialization(
-    element: Union[UnknownType, ArrayElementDependency]
-) -> ArrayElementDependency:
+    element: Union[UnknownType, _ArrayElementDependency]
+) -> _ArrayElementDependency:
     if isinstance(element, UnknownType):
         if "type" in element.value:
             element_type = element.value["type"]
@@ -201,7 +115,7 @@ def _fix_element_definition_deserialization(
     return element
 
 
-def workflow_task_schema_output_from_dependency(
+def _workflow_task_schema_output_from_dependency(
     dependency: WorkflowTaskSchemaDependency,
 ) -> Optional[WorkflowTaskSchemaDependencyOutput]:
     """Safely return a workflow task schema output from a workflow task schema or None."""
@@ -214,7 +128,7 @@ def workflow_task_schema_output_from_dependency(
     return None
 
 
-def options_from_dependency(dependency: DropdownDependency) -> List[BaseManifestConfig]:
+def _options_from_dependency(dependency: DropdownDependency) -> List[BaseManifestConfig]:
     """Safely return a list of options from a dropdown dependency or empty list."""
     try:
         if hasattr(dependency, "options"):
@@ -225,7 +139,7 @@ def options_from_dependency(dependency: DropdownDependency) -> List[BaseManifest
     return []
 
 
-def subtype_from_entity_schema_dependency(
+def _subtype_from_entity_schema_dependency(
     dependency: EntitySchemaDependency,
 ) -> Optional[SchemaDependencySubtypes]:
     """Safely return an entity schema dependency's subtype, if present."""
@@ -236,3 +150,8 @@ def subtype_from_entity_schema_dependency(
     except NotPresentError:
         pass
     return None
+
+
+def datetime_config_value_to_str(value: datetime) -> str:
+    """Convert a datetime value to a valid string accepted by a datetime app config item."""
+    return value.strftime("%Y-%m-%d %I:%M:%S %p")