Create taipy.gui.test

Author: FabienLelaquais

taipy/gui/state.py

@@ -311,4 +311,4 @@ def __getattr__(self, var_name: str) -> t.Any:
         )
 
     def _invoke_on_gui(self, method: t.Callable, *args):
-        return self.get_gui()._invoke_method(t.cast(str, self._get_placeholder("__state_id")), method, *args)
+        return self.get_gui()._invoke_method(t.cast(str, self._get_placeholder("__state_id")), method, *args)  # type: ignore[reportAttributeAccessIssue]

taipy/gui/mock/__init__.py renamed to taipy/gui/test/__init__.py

@@ -8,3 +8,5 @@
 # Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 # an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 # specific language governing permissions and limitations under the License.
+
+from .mock_state import MockState

taipy/gui/mock/mock_state.py renamed to taipy/gui/test/mock_state.py

@@ -15,14 +15,17 @@
 
 
 class MockState(State):
-    """A Mock implementation for `State`.
-    TODO
-    example of use:
-    ```py
+    """A mock version of the `State^` class that enables isolated testing of state updates.
+
+    This class can be used with the *unittest* or *pytest* Python test frameworks to test side
+    effects of changing the values of a state:
+
+    Ex:
+    ```python
     def test_callback():
-        ms = MockState(Gui(""), a = 1)
-        on_action(ms) # function to test
-        assert ms.a == 2
+        mock_state = MockState(Gui(""), a = 1)
+        on_action(mock_state)  # function to test
+        assert mock_state.a == 2
     ```
     """
 
@@ -60,3 +63,6 @@ def __exit__(self, exc_type, exc_value, traceback):
 
     def broadcast(self, name: str, value: t.Any):
         pass
+
+    def _invoke_on_gui(self, method: t.Callable, *args):
+        return method(self.get_gui(), *args)

tests/gui/mock/test_mock_state.py renamed to tests/gui/test/test_mock_state.py

@@ -12,7 +12,7 @@
 from unittest.mock import Mock
 
 from taipy.gui import Gui, State
-from taipy.gui.mock.mock_state import MockState
+from taipy.gui.test.mock_state import MockState
 from taipy.gui.utils import _MapDict
 
 
@@ -46,6 +46,7 @@ def test_write_attr():
     ms.a += 1
     assert ms.a == 3
 
+
 def test_dict():
     ms = MockState(Gui(""))
     a_dict = {"a": 1}
@@ -61,13 +62,15 @@ def test_write_context():
     ms["page"].b = 3
     assert ms["page"].b == 3
 
+
 def test_assign():
     ms = MockState(Gui(""), a=1)
     ms.assign("a", 2)
     assert ms.a == 2
     ms.assign("b", 1)
     assert ms.b == 1
 
+
 def test_refresh():
     ms = MockState(Gui(""), a=1)
     ms.refresh("a")
@@ -76,23 +79,27 @@ def test_refresh():
     ms.refresh("a")
     assert ms.a == 2
 
+
 def test_context_manager():
     with MockState(Gui(""), a=1) as ms:
         assert ms is not None
         ms.a = 2
     assert ms.a == 2
 
+
 def test_broadcast():
     ms = MockState(Gui(""), a=1)
     ms.broadcast("a", 2)
 
+
 def test_set_favicon():
     gui = Gui("")
     gui.set_favicon = Mock()
     ms = MockState(gui, a=1)
     ms.set_favicon("a_path")
     gui.set_favicon.assert_called_once()
 
+
 def test_callback():
     def on_action(state: State):
         state.assign("a", 2)
@@ -101,6 +108,7 @@ def on_action(state: State):
     on_action(ms)
     assert ms.a == 2
 
+
 def test_false():
     ms = MockState(Gui(""), a=False)
     assert ms.a is False

tests/gui_core/test_context_crud_scenario.py

@@ -15,7 +15,7 @@
 from taipy import Scope
 from taipy.core import DataNode, Scenario
 from taipy.core.data.pickle import PickleDataNode
-from taipy.gui.mock.mock_state import MockState
+from taipy.gui.test.mock_state import MockState
 from taipy.gui_core._context import _GuiCoreContext
 
 scenario_a = Scenario("scenario_a_config_id", None, {"a_prop": "a"})
@@ -35,9 +35,11 @@ def mock_core_get(entity_id):
         return datanode_b
     return None
 
+
 def mock_is_true(entity_id):
     return True
 
+
 class TestGuiCoreContext_crud_scenario:
     def test_crud_scenario_delete(self):
         gui_core_context = _GuiCoreContext(Mock())
@@ -48,7 +50,7 @@ def test_crud_scenario_delete(self):
         with (
             patch("taipy.gui_core._context.core_get", side_effect=mock_core_get),
             patch("taipy.gui_core._context.is_deletable", side_effect=mock_is_true),
-            patch("taipy.gui_core._context.core_delete", side_effect=mock_core_delete)
+            patch("taipy.gui_core._context.core_delete", side_effect=mock_core_delete),
         ):
             gui_core_context.crud_scenario(
                 state,