Python side of Plot -> VegaChart

Author: forman

chartlets.js/CHANGES.md

@@ -1,8 +1,5 @@
 ## Version 0.1.0 (not started)
 
-* Allow for different chart providers:
-  - Rename `Plot` into `VegaChart`. 
-  - Only define `VegaChart` if `vega-altair` is installed.
 * Reorganise Chartlets project
   - Create `chartlets` GH org. 
   - Split current `chartlets` repo and move to `chartlets` org:
@@ -19,6 +16,10 @@
 
 ## Version 0.0.30 (in development)
 
+* Allow for different chart providers:
+  - Renamed `Plot` into `VegaChart`.
+  - `VegaChart` is defined only if `vega-altair` is installed.
+
 * The `Plot` component now respects a `theme` property. If not given,
   it will respect the current MUI theme mode `"dark"`. 
 

chartlets.py/CHANGES.md

@@ -1,3 +1,9 @@
+## Version 0.0.30 (in development)
+
+* Allow for different chart providers:
+  - Renamed `Plot` into `VegaChart`.
+  - `VegaChart` is defined only if `vega-altair` is installed.
+  
 * The `Plot` component now respects a `theme` property. If not given,
   it will respect the current MUI theme mode `"dark"`. 
 

chartlets.py/chartlets/components/__init__.py

@@ -6,6 +6,6 @@
 from .progress import CircularProgressWithLabel
 from .progress import LinearProgress
 from .progress import LinearProgressWithLabel
-from .plot import Plot
+from .charts.vega import VegaChart
 from .select import Select
 from .typography import Typography

chartlets.py/chartlets/components/charts/__init__.py

@@ -1,20 +1,25 @@
 from dataclasses import dataclass
 from typing import Any
 
-import altair as alt
+try:
+    # noinspection PyUnresolvedReferences
+    import altair
+    AltairChart = altair.Chart
+except ImportError:
+    AltairChart = type(None)
 
 from chartlets import Component
 
 
 @dataclass(frozen=True)
-class Plot(Component):
-    """The plot component is a container for a
+class VegaChart(Component):
+    """A container for a
     [Vega Altair](https://altair-viz.github.io/) chart."""
 
     theme: str | None = None
     """The name of a [Vega theme](https://vega.github.io/vega-themes/)."""
 
-    chart: alt.Chart | None = None
+    chart: AltairChart | None = None
     """The [Vega Altair chart](https://altair-viz.github.io/gallery/index.html)."""
 
     def to_dict(self) -> dict[str, Any]:

chartlets.py/chartlets/components/plot.py …s.py/chartlets/components/charts/vega.pychartlets.py/chartlets/components/plot.py renamed to chartlets.py/chartlets/components/charts/vega.py chartlets.py/chartlets/components/plot.py renamed to chartlets.py/chartlets/components/charts/vega.py

@@ -4,6 +4,7 @@ channels:
 dependencies:
   # Library Dependencies
   - python >=3.12,<3.13
+  # Optional Dependencies
   - altair
   # Demo Dependencies
   - pandas

chartlets.py/environment.yml

@@ -1,12 +1,9 @@
-import copy
-from types import NoneType
 from typing import Any
 
 import altair as alt
-import pandas as pd
 
 from chartlets import Component, Input, Output, State
-from chartlets.components import Plot, Box, Select
+from chartlets.components import VegaChart, Box, Select
 from chartlets.demo.contribs import Panel
 from chartlets.demo.context import Context
 
@@ -17,8 +14,8 @@
 @panel.layout()
 def render_panel(ctx: Context) -> Component:
     selected_dataset: int = 0
-    plot = Plot(
-        id="plot", chart=make_figure(ctx, selected_dataset), style={"flexGrow": 1}
+    chart = VegaChart(
+        id="chart", chart=make_chart(ctx, selected_dataset), style={"flexGrow": 1}
     )
     select = Select(
         id="selected_dataset",
@@ -44,15 +41,15 @@ def render_panel(ctx: Context) -> Component:
             "width": "100%",
             "height": "100%",
         },
-        children=[plot, control_group],
+        children=[chart, control_group],
     )
 
 
 @panel.callback(
     Input("selected_dataset"),
-    Output("plot", "chart"),
+    Output("chart", "chart"),
 )
-def make_figure(ctx: Context, selected_dataset: int = 0) -> alt.Chart:
+def make_chart(ctx: Context, selected_dataset: int = 0) -> alt.Chart:
     dataset_key = tuple(ctx.datasets.keys())[selected_dataset]
     dataset = ctx.datasets[dataset_key]
 
@@ -88,9 +85,9 @@ def make_figure(ctx: Context, selected_dataset: int = 0) -> alt.Chart:
 
 
 @panel.callback(
-    Input("plot", property="points"),
-    State("plot", "chart.encoding"),
-    Output("plot", "chart.encoding.color"),
+    Input("chart", property="points"),
+    State("chart", "chart.encoding"),
+    Output("chart", "chart.encoding.color"),
 )
 def get_click_event_points(
     ctx: Context, points: dict[str, Any], encoding: dict[str, Any]

chartlets.py/my_extension/my_panel_1.py

@@ -2,7 +2,7 @@
 import pandas as pd
 
 from chartlets import Component, Input, State, Output
-from chartlets.components import Plot, Box, Select
+from chartlets.components import VegaChart, Box, Select
 from chartlets.demo.contribs import Panel
 from chartlets.demo.context import Context
 
@@ -17,9 +17,9 @@ def render_panel(
 ) -> Component:
     dataset = ctx.datasets.get(selected_dataset_id)
     variable_names, var_name = get_variable_names(dataset)
-    plot = Plot(
-        id="plot",
-        chart=make_figure(ctx, selected_dataset_id, var_name),
+    chart = VegaChart(
+        id="chart",
+        chart=make_chart(ctx, selected_dataset_id, var_name),
         style={"flexGrow": 1},
     )
     select = Select(
@@ -46,16 +46,16 @@ def render_panel(
             "width": "100%",
             "height": "100%",
         },
-        children=[plot, control_group],
+        children=[chart, control_group],
     )
 
 
 @panel.callback(
     Input("@app", "selectedDatasetId"),
     Input("selected_variable_name"),
-    Output("plot", "chart"),
+    Output("chart", "chart"),
 )
-def make_figure(
+def make_chart(
     ctx: Context,
     selected_dataset_id: str | None = None,
     selected_variable_name: str | None = None,

chartlets.py/my_extension/my_panel_2.py

@@ -14,9 +14,7 @@ keywords = [
 ]
 license = {text = "MIT"}
 requires-python = ">=3.10"
-dependencies = [
-  "altair",
-]
+dependencies = []
 classifiers = [
   "Development Status :: 5 - Production/Stable",
   "Intended Audience :: Science/Research",
@@ -46,7 +44,11 @@ exclude = [
 ]
 
 [project.optional-dependencies]
+opt = [
+  "altair",
+]
 dev = [
+  "altair",
   "black",
   "flake8",
   "pytest",
@@ -63,6 +65,7 @@ doc = [
   "mkdocstrings-python"
 ]
 demo = [
+  "altair",
   "pyaml",
   "pandas",
   "tornado",