pysepal.solara.notifications.notifier.Notifier#

class pysepal.solara.notifications.notifier.Notifier(bus)[source]#

Main publisher API for notifications.

Initialize notifier with a notification bus.

Methods

__init__

Initialize notifier with a notification bus.

cancel

Publish a cancellation toast (gray).

dismiss

Dismiss a toast by ID.

error

Publish an error toast.

info

Publish an info toast.

success

Publish a success toast.

track

Return a TaskTracker context manager for a long-running task.

warning

Publish a warning toast.
Parameters:

bus (NotificationBus)

Notifier.__init__(bus)[source]#

Initialize notifier with a notification bus.

Parameters:

bus (NotificationBus)

Notifier.cancel(message, *, timeout=None)[source]#

Publish a cancellation toast (gray). timeout overrides default.

Parameters:

  • message (str)

  • timeout (float | None)

Return type:

None

Notifier.dismiss(toast_id)[source]#

Dismiss a toast by ID.

Parameters:

toast_id (str)

Return type:

None

Notifier.error(message, *, timeout=None)[source]#

Publish an error toast. timeout overrides the per-type default.

Parameters:

  • message (str)

  • timeout (float | None)

Return type:

None

Notifier.info(message, *, timeout=None)[source]#

Publish an info toast. timeout overrides the per-type default.

Parameters:

  • message (str)

  • timeout (float | None)

Return type:

None

Notifier.success(message, *, timeout=None)[source]#

Publish a success toast. timeout overrides the per-type default.

Parameters:

  • message (str)

  • timeout (float | None)

Return type:

None

Notifier.track(title, total_steps=None)[source]#

Return a TaskTracker context manager for a long-running task.

Parameters:

  • title (str)

  • total_steps (int | None)

Return type:

_TaskTrackerContextManager

Notifier.warning(message, *, timeout=None)[source]#

Publish a warning toast. timeout overrides the per-type default.

Parameters:

  • message (str)

  • timeout (float | None)

Return type:

None