dara-components 1.8.5__py3-none-any.whl → 1.22.1__py3-none-any.whl

dara/components/graphs/graph_layout.py

@@ -17,9 +17,10 @@ limitations under the License.
 
 import abc
 from enum import Enum
-from typing import List, Optional, Union
 
-from pydantic import BaseModel, Field
+from pydantic import Field
+
+from dara.core.base_definitions import DaraBaseModel as BaseModel
 
 
 class GraphLayoutType(Enum):
@@ -47,7 +48,7 @@ class LayeringAlgorithm(Enum):
     SIMPLEX = 'simplex'
 
 
-Number = Union[int, float]
+Number = int | float
 
 
 class GraphLayout(BaseModel, abc.ABC):
@@ -58,25 +59,25 @@ class GraphLayout(BaseModel, abc.ABC):
     :param node_font_size: node font size in pixels
     """
 
-    node_size: Optional[int] = None
-    node_font_size: Optional[int] = None
+    node_size: int | None = None
+    node_font_size: int | None = None
 
 
 class TiersConfig(BaseModel):
-    """
+    r"""
     TiersConfig provides a way of defining tiers for a graph layout.
 
     :param group: Path within node to group property which defines the tier it belong to,
-        e.g. 'meta.group' would correspond to a group attribute in the meta of the node, 'meta': {'group': 'countries'}
+        e.g. 'meta.group' would correspond to a group attribute in the meta of the node, 'meta': \{'group': 'countries'\}
     :param order_nodes_by: A path to a node property which contains a number defining the order of nodes within a tier,
-        e.g. 'meta.order' would correspond to an order attribute in the meta of the node, 'meta': {'order': 1}
+        e.g. 'meta.order' would correspond to an order attribute in the meta of the node, 'meta': \{'order': 1\}
     :param rank: A list of group values defining the order they should appear in, e.g. ['countries', 'currency', 'industry']
         would result in the nodes representing nodes appearing in the first tier, then nodes representing currency in the second tier and finally those representing industry.
     """
 
     group: str
-    order_nodes_by: Optional[str] = None
-    rank: Optional[List[str]] = None
+    order_nodes_by: str | None = None
+    rank: list[str] | None = None
 
 
 class TieringLayout(BaseModel):
@@ -133,8 +134,42 @@ class TieringLayout(BaseModel):
     :param orientation: Orientation the tiers are displayed in default is horizontal
     """
 
-    tiers: Optional[Union[TiersConfig, List[List[str]]]] = None
-    orientation: Optional[DirectionType] = DirectionType.HORIZONTAL
+    tiers: TiersConfig | list[list[str]] | None = None
+    orientation: DirectionType | None = DirectionType.HORIZONTAL
+
+
+class GroupingLayout(BaseModel):
+    """
+    GroupingLayout provides a grouping or cluster layout for a graph. It can be used to represent nodes within groups or cluster which are collapsible.
+
+    You can set the group on the meta of a node and then define the path to this property on the layout:
+    ```
+    from dara.components import CausalGraphViewer, FcoseLayout
+    from cai_causal_graph import CausalGraph
+
+    cg = CausalGraph()
+    cg.add_node(identifier='A', meta={'group': 'group1'})
+    cg.add_node(identifier='B', meta={'group': 'group1'})
+    cg.add_node(identifier='C', meta={'group': 'group2'})
+    cg.add_node(identifier='D', meta={'group': 'group2'})
+    cg.add_node(identifier='E', meta={'group': 'group3'})
+    cg.add_edge('A', 'C')
+    cg.add_edge('B', 'D')
+    cg.add_edge('C', 'E')
+    cg.add_edge('D', 'E')
+
+    CausalGraphViewer(
+        causal_graph=cg,
+        graph_layout=FcoseLayout(
+            group='meta.group',
+            ),
+    )
+    ```
+
+    :param group: Path within node to group property which defines the group it belong to,
+    """
+
+    group: str | None = None
 
 
 class CircularLayout(GraphLayout):
@@ -145,7 +180,7 @@ class CircularLayout(GraphLayout):
     :param node_size: node size in pixels
     """
 
-    layout_type: GraphLayoutType = Field(default=GraphLayoutType.CIRCULAR, const=True)
+    layout_type: GraphLayoutType = Field(default=GraphLayoutType.CIRCULAR, frozen=True)
 
 
 class CustomLayout(GraphLayout):
@@ -172,12 +207,12 @@ class CustomLayout(GraphLayout):
     If not all nodes have coordinates defined, the graph editor will fall back to a default layout.
     """
 
-    layout_type: GraphLayoutType = Field(default=GraphLayoutType.CUSTOM, const=True)
+    layout_type: GraphLayoutType = Field(default=GraphLayoutType.CUSTOM, frozen=True)
 
 
-class FcoseLayout(GraphLayout, TieringLayout):
+class FcoseLayout(GraphLayout, TieringLayout, GroupingLayout):
     """
-    FcoseLayout utilises `fCoSE` (fast Compound Spring Embedder) algorithm to compute the layout.
+    FcoseLayout utilizes `fCoSE` (fast Compound Spring Embedder) algorithm to compute the layout.
     It works well in most circumstances and is highly configurable.
 
     See https://github.com/iVis-at-Bilkent/cytoscape.js-fcose for more details and interactive demos.
@@ -194,23 +229,23 @@ class FcoseLayout(GraphLayout, TieringLayout):
     :param tier_separation: Separation force between tiers (default value: 200)
     """
 
-    layout_type: GraphLayoutType = Field(default=GraphLayoutType.FCOSE, const=True)
+    layout_type: GraphLayoutType = Field(default=GraphLayoutType.FCOSE, frozen=True)
 
-    edge_elasticity: Optional[Number] = 0.45
-    edge_length: Optional[Number] = 3
-    energy: Optional[Number] = 0.1
-    gravity: Optional[Number] = 35
-    gravity_range: Optional[Number] = 80
-    high_quality: Optional[bool] = True
-    iterations: Optional[int] = 2500
-    node_repulsion: Optional[Number] = 6_500
-    node_separation: Optional[Number] = 75
-    tier_separation: Optional[Number] = 200
+    edge_elasticity: Number | None = 0.45
+    edge_length: Number | None = 3
+    energy: Number | None = 0.1
+    gravity: Number | None = 35
+    gravity_range: Number | None = 80
+    high_quality: bool | None = True
+    iterations: int | None = 2500
+    node_repulsion: Number | None = 6_500
+    node_separation: Number | None = 75
+    tier_separation: Number | None = 200
 
 
 class ForceAtlasLayout(GraphLayout):
     """
-    ForceAtlas utilises the `ForceAtlas2` algorithm to compute the layout. It is a force-directed layout
+    ForceAtlas utilizes the `ForceAtlas2` algorithm to compute the layout. It is a force-directed layout
     which integrates various optimizations and is highly configurable.
 
     See https://journals.plos.org/plosone/article?id=10.1371/journal.pone.0098679 for more details and
@@ -224,7 +259,7 @@ class ForceAtlasLayout(GraphLayout):
         of the space. Its main purpose is to compensate repulsion for nodes that are far away from the center. (default value:0.2)
     :param iterations: Number of iterations to run the layout for, per computation (default value: 10_000)
     :param lin_log_mode: Whether to use LinLog energy model, using logarithmic attraction force. Enabling it makes clusters
-        tighter but coverges slower. (default value: `True`)
+        tighter but converges slower. (default value: `True`)
     :param outbound_attraction_distribution: Whether to scale the attraction force between nodes according to their degree. (default value: `True`)
     :param scaling_ratio: Parameter to adjust the size of the produced graph (default value: 8)
     :param strong_gravity_mode: Whether to use strong gravity mode, which sets a force that attracts the nodes that are distant
@@ -232,16 +267,16 @@ class ForceAtlasLayout(GraphLayout):
         However, its advantage is to force a very compact layout, which may be useful for certain purposes. (default value: `False`)
     """
 
-    layout_type: GraphLayoutType = Field(default=GraphLayoutType.FORCE_ATLAS, const=True)
+    layout_type: GraphLayoutType = Field(default=GraphLayoutType.FORCE_ATLAS, frozen=True)
 
-    barnes_hut_optimize: Optional[bool] = False
-    edge_weight_influence: Optional[Number] = 1
-    gravity: Optional[Number] = 0.2
-    iterations: Optional[int] = 10_000
-    lin_log_mode: Optional[bool] = True
-    outbound_attraction_distribution: Optional[bool] = True
-    scaling_ratio: Optional[Number] = 8
-    strong_gravity_mode: Optional[bool] = False
+    barnes_hut_optimize: bool | None = False
+    edge_weight_influence: Number | None = 1
+    gravity: Number | None = 0.2
+    iterations: int | None = 10_000
+    lin_log_mode: bool | None = True
+    outbound_attraction_distribution: bool | None = True
+    scaling_ratio: Number | None = 8
+    strong_gravity_mode: bool | None = False
 
 
 class MarketingLayout(GraphLayout, TieringLayout):
@@ -254,9 +289,9 @@ class MarketingLayout(GraphLayout, TieringLayout):
     :param tier_separation: Separation force between tiers (default value: 300)
     """
 
-    layout_type: GraphLayoutType = Field(default=GraphLayoutType.MARKETING, const=True)
-    target_location: Optional[TargetLocation] = None
-    tier_separation: Optional[Number] = 300
+    layout_type: GraphLayoutType = Field(default=GraphLayoutType.MARKETING, frozen=True)
+    target_location: TargetLocation | None = None
+    tier_separation: Number | None = 300
 
 
 class PlanarLayout(GraphLayout, TieringLayout):
@@ -265,20 +300,20 @@ class PlanarLayout(GraphLayout, TieringLayout):
     uses d3-dag's sugiyama layout under the hood to minimize edge crossings.
 
     :param orientation: Orientation of target node relative to other nodes (horizontal or vertical). (default value: horizontal)
-    :param layering_algorithm: Algorithm to use for the layering step of sugyiama algorithm. Can choosen between simplex which
+    :param layering_algorithm: Algorithm to use for the layering step of sugyiama algorithm. Can chosen between simplex which
         optimizes for minimum edge length or long path which optimizes for minimum graph height.
         Do note that if tiers are passed in conjunction to this prop, its value will revert to simplex
         as tiers are only supported by it (defaults to: simplex)
     """
 
-    layout_type: GraphLayoutType = Field(default=GraphLayoutType.PLANAR, const=True)
-    layering_algorithm: Optional[LayeringAlgorithm] = LayeringAlgorithm.SIMPLEX
-    orientation: Optional[DirectionType] = None
+    layout_type: GraphLayoutType = Field(default=GraphLayoutType.PLANAR, frozen=True)
+    layering_algorithm: LayeringAlgorithm | None = LayeringAlgorithm.SIMPLEX
+    orientation: DirectionType | None = None
 
 
-class SpringLayout(GraphLayout, TieringLayout):
+class SpringLayout(GraphLayout, TieringLayout, GroupingLayout):
     """
-    SpringLayout provides a simple force-directed graph layout which produces the "spring" behaviour of edges.
+    SpringLayout provides a simple force-directed graph layout which produces the "spring" behavior of edges.
     This is a 'live' layout, which means a simulation keeps running in the background to compute the layout.
 
     :param collision_force: Multiplier for collision force between nodes (default value: 2)
@@ -288,12 +323,14 @@ class SpringLayout(GraphLayout, TieringLayout):
         make the initial render of the graph more stable (i.e. nodes won't move by themselves) but it comes at a
         small performance cost. (default value: 100)
     :param tier_separation: Separation force between tiers (default value: 300)
+    :param group_repel_strength: Strength of repulsion force between groups (default value: 2000)
     """
 
-    layout_type: GraphLayoutType = Field(default=GraphLayoutType.SPRING, const=True)
+    layout_type: GraphLayoutType = Field(default=GraphLayoutType.SPRING, frozen=True)
 
-    collision_force: Optional[Number] = 2
-    gravity: Optional[Number] = -50
-    link_force: Optional[Number] = 5
-    warmup_ticks: Optional[Number] = 100
-    tier_separation: Optional[Number] = 300
+    collision_force: Number | None = 2
+    gravity: Number | None = -50
+    link_force: Number | None = 5
+    warmup_ticks: Number | None = 100
+    tier_separation: Number | None = 300
+    group_repel_strength: Number | None = 2000

dara/components/plotting/__init__.py

@@ -14,8 +14,9 @@ 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.
 """
+# ruff: noqa: F401, F403
 
-import dara.components.plotting.palettes as PALETTES  # pylint: disable=unused-import
+import dara.components.plotting.palettes as PALETTES
 from dara.components.plotting.bokeh import *
 from dara.components.plotting.matplotlib import *
 from dara.components.plotting.plotly import *

dara/components/plotting/bokeh/bokeh.py

@@ -16,10 +16,11 @@ limitations under the License.
 """
 
 from json import dumps
-from typing import Any, List, Optional, Tuple
+from typing import Any
 
 from bokeh.document import Document
 from bokeh.themes import Theme
+from pydantic import ConfigDict
 
 from dara.components.plotting.bokeh.themes import light_theme
 from dara.core.base_definitions import Action
@@ -28,7 +29,7 @@ from dara.core.definitions import StyledComponentInstance
 SETTINGS = {'THEME': light_theme}
 
 
-def _get_theme(theme_input: Optional[dict]):
+def _get_theme(theme_input: dict | None):
     if theme_input is not None:
         return Theme(json=theme_input)
     else:
@@ -51,19 +52,16 @@ class Bokeh(StyledComponentInstance):
     js_module = '@darajs/components'
 
     document: str
-    events: Optional[List[Tuple[str, Action]]] = None
+    events: list[tuple[str, Action]] | None = None
 
-    class Config:
-        arbitrary_types_allowed = True
-        json_encoders = {Document: lambda v: v.to_json()}
-        use_enum_values = True
+    model_config = ConfigDict(arbitrary_types_allowed=True, use_enum_values=True)
 
     def __init__(
         self,
         figure: Any = None,
         document: Any = None,
-        theme: Optional[dict] = None,
-        events: Optional[List[Tuple[str, Action]]] = None,
+        theme: dict | None = None,
+        events: list[tuple[str, Action]] | None = None,
         **kwargs,
     ):
         """
@@ -71,7 +69,6 @@ class Bokeh(StyledComponentInstance):
         :param document: the document to display
         """
         if figure is not None:
-
             doc = Document()
             doc.theme = _get_theme(theme)
             doc.add_root(figure)

dara/components/plotting/bokeh/utils.py

@@ -35,21 +35,23 @@ def figure_events(fig: figure):
         :param
         """
 
-        def generate_event(args: dict = {}):
+        def generate_event(args: dict | None = None):
             """
             Generate a CustomJS event with the code, event name and arguments provided
 
             :param args: The arguments to provide to the JS code
             """
+            if args is None:
+                args = {}
             return CustomJS(
                 args=args,
                 code=f"""
-                function {event_name.replace(' ','')+'__'+fig.id}(cb_obj, args) {{
+                function {event_name.replace(' ', '') + '__' + fig.id}(cb_obj, args) {{
                     {code}
                 }}
 
                 document.dispatchEvent(
-                    new CustomEvent("BOKEH_FIGURE_{event_name}_{fig.id}", {{ detail: {event_name.replace(' ','')+'__'+fig.id}(cb_obj, {{{','.join(args.keys())}}}) }})
+                    new CustomEvent("BOKEH_FIGURE_{event_name}_{fig.id}", {{ detail: {event_name.replace(' ', '') + '__' + fig.id}(cb_obj, {{{','.join(args.keys())}}}) }})
                 )
                 """,
             )

dara/components/plotting/plotly/plotly.py

@@ -16,17 +16,27 @@ limitations under the License.
 """
 
 from enum import Enum
-from typing import Any, List, Optional
+from typing import Any, ClassVar
 
 import plotly.graph_objects as go
-from pydantic import BaseModel
+import plotly.io as pio
+from pydantic import ConfigDict
 
 from dara.components.plotting.plotly.themes import light_theme
 from dara.core.base_definitions import Action
+from dara.core.base_definitions import DaraBaseModel as BaseModel
 from dara.core.definitions import StyledComponentInstance
 
 SETTINGS = {'THEME': light_theme}
 
+# We need to set the default theme for plotly so that plotly express when setting traces is able to pick up dara theme colors
+base_template = pio.templates['plotly']
+dara_theme = base_template.layout.update(SETTINGS['THEME']['layout'])  # type: ignore
+dara_template = go.layout.Template(layout=dara_theme)
+# Set the default theme for plotly
+pio.templates['dara_theme'] = dara_template
+pio.templates.default = 'dara_theme'
+
 
 class PlotlyEventName(str, Enum):
     """
@@ -70,8 +80,8 @@ class PlotlyEvent(BaseModel):
     """
 
     event_name: PlotlyEventName
-    actions: Optional[List[Action]] = None
-    custom_js: Optional[str] = None
+    actions: list[Action] | None = None
+    custom_js: str | None = None
 
 
 class Plotly(StyledComponentInstance):
@@ -91,12 +101,8 @@ class Plotly(StyledComponentInstance):
     fig = px.scatter(df, x='sepal_width', y='sepal_length', color='species', title='Iris Dataset Scatter Plot')
 
 
-    def plotly_page():
-        return Plotly(figure=fig, min_height=100)
-
-
     config = ConfigurationBuilder()
-    config.add_page(name='MyPlot', content=plotly_page())
+    config.router.add_page(path='my-plot', content=Plotly(figure=fig, min_height=100))
     ```
 
     :param figure: A plotly figure
@@ -106,24 +112,23 @@ class Plotly(StyledComponentInstance):
     js_module = '@darajs/components'
 
     figure: str
-    events: Optional[List[PlotlyEvent]] = None
+    events: list[PlotlyEvent] | None = None
 
-    EventName = PlotlyEventName
-    Event = PlotlyEvent
+    EventName: ClassVar[type[PlotlyEventName]] = PlotlyEventName
+    Event: ClassVar[type[PlotlyEvent]] = PlotlyEvent
 
-    class Config:
-        arbitrary_types_allowed = True
-        json_encoders = {go.Figure: lambda v: v.to_json()}
-        use_enum_values = True
+    model_config = ConfigDict(
+        arbitrary_types_allowed=True,
+        use_enum_values=True,
+    )
 
     def __init__(
         self,
         figure: Any = None,
-        theme: Optional[dict] = None,
-        events: Optional[List[PlotlyEvent]] = None,
+        theme: dict | None = None,
+        events: list[PlotlyEvent] | None = None,
         **kwargs,
     ):
-
         if theme is None and figure is not None:
             figure.update_layout(template=theme if theme is not None else SETTINGS['THEME'])
 

dara/components/plotting/plotly/themes.py

@@ -15,15 +15,17 @@ See the License for the specific language governing permissions and
 limitations under the License.
 """
 
-from typing import Any, Dict
+from typing import Any
 
 from dara.components.plotting.palettes import CategoricalDark10, CategoricalLight10
 from dara.core.visual.themes import dark, light
 
 light_colors = light.Light.colors
+assert light_colors is not None
 dark_colors = dark.Dark.colors
+assert dark_colors is not None
 
-light_theme = {
+light_theme: dict[str, dict[str, Any]] = {
     'layout': {
         'paper_bgcolor': 'rgba(255,255,255,0)',  # Set the background color of the plot
         'plot_bgcolor': 'rgba(255,255,255,0)',  # Set the background color of the plot area
@@ -81,9 +83,9 @@ light_theme = {
             },
         },
     },
-}  # type: Dict[str, Dict[str, Any]]
+}
 
-dark_theme = {
+dark_theme: dict[str, dict[str, Any]] = {
     'layout': {
         'paper_bgcolor': 'rgba(255,255,255,0)',  # Set the background color of the plot
         'plot_bgcolor': 'rgba(255,255,255,0)',  # Set the background color of the plot area
@@ -141,4 +143,4 @@ dark_theme = {
             },
         },
     },
-}   # type: Dict[str, Dict[str, Any]]
+}

dara/components/smart/__init__.py

@@ -14,16 +14,22 @@ 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.
 """
+# ruff: noqa: F401, F403
 
 from dara.components.smart.chat import Chat
 from dara.components.smart.code_editor import CodeEditor, run_script
-from dara.components.smart.data_slicer import DataSlicer, DataSlicerModal
+from dara.components.smart.data_slicer import (
+    DataSlicer,
+    DataSlicerModal,
+    FilterStatusButton,
+)
 from dara.components.smart.hierarchy import HierarchySelector, HierarchyViewer
 from dara.components.smart.hierarchy import Node as HierarchyNode
 
 __all__ = [
     'DataSlicer',
     'DataSlicerModal',
+    'FilterStatusButton',
     'HierarchySelector',
     'HierarchyViewer',
     'HierarchyNode',

dara/components/smart/chat/chat.py

@@ -15,7 +15,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 """
 
-from pydantic import validator
+from pydantic import field_validator
 
 from dara.components.smart.chat.endpoints import on_new_message
 from dara.core.definitions import StyledComponentInstance
@@ -25,6 +25,8 @@ from dara.core.persistence import BackendStore
 
 class Chat(StyledComponentInstance):
     """
+    ![Chat](../../../../../docs/packages/dara-components/common/assets/Chat.png)
+
     A Chat component which can be added anywhere in your page. When added a chat button will appear in the bottom right
     of your page and when clicked a chat sidebar will appear. This can be added on a page by page basis, with the chat
     state being store in a Variable.
@@ -48,8 +50,8 @@ class Chat(StyledComponentInstance):
     config.add_auth(MultiBasicAuthConfig(users={'user': 'password', 'user2': 'password2'}))
 
     # Add a page with a chat component, this can be added anywhere within a page
-    config.add_page(
-        name='Chat Page',
+    config.router.add_page(
+        path='chat',
         content=Stack(
             Text('This is a page with a chat'),
             Chat(value=collab_variable),
@@ -65,12 +67,9 @@ class Chat(StyledComponentInstance):
 
     value: NonDataVariable
 
-    class Config:
-        extra = 'forbid'
-
-    @validator('value')
+    @field_validator('value')
     @classmethod
-    def validate_vaeiable(cls, value):
+    def validate_variable(cls, value):
         """
         Validate that the Variable has a store attached to it.
         """

dara/components/smart/chat/config.py

@@ -2,7 +2,7 @@
 Copyright (c) 2023 by Impulse Innovations Ltd. Private and confidential. Part of the causaLens product.
 """
 
-from typing import Callable
+from collections.abc import Callable
 
 from dara.components.smart.chat.types import NewMessageBody
 from dara.core.definitions import EndpointConfiguration

dara/components/smart/chat/types.py

@@ -2,9 +2,7 @@
 Copyright (c) 2023 by Impulse Innovations Ltd. Private and confidential. Part of the causaLens product.
 """
 
-from typing import List, Optional
-
-from pydantic import BaseModel
+from dara.core.base_definitions import DaraBaseModel as BaseModel
 
 
 class ChatUserData(BaseModel):
@@ -17,9 +15,9 @@ class ChatUserData(BaseModel):
     :param groups: list of groups user belongs to
     """
 
-    id: Optional[str] = None
+    id: str | None = None
     name: str
-    email: Optional[str] = None
+    email: str | None = None
 
 
 class ChatMessage(BaseModel):
@@ -50,5 +48,5 @@ class NewMessageBody(BaseModel):
     """
 
     app_url: str
-    users: List[ChatUserData]
+    users: list[ChatUserData]
     content: ChatMessage

dara/components/smart/code_editor/code_editor.py

@@ -15,20 +15,34 @@ See the License for the specific language governing permissions and
 limitations under the License.
 """
 
+from typing import Literal
+
 from dara.core.definitions import StyledComponentInstance
-from dara.core.interactivity import NonDataVariable
+from dara.core.interactivity import ClientVariable
 
 
 class CodeEditor(StyledComponentInstance):
     """
     A code editor component.
 
+    Example usage:
+
+    ```python
+    from dara.components.smart.code_editor import CodeEditor
+
+    script = Variable('print("Hello, World!")')
+
+    code_editor = CodeEditor(
+        script=script,
+        language='python'
+    )
+    ```
+
     :param script: The script to render
     """
 
     js_module = '@darajs/components'
 
-    script: NonDataVariable
+    script: ClientVariable
 
-    class Config:
-        extra = 'forbid'
+    language: Literal['json'] | Literal['python'] | Literal['markdown'] | Literal['sql'] | None = None