dara-core 1.19.1__py3-none-any.whl → 1.20.0__py3-none-any.whl

dara/core/interactivity/client_variable.py

@@ -0,0 +1,71 @@
+"""
+Copyright 2023 Impulse Innovations Limited
+
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+from __future__ import annotations
+
+import abc
+from typing import Optional
+
+from dara.core.interactivity.any_variable import AnyVariable
+
+
+class ClientVariable(AnyVariable, abc.ABC):
+    """
+    Client represents any variable which can be ordinarily serialized to the client
+
+    :param uid: the unique identifier for this variable; if not provided a random one is generated
+    """
+
+    uid: str
+
+    def __init__(self, uid: Optional[str] = None, **kwargs) -> None:
+        super().__init__(uid=uid, **kwargs)
+
+    @property
+    def list_item(self):
+        """
+        Get a LoopVariable that represents the current item in the list.
+        Should only be used in conjunction with the `For` component.
+
+        Note that it is a type of a Variable so it can be used in places where a regular Variable is expected.
+
+        By default, the entire list item is used as the item.
+
+        `LoopVariable` supports nested property access using `get` or index access i.e. `[]`.
+        You can mix and match those two methods to access nested properties as they are equivalent.
+
+        ```python
+        my_list = Variable(['foo', 'bar', 'baz'])
+
+        # Represents the entire item in the list
+        my_list.list_item
+
+        my_list_of_objects = Variable([
+            {'id': 1, 'name': 'John', 'data': {'city': 'London', 'country': 'UK'}},
+            {'id': 2, 'name': 'Jane', 'data': {'city': 'Paris', 'country': 'France'}},
+        ])
+
+        # Represents the item 'name' property
+        my_list_of_objects.list_item['name']
+
+        # Represents the item 'data.country' property
+        my_list_of_objects.list_item.get('data')['country']
+        """
+
+        from .loop_variable import LoopVariable
+
+        return LoopVariable()

dara/core/interactivity/data_variable.py

@@ -17,40 +17,15 @@ limitations under the License.
 
 from __future__ import annotations
 
-import asyncio
-from typing import Optional, Union, cast
+from typing import Optional
 
-from anyio.abc import TaskGroup
 from pandas import DataFrame
-from pandas.io.json._table_schema import build_table_schema
-from pydantic import (
-    BaseModel,
-    ConfigDict,
-    SerializerFunctionWrapHandler,
-    model_serializer,
-)
 
-from dara.core.base_definitions import BaseCachePolicy, Cache, CacheArgType
-from dara.core.interactivity.any_data_variable import (
-    AnyDataVariable,
-    DataFrameSchema,
-    DataVariableRegistryEntry,
-)
-from dara.core.interactivity.filtering import (
-    FilterQuery,
-    Pagination,
-    apply_filters,
-    coerce_to_filter_query,
-)
-from dara.core.internal.cache_store import CacheStore
-from dara.core.internal.hashing import hash_object
-from dara.core.internal.pandas_utils import append_index, df_convert_to_internal
-from dara.core.internal.utils import call_async
-from dara.core.internal.websocket import WebsocketManager
-from dara.core.logging import eng_logger
+from dara.core.base_definitions import Cache, CacheArgType
+from dara.core.interactivity.server_variable import ServerVariable
 
 
-class DataVariable(AnyDataVariable):
+class DataVariable(ServerVariable):
     """
     DataVariable represents a variable that is specifically designed to hold datasets.
 
@@ -69,11 +44,6 @@ class DataVariable(AnyDataVariable):
     >>> UpdateVariable(func=some_data_transformation, variable=session_data)
     """
 
-    uid: str
-    filters: Optional[FilterQuery] = None
-    cache: Optional[BaseCachePolicy] = None
-    model_config = ConfigDict(extra='forbid', arbitrary_types_allowed=True, use_enum_values=True)
-
     def __init__(
         self,
         data: Optional[DataFrame] = None,
@@ -89,239 +59,11 @@ class DataVariable(AnyDataVariable):
         :param filters: a dictionary of filters to apply to the data
         :param cache: how to cache the result; 'user' per user, 'session' per session, 'global' for all users
         """
-        cache = Cache.Policy.from_arg(cache)
+        cache_policy = Cache.Policy.from_arg(cache)
 
-        if data is not None and cache.cache_type is not Cache.Type.GLOBAL:
+        if data is not None and cache_policy.cache_type is not Cache.Type.GLOBAL:
             raise ValueError('Data cannot be cached per session or per user if provided upfront')
 
-        super().__init__(cache=cache, uid=uid, **kwargs)
-
-        # Register the variable with the dataset
-        from dara.core.internal.registries import data_variable_registry
-
-        var_entry = DataVariableRegistryEntry(
-            cache=cache,
-            uid=str(self.uid),
-            type='plain',
-            get_data=DataVariable.get_value,
-            get_total_count=DataVariable.get_total_count,
-            get_schema=DataVariable.get_schema,
-        )
-        data_variable_registry.register(
-            str(self.uid),
-            var_entry,
-        )
-
-        # Put the data entry into the store if not empty (so cache='global')
-        # We don't create an entry in a different case since session key will be global anyway at this point
-        if data is not None:
-            from dara.core.internal.registries import utils_registry
-
-            store: CacheStore = utils_registry.get('Store')
-            call_async(self._update, var_entry, store, data)
-
-    @staticmethod
-    def _get_cache_key(uid: str) -> str:
-        """
-        Get a unique cache key for the data variable.
-
-        :param uid: uid of the DataVariable
-        """
-        return f'data-{uid}'
-
-    @staticmethod
-    def _get_schema_cache_key(uid: str) -> str:
-        """
-        Get a unique cache key for the data variable's schema.
-
-        :param uid: uid of the DataVariable
-        """
-        return f'schema-{uid}'
-
-    @classmethod
-    def _get_count_cache_key(cls, uid: str, filters: Optional[Union[FilterQuery, dict]]) -> str:
-        return f'{cls._get_cache_key(uid)}_{hash_object(filters)}'
-
-    @classmethod
-    async def _update(cls, var_entry: DataVariableRegistryEntry, store: CacheStore, data: Optional[DataFrame]):
-        """
-        Internal helper which updates the data variable entry in store.
-
-        TODO: for now data is always kept in store, in the future depending on the size data might be cached on disk
-        """
-        await store.set(var_entry, key=cls._get_cache_key(var_entry.uid), value=DataStoreEntry(data=append_index(data)))
-
-    @classmethod
-    def update_value(cls, var_entry: DataVariableRegistryEntry, store: CacheStore, data: Optional[DataFrame]):
-        """
-        Update the data entry and notify all clients about the update.
-
-        :param var_entry: the entry in the registry
-        :param data: the data to update
-        :param store: store instance
-        """
-        from dara.core.internal.registries import utils_registry
-
-        ws_mgr: WebsocketManager = utils_registry.get('WebsocketManager')
-        task_group: TaskGroup = utils_registry.get('TaskGroup')
-
-        # Update store
-        task_group.start_soon(cls._update, var_entry, store, data)
-
-        # Broadcast the update to all clients
-        task_group.start_soon(
-            ws_mgr.broadcast,
-            {
-                'data_id': str(var_entry.uid),
-            },
-        )
-
-    @classmethod
-    async def get_value(
-        cls,
-        var_entry: DataVariableRegistryEntry,
-        store: CacheStore,
-        filters: Optional[Union[FilterQuery, dict]] = None,
-        pagination: Optional[Pagination] = None,
-        format_for_display: bool = False,
-    ) -> Optional[DataFrame]:
-        """
-        Get the value of this DataVariable.
-        """
-        _uid_short = f'{var_entry.uid[:3]}..{var_entry.uid[-3:]}'
-        eng_logger.info(
-            f'Data Variable {_uid_short} get_value',
-            {'uid': var_entry.uid, 'filters': filters, 'pagination': pagination},
-        )
-
-        cache_key = cls._get_cache_key(var_entry.uid)
-        entry = await store.get(var_entry, key=cache_key)
-
-        eng_logger.debug(
-            f'Data Variable {_uid_short}',
-            'retrieved from cache',
-            {
-                'uid': var_entry.uid,
-                'size': len(entry.data.index) if entry is not None and entry.data is not None else 0,
-            },
-        )
-
-        if entry is None:
-            await asyncio.gather(
-                store.set(var_entry, key=cls._get_count_cache_key(var_entry.uid, filters), value=0, pin=True),
-                store.set(var_entry, key=cls._get_schema_cache_key(var_entry.uid), value=None, pin=True),
-            )
-            return None
-
-        data = None
-
-        if entry.data is not None:
-            filtered_data, count = apply_filters(entry.data, coerce_to_filter_query(filters), pagination)
-            if format_for_display and filtered_data is not None:
-                filtered_data = filtered_data.copy()
-                for col in filtered_data.columns:
-                    if filtered_data[col].dtype == 'object':
-                        # We need to convert all values to string to avoid issues with displaying data in the Table component, for example when displaying datetime and number objects in the same column
-                        filtered_data.loc[:, col] = filtered_data[col].apply(str)
-            data = filtered_data
-            # Store count for given filters and schema
-            await asyncio.gather(
-                store.set(var_entry, key=cls._get_count_cache_key(var_entry.uid, filters), value=count, pin=True),
-                store.set(
-                    var_entry,
-                    key=cls._get_schema_cache_key(var_entry.uid),
-                    value=build_table_schema(df_convert_to_internal(entry.data)),
-                    pin=True,
-                ),
-            )
-        else:
-            await asyncio.gather(
-                store.set(var_entry, key=cls._get_count_cache_key(var_entry.uid, filters), value=0, pin=True),
-                store.set(var_entry, key=cls._get_schema_cache_key(var_entry.uid), value=None, pin=True),
-            )
-
-        # TODO: once path is supported, stream&filter from disk
-        if entry.path:
-            raise NotImplementedError('DataVariable.get_value() does not support disk caching yet')
-
-        eng_logger.info(
-            f'Data Variable {_uid_short} returning filtered data',
-            {'uid': var_entry.uid, 'size': len(data.index) if data is not None else 0},
-        )
-
-        return data
-
-    @classmethod
-    async def get_total_count(
-        cls, var_entry: DataVariableRegistryEntry, store: CacheStore, filters: Optional[FilterQuery]
-    ):
-        """
-        Get total count of the data variable.
-
-        :param var_entry: variable entry
-        :param store: store
-        :param filters: filters to get count for
-        """
-        cache_key = cls._get_count_cache_key(var_entry.uid, filters)
-        entry = await store.get(var_entry, key=cache_key, unpin=True)
-
-        if entry is None:
-            raise ValueError('Requested count for filter setup which has not been performed yet')
-
-        return entry
-
-    @classmethod
-    async def get_schema(cls, var_entry: DataVariableRegistryEntry, store: CacheStore):
-        """
-        Get the schema of the data variable.
-
-        :param var_entry: variable entry
-        :param store: store
-        """
-        cache_key = cls._get_schema_cache_key(var_entry.uid)
-        entry = await store.get(var_entry, key=cache_key, unpin=True)
-
-        return cast(DataFrameSchema, entry)
-
-    def reset(self):
-        raise NotImplementedError('DataVariable cannot be reset')
-
-    def update(self, value: Optional[DataFrame]):
-        """
-        Create an action to update the value of this Variable to a provided value.
-
-        ```python
-        import pandas as pd
-        from dara.core import DataVariable
-        from dara.components import Button
-
-        data = DataVariable(pd.DataFrame({'a': [1, 2, 3]}))
-
-        Button(
-            'Empty Data',
-            onclick=data.update(None),
-        )
-
-        ```
-        """
-        from dara.core.interactivity.actions import UpdateVariableImpl
-
-        return UpdateVariableImpl(variable=self, value=value)
-
-    @model_serializer(mode='wrap')
-    def ser_model(self, nxt: SerializerFunctionWrapHandler) -> dict:
-        parent_dict = nxt(self)
-        if 'data' in parent_dict:
-            parent_dict.pop('data')  # make sure data is not included in the serialised dict
-        return {**parent_dict, '__typename': 'DataVariable', 'uid': str(parent_dict['uid'])}
-
-
-class DataStoreEntry(BaseModel):
-    """
-    Entry in the cache store for a DataVariable.
-    Can either be a DataFrame or a path to a file on disk.
-    """
+        scope = 'global' if cache_policy.cache_type == Cache.Type.GLOBAL else 'user'
 
-    data: Optional[DataFrame] = None
-    path: Optional[str] = None
-    model_config = ConfigDict(extra='forbid', arbitrary_types_allowed=True)
+        super().__init__(scope=scope, uid=uid, default=data, **kwargs)