Add binding support for DataSelector (c7ec135a) · Commits · NDIP / Nova Packages / nova-trame

src/nova/trame/model/data_selector.py

+4 −7

Original line number	Diff line number	Diff line
		@@ -12,7 +12,6 @@ class DataSelectorState(BaseModel, validate_assignment=True):
		"""Selection state for identifying datafiles."""

		directory: str = Field(default="")
		subdirectory: str = Field(default="")
		extensions: List[str] = Field(default=[])
		prefix: str = Field(default="")

		@@ -20,9 +19,10 @@ class DataSelectorState(BaseModel, validate_assignment=True):
		class DataSelectorModel:
		"""Manages file system interactions for the DataSelector widget."""

		def __init__(self, state: DataSelectorState, directory: str, extensions: List[str], prefix: str) -> None:
		def __init__(self, state: DataSelectorState) -> None:
		self.state: DataSelectorState = state

		def set_binding_parameters(self, directory: str, extensions: List[str], prefix: str) -> None:
		self.state.directory = directory
		self.state.extensions = extensions
		self.state.prefix = prefix
		@@ -89,10 +89,7 @@ class DataSelectorModel:
		def get_datafiles_from_path(self, base_path: Path) -> List[str]:
		datafiles = []
		try:
		if self.state.prefix:
		datafile_path = base_path / self.state.prefix
		else:
		datafile_path = base_path / self.state.subdirectory

		for entry in os.scandir(datafile_path):
		if entry.is_file():
		@@ -113,4 +110,4 @@ class DataSelectorModel:
		return self.get_datafiles_from_path(base_path)

		def set_subdirectory(self, subdirectory_path: str) -> None:
		self.state.subdirectory = subdirectory_path
		self.state.prefix = subdirectory_path

src/nova/trame/view/components/data_selector.py

+108 −21

Original line number	Diff line number	Diff line
		"""View Implementation for DataSelector."""

		from asyncio import ensure_future, sleep
		from typing import Any, List, Optional, cast
		from pathlib import Path
		from typing import Any, List, Tuple, Union, cast

		from trame.app import get_server
		from trame.widgets import client, datagrid, html
		from trame.widgets import vuetify3 as vuetify
		from trame_server.core import State

		from nova.mvvm._internal.utils import rgetdictvalue, rsetdictvalue
		from nova.mvvm.trame_binding import TrameBinding
		from nova.trame.model.data_selector import DataSelectorModel, DataSelectorState
		from nova.trame.view.layouts import GridLayout, HBoxLayout, VBoxLayout
		@@ -17,38 +20,58 @@ from .input_field import InputField
		vuetify.enable_lab()


		# TODO: refactor
		def get_state_param(state: State, value: Union[Any, Tuple]) -> Any:
		if isinstance(value, tuple):
		return rgetdictvalue(state, value[0])

		return value


		def set_state_param(state: State, value: Union[Any, Tuple], new_value: Any = None) -> Any:
		with state:
		if isinstance(value, tuple):
		if new_value is not None:
		rsetdictvalue(state, value[0], new_value)
		elif len(value) > 1:
		rsetdictvalue(state, value[0], value[1])
		state.dirty(value[0].split(".")[0])

		return get_state_param(state, value)


		class DataSelector(datagrid.VGrid):
		"""Allows the user to select datafiles from the server."""

		def __init__(
		self,
		v_model: str,
		directory: str,
		extensions: Optional[List[str]] = None,
		prefix: str = "",
		refresh_rate: int = 30,
		select_strategy: str = "all",
		v_model: Union[str, Tuple],
		directory: Union[str, Tuple],
		extensions: Union[List[str], Tuple, None] = None,
		prefix: Union[str, Tuple] = "",
		refresh_rate: Union[int, Tuple] = 30,
		select_strategy: Union[str, Tuple] = "all",
		**kwargs: Any,
		) -> None:
		"""Constructor for DataSelector.

		Parameters
		----------
		v_model : str
		v_model : Union[str, Tuple]
		The name of the state variable to bind to this widget. The state variable will contain a list of the files
		selected by the user.
		directory : str
		directory : Union[str, Tuple]
		The top-level folder to expose to users. Only contents of this directory and its children will be exposed to
		users.
		extensions : List[str], optional
		extensions : Union[List[str], Tuple], optional
		A list of file extensions to restrict selection to. If unset, then all files will be shown.
		prefix : str, optional
		prefix : Union[str, Tuple], optional
		A subdirectory within the selected top-level folder to show files. If not specified, the user will be shown
		a folder browser and will be able to see all files in the selected top-level folder.
		refresh_rate : int, optional
		refresh_rate : Union[int, Tuple], optional
		The number of seconds between attempts to automatically refresh the file list. Set to zero to disable this
		feature. Defaults to 30 seconds.
		select_strategy : str, optional
		select_strategy : Union[str, Tuple], optional
		The selection strategy to pass to the `VDataTable component <https://trame.readthedocs.io/en/latest/trame.widgets.vuetify3.html#trame.widgets.vuetify3.VDataTable>`__.
		If unset, the `all` strategy will be used.
		**kwargs
		@@ -74,7 +97,10 @@ class DataSelector(datagrid.VGrid):
		self._label = None

		self._v_model = v_model
		if isinstance(v_model, str):
		self._v_model_name_in_state = v_model.split(".")[0]
		else:
		self._v_model_name_in_state = v_model[0].split(".")[0]
		self._directory = directory
		self._extensions = extensions if extensions is not None else []
		self._prefix = prefix
		@@ -94,11 +120,17 @@ class DataSelector(datagrid.VGrid):

		self.create_model()
		self.create_viewmodel()
		self.setup_binding_listeners()
		self._vm.update_view()

		self.create_ui(**kwargs)

		ensure_future(self._refresh_loop())

		@property
		def state(self) -> State:
		return get_server(None, client_type="vue3").state

		def create_ui(self, args: Any, *kwargs: Any) -> None:
		with VBoxLayout(classes="nova-data-selector", height="100%") as self._layout:
		with HBoxLayout(valign="center"):
		@@ -110,7 +142,13 @@ class DataSelector(datagrid.VGrid):
		vuetify.VTooltip("Refresh Contents", activator="parent")

		with GridLayout(columns=2, classes="flex-1-0 h-0", valign="start"):
		if not self._prefix:
		if isinstance(self._prefix, tuple) or not self._prefix:
		if self._prefix:
		initial_prefix = str(
		Path(get_state_param(self.state, self._directory))
		/ get_state_param(self.state, self._prefix)
		)
		print(initial_prefix)
		with html.Div(classes="d-flex flex-column h-100 overflow-hidden"):
		vuetify.VListSubheader("Available Directories", classes="flex-0-1 justify-center px-0")
		vuetify.VTreeview(
		@@ -122,7 +160,7 @@ class DataSelector(datagrid.VGrid):
		item_value="path",
		items=(self._directories_name,),
		click_open=(self._vm.expand_directory, "[$event.path]"),
		update_activated=(self._vm.set_subdirectory, "$event"),
		update_activated=(self.set_subdirectory, "$event"),
		)
		vuetify.VListItem("No directories found", classes="flex-0-1 text-center", v_else=True)

		@@ -185,7 +223,7 @@ class DataSelector(datagrid.VGrid):

		def create_model(self) -> None:
		state = DataSelectorState()
		self._model = DataSelectorModel(state, self._directory, self._extensions, self._prefix)
		self._model = DataSelectorModel(state)

		def create_viewmodel(self) -> None:
		server = get_server(None, client_type="vue3")
		@@ -197,8 +235,6 @@ class DataSelector(datagrid.VGrid):
		self._vm.datafiles_bind.connect(self._datafiles_name)
		self._vm.reset_bind.connect(self.reset)

		self._vm.update_view()

		def refresh_contents(self) -> None:
		self._vm.update_view(refresh_directories=True)

		@@ -206,16 +242,67 @@ class DataSelector(datagrid.VGrid):
		self._reset_state()
		self._reset_rv_grid()

		def set_subdirectory(self, subdirectory_path: str = "") -> None:
		set_state_param(self.state, self._prefix, subdirectory_path)
		self._vm.set_subdirectory(subdirectory_path)

		def set_state(self, args: Any, *kwargs: Any) -> None:
		raise TypeError(
		"The old DataSelector component has been renamed to NeutronDataSelector. Please import it from "
		"`nova.trame.view.components.ornl`."
		)

		def setup_binding_listeners(self) -> None:
		set_state_param(self.state, self._directory)
		set_state_param(self.state, self._extensions)
		set_state_param(self.state, self._prefix)

		self._vm.set_binding_parameters(
		get_state_param(self.state, self._directory),
		get_state_param(self.state, self._extensions),
		get_state_param(self.state, self._prefix),
		)
		if isinstance(self._prefix, tuple):
		self._prefix = (self._prefix[0],)

		if isinstance(self._directory, tuple):

		@self.state.change(self._directory[0])
		def on_directory_change(args: Any, *kwargs: Any) -> None:
		self._vm.set_binding_parameters(
		get_state_param(self.state, self._directory),
		get_state_param(self.state, self._extensions),
		get_state_param(self.state, self._prefix),
		)

		if isinstance(self._extensions, tuple):

		@self.state.change(self._extensions[0])
		def on_extensions_change(args: Any, *kwargs: Any) -> None:
		self._vm.set_binding_parameters(
		get_state_param(self.state, self._directory),
		get_state_param(self.state, self._extensions),
		get_state_param(self.state, self._prefix),
		)

		if isinstance(self._prefix, tuple):

		@self.state.change(self._prefix[0])
		def on_prefix_change(args: Any, *kwargs: Any) -> None:
		self._vm.set_binding_parameters(
		get_state_param(self.state, self._directory),
		get_state_param(self.state, self._extensions),
		get_state_param(self.state, self._prefix),
		)

		async def _refresh_loop(self) -> None:
		if self._refresh_rate > 0:
		refresh_rate: int = set_state_param(self.state, self._refresh_rate)

		if refresh_rate > 0:
		while True:
		await sleep(self._refresh_rate)
		await sleep(refresh_rate)

		self.refresh_contents()
		self.state.dirty(self._datafiles_name)

		refresh_rate = get_state_param(self.state, self._refresh_rate)

src/nova/trame/view/components/ornl/neutron_data_selector.py

+23 −17

Original line number	Diff line number	Diff line
		"""View Implementation for DataSelector."""

		from typing import Any, List, Optional
		from typing import Any, List, Optional, Tuple, Union
		from warnings import warn

		from trame.app import get_server
		@@ -26,39 +26,45 @@ class NeutronDataSelector(DataSelector):

		def __init__(
		self,
		v_model: str,
		allow_custom_directories: bool = False,
		facility: str = "",
		instrument: str = "",
		extensions: Optional[List[str]] = None,
		prefix: str = "",
		refresh_rate: int = 30,
		select_strategy: str = "all",
		v_model: Union[str, Tuple],
		allow_custom_directories: Union[bool, Tuple] = False,
		facility: Union[str, Tuple] = "",
		instrument: Union[str, Tuple] = "",
		experiment: Union[str, Tuple] = "",
		selected_directory: Union[str, Tuple] = "",
		extensions: Union[List[str], Tuple, None] = None,
		prefix: Union[str, Tuple] = "",
		refresh_rate: Union[int, Tuple] = 30,
		select_strategy: Union[str, Tuple] = "all",
		**kwargs: Any,
		) -> None:
		"""Constructor for DataSelector.

		Parameters
		----------
		v_model : str
		v_model : Union[str, Tuple]
		The name of the state variable to bind to this widget. The state variable will contain a list of the files
		selected by the user.
		allow_custom_directories : bool, optional
		allow_custom_directories : Union[bool, Tuple], optional
		Whether or not to allow users to provide their own directories to search for datafiles in. Ignored if the
		facility parameter is set.
		facility : str, optional
		facility : Union[str, Tuple], optional
		The facility to restrict data selection to. Options: HFIR, SNS
		instrument : str, optional
		instrument : Union[str, Tuple], optional
		The instrument to restrict data selection to. Please use the instrument acronym (e.g. CG-2).
		extensions : List[str], optional
		experiment : Union[str, Tuple], optional
		The experiment to restrict data selection to.
		selected_directory : Union[str, Tuple], optional
		The directory containing the visible datafiles.
		extensions : Union[List[str], Tuple], optional
		A list of file extensions to restrict selection to. If unset, then all files will be shown.
		prefix : str, optional
		prefix : Union[str, Tuple], optional
		A subdirectory within the user's chosen experiment to show files. If not specified, the user will be shown a
		folder browser and will be able to see all files in the experiment that they have access to.
		refresh_rate : int, optional
		refresh_rate : Union[str, Tuple], optional
		The number of seconds between attempts to automatically refresh the file list. Set to zero to disable this
		feature. Defaults to 30 seconds.
		select_strategy : str, optional
		select_strategy : Union[str, Tuple], optional
		The selection strategy to pass to the `VDataTable component <https://trame.readthedocs.io/en/latest/trame.widgets.vuetify3.html#trame.widgets.vuetify3.VDataTable>`__.
		If unset, the `all` strategy will be used.
		**kwargs

src/nova/trame/view_model/data_selector.py

+4 −0

Original line number	Diff line number	Diff line
		@@ -57,6 +57,10 @@ class DataSelectorViewModel:
		def on_state_updated(self, results: Dict[str, Any]) -> None:
		pass

		def set_binding_parameters(self, directory: str, extensions: List[str], prefix: str) -> None:
		self.model.set_binding_parameters(directory, extensions, prefix)
		self.update_view()

		def set_subdirectory(self, subdirectory_path: str = "") -> None:
		self.model.set_subdirectory(subdirectory_path)
		self.update_view()

tests/gallery/models/data_selector.py

+6 −0

Original line number	Diff line number	Diff line
		@@ -5,6 +5,12 @@ from typing import List
		from pydantic import BaseModel, Field


		class DataSelectorBindingTest(BaseModel):
		"""Model for testing binding parameters for DataSelector."""

		prefix: str = Field(default="")


		class DataSelectorState(BaseModel):
		"""Model for MVVM demo of DataSelector."""