dicogis.utils.notifier module

dicogis.utils.notifier.build_notification()

Build a notify-py notification with DicoGIS defaults (name, icon).

A new one per notification, rather than a module-level one: options such as the sound would otherwise carry over from one notification to the next.

Return type:

Notify | None

Returns:

notification, or None if no notification backend is available

dicogis.utils.notifier.send_system_notify(notification_message, notification_title, notification_sound=True)

Send a notification to the system.

Parameters:

  • notification_message (str) – notification message

  • notification_title (str) – notification title

  • notification_sound (bool) – play the DicoGIS notification sound. Defaults to True.

Return type:

None

dicogis.utils.notifier.sound_player_is_available()

Tell if notify-py can play a sound on this system.

notify-py relies on the system to play sounds on Windows and macOS, but on aplay (ALSA utilities) anywhere else, and fails the whole notification, not only its sound, when it’s missing.

Return type:

bool

Returns:

True if notify-py has what it needs to play a sound