dara-core 1.16.21__py3-none-any.whl → 1.16.22__py3-none-any.whl

dara/core/__init__.py

@@ -34,6 +34,7 @@ __version__ = version('dara-core')
 
 __all__ = [
     'action',
+    'ActionCtx',
     'ConfigurationBuilder',
     'DerivedVariable',
     'DerivedDataVariable',

dara/core/interactivity/__init__.py

@@ -20,6 +20,7 @@ from __future__ import annotations
 from pydantic import BaseModel
 
 from dara.core.interactivity.actions import (
+    ActionCtx,
     DownloadContent,
     DownloadContentImpl,
     DownloadVariable,
@@ -45,6 +46,7 @@ from dara.core.interactivity.url_variable import UrlVariable
 
 __all__ = [
     'action',
+    'ActionCtx',
     'AnyVariable',
     'AnyDataVariable',
     'DataVariable',

dara/core/interactivity/actions.py

@@ -52,6 +52,7 @@ from dara.core.base_definitions import (
     AnnotatedAction,
 )
 from dara.core.base_definitions import DaraBaseModel as BaseModel
+from dara.core.base_definitions import TaskProgressUpdate
 from dara.core.interactivity.data_variable import DataVariable
 from dara.core.internal.download import generate_download_code
 from dara.core.internal.registry_lookup import RegistryLookup
@@ -1192,6 +1193,70 @@ class ActionCtx:
         """
         return await DownloadVariable(variable=variable, file_name=file_name, type=type).execute(self)
 
+    async def run_task(
+        self,
+        func: Callable,
+        args: Union[List[Any], None] = None,
+        kwargs: Union[Dict[str, Any], None] = None,
+        on_progress: Optional[Callable[[TaskProgressUpdate], Union[None, Awaitable[None]]]] = None,
+    ):
+        """
+        Run a calculation as a task in a separate process. Recommended for CPU intensive tasks.
+        Returns the result of the task function.
+
+        Note that the function must be defined in a separate module as configured in `task_module` field of the
+        configuration builder. This is because Dara spawns separate worker processes only designed to run
+        functions from that designated module.
+
+        ```python
+        from dara.core import ConfigurationBuilder, TaskProgressUpdate, action, ActionCtx, Variable
+        from dara.components import Text, Stack, Button
+        from .my_module import my_task_function
+
+        config = ConfigurationBuilder()
+        config.task_module = 'my_module'
+
+        status = Variable('Not started')
+
+        @action
+        async def my_task(ctx: ActionCtx):
+            async def on_progress(update: TaskProgressUpdate):
+                await ctx.update(status, f'Progress: {update.progress}% - {update.message}')
+
+            try:
+                result = await ctx.run_task(my_task_function, args=[1, 10], on_progress=on_progress)
+                await ctx.update(status, f'Result: {result}')
+            except Exception as e:
+                await ctx.update(status, f'Error: {e}')
+
+        def task_page():
+            return Stack(Text('Status display:'), Text(text=status), Button('Run', onclick=my_task()))
+
+        config.add_page(name='task', content=task_page())
+        ```
+
+        :param func: the function to run as a task
+        :param args: the arguments to pass to the function
+        :param kwargs: the keyword arguments to pass to the function
+        :param on_progress: a callback to receive progress updates
+        """
+        from dara.core.internal.registries import utils_registry
+        from dara.core.internal.tasks import Task, TaskManager
+
+        task_mgr: TaskManager = utils_registry.get('TaskManager')
+
+        task = Task(func=func, args=args, kwargs=kwargs, on_progress=on_progress)
+        pending_task = await task_mgr.run_task(task)
+
+        # Run until completion
+        await pending_task.event.wait()
+
+        # Raise exception if there was one
+        if pending_task.error:
+            raise pending_task.error
+
+        return pending_task.result
+
     async def execute_action(self, action: ActionImpl):
         """
         Execute a given action.

dara/core/interactivity/derived_variable.py

@@ -90,7 +90,7 @@ class DerivedVariable(NonDataVariable, Generic[VariableType]):
 
     def __init__(
         self,
-        func: Callable[..., VariableType],
+        func: Callable[..., VariableType] | Callable[..., Awaitable[VariableType]],
         variables: List[AnyVariable],
         cache: Optional[CacheArgType] = Cache.Type.GLOBAL,
         run_as_task: bool = False,

dara/core/internal/tasks.py

@@ -17,7 +17,7 @@ limitations under the License.
 
 import inspect
 import math
-from typing import Any, Callable, Dict, List, Optional, Union
+from typing import Any, Awaitable, Callable, Dict, List, Optional, Union, overload
 
 from anyio import (
     CancelScope,
@@ -70,6 +70,7 @@ class Task(BaseTask):
         notify_channels: Optional[List[str]] = None,
         cache_key: Optional[str] = None,
         task_id: Optional[str] = None,
+        on_progress: Optional[Callable[[TaskProgressUpdate], Union[None, Awaitable[None]]]] = None,
     ):
         """
         :param func: The function to execute within the process
@@ -87,6 +88,7 @@ class Task(BaseTask):
         self.notify_channels = notify_channels if notify_channels is not None else []
         self.cache_key = cache_key
         self.reg_entry = reg_entry
+        self.on_progress = on_progress
 
         super().__init__(task_id)
 
@@ -359,6 +361,14 @@ class TaskManager:
         self.ws_manager = ws_manager
         self.store = store
 
+    @overload
+    async def run_task(self, task: PendingTask, ws_channel: Optional[str] = None) -> Any:
+        ...
+
+    @overload
+    async def run_task(self, task: BaseTask, ws_channel: Optional[str] = None) -> PendingTask:
+        ...
+
     async def run_task(self, task: BaseTask, ws_channel: Optional[str] = None):
         """
         Run a task and store it in the tasks dict
@@ -504,6 +514,8 @@ class TaskManager:
                                     'message': message.message,
                                 }
                             )
+                            if isinstance(task, Task) and task.on_progress:
+                                await run_user_handler(task.on_progress, args=(message,))
                         elif isinstance(message, TaskResult):
                             # Resolve the pending task related to the result
                             if message.task_id in self.tasks:

{dara_core-1.16.21.dist-info → dara_core-1.16.22.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dara-core
-Version: 1.16.21
+Version: 1.16.22
 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.21)
+Requires-Dist: create-dara-app (==1.16.22)
 Requires-Dist: croniter (>=1.0.15,<3.0.0)
 Requires-Dist: cryptography (>=42.0.4)
-Requires-Dist: dara-components (==1.16.21) ; extra == "all"
+Requires-Dist: dara-components (==1.16.22) ; 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)
@@ -54,7 +54,7 @@ Description-Content-Type: text/markdown
 
 # Dara Application Framework
 
-<img src="https://github.com/causalens/dara/blob/v1.16.21/img/dara_light.svg?raw=true">
+<img src="https://github.com/causalens/dara/blob/v1.16.22/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)
@@ -99,7 +99,7 @@ source .venv/bin/activate
 dara start
 ```
 
-![Dara App](https://github.com/causalens/dara/blob/v1.16.21/img/components_gallery.png?raw=true)
+![Dara App](https://github.com/causalens/dara/blob/v1.16.22/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:
 
@@ -116,9 +116,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.21/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.21/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.21/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.22/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.22/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.22/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!
 
@@ -145,9 +145,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.21/CONTRIBUTING.md) file.
+More information on the repository structure can be found in the [CONTRIBUTING.md](https://github.com/causalens/dara/blob/v1.16.22/CONTRIBUTING.md) file.
 
 ## License
 
-Dara is open-source and licensed under the [Apache 2.0 License](https://github.com/causalens/dara/blob/v1.16.21/LICENSE).
+Dara is open-source and licensed under the [Apache 2.0 License](https://github.com/causalens/dara/blob/v1.16.22/LICENSE).
 

{dara_core-1.16.21.dist-info → dara_core-1.16.22.dist-info}/RECORD

@@ -1,4 +1,4 @@
-dara/core/__init__.py,sha256=eF6Fmf5TkWYIPiZ3CR6kMGinIcFXoA8LQN5m4EpZzHY,2094
+dara/core/__init__.py,sha256=Hib2omvNFpEk72wyYMWQrbf18-uKyn4GW8LlcAtBMoI,2111
 dara/core/actions.py,sha256=gARcrrtzYuBAVJUCtuHwpFc6PPVPb7x3ITIISCLw0GA,965
 dara/core/auth/__init__.py,sha256=H0bJoXff5wIRZmHvvQ3y9p5SXA9lM8OuLCGceYGqfb0,851
 dara/core/auth/base.py,sha256=qxmiIzx-n2g4ZWicgxsYtHjiB14AemOWM_GNxcr98mE,3294
@@ -14,14 +14,14 @@ dara/core/data_utils.py,sha256=5GGz4vk6srLO8HMySiAEk_xZCvmf0SeTTgVi-N4qaKY,12636
 dara/core/defaults.py,sha256=UkjWwIbo8GLyn8RZRoD3cJe174-3wHZYzvMB0hQCnMg,4150
 dara/core/definitions.py,sha256=QouD2P2XInW6bqrhPtrfIyDi8i99Au2PTBdWBtgBVrE,16713
 dara/core/http.py,sha256=LR1Kr5Hca-Z6klNl-M8R8Q1eOfFh3hLrjVS3kVrRsKA,4658
-dara/core/interactivity/__init__.py,sha256=3e5G5Nww33irzs1LinUmfs6wYpmSLPp9e4BHplw3gIk,2294
-dara/core/interactivity/actions.py,sha256=paujB21J5MYbYZlIP2dIbUStqKbm9PsfCcpcYmOqCSI,45605
+dara/core/interactivity/__init__.py,sha256=zZp4wO6nHZ_-IzDtlv8D5mjlutn4bckqIiSCaPoCYZw,2326
+dara/core/interactivity/actions.py,sha256=yMw8S11wj4J2HVmDsmedh9D0IZFL9hxw6WGNj7X2f6M,48198
 dara/core/interactivity/any_data_variable.py,sha256=1dLLxLuDErRsgaFPSTXxZHvpVucKKty90twQE6N-_NI,5286
 dara/core/interactivity/any_variable.py,sha256=LOGhbDdYffujlRxF4LR9ZuWdai03R-EXuGsTEJAwfo0,13544
 dara/core/interactivity/condition.py,sha256=q_RDDt-DtZEUQL054Mc7zHyJIJIGACljJ2gOFygCHQc,1309
 dara/core/interactivity/data_variable.py,sha256=pvPOx6SMxHWDxoo5Ea5xqLwrBTrWN68x8lnBiblYSGg,11760
 dara/core/interactivity/derived_data_variable.py,sha256=u2HOts5rtmzK3D1K383YfYYQnb4pHZF3rTu1lfwMpPA,15323
-dara/core/interactivity/derived_variable.py,sha256=7ActxJISTI-EdYUaoqioi8SPznpfCPlqDYlFJO43a38,21886
+dara/core/interactivity/derived_variable.py,sha256=x_vdt8hvgubDEISX6GfpR5CS7n2Vxq3oZIkVd8Daiw0,21927
 dara/core/interactivity/filtering.py,sha256=BZsWsQvXPhn6WUoAFpAtgN6hXlGDudPbi4h97Qao2ic,9197
 dara/core/interactivity/loop_variable.py,sha256=EqZX3bMCwKmI2Yu4pQ7TJG9hf3PY2AlAIBLxEzHFbTw,2998
 dara/core/interactivity/non_data_variable.py,sha256=IMH5cNce2O6RUbu4HB_VLT-BBnDnGHr3lp09XU_lWa4,2378
@@ -59,7 +59,7 @@ dara/core/internal/routing.py,sha256=D2HFfwPKKpDuvvIwXInDWKoq2-zweMVmt4MiVBzorO0
 dara/core/internal/scheduler.py,sha256=tKpyN_yhtEepfqfkNTfFep055dl-Lq1_Itte6FTkH9o,12978
 dara/core/internal/settings.py,sha256=ViEni6lVXvbP6Ofb0VoTaWXkI0XajmD-LBpqz1LzwpA,3923
 dara/core/internal/store.py,sha256=kLRDuYEFwqpJMS0CmL5jGmETs645Xcug4jlelJqk5w4,7706
-dara/core/internal/tasks.py,sha256=oCfmOMm3pVH0-dvZzJv4nspCRWc_u-J3J7lmNI_ys5E,24763
+dara/core/internal/tasks.py,sha256=5NdUWGwy11Dd0riPBxiUP9IMb6Is7bfSnD40WLVRFik,25328
 dara/core/internal/utils.py,sha256=b1YYkn8qHl6-GY6cCm2MS1NXRS9j_rElYCKMZOxJgrY,8232
 dara/core/internal/websocket.py,sha256=qeW7KOeJ_FPkpAJNZaVwxIN_DqDv7XK7uyjTxJ8HIno,22043
 dara/core/jinja/index.html,sha256=1gkCFiihXOUH7vp7tT5gH8mKeJB4KqNg394xO3a0usI,1208
@@ -106,8 +106,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.21.dist-info/LICENSE,sha256=r9u1w2RvpLMV6YjuXHIKXRBKzia3fx_roPwboGcLqCc,10944
-dara_core-1.16.21.dist-info/METADATA,sha256=GU0DRGfGG3DPDKHF_xCnlOgibNnCB7zccD42ys_Cvlo,7507
-dara_core-1.16.21.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-dara_core-1.16.21.dist-info/entry_points.txt,sha256=H__D5sNIGuPIhVam0DChNL-To5k8Y7nY7TAFz9Mz6cc,139
-dara_core-1.16.21.dist-info/RECORD,,
+dara_core-1.16.22.dist-info/LICENSE,sha256=r9u1w2RvpLMV6YjuXHIKXRBKzia3fx_roPwboGcLqCc,10944
+dara_core-1.16.22.dist-info/METADATA,sha256=OaGKDjB2t-bVSdBdPCJCOz3MbS5V_Cqsb9zazY8dh-I,7507
+dara_core-1.16.22.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+dara_core-1.16.22.dist-info/entry_points.txt,sha256=H__D5sNIGuPIhVam0DChNL-To5k8Y7nY7TAFz9Mz6cc,139
+dara_core-1.16.22.dist-info/RECORD,,