Move AbstractAction to vizro.actions

Author: antonymilne

vizro-core/examples/scratch_dev/app.py

@@ -7,6 +7,9 @@
 from vizro.actions import filter_interaction, export_data
 from vizro.models.types import capture
 
+# TODO NOW: move this
+from vizro.actions import AbstractAction
+
 df_gapminder = px.data.gapminder().query("year == 2007")
 
 page_1 = vm.Page(
@@ -74,6 +77,35 @@ def my_custom_action(points_data, controls):
     return card_1_text, card_2_text
 
 
+# from typing import Literal
+#
+#
+# class f(AbstractAction):
+#     type: Literal["f"] = "f"
+#     points_data: str
+#     swap: bool = False
+#
+#     def function(self, points_data, controls):
+#         """Custom action."""
+#         clicked_point = points_data["points"][0]
+#         x, y = clicked_point["x"], clicked_point["y"]
+#         species = clicked_point["customdata"][0]
+#         card_1_text = f"Clicked point has sepal length {x}, petal width {y}."
+#         card_2_text = f"Controls are `{controls}`"
+#         return card_1_text, card_2_text
+#
+#     @property
+#     def outputs(self):
+#         return (
+#             ["my_card_2.children", "my_card_1.children"] if self.swap else ["my_card_1.children", "my_card_2.children"]
+#         )
+#
+#
+# from vizro.models._action._actions_chain import ActionsChain
+#
+# # vm.Graph.add_type("actions", f)
+# # ActionsChain.add_type("actions", f)
+
 # @capture("action")
 # def my_custom_action():
 #     """Custom action."""
@@ -102,13 +134,14 @@ def my_custom_action(points_data, controls):
                 vm.Action(
                     function=my_custom_action("scatter_chart.clickData"),
                     # TODO NOW CHECK: make sure user-specified argument continues to take precedence
-                    # function=my_custom_action("scatter_chart.clickData", controls="my_card_1.children"),
-                    # TODO NOW CHECK: test to make sure this old way continues to work
-                    # function=my_custom_action(),
-                    # function=my_custom_action(t=4),
-                    # inputs=["scatter_chart.clickData"],
+                    #     # function=my_custom_action("scatter_chart.clickData", controls="my_card_1.children"),
+                    #     # TODO NOW CHECK: test to make sure this old way continues to work
+                    #     # function=my_custom_action(),
+                    #     # function=my_custom_action(t=4),
+                    #     # inputs=["scatter_chart.clickData"],
                     outputs=["my_card_1.children", "my_card_2.children"],
                 ),
+                # f(swap=True, points_data="scatter_chart.clickData")
             ],
         ),
         vm.Card(id="my_card_1", text="Click on a point on the above graph."),

vizro-core/examples/scratch_dev/notes.md

@@ -23,6 +23,7 @@
 
 TODO future: rename _on_page_load if desired and make _filter etc. public.
 Add deprecation warnings etc. for when legacy=True
+ActionsChain.add_type("actions", f) is needed as well as vm.Graph.add_type("actions", f). Remove ActionsChain and then this will be possible. Should you need to add_type at all though compared to just having AbstractAction as an allowed type? Probably yes.
 
 # Put in PR/docs
 

vizro-core/src/vizro/actions/__init__.py

@@ -1,7 +1,8 @@
+from vizro.actions._abstract_action import AbstractAction
 from vizro.actions._filter_action import _filter
-from vizro.actions._on_page_load_action import _on_page_load
+from vizro.actions._on_page_load import _on_page_load
 from vizro.actions._parameter_action import _parameter
-from vizro.actions.export_data_action import export_data
-from vizro.actions.filter_interaction_action import filter_interaction
+from vizro.actions._export_data import export_data
+from vizro.actions._filter_interaction import filter_interaction
 
-__all__ = ["export_data", "filter_interaction"]
+__all__ = ["AbstractAction", "export_data", "filter_interaction"]

vizro-core/src/vizro/actions/_abstract_action.py

@@ -0,0 +1,65 @@
+from __future__ import annotations
+
+import abc
+import inspect
+
+from vizro.models._action._action import IdProperty, _BaseAction
+
+
+class AbstractAction(_BaseAction, abc.ABC):
+    """AbstractAction to be inserted into `actions` of relevant component.
+
+    To use this class, you must subclass it and define `function` and `outputs` to make a concrete action class. All
+    built in actions follow this pattern, and it's also an option for user-defined acftions. This class is not
+    relevant for user-defined actions using @capture("action").
+
+    When subclassing, you can optionally define model fields. The handling of fields depends on whether it is also
+    present in the function signature:
+      - static arguments, e.g. file_format = "csv": model fields, not explicitly in function signature, go through self.
+        Uses self and not Dash State
+      - runtime arguments, e.g. arg_name="dropdown.value": model fields, explicitly in function signature. Uses Dash
+        State
+      - built in runtime arguments, e.g. controls: not model fields, explicitly in function signature. Uses Dash State
+    """
+
+    _legacy = False
+
+    # TODO NOW COMMENT: Check schema and make sure these don't appear, comment on importance of this.
+
+    # TODO NOW: make keyword args only? What are actual limitations here? Don't worry much about it.
+    @abc.abstractmethod
+    def function(self, *args, **kwargs):
+        """Function that must be defined by concrete action."""
+        pass
+
+    @property
+    @abc.abstractmethod
+    def outputs(self) -> dict[str, IdProperty]:
+        """Must be defined by concrete action, even if there's no output."""
+        # TODO NOW OR IN FUTURE: handle list[str], align with Action. Maybe allow more deeply nested things too.
+        # TODO NOW: should it handle dictionary ids too? Currently this needs overriding _get_outputs. Pattern matching
+        # probably not needed for outputs and only for built-in inputs. Even if add more functionality here in future
+        # we shoulod still at least the support same as Action.output so it's easy for someone to move from a function
+        # action to a class one. In future we'd even like to just allow specifying the component id without the property.
+
+        # Maybe there will be some special built-in behaviour here e.g. to generate outputs automatically from
+        # certain reserved arguments like self.targets. Would need to make sure it's not breaking if someone already
+        # uses that variable name though.
+        pass
+
+    @property
+    def _parameters(self) -> set[str]:
+        # Note order of parameters doesn't matter since we always handle things with keyword arguments.
+        return set(inspect.signature(self.function).parameters)
+
+    @property
+    def _runtime_args(self) -> dict[str, IdProperty]:
+        # Since function is not a CapturedCallable, input arguments have not yet been bound. They correspond to the
+        # model fields that are present in the function signature. This is just the user-specified runtime arguments, as
+        # static arguments are not in the function signature (they're in self) and built in runtime arguments are not
+        # model fields. These will be of the form {"argument_name": "dropdown.value"}.
+        return {arg_name: getattr(self, arg_name) for arg_name in self.model_fields if arg_name in self._parameters}
+
+    @property
+    def _action_name(self):
+        return self.__class__.__name__

vizro-core/src/vizro/actions/_action_loop/_action_loop.py

@@ -41,7 +41,6 @@ def _build_actions_models():
             List of required components for each `Action` in the `Dashboard` e.g. list[dcc.Download]
 
         """
-
         return html.Div(
             [action.build() for action in cast(Iterable[_BaseAction], model_manager._get_models(_BaseAction))],
             id="app_action_models_components_div",

vizro-core/src/vizro/actions/_action_loop/_build_action_loop_callbacks.py

@@ -6,7 +6,6 @@
 
 from vizro.managers import model_manager
 from vizro.managers._model_manager import ModelID
-from vizro.models import Action
 from vizro.models._action._action import _BaseAction
 from vizro.models._action._actions_chain import ActionsChain
 

vizro-core/src/vizro/actions/_action_loop/_get_action_loop_components.py

@@ -3,9 +3,8 @@
 from dash import dcc, html
 
 from vizro.managers import model_manager
-from vizro.models import Action
-from vizro.models._action._actions_chain import ActionsChain
 from vizro.models._action._action import _BaseAction
+from vizro.models._action._actions_chain import ActionsChain
 
 
 def _get_action_loop_components() -> html.Div:

vizro-core/src/vizro/actions/_actions_utils.py

@@ -21,7 +21,7 @@
 )
 
 if TYPE_CHECKING:
-    from vizro.models import Action, VizroBaseModel
+    from vizro.models import VizroBaseModel
     from vizro.models.type import ActionsType
 
 ValidatedNoneValueType = Union[SingleValueType, MultiValueType, None, list[None], list[SingleValueType]]

vizro-core/src/vizro/actions/export_data_action.py vizro-core/src/vizro/actions/_export_data.py

@@ -1,23 +1,16 @@
 import importlib
-from typing import Any
+from collections.abc import Iterable
+from typing import Any, Literal, cast
 
-from dash import ctx, dcc
+from dash import Output, ctx, dcc
 from typing_extensions import Literal
 
+from vizro.actions import AbstractAction
 from vizro.actions._actions_utils import _apply_filters, _get_unfiltered_data
 from vizro.managers import model_manager
-from vizro.managers._model_manager import ModelID
-
-from collections.abc import Iterable
-from typing import Literal, cast
-
-from dash import Output
-
-from vizro.managers._model_manager import FIGURE_MODELS
+from vizro.managers._model_manager import FIGURE_MODELS, ModelID
 from vizro.models import VizroBaseModel
-from vizro.models._action._action import AbstractAction, Controls
-
-from typing import Literal
+from vizro.models._action._action import Controls
 
 
 # TODO NOW: check how schema for this is generated.

vizro-core/src/vizro/actions/_filter_action.py

@@ -1,14 +1,13 @@
-from typing import Any, Callable
+from typing import Any, Callable, Literal
 
 import pandas as pd
 from dash import ctx
 from pydantic import Field
 
+from vizro.actions import AbstractAction
 from vizro.actions._actions_utils import _get_modified_page_figures
 from vizro.managers._model_manager import ModelID, model_manager
-from vizro.models._action._action import AbstractAction, Controls
-
-from typing import Literal
+from vizro.models._action._action import Controls
 
 
 class _filter(AbstractAction):

vizro-core/src/vizro/actions/filter_interaction_action.py vizro-core/src/vizro/actions/_filter_interaction.py

@@ -1,13 +1,12 @@
-from typing import Any
+from typing import Any, Literal
 
 from dash import ctx
 from pydantic import Field
 
+from vizro.actions import AbstractAction
 from vizro.actions._actions_utils import _get_modified_page_figures
 from vizro.managers._model_manager import ModelID, model_manager
-from vizro.models._action._action import AbstractAction, Controls
-
-from typing import Literal
+from vizro.models._action._action import Controls
 
 
 class filter_interaction(AbstractAction):

vizro-core/src/vizro/actions/_on_page_load_action.py vizro-core/src/vizro/actions/_on_page_load.py

@@ -1,13 +1,12 @@
-from typing import Any
+from typing import Any, Literal
 
 from dash import ctx
 from pydantic import Field
 
+from vizro.actions import AbstractAction
 from vizro.actions._actions_utils import _get_modified_page_figures
 from vizro.managers._model_manager import ModelID, model_manager
-from vizro.models._action._action import AbstractAction, Controls
-
-from typing import Literal
+from vizro.models._action._action import Controls
 
 
 class _on_page_load(AbstractAction):

vizro-core/src/vizro/actions/_parameter_action.py

@@ -1,13 +1,12 @@
-from typing import Any
+from typing import Any, Literal
 
 from dash import ctx
 from pydantic import Field
 
+from vizro.actions import AbstractAction
 from vizro.actions._actions_utils import _get_modified_page_figures
 from vizro.managers._model_manager import ModelID, model_manager
-from vizro.models._action._action import AbstractAction, Controls
-
-from typing import Literal
+from vizro.models._action._action import Controls
 
 
 class _parameter(AbstractAction):

vizro-core/src/vizro/models/_action/_action.py

@@ -1,12 +1,11 @@
 from __future__ import annotations
 
 import inspect
-import abc
 import logging
 import re
 from collections.abc import Collection, Iterable, Mapping
 from pprint import pformat
-from typing import Annotated, Any, NewType, TypedDict, Union, cast, Callable
+from typing import Annotated, Any, Literal, NewType, TypedDict, Union, cast
 
 from dash import Input, Output, State, callback, html
 from dash.development.base_component import Component
@@ -16,9 +15,7 @@
 from vizro.managers._model_manager import ModelID, model_manager
 from vizro.models import VizroBaseModel
 from vizro.models._models_utils import _log_call
-from vizro.models.types import CapturedCallable, ControlType, capture, validate_captured_callable
-
-from typing import Literal
+from vizro.models.types import CapturedCallable, ControlType, validate_captured_callable
 
 logger = logging.getLogger(__name__)
 
@@ -37,7 +34,6 @@ class Controls(TypedDict):
     filter_interaction: list[dict[str, Any]]
 
 
-# TODO NOW: probably split into one model per file structure
 class _BaseAction(VizroBaseModel):
     def _get_control_states(self, control_type: ControlType) -> list[State]:
         """Gets list of `States` for selected `control_type` that appear on page where this Action is defined."""
@@ -322,62 +318,3 @@ def _runtime_args(self) -> dict[str, IdProperty]:
     @property
     def _action_name(self):
         return self.function._function.__name__
-
-
-class AbstractAction(_BaseAction, abc.ABC):
-    """AbstractAction to be inserted into `actions` of relevant component.
-
-    To use this class, you must subclass it and define `function` and `outputs` to make a concrete action class. All
-    built in actions follow this pattern, and it's also an option for user-defined acftions. This class is not
-    relevant for user-defined actions using @capture("action").
-
-    When subclassing, you can optionally define model fields. The handling of fields depends on whether it is also
-    present in the function signature:
-      - static arguments, e.g. file_format = "csv": model fields, not explicitly in function signature, go through self.
-        Uses self and not Dash State
-      - runtime arguments, e.g. arg_name="dropdown.value": model fields, explicitly in function signature. Uses Dash
-        State
-      - built in runtime arguments, e.g. controls: not model fields, explicitly in function signature. Uses Dash State
-    """
-
-    _legacy = False
-
-    # TODO NOW COMMENT: Check schema and make sure these don't appear, comment on importance of this.
-
-    # TODO NOW: make keyword args only? What are actual limitations here? Don't worry much about it.
-    @abc.abstractmethod
-    def function(self, *args, **kwargs):
-        """Function that must be defined by concrete action."""
-        pass
-
-    @property
-    @abc.abstractmethod
-    def outputs(self) -> dict[str, IdProperty]:
-        """Must be defined by concrete action, even if there's no output."""
-        # TODO NOW OR IN FUTURE: handle list[str], align with Action. Maybe allow more deeply nested things too.
-        # TODO NOW: should it handle dictionary ids too? Currently this needs overriding _get_outputs. Pattern matching
-        # probably not needed for outputs and only for built-in inputs. Even if add more functionality here in future
-        # we shoulod still at least the support same as Action.output so it's easy for someone to move from a function
-        # action to a class one. In future we'd even like to just allow specifying the component id without the property.
-
-        # Maybe there will be some special built-in behaviour here e.g. to generate outputs automatically from
-        # certain reserved arguments like self.targets. Would need to make sure it's not breaking if someone already
-        # uses that variable name though.
-        pass
-
-    @property
-    def _parameters(self) -> set[str]:
-        # Note order of parameters doesn't matter since we always handle things with keyword arguments.
-        return set(inspect.signature(self.function).parameters)
-
-    @property
-    def _runtime_args(self) -> dict[str, IdProperty]:
-        # Since function is not a CapturedCallable, input arguments have not yet been bound. They correspond to the
-        # model fields that are present in the function signature. This is just the user-specified runtime arguments, as
-        # static arguments are not in the function signature (they're in self) and built in runtime arguments are not
-        # model fields. These will be of the form {"argument_name": "dropdown.value"}.
-        return {arg_name: getattr(self, arg_name) for arg_name in self.model_fields if arg_name in self._parameters}
-
-    @property
-    def _action_name(self):
-        return self.__class__.__name__

vizro-core/src/vizro/models/_action/_actions_chain.py

@@ -4,7 +4,7 @@
 from pydantic import ValidationInfo
 
 from vizro.managers import model_manager
-from vizro.models import Action, VizroBaseModel
+from vizro.models import VizroBaseModel
 from vizro.models.types import ActionsType