Skip to content

Results of checks are now collected before handling #64

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 24, 2024
Merged

Results of checks are now collected before handling #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions src/scwidgets/check/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
assert_shape,
assert_type,
)
from ._check import AssertResult, Check, ChecksResult
from ._check import AssertResult, Check, CheckResult
from ._widget_check_registry import CheckableWidget, CheckRegistry

__all__ = [
"Check",
"ChecksResult",
"CheckResult",
"AssertResult",
"CheckRegistry",
"CheckableWidget",
Expand Down
12 changes: 3 additions & 9 deletions src/scwidgets/check/_check.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ def compute_outputs(self):
def compute_and_set_references(self):
self._outputs_references = self.compute_outputs()

def check_function(self) -> ChecksResult:
def check_function(self) -> CheckResult:
"""
Returns for each input (first depth list) the result message for each assert
(second depth list). If a result message is empty, the assert was successful,
Expand All @@ -199,7 +199,7 @@ def check_function(self) -> ChecksResult:
f"[{len(self._inputs_parameters)} != {len(self._outputs_references)}]."
)

check_result = ChecksResult()
check_result = CheckResult()
for i, input_parameters in enumerate(self._inputs_parameters):
output = self._function_to_check(**input_parameters)
if not (isinstance(output, tuple)):
Expand Down Expand Up @@ -265,7 +265,7 @@ def check_function(self) -> ChecksResult:
return check_result


class ChecksResult:
class CheckResult:
def __init__(self):
self._assert_results = []
self._assert_names = []
Expand All @@ -288,12 +288,6 @@ def append(
self._inputs_parameters.append(input_parameters)
self._suppress_assert_messages.append(suppress_assert_message)

def extend(self, check_results: ChecksResult):
self._assert_results.extend(check_results._assert_results)
self._assert_names.extend(check_results._assert_names)
self._inputs_parameters.extend(check_results._inputs_parameters)
self._suppress_assert_messages.extend(check_results._suppress_assert_messages)

@property
def successful(self):
return (
Expand Down
100 changes: 59 additions & 41 deletions src/scwidgets/check/_widget_check_registry.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
from ipywidgets import Button, HBox, Layout, Output, VBox, Widget

from .._utils import Formatter
from ._check import Check, ChecksResult
from ._check import Check, CheckResult


class CheckableWidget:
Expand Down Expand Up @@ -38,7 +38,9 @@ def compute_output_to_check(
"""
raise NotImplementedError("compute_output_to_check has not been implemented")

def handle_checks_result(self, result: Union[ChecksResult, Exception]) -> None:
def handle_checks_result(
self, results: List[Union[CheckResult, Exception]]
) -> None:
"""
Function that controls how results of the checks are handled.
"""
Expand Down Expand Up @@ -102,7 +104,7 @@ def compute_and_set_references(self):

self._check_registry.compute_and_set_references(self)

def check(self) -> Union[ChecksResult, Exception]:
def check(self) -> List[Union[CheckResult, Exception]]:
if self._check_registry is None:
raise ValueError(
"No check registry given on initialization, " "check cannot be used"
Expand Down Expand Up @@ -220,44 +222,47 @@ def compute_and_set_references(self, widget: Widget):
try:
check.compute_and_set_references()
except Exception as exception:
widget.handle_checks_result(exception)
widget.handle_checks_result([exception])
raise exception

def compute_outputs(self, widget: CheckableWidget):
for check in self._checks[widget]:
try:
return check.compute_outputs()
except Exception as exception:
widget.handle_checks_result(exception)
widget.handle_checks_result([exception])
raise exception

def compute_and_set_all_references(self):
for widget in self._checks.keys():
self.compute_and_set_references(widget)

def check_widget(self, widget: CheckableWidget) -> Union[ChecksResult, Exception]:
def check_widget(
self, widget: CheckableWidget
) -> List[Union[CheckResult, Exception]]:
checks_result = []
try:
results = ChecksResult()
for check in self._checks[widget]:
result = check.check_function()
results.extend(result)
widget.handle_checks_result(result)
return results
checks_result.append(result)
widget.handle_checks_result(checks_result)
return checks_result
except Exception as exception:
widget.handle_checks_result(exception)
return exception
checks_result.append(exception)
widget.handle_checks_result(checks_result)
return checks_result

def check_all_widgets(
self,
) -> OrderedDict[CheckableWidget, Union[ChecksResult, Exception]]:
messages: OrderedDict[CheckableWidget, Union[ChecksResult, Exception]] = (
) -> OrderedDict[CheckableWidget, List[Union[CheckResult, Exception]]]:
messages: OrderedDict[CheckableWidget, List[Union[CheckResult, Exception]]] = (
OrderedDict()
)
for widget in self._checks.keys():
try:
messages[widget] = self.check_widget(widget)
except Exception as exception:
messages[widget] = exception
messages[widget] = [exception]
return messages

def _on_click_set_all_references_button(self, change: dict):
Expand All @@ -276,47 +281,60 @@ def _on_click_check_all_widgets_button(self, change: dict):
widgets_results = self.check_all_widgets()
for widget, widget_results in widgets_results.items():
with self._output:
if isinstance(widget_results, Exception):
if wrong_types := [
result
for result in widget_results
if not (
isinstance(result, Exception)
or isinstance(result, CheckResult)
)
]:
raise ValueError(
f"Not supported result type {type(wrong_types[0])}. "
"Only results of type `Exception` and `CheckResult` "
"are supported."
)
elif [
result
for result in widget_results
if isinstance(result, Exception)
]:
print(
Formatter.color_error_message(
Formatter.format_title_message(
f"Widget {self._names[widget]} " f"raised error:"
f"Widget {self._names[widget]} raised error."
)
)
)
raise widget_results
elif isinstance(widget_results, ChecksResult):
if widget_results.successful:
print(
Formatter.color_success_message(
Formatter.format_title_message(
f"Widget {self._names[widget]} all checks "
f"were successful"
)

elif not [
result
for result in widget_results
if isinstance(result, CheckResult) and not result.successful
]:
print(
Formatter.color_success_message(
Formatter.format_title_message(
f"Widget {self._names[widget]} all checks "
f"were successful."
)
)
print(widget_results.message())
else:
print(
Formatter.color_error_message(
Formatter.format_title_message(
f"Widget {self._names[widget]} not all checks "
"were successful:"
)
)
else:
print(
Formatter.color_error_message(
Formatter.format_title_message(
f"Widget {self._names[widget]} not all checks "
"were successful."
)
)
print(widget_results.message())
else:
raise ValueError(
f"Not supported result type {type(widget_results)}. "
"Only results of type `Exception` and `CheckResult` "
"are supported."
)
except Exception as exception:
with self._output:
print(
Formatter.color_error_message(
"Error raised while checking widgets:"
)
),
exception,
)
raise exception
41 changes: 24 additions & 17 deletions src/scwidgets/exercise/_widget_code_exercise.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
from widget_code_input.utils import CodeValidationError

from .._utils import Formatter
from ..check import Check, CheckableWidget, CheckRegistry, ChecksResult
from ..check import Check, CheckableWidget, CheckRegistry, CheckResult
from ..code._widget_code_input import CodeInput
from ..code._widget_parameter_panel import ParameterPanel
from ..cue import (
Expand Down Expand Up @@ -527,7 +527,7 @@ def _on_click_check_action(self) -> bool:
raised_error = False
with self._output:
try:
self.check()
self._check()
except Exception as e:
raised_error = True
if python_version() >= "3.11":
Expand Down Expand Up @@ -571,29 +571,35 @@ def _on_click_load_action(self) -> bool:
raise e
return not (raised_error)

def check(self) -> Union[ChecksResult, Exception]:
self._output.clear_output(wait=True)
def _check(self) -> List[Union[CheckResult, Exception]]:
return CheckableWidget.check(self)

def run_check(self) -> None:
if self._check_button is not None:
self._check_button.click()
else:
self._on_click_check_action()

def compute_output_to_check(self, *args, **kwargs) -> Check.FunOutParamsT:
return self.run_code(*args, **kwargs)

def handle_checks_result(self, result: Union[ChecksResult, Exception]):
def handle_checks_result(self, results: List[Union[CheckResult, Exception]]):
self._output.clear_output(wait=True)
with self._output:
if isinstance(result, Exception):
raise result
elif isinstance(result, ChecksResult):
if result.successful:
print(Formatter.color_success_message("Check was successful"))
print(Formatter.color_success_message("--------------------"))
print(result.message())
for result in results:
if isinstance(result, Exception):
raise result
elif isinstance(result, CheckResult):
if result.successful:
print(Formatter.color_success_message("Check was successful"))
print(Formatter.color_success_message("--------------------"))
print(result.message())
else:
print(Formatter.color_error_message("Check failed"))
print(Formatter.color_error_message("------------"))
print(result.message())
else:
print(Formatter.color_error_message("Check failed"))
print(Formatter.color_error_message("------------"))
print(result.message())
else:
print(result)
print(result)

def handle_save_result(self, result: Union[str, Exception]):
self._output.clear_output(wait=True)
Expand Down Expand Up @@ -671,6 +677,7 @@ def run_update(self):
parameter is changed
"""
if self._update_button is not None:
# to also invoke the reset cue action, we click the cued button
self._update_button.click()
else:
# we might be in update_mode "release" or "continuous" where no button is
Expand Down
Loading
Loading