Back to just Input, State, Output

Author: forman

dashipy/dashipy/__init__.py

@@ -1,6 +1,4 @@
 from .callback import Callback
-from .inputoutput import AppInput
-from .inputoutput import AppOutput
 from .inputoutput import Input
 from .inputoutput import Output
 from .inputoutput import State

dashipy/dashipy/callback.py

@@ -3,8 +3,6 @@
 from typing import Any, Callable
 
 from dashipy.inputoutput import (
-    AppInput,
-    AppOutput,
     Input,
     Output,
     State,
@@ -44,12 +42,12 @@ def from_decorator(
                 f" context parameter"
             )
 
-        inputs: list[Input | State | AppInput] = []
-        outputs: list[Output | AppOutput] = []
+        inputs: list[Input | State] = []
+        outputs: list[Output] = []
         for arg in decorator_args:
-            if isinstance(arg, (Input, State, AppInput)):
+            if isinstance(arg, (Input, State)):
                 inputs.append(arg)
-            elif outputs_allowed and isinstance(arg, (Output, AppOutput)):
+            elif outputs_allowed and isinstance(arg, Output):
                 outputs.append(arg)
             elif outputs_allowed:
                 raise TypeError(
@@ -81,8 +79,8 @@ def from_decorator(
     def __init__(
         self,
         function: Callable,
-        inputs: list[Input | State | AppInput],
-        outputs: list[Output | AppOutput],
+        inputs: list[Input | State],
+        outputs: list[Output],
         signature: inspect.Signature | None = None,
     ):
         """Private constructor.

dashipy/dashipy/inputoutput.py

@@ -1,5 +1,44 @@
 from abc import ABC
-from typing import Any
+from typing import Any, Literal
+
+from .util.assertions import assert_is_one_of
+from .util.assertions import assert_is_instance_of
+
+
+Source = Literal["component"] | Literal["container"] | Literal["app"]
+Target = Literal["component"] | Literal["container"] | Literal["app"]
+NoneType = type(None)
+
+
+# noinspection PyShadowingBuiltins
+def _validate_input(
+    source: str | None, id: str | None, property: str | None
+) -> tuple[str, str | None, str | None]:
+    return _validate_kind("source", source, id, property)
+
+
+# noinspection PyShadowingBuiltins
+def _validate_output(
+    target: str | None, id: str | None, property: str | None
+) -> tuple[str, str | None, str | None]:
+    return _validate_kind("target", target, id, property)
+
+
+# noinspection PyShadowingBuiltins
+def _validate_kind(
+    kind_name: str, kind: str | None, id: str | None, property: str | None
+) -> tuple[str, str | None, str | None]:
+    assert_is_one_of(kind_name, kind, ("component", "container", "app", None))
+    if not kind or kind == "component":
+        assert_is_instance_of("id", id, (str, NoneType))
+        assert_is_instance_of("property", id, (str, NoneType))
+        kind = kind or "component"
+        if property is None and id is not None:
+            property = "value"
+    else:
+        assert_is_instance_of("id", id, NoneType)
+        assert_is_instance_of("property", property, str)
+    return kind, id, property
 
 
 class InputOutput(ABC):
@@ -13,12 +52,14 @@ def __init__(
         self.property = property
 
     def to_dict(self) -> dict[str, Any]:
-        d = {"type": self.__class__.__name__}
-        d.update({
-            k: v
-            for k, v in self.__dict__.items()
-            if not k.startswith("_") and v is not None
-        })
+        d = {"class": self.__class__.__name__}
+        d.update(
+            {
+                k: v
+                for k, v in self.__dict__.items()
+                if not k.startswith("_") and v is not None
+            }
+        )
         return d
 
 
@@ -28,41 +69,42 @@ class Input(InputOutput):
     """
 
     # noinspection PyShadowingBuiltins
-    def __init__(self, id: str, property: str = "value"):
-        super().__init__(id, property)
+    def __init__(
+        self,
+        id: str | None = None,
+        property: str | None = None,
+        source: Source | None = None,
+    ):
+        source, id, property = _validate_input(source, id, property)
+        super().__init__(id=id, property=property)
+        self.source = source
 
 
-class State(InputOutput):
+class State(Input):
     """An input value read from component state.
     Does not trigger callback invocation.
     """
 
     # noinspection PyShadowingBuiltins
-    def __init__(self, id: str, property: str = "value"):
-        super().__init__(id, property)
+    def __init__(
+        self,
+        id: str | None = None,
+        property: str | None = None,
+        source: Source | None = None,
+    ):
+        super().__init__(id=id, property=property, source=source)
 
 
 class Output(InputOutput):
     """Callback output."""
 
     # noinspection PyShadowingBuiltins
-    def __init__(self, id: str, property: str = "value"):
-        super().__init__(id, property)
-
-
-class AppInput(InputOutput):
-    """An input value read from application state.
-    An application state change may trigger callback invocation.
-    """
-
-    # noinspection PyShadowingBuiltins
-    def __init__(self, property: str):
-        super().__init__(property=property)
-
-
-class AppOutput(InputOutput):
-    """An output written to application state."""
-
-    # noinspection PyShadowingBuiltins
-    def __init__(self, property: str):
-        super().__init__(property=property)
+    def __init__(
+        self,
+        id: str | None = None,
+        property: str | None = None,
+        target: Target | None = None,
+    ):
+        target, id, property = _validate_output(target, id, property)
+        super().__init__(id=id, property=property)
+        self.target = target

dashipy/dashipy/util/__init__.py

@@ -0,0 +1,15 @@
+from typing import Any, Container, Type
+
+
+def assert_is_one_of(name: str, value: Any, value_set: Container):
+    if value not in value_set:
+        raise ValueError(
+            f"value of {name!r} must be one of {value_set!r}, but was {value!r}"
+        )
+
+
+def assert_is_instance_of(name: str, value: Any, type_set: Type | tuple[Type, ...]):
+    if not isinstance(value, type_set):
+        raise ValueError(
+            f"value of {name!r} must be an instance of {type_set!r}, but was {value!r}"
+        )

dashipy/dashipy/util/assertions.py

@@ -1,7 +1,7 @@
 import altair as alt
 import pandas as pd
 
-from dashipy import Component, AppInput, Input, Output
+from dashipy import Component, Input, Output
 from dashipy.components import Plot, Box, Dropdown
 from dashipy.demo.contribs import Panel
 from dashipy.demo.context import Context
@@ -10,7 +10,7 @@
 panel = Panel(__name__, title="Panel B")
 
 
-@panel.layout(AppInput("selectedDatasetId"))
+@panel.layout(Input(property="selectedDatasetId", source="app"))
 def render_panel(
     ctx: Context,
     selected_dataset_id: str = "",
@@ -51,7 +51,7 @@ def render_panel(
 
 
 @panel.callback(
-    AppInput("selectedDatasetId"),
+    Input(property="selectedDatasetId", source="app"),
     Input("selected_variable_name"),
     Output("plot", "chart"),
 )
@@ -89,7 +89,7 @@ def make_figure(
 
 
 @panel.callback(
-    AppInput("selectedDatasetId"),
+    Input(property="selectedDatasetId", source="app"),
     Output("selected_variable_name", "options"),
     Output("selected_variable_name", "value"),
 )

dashipy/my_extension/my_panel_2.py

@@ -1,4 +1,4 @@
-from dashipy import Component, AppInput, Input, Output
+from dashipy import Component, Input, Output
 from dashipy.components import Box, Dropdown, Checkbox, Typography
 from dashipy.demo.contribs import Panel
 from dashipy.demo.context import Context
@@ -11,7 +11,7 @@
 
 
 @panel.layout(
-    AppInput("selectedDatasetId"),
+    Input(property="selectedDatasetId", source="app"),
 )
 def render_panel(
     ctx: Context,
@@ -53,7 +53,7 @@ def render_panel(
 
 # noinspection PyUnusedLocal
 @panel.callback(
-    AppInput(property="selectedDatasetId"),
+    Input("selectedDatasetId", source="app"),
     Input("opaque"),
     Input("color"),
     Output("info_text", "text"),

dashipy/my_extension/my_panel_3.py

@@ -1,9 +1,6 @@
 import json
 import unittest
 
-import plotly.graph_objects as go
-from plotly.graph_objs import Layout
-
 from dashipy.components import Box
 
 

dashipy/tests/components/box_test.py

@@ -1,22 +1,7 @@
-import json
 import unittest
 
-import plotly.graph_objects as go
-from plotly.graph_objs import Layout
-
-from dashipy.components import Plot
-
 
 class PlotTest(unittest.TestCase):
 
     def test_is_json_serializable(self):
-        figure = go.Figure(layout=Layout(title="Bar Chart", autosize=True))
-        figure.add_trace(go.Bar(x=["A", "B", "C"], y=[0.2, 0.3, 0.4]))
-        plot = Plot(figure=figure)
-
-        d = plot.to_dict()
-        self.assertIsInstance(d, dict)
-        self.assertIsInstance(d.get("figure"), dict)
-        json_text = json.dumps(d)
-        self.assertEqual("{", json_text[0])
-        self.assertEqual("}", json_text[-1])
+        pass

dashipy/tests/components/plot_test.py

@@ -0,0 +1,71 @@
+import unittest
+from typing import Type
+
+import pytest
+
+from dashipy.inputoutput import Input, State, Output
+
+
+def make_base():
+    class Base(unittest.TestCase):
+        kind_attr: str
+        cls: Type[Input] | Type[State] | Type[Output]
+
+        def kind(self, obj):
+            return getattr(obj, self.kind_attr)
+
+        def test_no_args(self):
+            obj = self.cls()
+            self.assertEqual("component", self.kind(obj))
+            self.assertEqual(None, obj.id)
+            self.assertEqual(None, obj.property)
+
+        def test_id_given(self):
+            obj = self.cls("dataset_select")
+            self.assertEqual("component", self.kind(obj))
+            self.assertEqual("dataset_select", obj.id)
+            self.assertEqual("value", obj.property)
+
+        def test_app(self):
+            obj = self.cls(property="datasetId", **{self.kind_attr: "app"})
+            self.assertEqual("app", self.kind(obj))
+            self.assertEqual(None, obj.id)
+            self.assertEqual("datasetId", obj.property)
+
+        def test_app_no_prop(self):
+            with pytest.raises(
+                ValueError,
+                match=(
+                    "value of 'property' must be an instance"
+                    " of <class 'str'>, but was None"
+                ),
+            ):
+                self.cls(**{self.kind_attr: "app"})
+
+        def test_wrong_kind(self):
+            with pytest.raises(
+                ValueError,
+                match=(
+                    f"value of '{self.kind_attr}' must be one of"
+                    f" \\('component', 'container', 'app', None\\),"
+                    f" but was 'host'"
+                ),
+            ):
+                self.cls(**{self.kind_attr: "host"})
+
+    return Base
+
+
+class InputTest(make_base(), unittest.TestCase):
+    cls = Input
+    kind_attr = "source"
+
+
+class StateTest(make_base(), unittest.TestCase):
+    cls = State
+    kind_attr = "source"
+
+
+class OutputTest(make_base(), unittest.TestCase):
+    cls = Output
+    kind_attr = "target"