dara-core 1.16.12__py3-none-any.whl → 1.16.13__py3-none-any.whl

dara/core/persistence.py

@@ -1,7 +1,7 @@
 import abc
 import json
 import os
-from typing import TYPE_CHECKING, Any, Dict, Literal, Optional, Set
+from typing import TYPE_CHECKING, Any, Awaitable, Callable, Dict, Literal, Optional, Set
 from uuid import uuid4
 
 import aiorwlock
@@ -21,13 +21,12 @@ from dara.core.internal.websocket import WS_CHANNEL
 
 if TYPE_CHECKING:
     from dara.core.interactivity.plain_variable import Variable
+    from dara.core.internal.websocket import WebsocketManager
 
 
 class PersistenceBackend(BaseModel, abc.ABC):
     """
-    Abstract base class for a BackendStore backend
-
-    Warning: the API is not stable yet and may change in the future
+    Abstract base class for a BackendStore backend.
     """
 
     @abc.abstractmethod
@@ -60,6 +59,12 @@ class PersistenceBackend(BaseModel, abc.ABC):
         Get all the values as a dictionary of key-value pairs
         """
 
+    async def subscribe(self, on_value: Callable[[str, Any], Awaitable[None]]):
+        """
+        Subscribe to changes in the backend. Called with a callback that should be invoked whenever a value is updated.
+        """
+        # Default implementation does nothing, not all backends need to support this
+
 
 class InMemoryBackend(PersistenceBackend):
     """
@@ -173,17 +178,23 @@ class BackendStore(PersistenceStore):
     :param backend: the backend to use for storing data; defaults to an in-memory backend
     :param scope: the scope for the store; if 'global' a single value is stored for all users,
         if 'user' a value is stored per user
+    :param readonly: whether to use the backend in read-only mode, i.e. skip syncing values from client to backend and raise if write()/delete() is called
     """
 
     uid: str = Field(default_factory=lambda: str(uuid4()))
     backend: PersistenceBackend = Field(default_factory=InMemoryBackend, exclude=True)
     scope: Literal['global', 'user'] = 'global'
+    readonly: bool = False
 
     default_value: Any = Field(default=None, exclude=True)
     initialized_scopes: Set[str] = Field(default_factory=set, exclude=True)
 
     def __init__(
-        self, backend: Optional[PersistenceBackend] = None, uid: Optional[str] = None, scope: Optional[str] = None
+        self,
+        backend: Optional[PersistenceBackend] = None,
+        uid: Optional[str] = None,
+        scope: Optional[str] = None,
+        readonly: bool = False,
     ):
         """
         Persistence store implementation that uses a backend implementation to store data server-side
@@ -192,6 +203,7 @@ class BackendStore(PersistenceStore):
         :param backend: the backend to use for storing data; defaults to an in-memory backend
         :param scope: the scope for the store; if 'global' a single value is stored for all users,
             if 'user' a value is stored per user
+        :param readonly: whether to use the backend in read-only mode, i.e. skip syncing values from client to backend and raise if write()/delete() is called
         """
         kwargs: Dict[str, Any] = {}
         if backend:
@@ -203,6 +215,9 @@ class BackendStore(PersistenceStore):
         if scope:
             kwargs['scope'] = scope
 
+        if readonly:
+            kwargs['readonly'] = readonly
+
         super().__init__(**kwargs)
 
     async def _get_key(self):
@@ -235,6 +250,17 @@ class BackendStore(PersistenceStore):
 
         raise ValueError('User not found when trying to compute the key for a user-scoped store')
 
+    def _get_user(self, key: str) -> Optional[str]:
+        """
+        Get the user for a given key. Returns None if the key is global.
+        Reverts the `_get_key` method to get the user for a given key.
+        """
+        if key == 'global':
+            return None
+
+        # otherwise key is a user identity_id or identity_name
+        return key
+
     def _register(self):
         """
         Register this store in the backend store registry.
@@ -253,20 +279,50 @@ class BackendStore(PersistenceStore):
         except ValueError as e:
             raise ValueError('BackendStore uid must be unique') from e
 
-    async def _notify(self, value: Any):
+    @property
+    def ws_mgr(self) -> 'WebsocketManager':
+        from dara.core.internal.registries import utils_registry
+
+        return utils_registry.get('WebsocketManager')
+
+    def _create_msg(self, value: Any) -> Dict[str, Any]:
+        """
+        Create a message to send to the frontend.
+        :param value: value to send
         """
-        Notify all clients about the new value for this store
+        return {'store_uid': self.uid, 'value': value}
 
+    async def _notify_user(self, user_identifier: str, value: Any):
+        """
+        Notify a given user about the new value for this store.
+        :param user_identifier: user to notify
         :param value: value to notify about
         """
-        from dara.core.internal.registries import utils_registry
-        from dara.core.internal.websocket import WebsocketManager
+        return await self.ws_mgr.send_message_to_user(
+            user_identifier,
+            self._create_msg(value),
+            ignore_channel=WS_CHANNEL.get(),
+        )
 
-        ws_mgr: WebsocketManager = utils_registry.get('WebsocketManager')
-        msg = {'store_uid': self.uid, 'value': value}
+    async def _notify_global(self, value: Any):
+        """
+        Notify all users about the new value for this store.
+        :param value: value to notify about
+        """
+        return await self.ws_mgr.broadcast(
+            self._create_msg(value),
+            ignore_channel=WS_CHANNEL.get(),
+        )
+
+    async def _notify_value(self, value: Any):
+        """
+        Notify all clients about the new value for this store.
+        Broadcasts to all users if scope is global or sends to the current user if scope is user.
 
+        :param value: value to notify about
+        """
         if self.scope == 'global':
-            return await ws_mgr.broadcast(msg, ignore_channel=WS_CHANNEL.get())
+            return await self._notify_global(value)
 
         # For user scope, we need to find channels for the user and notify them
         user = USER.get()
@@ -275,7 +331,7 @@ class BackendStore(PersistenceStore):
             return
 
         user_identifier = user.identity_id or user.identity_name
-        return await ws_mgr.send_message_to_user(user_identifier, msg, ignore_channel=WS_CHANNEL.get())
+        return await self._notify_user(user_identifier, value)
 
     async def init(self, variable: 'Variable'):
         """
@@ -286,6 +342,13 @@ class BackendStore(PersistenceStore):
         self._register()
         self.default_value = variable.default
 
+        async def _on_value(key: str, value: Any):
+            if user := self._get_user(key):
+                return await self._notify_user(user, value)
+            return await self._notify_global(value)
+
+        await self.backend.subscribe(_on_value)
+
     async def write(self, value: Any, notify=True):
         """
         Persist a value to the store.
@@ -296,10 +359,13 @@ class BackendStore(PersistenceStore):
         :param value: value to write
         :param notify: whether to broadcast the new value to clients
         """
+        if self.readonly:
+            raise ValueError('Cannot write to a read-only store')
+
         key = await self._get_key()
 
         if notify:
-            await self._notify(value)
+            await self._notify_value(value)
 
         return await run_user_handler(self.backend.write, (key, value))
 
@@ -325,10 +391,13 @@ class BackendStore(PersistenceStore):
 
         :param notify: whether to broadcast that the value was deleted to clients
         """
+        if self.readonly:
+            raise ValueError('Cannot delete from a read-only store')
+
         key = await self._get_key()
         if notify:
             # Schedule notification on delete
-            await self._notify(None)
+            await self._notify_value(None)
         return await run_user_handler(self.backend.delete, (key,))
 
     async def get_all(self) -> Dict[str, Any]:

dara/core/umd/dara.core.umd.js

@@ -7527,6 +7527,7 @@ var __privateWrapper = (obj, member, setter, getter) => ({
     useRetain: Recoil_useRetain,
     retentionZone: retentionZone$1
   };
+  var Recoil_index_1 = Recoil_index.DefaultValue;
   var Recoil_index_5 = Recoil_index.RecoilRoot;
   var Recoil_index_8 = Recoil_index.atom;
   var Recoil_index_10 = Recoil_index.atomFamily;
@@ -57943,7 +57944,16 @@ You must set sticky: 'left' | 'right' for the '${bugWithUnderColumnsSticky.Heade
     return RecoilSync_index_2({
       itemKey: variable.store.uid,
       refine: Refine_index_6(),
-      storeKey: "BackendStore"
+      storeKey: "BackendStore",
+      write({ write: write2 }, newValue) {
+        if (variable.store.readonly) {
+          return;
+        }
+        if (newValue instanceof Recoil_index_1) {
+          return;
+        }
+        write2(variable.store.uid, newValue);
+      }
     });
   }
   function getSessionKey(uid2) {

{dara_core-1.16.12.dist-info → dara_core-1.16.13.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dara-core
-Version: 1.16.12
+Version: 1.16.13
 Summary: Dara Framework Core
 Home-page: https://dara.causalens.com/
 License: Apache-2.0
@@ -20,10 +20,10 @@ Requires-Dist: async-asgi-testclient (>=1.4.11,<2.0.0)
 Requires-Dist: certifi (>=2024.7.4)
 Requires-Dist: click (==8.1.3)
 Requires-Dist: colorama (>=0.4.6,<0.5.0)
-Requires-Dist: create-dara-app (==1.16.12)
+Requires-Dist: create-dara-app (==1.16.13)
 Requires-Dist: croniter (>=1.0.15,<3.0.0)
 Requires-Dist: cryptography (>=42.0.4)
-Requires-Dist: dara-components (==1.16.12) ; extra == "all"
+Requires-Dist: dara-components (==1.16.13) ; extra == "all"
 Requires-Dist: exceptiongroup (>=1.1.3,<2.0.0)
 Requires-Dist: fastapi (>=0.115.0,<0.116.0)
 Requires-Dist: fastapi_vite_dara (==0.4.0)
@@ -53,7 +53,7 @@ Description-Content-Type: text/markdown
 
 # Dara Application Framework
 
-<img src="https://github.com/causalens/dara/blob/v1.16.12/img/dara_light.svg?raw=true">
+<img src="https://github.com/causalens/dara/blob/v1.16.13/img/dara_light.svg?raw=true">
 
 ![Master tests](https://github.com/causalens/dara/actions/workflows/tests.yml/badge.svg?branch=master)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
@@ -98,7 +98,7 @@ source .venv/bin/activate
 dara start
 ```
 
-![Dara App](https://github.com/causalens/dara/blob/v1.16.12/img/components_gallery.png?raw=true)
+![Dara App](https://github.com/causalens/dara/blob/v1.16.13/img/components_gallery.png?raw=true)
 
 Note: `pip` installation uses [PEP 660](https://peps.python.org/pep-0660/) `pyproject.toml`-based editable installs which require `pip >= 21.3` and `setuptools >= 64.0.0`. You can upgrade both with:
 
@@ -115,9 +115,9 @@ Explore some of our favorite apps - a great way of getting started and getting t
 
 | Dara App                                                                                                 | Description                                                                                                                                                                                                       |
 | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| ![Large Language Model](https://github.com/causalens/dara/blob/v1.16.12/img/llm.png?raw=true)              | Demonstrates how to use incorporate a LLM chat box into your decision app to understand model insights                                                                                                            |
-| ![Plot Interactivity](https://github.com/causalens/dara/blob/v1.16.12/img/plot_interactivity.png?raw=true) | Demonstrates how to enable the user to interact with plots, trigger actions based on clicks, mouse movements and other interactions with `Bokeh` or `Plotly` plots                                                |
-| ![Graph Editor](https://github.com/causalens/dara/blob/v1.16.12/img/graph_viewer.png?raw=true)             | Demonstrates how to use the `CausalGraphViewer` component to display your graphs or networks, customising the displayed information through colors and tooltips, and updating the page based on user interaction. |
+| ![Large Language Model](https://github.com/causalens/dara/blob/v1.16.13/img/llm.png?raw=true)              | Demonstrates how to use incorporate a LLM chat box into your decision app to understand model insights                                                                                                            |
+| ![Plot Interactivity](https://github.com/causalens/dara/blob/v1.16.13/img/plot_interactivity.png?raw=true) | Demonstrates how to enable the user to interact with plots, trigger actions based on clicks, mouse movements and other interactions with `Bokeh` or `Plotly` plots                                                |
+| ![Graph Editor](https://github.com/causalens/dara/blob/v1.16.13/img/graph_viewer.png?raw=true)             | Demonstrates how to use the `CausalGraphViewer` component to display your graphs or networks, customising the displayed information through colors and tooltips, and updating the page based on user interaction. |
 
 Check out our [App Gallery](https://dara.causalens.com/gallery) for more inspiration!
 
@@ -144,9 +144,9 @@ And the supporting UI packages and tools.
 - `ui-utils` - miscellaneous utility functions
 - `ui-widgets` - widget components
 
-More information on the repository structure can be found in the [CONTRIBUTING.md](https://github.com/causalens/dara/blob/v1.16.12/CONTRIBUTING.md) file.
+More information on the repository structure can be found in the [CONTRIBUTING.md](https://github.com/causalens/dara/blob/v1.16.13/CONTRIBUTING.md) file.
 
 ## License
 
-Dara is open-source and licensed under the [Apache 2.0 License](https://github.com/causalens/dara/blob/v1.16.12/LICENSE).
+Dara is open-source and licensed under the [Apache 2.0 License](https://github.com/causalens/dara/blob/v1.16.13/LICENSE).
 

{dara_core-1.16.12.dist-info → dara_core-1.16.13.dist-info}/RECORD

@@ -80,8 +80,8 @@ dara/core/metrics/__init__.py,sha256=2UqpWHv-Ie58QLJIHJ9Szfjq8xifAuwy5FYGUIFwWtI
 dara/core/metrics/cache.py,sha256=bGXwjO_rSc-FkS3PnPi1mvIZf1x-hvmG113dAUk1g-Y,2616
 dara/core/metrics/runtime.py,sha256=YP-6Dz0GeI9_Yr7bUk_-OqShyFySGH_AKpDO126l6es,1833
 dara/core/metrics/utils.py,sha256=aKaa_hskV3M3h4xOGZYvegDLq_OWOEUlslkQKrrPQiI,2281
-dara/core/persistence.py,sha256=RaGiGQE3oIzEH7kHC1ZXji2VJa0aP0ewMjt1wRWYWjI,10634
-dara/core/umd/dara.core.umd.js,sha256=rmSffasPPrCogBEk8EVuHvCdFtfBfUL9OpP4HMEyH-A,4869727
+dara/core/persistence.py,sha256=SsWGyBO1Wn9rlkaUqf0pqNVatRN8Aw-pK_CVV7v5fJc,13150
+dara/core/umd/dara.core.umd.js,sha256=zv9FZRX2NtIjgKhiqjzyeFmwuGnkRtxgxFNVfzePAOI,4870020
 dara/core/umd/style.css,sha256=YQtQ4veiSktnyONl0CU1iU1kKfcQhreH4iASi1MP7Ak,4095007
 dara/core/visual/__init__.py,sha256=QN0wbG9HPQ_vXh8BO8DnBXeYLIENVTNtRmYzZf1lx7c,577
 dara/core/visual/components/__init__.py,sha256=4km21GLMLM2cr42SwehLUD7DJOlzvhwHl5hdG1OqmIM,2274
@@ -104,8 +104,8 @@ dara/core/visual/themes/__init__.py,sha256=aM4mgoIYo2neBSw5FRzswsht7PUKjLthiHLmF
 dara/core/visual/themes/dark.py,sha256=UQGDooOc8ric73eHs9E0ltYP4UCrwqQ3QxqN_fb4PwY,1942
 dara/core/visual/themes/definitions.py,sha256=nS_gQvOzCt5hTmj74d0_siq_9QWuj6wNuir4VCHy0Dk,2779
 dara/core/visual/themes/light.py,sha256=-Tviq8oEwGbdFULoDOqPuHO0UpAZGsBy8qFi0kAGolQ,1944
-dara_core-1.16.12.dist-info/LICENSE,sha256=r9u1w2RvpLMV6YjuXHIKXRBKzia3fx_roPwboGcLqCc,10944
-dara_core-1.16.12.dist-info/METADATA,sha256=W0YuhRucRe-8fD3TOj0xDEvrYY7d-AIiHyhknUDrogE,7473
-dara_core-1.16.12.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-dara_core-1.16.12.dist-info/entry_points.txt,sha256=H__D5sNIGuPIhVam0DChNL-To5k8Y7nY7TAFz9Mz6cc,139
-dara_core-1.16.12.dist-info/RECORD,,
+dara_core-1.16.13.dist-info/LICENSE,sha256=r9u1w2RvpLMV6YjuXHIKXRBKzia3fx_roPwboGcLqCc,10944
+dara_core-1.16.13.dist-info/METADATA,sha256=uUJ6n6ebwTD7eQUw8Gn_NwAMdrKGmb8E1IJZmZQT8Do,7473
+dara_core-1.16.13.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+dara_core-1.16.13.dist-info/entry_points.txt,sha256=H__D5sNIGuPIhVam0DChNL-To5k8Y7nY7TAFz9Mz6cc,139
+dara_core-1.16.13.dist-info/RECORD,,