benchling-sdk 1.10.0a1__tar.gz → 1.10.0a3__tar.gz

{benchling_sdk-1.10.0a1 → benchling_sdk-1.10.0a3}/PKG-INFO

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

benchling_sdk-1.10.0a3/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-1.10.0a1/benchling_sdk/apps/helpers/canvas_helpers.py → benchling_sdk-1.10.0a3/benchling_sdk/apps/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-1.10.0a3/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-1.10.0a1 → benchling_sdk-1.10.0a3}/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-1.10.0a1/benchling_sdk/apps → benchling_sdk-1.10.0a3/benchling_sdk/apps/config}/framework.py

@@ -1,23 +1,14 @@
-from __future__ import annotations
-
 import collections
-from typing import Dict, List, Optional, OrderedDict, Protocol, Tuple, TypeVar
+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 import helpers
 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.helpers.logging_helpers import log_stability_warning, StabilityLevel
 from benchling_sdk.models import AppConfigItem, ListAppConfigurationItemsSort
 
-log_stability_warning(StabilityLevel.ALPHA)
-
-
-AppType = TypeVar("AppType", bound="App")
-
 
 class ConfigProvider(Protocol):
     """
@@ -31,96 +22,6 @@ class ConfigProvider(Protocol):
         pass
 
 
-class ConfigItemStoreProvider(Protocol):
-    """Return a config item store."""
-
-    def __call__(self, app_id: str) -> ConfigItemStore:
-        """Return a config item store."""
-        pass
-
-
-class App:
-    """
-    App.
-
-    See https://docs.benchling.com/docs/getting-started-benchling-apps
-
-    Accepts providers as arguments to lazily initialize since some required attributes may not be
-    known until runtime. Also allows for easier mocking in tests.
-    """
-
-    _app_id: str
-    _benchling: Benchling
-    _config_store: ConfigItemStore
-
-    def __init__(
-        self, app_id: str, benchling: Benchling, config_store: Optional[ConfigItemStore] = None
-    ) -> None:
-        """
-        Initialize a Benchling App.
-
-        :param app_id: An id representing a tenanted app installation (e.g., "app_Uh3BZ55aYcXGFJVb")
-        :param benchling: A Benchling object for making API calls. The auth_method should be valid for the specified App.
-            Commonly this is ClientCredentialsOAuth2 using the app's client ID and client secret.
-        :param config_store: The configuration item store for accessing an App's tenanted app config items.
-            If unspecified, will default to retrieving app config from the tenant referenced by Benchling.
-            Apps that don't use app configuration can safely ignore this.
-        """
-        self._app_id = app_id
-        self._benchling = benchling
-        self._config_store = (
-            config_store if config_store else ConfigItemStore(BenchlingConfigProvider(benchling, app_id))
-        )
-
-    @property
-    def id(self) -> str:
-        """Return the app tenanted installation id."""
-        return self._app_id
-
-    @property
-    def benchling(self) -> Benchling:
-        """Return a Benchling instance for the App."""
-        return self._benchling
-
-    @property
-    def config_store(self) -> ConfigItemStore:
-        """Return a ConfigItemStore instance for the App."""
-        return self._config_store
-
-    def create_session_context(
-        self: AppType,
-        name: str,
-        timeout_seconds: int,
-        context_enter_handler: Optional[helpers.session_helpers.SessionContextEnterHandler[AppType]] = None,
-        context_exit_handler: Optional[helpers.session_helpers.SessionContextExitHandler[AppType]] = None,
-    ) -> helpers.session_helpers.SessionContextManager[AppType]:
-        """
-        Create Session Context.
-
-        Create a new app session in Benchling.
-        """
-        # Avoid circular import + MyPy "is not defined" if using relative like above
-        from benchling_sdk.apps.helpers.session_helpers import new_session_context
-
-        return new_session_context(self, name, timeout_seconds, context_enter_handler, context_exit_handler)
-
-    def continue_session_context(
-        self: AppType,
-        session_id: str,
-        context_enter_handler: Optional[helpers.session_helpers.SessionContextEnterHandler[AppType]] = None,
-        context_exit_handler: Optional[helpers.session_helpers.SessionContextExitHandler[AppType]] = None,
-    ) -> helpers.session_helpers.SessionContextManager[AppType]:
-        """
-        Continue Session Context.
-
-        Fetch an existing app session from Benchling and enter a context with it.
-        """
-        # Avoid circular import + MyPy "is not defined" if using relative like above
-        from benchling_sdk.apps.helpers.session_helpers import continue_session_context
-
-        return continue_session_context(self, session_id, context_enter_handler, context_exit_handler)
-
-
 class BenchlingConfigProvider(ConfigProvider):
     """
     Benchling Config provider.
@@ -135,8 +36,7 @@ class BenchlingConfigProvider(ConfigProvider):
         """
         Initialize Benchling Config Provider.
 
-        :param benchling_provider: A provider for a Benchling instance.
-        :param tenant_url_provider: A provider for a tenant url.
+        :param benchling: A Benchling instance.
         :param app_id: The app_id from which to retrieve configuration.
         """
         self._app_id = app_id

{benchling_sdk-1.10.0a1 → benchling_sdk-1.10.0a3}/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,

benchling_sdk-1.10.0a3/benchling_sdk/apps/framework.py

@@ -0,0 +1,92 @@
+from __future__ import annotations
+
+from typing import Optional
+
+from benchling_sdk.apps.config.framework import BenchlingConfigProvider, ConfigItemStore
+from benchling_sdk.apps.status.framework import (
+    continue_session_context,
+    new_session_context,
+    SessionContextEnterHandler,
+    SessionContextExitHandler,
+    SessionContextManager,
+)
+from benchling_sdk.benchling import Benchling
+from benchling_sdk.helpers.logging_helpers import log_stability_warning, StabilityLevel
+
+log_stability_warning(StabilityLevel.ALPHA)
+
+
+class App:
+    """
+    App.
+
+    See https://docs.benchling.com/docs/getting-started-benchling-apps
+
+    Accepts providers as arguments to lazily initialize since some required attributes may not be
+    known until runtime. Also allows for easier mocking in tests.
+    """
+
+    _app_id: str
+    _benchling: Benchling
+    _config_store: ConfigItemStore
+
+    def __init__(
+        self, app_id: str, benchling: Benchling, config_store: Optional[ConfigItemStore] = None
+    ) -> None:
+        """
+        Initialize a Benchling App.
+
+        :param app_id: An id representing a tenanted app installation (e.g., "app_Uh3BZ55aYcXGFJVb")
+        :param benchling: A Benchling object for making API calls. The auth_method should be valid for the specified App.
+            Commonly this is ClientCredentialsOAuth2 using the app's client ID and client secret.
+        :param config_store: The configuration item store for accessing an App's tenanted app config items.
+            If unspecified, will default to retrieving app config from the tenant referenced by Benchling.
+            Apps that don't use app configuration can safely ignore this.
+        """
+        self._app_id = app_id
+        self._benchling = benchling
+        self._config_store = (
+            config_store if config_store else ConfigItemStore(BenchlingConfigProvider(benchling, app_id))
+        )
+
+    @property
+    def id(self) -> str:
+        """Return the app tenanted installation id."""
+        return self._app_id
+
+    @property
+    def benchling(self) -> Benchling:
+        """Return a Benchling instance for the App."""
+        return self._benchling
+
+    @property
+    def config_store(self) -> ConfigItemStore:
+        """Return a ConfigItemStore instance for the App."""
+        return self._config_store
+
+    def create_session_context(
+        self,
+        name: str,
+        timeout_seconds: int,
+        context_enter_handler: Optional[SessionContextEnterHandler] = None,
+        context_exit_handler: Optional[SessionContextExitHandler] = None,
+    ) -> SessionContextManager:
+        """
+        Create Session Context.
+
+        Create a new app session in Benchling.
+        """
+        return new_session_context(self, name, timeout_seconds, context_enter_handler, context_exit_handler)
+
+    def continue_session_context(
+        self,
+        session_id: str,
+        context_enter_handler: Optional[SessionContextEnterHandler] = None,
+        context_exit_handler: Optional[SessionContextExitHandler] = None,
+    ) -> SessionContextManager:
+        """
+        Continue Session Context.
+
+        Fetch an existing app session from Benchling and enter a context with it.
+        """
+        return continue_session_context(self, session_id, context_enter_handler, context_exit_handler)

benchling_sdk-1.10.0a3/benchling_sdk/apps/status/errors.py

@@ -0,0 +1,82 @@
+from typing import List, Union
+
+from benchling_sdk.models import AppSessionMessageCreate, AppSessionMessageStyle
+
+
+class SessionClosedError(Exception):
+    """
+    Session Closed Error.
+
+    A session was inoperable because its status in Benchling was terminal.
+    """
+
+    pass
+
+
+class SessionContextClosedError(Exception):
+    """
+    Session Context Closed Error.
+
+    An operation was attempted using the session context manager after it was closed.
+    """
+
+    pass
+
+
+class InvalidSessionTimeoutError(Exception):
+    """
+    Invalid Session Timeout Error.
+
+    A session's timeout value was set to an invalid value.
+    """
+
+    pass
+
+
+class MissingAttachedCanvasError(Exception):
+    """
+    Missing Attached Canvas Error.
+
+    A canvas operation was requested, but a session context has no attached canvas.
+    """
+
+    pass
+
+
+class AppUserFacingError(Exception):
+    """
+    App User Facing Error.
+
+    Extend this class with custom exceptions you want to be written back to the user as a SessionMessage.
+
+    SessionClosingContextExitHandler will invoke messages() and write them to a user. Callers choosing to
+    write their own SessionContextExitHandler may need to replicate this behavior themselves.
+
+    This is useful for control flow where an app wants to terminate with an error state that is resolvable
+    by the user.
+
+    For example:
+
+    class InvalidUserInputError(AppUserFacingError):
+        pass
+
+    raise InvalidUserInputError("Please enter a number between 1 and 10")
+
+    This would create a message shown to the user like:
+
+    AppSessionMessageCreate("Please enter a number between 1 and 10", style=AppSessionMessageStyle.ERROR)
+    """
+
+    _messages: List[str]
+
+    def __init__(self, messages: Union[str, List[str]], *args) -> None:
+        """Initialize an AppUserFacingError with one message or a list."""
+        self._messages = [messages] if isinstance(messages, str) else messages
+        super().__init__(args)
+
+    def messages(self) -> List[AppSessionMessageCreate]:
+        """Create a series of AppSessionMessageCreate to write to a Session and displayed to the user."""
+        return [
+            AppSessionMessageCreate(content=message, style=AppSessionMessageStyle.ERROR)
+            for message in self._messages
+        ]