Utilities

Taipy GUI provides a set of utility features that enhance application development. While not core structural elements like pages or visual components, these utilities offer useful interactions with the application environment.
They include features that provide user notifications for alerts and and simplify application testing.

Notifications

Taipy provides a way to inform users about ongoing actions through non-intrusive messages that do not disrupt user interaction.
A notification is a short message displayed as a small popup at the bottom of the page. The message’s urgency level is indicated by the popup’s color, and a close button () allows users to dismiss it manually.

Notifications can be triggered at any time using the notify() function to send temporary messages to users:

notify(state, "success", "Taipy up and running!")

This results in a notification appearing on the current page:

Success notification

By default, the notification remains visible for a duration controlled by the duration parameter in notify() or until the user closes it manually.

If browser permissions allow, notifications can also appear directly on the user’s desktop. This behavior is controlled by the system_notification configuration setting.

Permanent notifications

The duration of a notification’s visibility can be customized. By default, notifications remain on the screen for 3 seconds before disappearing. This default duration can be modified using the notification_duration configuration setting.

To make a notification permanent, set the duration parameter of the notify() function to 0:

notify(state, "info", "This is a permanent notification!", duration=0)

A permanent notification remains visible until the user clicks the close button.

Mocking State in unit tests

Taipy includes the MockState class to facilitate unit testing of stateful logic typically executed in response to user interactions or programmatic events in a GUI application (actions and callbacks). This can be used in frameworks like unittest or pytest.

MockState simulates a GUI state object, allowing you to test how your logic updates the application state without needing to launch an actual UI. This is especially useful for testing action callbacks, value assignments, and conditional logic in isolation.

You can create a MockState instance by calling it constructor:

MockState(gui: Gui, **initial_state_variables)

Where:

• gui is an instance of Gui, typically created with an empty or dummy page.
• **initial_state_variables: Keyword arguments representing the initial values of state variables.
  Each key indicates the name of a variable that is managed in the state, and values define the initial values of these variables.

Here is an example of how this can be used:

from taipy.gui import Gui
from taipy.gui.mock import MockState

def test_callback():
    def on_action(state: State):
        state.assign("my_var", "my_new_value")

    mock_state = MockState(Gui(""), my_var="my_value")
    on_action(mock_state)
    assert mock_state.my_var == "my_new_value"