Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix multifile widget init #156

Merged
merged 2 commits into from
Dec 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ addopts = """
testpaths = "tests"
filterwarnings = [
"error",
'ignore:\n Sentinel is not a public part of the traitlets API:DeprecationWarning',
]

[tool.ruff]
Expand Down
9 changes: 9 additions & 0 deletions src/ess/reduce/widgets/_string_widget.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,15 @@ def value(self, value: str | None):


class MultiStringWidget(StringWidget):
def __init__(
self, description: str, value: tuple[str, ...] | None = None, **kwargs
):
# Special case handling to allow initialising with a single string
if not isinstance(value, str) and value is not None:
value = ', '.join(value)

super().__init__(description, value, **kwargs)

@property
def value(self) -> tuple[str, ...]:
v = super().value
Expand Down
56 changes: 55 additions & 1 deletion tests/widget_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,13 @@
import scipp as sc
from ipywidgets import FloatText, IntText

from ess.reduce.parameter import BinEdgesParameter, Parameter, parameter_registry
from ess.reduce.parameter import (
BinEdgesParameter,
FilenameParameter,
MultiFilenameParameter,
Parameter,
parameter_registry,
)
from ess.reduce.ui import ResultBox, WorkflowWidget, workflow_widget
from ess.reduce.widgets import OptionalWidget, SwitchWidget, create_parameter_widget
from ess.reduce.workflow import register_workflow, workflow_registry
Expand Down Expand Up @@ -423,3 +429,51 @@ def run_workflow():

ResultBox(run_workflow).run_button.click()
assert was_called


FilenameSampleRun = NewType('FilenameSampleRun', str)
parameter_registry[FilenameSampleRun] = FilenameParameter.from_type(
FilenameSampleRun, default="SampleRun.hdf"
)
MultiFilenameSampleRun = NewType('MultiFilenameSampleRun', list[str])
parameter_registry[MultiFilenameSampleRun] = MultiFilenameParameter.from_type(
MultiFilenameSampleRun, default=["file1.hdf", "file2.hdf"]
)
MultiFilenameBackgroundRun = NewType('MultiFilenameBackgroundRun', list[str])
parameter_registry[MultiFilenameBackgroundRun] = MultiFilenameParameter.from_type(
MultiFilenameBackgroundRun, default="background.hdf"
)


def filename_print_provider(fname: FilenameSampleRun) -> str:
return str(fname)


def multi_filename_print_provider(fnames: MultiFilenameSampleRun) -> list[str]:
return [str(fname) for fname in fnames]


def multi_filename_print_provider_bis(fnames: MultiFilenameBackgroundRun) -> list[str]:
return [str(fname) for fname in fnames]


def test_filename_widget_single() -> None:
widget = _ready_widget(providers=[filename_print_provider], output_selections=[str])
param_widget = _get_param_widget(widget, FilenameSampleRun)
assert param_widget.value == "SampleRun.hdf"


def test_filename_widget_multiple() -> None:
widget = _ready_widget(
providers=[multi_filename_print_provider], output_selections=[list[str]]
)
param_widget = _get_param_widget(widget, MultiFilenameSampleRun)
assert param_widget.value == ("file1.hdf", "file2.hdf")


def test_filename_widget_multiple_initialized_with_single_string() -> None:
widget = _ready_widget(
providers=[multi_filename_print_provider_bis], output_selections=[list[str]]
)
param_widget = _get_param_widget(widget, MultiFilenameBackgroundRun)
assert param_widget.value == ("background.hdf",)