rename ChecksLog to ChecksResult

src/scwidgets/check/__init__.py

@@ -5,12 +5,12 @@
     assert_shape,
     assert_type,
 )
-from ._check import AssertResult, Check, ChecksLog
+from ._check import AssertResult, Check, ChecksResult
 from ._widget_check_registry import CheckableWidget, CheckRegistry
 
 __all__ = [
     "Check",
-    "ChecksLog",
+    "ChecksResult",
     "AssertResult",
     "CheckRegistry",
     "CheckableWidget",

src/scwidgets/check/_check.py

@@ -181,7 +181,7 @@ def compute_outputs(self):
     def compute_and_set_references(self):
         self._outputs_references = self.compute_outputs()
 
-    def check_function(self) -> ChecksLog:
+    def check_function(self) -> ChecksResult:
         """
         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,
@@ -199,7 +199,7 @@ def check_function(self) -> ChecksLog:
                 f"[{len(self._inputs_parameters)} != {len(self._outputs_references)}]."
             )
 
-        check_result = ChecksLog()
+        check_result = ChecksResult()
         for i, input_parameters in enumerate(self._inputs_parameters):
             output = self._function_to_check(**input_parameters)
             if not (isinstance(output, tuple)):
@@ -263,7 +263,7 @@ def check_function(self) -> ChecksLog:
         return check_result
 
 
-class ChecksLog:
+class ChecksResult:
     def __init__(self):
         self._assert_results = []
         self._assert_names = []
@@ -286,7 +286,7 @@ def append(
         self._inputs_parameters.append(input_parameters)
         self._suppress_assert_messages.append(suppress_assert_message)
 
-    def extend(self, check_results: ChecksLog):
+    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)

src/scwidgets/check/_widget_check_registry.py

@@ -8,7 +8,7 @@
 from ipywidgets import Button, HBox, Layout, Output, VBox, Widget
 
 from .._utils import Formatter
-from ._check import Check, ChecksLog
+from ._check import Check, ChecksResult
 
 
 class CheckableWidget:
@@ -38,7 +38,7 @@ def compute_output_to_check(
         """
         raise NotImplementedError("compute_output_to_check has not been implemented")
 
-    def handle_checks_result(self, result: Union[ChecksLog, Exception]) -> None:
+    def handle_checks_result(self, result: Union[ChecksResult, Exception]) -> None:
         """
         Function that controls how results of the checks are handled.
         """
@@ -102,7 +102,7 @@ def compute_and_set_references(self):
 
         self._check_registry.compute_and_set_references(self)
 
-    def check(self) -> Union[ChecksLog, Exception]:
+    def check(self) -> Union[ChecksResult, Exception]:
         if self._check_registry is None:
             raise ValueError(
                 "No check registry given on initialization, " "check cannot be used"
@@ -235,9 +235,9 @@ 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[ChecksLog, Exception]:
+    def check_widget(self, widget: CheckableWidget) -> Union[ChecksResult, Exception]:
         try:
-            results = ChecksLog()
+            results = ChecksResult()
             for check in self._checks[widget]:
                 result = check.check_function()
                 results.extend(result)
@@ -249,9 +249,9 @@ def check_widget(self, widget: CheckableWidget) -> Union[ChecksLog, Exception]:
 
     def check_all_widgets(
         self,
-    ) -> OrderedDict[CheckableWidget, Union[ChecksLog, Exception]]:
+    ) -> OrderedDict[CheckableWidget, Union[ChecksResult, Exception]]:
         messages: OrderedDict[
-            CheckableWidget, Union[ChecksLog, Exception]
+            CheckableWidget, Union[ChecksResult, Exception]
         ] = OrderedDict()
         for widget in self._checks.keys():
             try:
@@ -285,7 +285,7 @@ def _on_click_check_all_widgets_button(self, change: dict):
                             )
                         )
                         raise widget_results
-                    elif isinstance(widget_results, ChecksLog):
+                    elif isinstance(widget_results, ChecksResult):
                         if widget_results.successful:
                             print(
                                 Formatter.color_success_message(

src/scwidgets/code/_widget_code_demo.py

@@ -11,7 +11,7 @@
 
 from .._utils import Formatter
 from ..answer import AnswerRegistry, AnswerWidget
-from ..check import Check, CheckableWidget, CheckRegistry, ChecksLog
+from ..check import Check, CheckableWidget, CheckRegistry, ChecksResult
 from ..cue import (
     CheckCueBox,
     CheckResetCueButton,
@@ -550,19 +550,19 @@ def _on_click_load_action(self) -> bool:
                 raise e
         return not (raised_error)
 
-    def check(self) -> Union[ChecksLog, Exception]:
+    def check(self) -> Union[ChecksResult, Exception]:
         self._output.clear_output(wait=True)
         return CheckableWidget.check(self)
 
     def compute_output_to_check(self, *args, **kwargs) -> Check.FunOutParamsT:
         return self.run_code(*args, **kwargs)
 
-    def handle_checks_result(self, result: Union[ChecksLog, Exception]):
+    def handle_checks_result(self, result: Union[ChecksResult, Exception]):
         self._output.clear_output(wait=True)
         with self._output:
             if isinstance(result, Exception):
                 raise result
-            elif isinstance(result, ChecksLog):
+            elif isinstance(result, ChecksResult):
                 if result.successful:
                     print(Formatter.color_success_message("Check was successful"))
                     print(Formatter.color_success_message("--------------------"))

tests/test_check.py

@@ -7,7 +7,7 @@
     Check,
     CheckableWidget,
     CheckRegistry,
-    ChecksLog,
+    ChecksResult,
     assert_numpy_allclose,
     assert_numpy_floating_sub_dtype,
     assert_shape,
@@ -186,7 +186,7 @@ def test_compute_and_set_references(self, check):
         check.compute_and_set_references()
         # now checks should be successful again
         result = check.check_function()
-        assert isinstance(result, ChecksLog)
+        assert isinstance(result, ChecksResult)
         assert result.successful
 
     @pytest.mark.parametrize(
@@ -200,7 +200,7 @@ def test_compute_and_set_references(self, check):
     )
     def test_failing_check_all_widgets(self, check):
         result = check.check_function()
-        assert isinstance(result, ChecksLog)
+        assert isinstance(result, ChecksResult)
         assert not (result.successful)
 
     def test_invalid_asserts_arguments_count(self):
@@ -286,15 +286,15 @@ def test_successful_check_all_widgets(self, checks):
         widgets_results = check_registry.check_all_widgets()
         nb_conducted_asserts = 0
         for result in widgets_results.values():
-            assert isinstance(result, ChecksLog)
+            assert isinstance(result, ChecksResult)
             assert result.successful
             nb_conducted_asserts += len(result.assert_results)
         assert nb_conducted_asserts == checkable_widget.nb_conducted_asserts
 
         assert len(checkable_widget.results) == len(checks)
         nb_conducted_asserts = 0
         for result in checkable_widget.results:
-            assert isinstance(result, ChecksLog)
+            assert isinstance(result, ChecksResult)
             assert result.successful
             nb_conducted_asserts += len(result.assert_results)
         assert nb_conducted_asserts == checkable_widget.nb_conducted_asserts
@@ -324,15 +324,15 @@ def test_compute_and_set_all_references(self, checks):
 
         nb_conducted_asserts = 0
         for result in widgets_results.values():
-            assert isinstance(result, ChecksLog)
+            assert isinstance(result, ChecksResult)
             assert result.successful
             nb_conducted_asserts += len(result.assert_results)
         assert nb_conducted_asserts == checkable_widget.nb_conducted_asserts
 
         nb_conducted_asserts = 0
         assert len(checkable_widget.results) == len(checks)
         for result in checkable_widget.results:
-            assert isinstance(result, ChecksLog)
+            assert isinstance(result, ChecksResult)
             assert result.successful
             nb_conducted_asserts += len(result.assert_results)
         assert nb_conducted_asserts == checkable_widget.nb_conducted_asserts
@@ -357,10 +357,10 @@ def test_failing_check_all_widgets(self, checks):
 
         widgets_results = check_registry.check_all_widgets()
         for result in widgets_results.values():
-            assert isinstance(result, ChecksLog)
+            assert isinstance(result, ChecksResult)
             assert not (result.successful)
 
         assert len(checkable_widget.results) == len(checks)
         for result in checkable_widget.results:
-            assert isinstance(result, ChecksLog)
+            assert isinstance(result, ChecksResult)
             assert not (result.successful)

tests/test_code.py

@@ -5,7 +5,7 @@
 from ipywidgets import fixed
 from widget_code_input.utils import CodeValidationError
 
-from scwidgets.check import Check, CheckRegistry, ChecksLog
+from scwidgets.check import Check, CheckRegistry, ChecksResult
 from scwidgets.code import CodeDemo, CodeInput
 from scwidgets.cue import CueObject
 
@@ -148,7 +148,7 @@ class TestCodeDemo:
     )
     def test_successful_check_widget(self, code_demo):
         result = code_demo.check()
-        assert isinstance(result, ChecksLog)
+        assert isinstance(result, ChecksResult)
         assert result.successful
         assert len(result.assert_results) == code_demo.nb_conducted_asserts
 
@@ -174,7 +174,7 @@ def test_compute_and_set_references(self, code_demo):
         code_demo.compute_and_set_references()
 
         result = code_demo.check()
-        assert isinstance(result, ChecksLog)
+        assert isinstance(result, ChecksResult)
         assert result.successful
         assert len(result.assert_results) == code_demo.nb_conducted_asserts