benchling-sdk 1.10.0a2__py3-none-any.whl → 1.10.0a3__py3-none-any.whl

benchling_sdk/apps/canvas/errors.py

@@ -0,0 +1,14 @@
+class DuplicateBlockIdError(Exception):
+    """Error indicating that duplicate ids were present on blocks within a Canvas."""
+
+    pass
+
+
+class NoMatchingBlocksError(Exception):
+    """
+    Error indicating that blocks were expected, but none matched.
+
+    Used to prevent requiring developers to handle Optional[_UiBlock] for type safety.
+    """
+
+    pass

benchling_sdk/apps/{helpers/canvas_helpers.py → canvas/framework.py}

@@ -4,137 +4,36 @@ from typing import cast, Dict, Generic, List, Optional, Protocol, Set, Type, Typ
 
 from benchling_api_client.v2.extensions import UnknownType
 
+from benchling_sdk.apps.canvas.errors import DuplicateBlockIdError, NoMatchingBlocksError
+from benchling_sdk.apps.canvas.types import (
+    _UI_BLOCK_MAPPINGS_CREATE,
+    _UI_BLOCK_MAPPINGS_UPDATE,
+    _UiBlock,
+    _UiBlockCreate,
+    _UiBlockType,
+    _UiBlockUpdate,
+)
 from benchling_sdk.helpers.logging_helpers import log_stability_warning, StabilityLevel
 from benchling_sdk.models import (
     AppCanvas,
     AppCanvasApp,
     AppCanvasCreate,
     AppCanvasUpdate,
-    ButtonUiBlock,
-    ButtonUiBlockCreate,
-    ButtonUiBlockUpdate,
-    ChipUiBlock,
-    ChipUiBlockCreate,
-    ChipUiBlockUpdate,
     DropdownMultiValueUiBlock,
-    DropdownMultiValueUiBlockCreate,
-    DropdownMultiValueUiBlockUpdate,
     DropdownUiBlock,
-    DropdownUiBlockCreate,
-    DropdownUiBlockUpdate,
-    MarkdownUiBlock,
-    MarkdownUiBlockCreate,
-    MarkdownUiBlockUpdate,
     SearchInputMultiValueUiBlock,
-    SearchInputMultiValueUiBlockCreate,
-    SearchInputMultiValueUiBlockUpdate,
     SearchInputUiBlock,
-    SearchInputUiBlockCreate,
-    SearchInputUiBlockUpdate,
     SectionUiBlock,
-    SectionUiBlockCreate,
-    SectionUiBlockUpdate,
     SelectorInputMultiValueUiBlock,
-    SelectorInputMultiValueUiBlockCreate,
-    SelectorInputMultiValueUiBlockUpdate,
     SelectorInputUiBlock,
-    SelectorInputUiBlockCreate,
-    SelectorInputUiBlockUpdate,
     TableUiBlock,
-    TableUiBlockCreate,
-    TableUiBlockUpdate,
     TextInputUiBlock,
-    TextInputUiBlockCreate,
-    TextInputUiBlockUpdate,
 )
 
 log_stability_warning(StabilityLevel.BETA)
 
 S = TypeVar("S", bound="_FilteredCanvasBuilderBlockStream")
 
-_UiBlock = Union[
-    ButtonUiBlock,
-    ChipUiBlock,
-    DropdownMultiValueUiBlock,
-    DropdownUiBlock,
-    MarkdownUiBlock,
-    SearchInputMultiValueUiBlock,
-    SearchInputUiBlock,
-    SectionUiBlock,
-    SelectorInputMultiValueUiBlock,
-    SelectorInputUiBlock,
-    TableUiBlock,
-    TextInputUiBlock,
-    UnknownType,
-]
-
-_UiBlockType = TypeVar(
-    "_UiBlockType",
-    bound=_UiBlock,
-)
-
-_UiBlockCreate = Union[
-    ButtonUiBlockCreate,
-    ChipUiBlockCreate,
-    DropdownMultiValueUiBlockCreate,
-    DropdownUiBlockCreate,
-    MarkdownUiBlockCreate,
-    SearchInputMultiValueUiBlockCreate,
-    SearchInputUiBlockCreate,
-    SectionUiBlockCreate,
-    SelectorInputMultiValueUiBlockCreate,
-    SelectorInputUiBlockCreate,
-    TableUiBlockCreate,
-    TextInputUiBlockCreate,
-    UnknownType,
-]
-
-_UiBlockUpdate = Union[
-    ButtonUiBlockUpdate,
-    ChipUiBlockUpdate,
-    DropdownMultiValueUiBlockUpdate,
-    DropdownUiBlockUpdate,
-    MarkdownUiBlockUpdate,
-    SearchInputMultiValueUiBlockUpdate,
-    SearchInputUiBlockUpdate,
-    SectionUiBlockUpdate,
-    SelectorInputMultiValueUiBlockUpdate,
-    SelectorInputUiBlockUpdate,
-    TableUiBlockUpdate,
-    TextInputUiBlockUpdate,
-    UnknownType,
-]
-
-_UI_BLOCK_MAPPINGS_CREATE = {
-    ButtonUiBlock: ButtonUiBlockCreate,
-    ChipUiBlock: ChipUiBlockCreate,
-    DropdownMultiValueUiBlock: DropdownMultiValueUiBlockCreate,
-    DropdownUiBlock: DropdownUiBlockCreate,
-    MarkdownUiBlock: MarkdownUiBlockCreate,
-    SearchInputMultiValueUiBlock: SearchInputMultiValueUiBlockCreate,
-    SearchInputUiBlock: SearchInputUiBlockCreate,
-    SectionUiBlock: SectionUiBlockCreate,
-    SelectorInputMultiValueUiBlock: SelectorInputMultiValueUiBlockCreate,
-    SelectorInputUiBlock: SelectorInputUiBlockCreate,
-    TableUiBlock: TableUiBlockCreate,
-    TextInputUiBlock: TextInputUiBlockCreate,
-}
-
-_UI_BLOCK_MAPPINGS_UPDATE = {
-    ButtonUiBlock: ButtonUiBlockUpdate,
-    ChipUiBlock: ChipUiBlockUpdate,
-    DropdownMultiValueUiBlock: DropdownMultiValueUiBlockUpdate,
-    DropdownUiBlock: DropdownUiBlockUpdate,
-    MarkdownUiBlock: MarkdownUiBlockUpdate,
-    SearchInputMultiValueUiBlock: SearchInputMultiValueUiBlockUpdate,
-    SearchInputUiBlock: SearchInputUiBlockUpdate,
-    SectionUiBlock: SectionUiBlockUpdate,
-    SelectorInputMultiValueUiBlock: SelectorInputMultiValueUiBlockUpdate,
-    SelectorInputUiBlock: SelectorInputUiBlockUpdate,
-    TableUiBlock: TableUiBlockUpdate,
-    TextInputUiBlock: TextInputUiBlockUpdate,
-}
-
 
 def _ui_block_to_create(block: _UiBlock) -> _UiBlockCreate:
     # Rely on the fact that the read/write shapes are compatible, for now
@@ -166,22 +65,6 @@ def _ui_block_to_update(block: _UiBlock) -> _UiBlockUpdate:
     return block  # type: ignore
 
 
-class DuplicateBlockIdError(Exception):
-    """Error indicating that duplicate ids were present on blocks within a Canvas."""
-
-    pass
-
-
-class NoMatchingBlocksError(Exception):
-    """
-    Error indicating that blocks were expected, but none matched.
-
-    Used to prevent requiring developers to handle Optional[_UiBlock] for type safety.
-    """
-
-    pass
-
-
 class _CanvasBuilderUiBlock(Generic[_UiBlockType]):
     """Internal UI block wrapper for CanvasBuilder."""
 

benchling_sdk/apps/canvas/types.py

@@ -0,0 +1,125 @@
+from typing import TypeVar, Union
+
+from benchling_api_client.v2.extensions import UnknownType
+
+from benchling_sdk.models import (
+    ButtonUiBlock,
+    ButtonUiBlockCreate,
+    ButtonUiBlockUpdate,
+    ChipUiBlock,
+    ChipUiBlockCreate,
+    ChipUiBlockUpdate,
+    DropdownMultiValueUiBlock,
+    DropdownMultiValueUiBlockCreate,
+    DropdownMultiValueUiBlockUpdate,
+    DropdownUiBlock,
+    DropdownUiBlockCreate,
+    DropdownUiBlockUpdate,
+    MarkdownUiBlock,
+    MarkdownUiBlockCreate,
+    MarkdownUiBlockUpdate,
+    SearchInputMultiValueUiBlock,
+    SearchInputMultiValueUiBlockCreate,
+    SearchInputMultiValueUiBlockUpdate,
+    SearchInputUiBlock,
+    SearchInputUiBlockCreate,
+    SearchInputUiBlockUpdate,
+    SectionUiBlock,
+    SectionUiBlockCreate,
+    SectionUiBlockUpdate,
+    SelectorInputMultiValueUiBlock,
+    SelectorInputMultiValueUiBlockCreate,
+    SelectorInputMultiValueUiBlockUpdate,
+    SelectorInputUiBlock,
+    SelectorInputUiBlockCreate,
+    SelectorInputUiBlockUpdate,
+    TableUiBlock,
+    TableUiBlockCreate,
+    TableUiBlockUpdate,
+    TextInputUiBlock,
+    TextInputUiBlockCreate,
+    TextInputUiBlockUpdate,
+)
+
+_UiBlock = Union[
+    ButtonUiBlock,
+    ChipUiBlock,
+    DropdownMultiValueUiBlock,
+    DropdownUiBlock,
+    MarkdownUiBlock,
+    SearchInputMultiValueUiBlock,
+    SearchInputUiBlock,
+    SectionUiBlock,
+    SelectorInputMultiValueUiBlock,
+    SelectorInputUiBlock,
+    TableUiBlock,
+    TextInputUiBlock,
+    UnknownType,
+]
+
+_UiBlockType = TypeVar(
+    "_UiBlockType",
+    bound=_UiBlock,
+)
+
+_UiBlockCreate = Union[
+    ButtonUiBlockCreate,
+    ChipUiBlockCreate,
+    DropdownMultiValueUiBlockCreate,
+    DropdownUiBlockCreate,
+    MarkdownUiBlockCreate,
+    SearchInputMultiValueUiBlockCreate,
+    SearchInputUiBlockCreate,
+    SectionUiBlockCreate,
+    SelectorInputMultiValueUiBlockCreate,
+    SelectorInputUiBlockCreate,
+    TableUiBlockCreate,
+    TextInputUiBlockCreate,
+    UnknownType,
+]
+
+_UiBlockUpdate = Union[
+    ButtonUiBlockUpdate,
+    ChipUiBlockUpdate,
+    DropdownMultiValueUiBlockUpdate,
+    DropdownUiBlockUpdate,
+    MarkdownUiBlockUpdate,
+    SearchInputMultiValueUiBlockUpdate,
+    SearchInputUiBlockUpdate,
+    SectionUiBlockUpdate,
+    SelectorInputMultiValueUiBlockUpdate,
+    SelectorInputUiBlockUpdate,
+    TableUiBlockUpdate,
+    TextInputUiBlockUpdate,
+    UnknownType,
+]
+
+_UI_BLOCK_MAPPINGS_CREATE = {
+    ButtonUiBlock: ButtonUiBlockCreate,
+    ChipUiBlock: ChipUiBlockCreate,
+    DropdownMultiValueUiBlock: DropdownMultiValueUiBlockCreate,
+    DropdownUiBlock: DropdownUiBlockCreate,
+    MarkdownUiBlock: MarkdownUiBlockCreate,
+    SearchInputMultiValueUiBlock: SearchInputMultiValueUiBlockCreate,
+    SearchInputUiBlock: SearchInputUiBlockCreate,
+    SectionUiBlock: SectionUiBlockCreate,
+    SelectorInputMultiValueUiBlock: SelectorInputMultiValueUiBlockCreate,
+    SelectorInputUiBlock: SelectorInputUiBlockCreate,
+    TableUiBlock: TableUiBlockCreate,
+    TextInputUiBlock: TextInputUiBlockCreate,
+}
+
+_UI_BLOCK_MAPPINGS_UPDATE = {
+    ButtonUiBlock: ButtonUiBlockUpdate,
+    ChipUiBlock: ChipUiBlockUpdate,
+    DropdownMultiValueUiBlock: DropdownMultiValueUiBlockUpdate,
+    DropdownUiBlock: DropdownUiBlockUpdate,
+    MarkdownUiBlock: MarkdownUiBlockUpdate,
+    SearchInputMultiValueUiBlock: SearchInputMultiValueUiBlockUpdate,
+    SearchInputUiBlock: SearchInputUiBlockUpdate,
+    SectionUiBlock: SectionUiBlockUpdate,
+    SelectorInputMultiValueUiBlock: SelectorInputMultiValueUiBlockUpdate,
+    SelectorInputUiBlock: SelectorInputUiBlockUpdate,
+    TableUiBlock: TableUiBlockUpdate,
+    TextInputUiBlock: TextInputUiBlockUpdate,
+}

benchling_sdk/apps/config/decryption_provider.py

@@ -1,6 +1,6 @@
 from abc import ABC, abstractmethod
 
-from benchling_sdk.apps.helpers.cryptography_helpers import _create_key_type
+from benchling_sdk.apps.config.cryptography_helpers import _create_key_type
 from benchling_sdk.helpers.package_helpers import _required_packages_context, ExtrasPackage
 
 

benchling_sdk/apps/config/framework.py

@@ -0,0 +1,207 @@
+import collections
+from typing import Dict, List, Optional, OrderedDict, Protocol, Tuple
+
+from benchling_api_client.v2.extensions import UnknownType
+from ordered_set import OrderedSet
+
+from benchling_sdk.apps.config.errors import UnsupportedConfigItemError
+from benchling_sdk.apps.config.types import ConfigItemPath, ConfigurationReference
+from benchling_sdk.benchling import Benchling
+from benchling_sdk.models import AppConfigItem, ListAppConfigurationItemsSort
+
+
+class ConfigProvider(Protocol):
+    """
+    Config provider.
+
+    Provides a list of ConfigurationReference.
+    """
+
+    def config(self) -> List[ConfigurationReference]:
+        """Implement to provide a list of configuration items, for instance from Benchling APIs."""
+        pass
+
+
+class BenchlingConfigProvider(ConfigProvider):
+    """
+    Benchling Config provider.
+
+    Provides a BenchlingAppConfiguration retrieved from Benchling's API.
+    """
+
+    _app_id: str
+    _benchling: Benchling
+
+    def __init__(self, benchling: Benchling, app_id: str):
+        """
+        Initialize Benchling Config Provider.
+
+        :param benchling: A Benchling instance.
+        :param app_id: The app_id from which to retrieve configuration.
+        """
+        self._app_id = app_id
+        self._benchling = benchling
+
+    def config(self) -> List[ConfigurationReference]:
+        """Provide a Benchling app configuration from Benchling's APIs."""
+        app_pages = self._benchling.apps.list_app_configuration_items(
+            app_id=self._app_id,
+            page_size=100,
+            sort=ListAppConfigurationItemsSort.CREATEDATASC,
+        )
+
+        # 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
+        all_config_items = [
+            _supported_config_item(config_item) for page in all_config_pages for config_item in page
+        ]
+
+        return all_config_items
+
+
+class StaticConfigProvider(ConfigProvider):
+    """
+    Static Config provider.
+
+    Provides a BenchlingAppConfiguration from a static declaration. Useful for mocking or testing.
+    """
+
+    _configuration_items: List[ConfigurationReference]
+
+    def __init__(self, configuration_items: List[ConfigurationReference]):
+        """
+        Initialize Static Config Provider.
+
+        :param configuration_items: The configuration items to return.
+        """
+        self._configuration_items = configuration_items
+
+    def config(self) -> List[ConfigurationReference]:
+        """Provide Benchling app configuration items from a static reference."""
+        return self._configuration_items
+
+
+class ConfigItemStore:
+    """
+    Dependency Link Store.
+
+    Marshalls an app configuration from the configuration provider into an indexable structure.
+    Only retrieves app configuration once unless its cache is invalidated.
+    """
+
+    _configuration_provider: ConfigProvider
+    _configuration: Optional[List[ConfigurationReference]] = None
+    _configuration_map: Optional[Dict[ConfigItemPath, ConfigurationReference]] = None
+    _array_path_row_names: Dict[Tuple[str, ...], OrderedSet[str]] = dict()
+
+    def __init__(self, configuration_provider: ConfigProvider):
+        """
+        Initialize Dependency Link Store.
+
+        :param configuration_provider: A ConfigProvider that will be invoked to provide the
+        underlying config from which to organize dependency links.
+        """
+        self._configuration_provider = configuration_provider
+        self._array_path_row_names = dict()
+
+    @property
+    def configuration(self) -> List[ConfigurationReference]:
+        """
+        Get the underlying configuration.
+
+        Return the raw, stored configuration. Can be used if the provided accessors are inadequate
+        to find particular configuration items.
+        """
+        if not self._configuration:
+            self._configuration = self._configuration_provider.config()
+        return self._configuration
+
+    @property
+    def configuration_path_map(self) -> Dict[ConfigItemPath, ConfigurationReference]:
+        """
+        Config links.
+
+        Return a map of configuration item paths to their corresponding configuration items.
+        """
+        if not self._configuration_map:
+            self._configuration_map = {tuple(item.path): item for item in self.configuration}
+        return self._configuration_map
+
+    def config_by_path(self, path: List[str]) -> Optional[ConfigurationReference]:
+        """
+        Config by path.
+
+        Find an app config item by its exact path match, if it exists. Does not search partial paths.
+        """
+        # 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))
+
+    def config_keys_by_path(self, path: List[str]) -> OrderedSet[str]:
+        """
+        Config keys by path.
+
+        Find a set of app config keys at the specified path, if any. Does not return keys that are nested
+        beyond the current level.
+
+        For instance, given paths:
+        ["One", "Two"]
+        ["One", "Two", "Three"]
+        ["One", "Two", "Four"]
+        ["One", "Two", "Three", "Five"]
+        ["Zero", "One", "Two", "Three"]
+
+        The expected return from this method when path=["One", "Two"] is a set {"Three", "Four"}.
+        """
+        # Convert path to tuple, as list is not hashable for dict keys
+        path_tuple = tuple(path)
+        if path_tuple not in self._array_path_row_names:
+            self._array_path_row_names[path_tuple] = OrderedSet(
+                [
+                    config_item.path[len(path)]
+                    # Use the list instead of configuration_map 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
+                    # Ignoring flake8 error E203 because black keeps putting in whitespace padding :
+                    and config_item.path[0 : len(path_tuple)] == path  # noqa: E203
+                    and config_item.value is not None
+                ]
+            )
+        return self._array_path_row_names[path_tuple]
+
+    def array_rows_to_dict(self, path: List[str]) -> OrderedDict[str, Dict[str, ConfigurationReference]]:
+        """Given a path to the root of a config array, return each element as a named dict."""
+        # TODO BNCH-52772 Improve docstring if we keep this method
+        array_keys = self.config_keys_by_path(path)
+        # Although we don't have a way of preserving order when pulling array elements from the API right now
+        # we should intentionally order these to accommodate a potential ordered future
+        array_elements_map = collections.OrderedDict()
+        for key in array_keys:
+            # Don't care about order for the keys within a row, only the order of the rows themselves
+            array_elements_map[key] = {
+                array_element_key: self.config_by_path([*path, key, array_element_key])
+                for array_element_key in self.config_keys_by_path([*path, key])
+                if self.config_by_path([*path, key, array_element_key]) is not None
+            }
+        # TODO BNCH-52772 MyPy thinks the inner dict values can be None
+        return array_elements_map  # type: ignore
+
+    def invalidate_cache(self) -> None:
+        """
+        Invalidate Cache.
+
+        Will force retrieval of configuration from the ConfigProvider the next time the link store is accessed.
+        """
+        self._configuration = None
+        self._configuration_map = None
+        self._array_path_row_names = dict()
+
+
+def _supported_config_item(config_item: AppConfigItem) -> ConfigurationReference:
+    if isinstance(config_item, UnknownType):
+        raise UnsupportedConfigItemError(
+            f"Unable to read app configuration with unsupported type: {config_item}"
+        )
+    return config_item

benchling_sdk/apps/config/mock_config.py

@@ -34,6 +34,7 @@ from benchling_api_client.v2.extensions import UnknownType
 from benchling_api_client.v2.stable.types import UNSET, Unset
 
 from benchling_sdk.apps.config.decryption_provider import BaseDecryptionProvider
+from benchling_sdk.apps.config.framework import _supported_config_item, ConfigItemStore, StaticConfigProvider
 from benchling_sdk.apps.config.scalars import (
     BoolScalar,
     DateScalar,
@@ -48,7 +49,6 @@ from benchling_sdk.apps.config.scalars import (
     TextScalar,
 )
 from benchling_sdk.apps.config.types import ConfigurationReference
-from benchling_sdk.apps.framework import _supported_config_item, ConfigItemStore, StaticConfigProvider
 from benchling_sdk.apps.helpers.config_helpers import (
     element_definition_from_dependency,
     enum_from_dependency,