MessageDispatcher

Class to dispatch messages to observers. It has a built in buffer to merge messages and dispatch them in a single call to the observers.

:return: description :rtype: type

Attributes

interval_time_dispatched_buffer: floatinterval_time_merging_message: floatmessage_level: MessageLevelprefix: str

Functions

__init__

Initialize self. See help(type(self)) for accurate signature.

interval_time_merging_message : float - 0.1

interval_time_dispatched_buffer : int - 1

log_level : MessageLevel - INFO

prefix : str

parent_dispatcher : MessageDispatcher

attach

Attach the listener method and return an id to detach it later

observer : MessageObserver

attach_progress_bar

Attach a progress bar to update task messages when a message is sent. return an id to detach it later

progress_bar : ProgressBar

Return type : ProgressBarMessageObserver

create_sub_dispatcher

Create a sub dispatcher with the same configuration as the current dispatcher. The message will be forwarded to the parent dispatcher after prefix and log level modification. This is useful to override the prefix or the log level for a specific part of the code without affecting the parent dispatcher.

log_level : gws_core.core.classes.observer.message_level.MessageLevel | None

prefix : str | None

detach

observer : MessageObserver

force_dispatch_waiting_messages

has_observers

has_parent_dispatcher

Return type : bool

notify_debug_message

Trigger a debug in each subscriber.

message : str

notify_error_message

Trigger a error in each subscriber.

message : str

notify_info_message

Trigger an info in each subscriber.

message : str

notify_message

Trigger a message in each subscriber.

message : DispatchedMessage

notify_message_with_format

Parse and trigger a message in each subscriber based on format prefix.

Supported formats:

[INFO] Message - Sends an info message
[WARNING] Message - Sends a warning message
[ERROR] Message - Sends an error message
[SUCCESS] Message - Sends a success message
[DEBUG] Message - Sends a debug message
[PROGRESS:XX] Message - Sends a progress message with value XX (0-100)

If no format prefix is found, the message is sent as an info message.

Examples:

"[INFO] Processing data" -> Info message
"[WARNING] Low memory" -> Warning message
"[PROGRESS:50] Half way done" -> Progress at 50% with message "Half way done"
"[PROGRESS:75.5] Almost complete" -> Progress at 75.5%
"Regular message" -> Info message (no prefix)

message : str

The formatted message string

notify_progress_value

Trigger an update in each subscriber.

progress : float

message : str

notify_success_message

Trigger a success in each subscriber.

message : str

notify_warning_message

Trigger a warning in each subscriber.

message : str

Have you developed a brick?