Skip to content

service

dev_tool.services.notification.service

Notification dataclass

A data class representing a single notification with expiration logic.

This class contains notification details including message, type, format, timing information, and display preferences.

message instance-attribute

notification_type instance-attribute

notification_format instance-attribute

timestamp instance-attribute

duration = 5.0 class-attribute instance-attribute

persistent = False class-attribute instance-attribute

show_prefix = False class-attribute instance-attribute

identifier = None class-attribute instance-attribute

expired property

A property that checks if notification has expired based on timestamp and duration.

Returns:

  • bool –

    True if the notification has expired, False otherwise.

remaining_time property

A property that calculates remaining display time for non-persistent notifications.

Returns:

  • float –

    The remaining time in seconds, or infinity for persistent notifications.

NotificationService

A thread-safe singleton service for managing application notifications.

This class provides centralized notification management with support for different notification types, formats, and lifecycle management.

The constructor for the NotificationService class.

Initializes the service with an empty notification list and thread safety.

Source code in dev_tool/services/notification/service.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
def __init__(self) -> None:
    """
    The constructor for the NotificationService class.

    Initializes the service with an empty notification list and thread safety.
    """

    if hasattr(self, '_initialized'):
        return

    self._initialized = True
    self._notifications = []
    self._lock = threading.Lock()

__new__

A class method that creates a singleton instance with thread safety.

Returns:

  • Self –

    The singleton NotificationService instance.

Source code in dev_tool/services/notification/service.py 
86
87
88
89
90
91
92
93
94
95
96
97
98
def __new__(cls) -> Self:
    """
    A class method that creates a singleton instance with thread safety.

    :return: The singleton NotificationService instance.
    """

    if cls._instance is None:
        with cls._lock:
            if cls._instance is None:
                cls._instance = super().__new__(cls)

    return cls._instance

add_notification

A method that adds a new notification to the active list.

Parameters:

  • message (str) –

    The notification message text.

  • notification_type (NotificationType, default: INFO ) –

    The type of notification for styling.

  • notification_format (NotificationFormat, default: BANNER ) –

    The display format for the notification.

  • duration (float, default: 5.0 ) –

    The display duration in seconds.

  • persistent (bool, default: False ) –

    Whether the notification should persist until dismissed.

  • show_prefix (bool, default: False ) –

    Whether to show the notification type prefix.

  • identifier (str | None, default: None ) –

    Optional identifier for targeted dismissal.

Source code in dev_tool/services/notification/service.py 
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
def add_notification(
    self,
    message: str,
    notification_type: NotificationType = NotificationType.INFO,
    notification_format: NotificationFormat = NotificationFormat.BANNER,
    duration: float = 5.0,
    persistent: bool = False,
    show_prefix: bool = False,
    identifier: str | None = None
) -> None:
    """
    A method that adds a new notification to the active list.

    :param message: The notification message text.
    :param notification_type: The type of notification for styling.
    :param notification_format: The display format for the notification.
    :param duration: The display duration in seconds.
    :param persistent: Whether the notification should persist until dismissed.
    :param show_prefix: Whether to show the notification type prefix.
    :param identifier: Optional identifier for targeted dismissal.
    """

    notification = Notification(
        message=message,
        notification_type=notification_type,
        notification_format=notification_format,
        timestamp=time.time(),
        duration=duration,
        persistent=persistent,
        show_prefix=show_prefix,
        identifier=identifier
    )

    with self._lock:
        self._notifications.append(notification)

clear

A method that removes all notifications from the active list.

Source code in dev_tool/services/notification/service.py 
136
137
138
139
140
def clear(self) -> None:
    """A method that removes all notifications from the active list."""

    with self._lock:
        self._notifications.clear()

dismiss

A method that removes a specific notification from the active list.

Parameters:

  • notification (Notification) –

    The notification object to remove.

Source code in dev_tool/services/notification/service.py 
142
143
144
145
146
147
148
149
150
151
def dismiss(self, notification: Notification) -> None:
    """
    A method that removes a specific notification from the active list.

    :param notification: The notification object to remove.
    """

    with self._lock:
        if notification in self._notifications:
            self._notifications.remove(notification)

dismiss_by_identifier

A method that removes notifications with a specific identifier.

Parameters:

  • identifier (str) –

    The identifier to match for removal.

Source code in dev_tool/services/notification/service.py 
153
154
155
156
157
158
159
160
161
162
163
164
def dismiss_by_identifier(self, identifier: str) -> None:
    """
    A method that removes notifications with a specific identifier.

    :param identifier: The identifier to match for removal.
    """

    with self._lock:
        self._notifications = [
            n for n in self._notifications
            if n.identifier != identifier
        ]

error

A method that adds an error notification with red styling.

Parameters:

  • message (str) –

    The error message text.

  • duration (float, default: 10.0 ) –

    The display duration in seconds.

  • persistent (bool, default: False ) –

    Whether the notification should persist until dismissed.

  • banner (bool, default: False ) –

    Whether to use banner format instead of text format.

  • show_prefix (bool, default: False ) –

    Whether to show the error prefix.

  • identifier (str | None, default: None ) –

    Optional identifier for targeted dismissal.

Source code in dev_tool/services/notification/service.py 
166
167
168
169
170
171
172
173
174
175
176
177
178
179
def error(self, message: str, duration: float = 10.0, persistent: bool = False, banner: bool = False, show_prefix: bool = False, identifier: str | None = None) -> None:
    """
    A method that adds an error notification with red styling.

    :param message: The error message text.
    :param duration: The display duration in seconds.
    :param persistent: Whether the notification should persist until dismissed.
    :param banner: Whether to use banner format instead of text format.
    :param show_prefix: Whether to show the error prefix.
    :param identifier: Optional identifier for targeted dismissal.
    """

    format_type = NotificationFormat.BANNER if banner else NotificationFormat.TEXT
    self.add_notification(message, NotificationType.ERROR, format_type, duration, persistent, show_prefix, identifier)

error_banner

A method that adds an error notification with banner format.

Parameters:

  • message (str) –

    The error message text.

  • duration (float, default: 10.0 ) –

    The display duration in seconds.

  • persistent (bool, default: False ) –

    Whether the notification should persist until dismissed.

  • show_prefix (bool, default: False ) –

    Whether to show the error prefix.

  • identifier (str | None, default: None ) –

    Optional identifier for targeted dismissal.

Source code in dev_tool/services/notification/service.py 
181
182
183
184
185
186
187
188
189
190
191
192
def error_banner(self, message: str, duration: float = 10.0, persistent: bool = False, show_prefix: bool = False, identifier: str | None = None) -> None:
    """
    A method that adds an error notification with banner format.

    :param message: The error message text.
    :param duration: The display duration in seconds.
    :param persistent: Whether the notification should persist until dismissed.
    :param show_prefix: Whether to show the error prefix.
    :param identifier: Optional identifier for targeted dismissal.
    """

    self.add_notification(message, NotificationType.ERROR, NotificationFormat.BANNER, duration, persistent, show_prefix, identifier)

error_text

A method that adds an error notification with text format.

Parameters:

  • message (str) –

    The error message text.

  • duration (float, default: 10.0 ) –

    The display duration in seconds.

  • persistent (bool, default: False ) –

    Whether the notification should persist until dismissed.

  • show_prefix (bool, default: False ) –

    Whether to show the error prefix.

  • identifier (str | None, default: None ) –

    Optional identifier for targeted dismissal.

Source code in dev_tool/services/notification/service.py 
194
195
196
197
198
199
200
201
202
203
204
205
def error_text(self, message: str, duration: float = 10.0, persistent: bool = False, show_prefix: bool = False, identifier: str | None = None) -> None:
    """
    A method that adds an error notification with text format.

    :param message: The error message text.
    :param duration: The display duration in seconds.
    :param persistent: Whether the notification should persist until dismissed.
    :param show_prefix: Whether to show the error prefix.
    :param identifier: Optional identifier for targeted dismissal.
    """

    self.add_notification(message, NotificationType.ERROR, NotificationFormat.TEXT, duration, persistent, show_prefix, identifier)

flush

A method that clears all active notifications.

Source code in dev_tool/services/notification/service.py 
207
208
209
210
211
def flush(self) -> None:
    """A method that clears all active notifications."""

    with self._lock:
        self._notifications.clear()

get_active

A method that gets active notifications and cleans up expired ones.

Returns:

Source code in dev_tool/services/notification/service.py 
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
def get_active(self) -> list[Notification]:
    """
    A method that gets active notifications and cleans up expired ones.

    :return: A list of active notification objects.
    """

    with self._lock:
        active = [
            notification
            for notification in self._notifications
            if not notification.expired
        ]

        self._notifications = active
        return active.copy()

info

A method that adds an info notification with blue styling.

Parameters:

  • message (str) –

    The info message text.

  • duration (float, default: 5.0 ) –

    The display duration in seconds.

  • persistent (bool, default: False ) –

    Whether the notification should persist until dismissed.

  • banner (bool, default: False ) –

    Whether to use banner format instead of text format.

  • show_prefix (bool, default: False ) –

    Whether to show the info prefix.

  • identifier (str | None, default: None ) –

    Optional identifier for targeted dismissal.

Source code in dev_tool/services/notification/service.py 
230
231
232
233
234
235
236
237
238
239
240
241
242
243
def info(self, message: str, duration: float = 5.0, persistent: bool = False, banner: bool = False, show_prefix: bool = False, identifier: str | None = None) -> None:
    """
    A method that adds an info notification with blue styling.

    :param message: The info message text.
    :param duration: The display duration in seconds.
    :param persistent: Whether the notification should persist until dismissed.
    :param banner: Whether to use banner format instead of text format.
    :param show_prefix: Whether to show the info prefix.
    :param identifier: Optional identifier for targeted dismissal.
    """

    format_type = NotificationFormat.BANNER if banner else NotificationFormat.TEXT
    self.add_notification(message, NotificationType.INFO, format_type, duration, persistent, show_prefix, identifier)

info_banner

A method that adds an info notification with banner format.

Parameters:

  • message (str) –

    The info message text.

  • duration (float, default: 5.0 ) –

    The display duration in seconds.

  • persistent (bool, default: False ) –

    Whether the notification should persist until dismissed.

  • show_prefix (bool, default: False ) –

    Whether to show the info prefix.

  • identifier (str | None, default: None ) –

    Optional identifier for targeted dismissal.

Source code in dev_tool/services/notification/service.py 
245
246
247
248
249
250
251
252
253
254
255
256
def info_banner(self, message: str, duration: float = 5.0, persistent: bool = False, show_prefix: bool = False, identifier: str | None = None) -> None:
    """
    A method that adds an info notification with banner format.

    :param message: The info message text.
    :param duration: The display duration in seconds.
    :param persistent: Whether the notification should persist until dismissed.
    :param show_prefix: Whether to show the info prefix.
    :param identifier: Optional identifier for targeted dismissal.
    """

    self.add_notification(message, NotificationType.INFO, NotificationFormat.BANNER, duration, persistent, show_prefix, identifier)

info_text

A method that adds an info notification with text format.

Parameters:

  • message (str) –

    The info message text.

  • duration (float, default: 5.0 ) –

    The display duration in seconds.

  • persistent (bool, default: False ) –

    Whether the notification should persist until dismissed.

  • show_prefix (bool, default: False ) –

    Whether to show the info prefix.

  • identifier (str | None, default: None ) –

    Optional identifier for targeted dismissal.

Source code in dev_tool/services/notification/service.py 
258
259
260
261
262
263
264
265
266
267
268
269
def info_text(self, message: str, duration: float = 5.0, persistent: bool = False, show_prefix: bool = False, identifier: str | None = None) -> None:
    """
    A method that adds an info notification with text format.

    :param message: The info message text.
    :param duration: The display duration in seconds.
    :param persistent: Whether the notification should persist until dismissed.
    :param show_prefix: Whether to show the info prefix.
    :param identifier: Optional identifier for targeted dismissal.
    """

    self.add_notification(message, NotificationType.INFO, NotificationFormat.TEXT, duration, persistent, show_prefix, identifier)

normal

A method that adds a normal notification with plain styling.

Parameters:

  • message (str) –

    The notification message text.

  • duration (float, default: 5.0 ) –

    The display duration in seconds.

  • persistent (bool, default: False ) –

    Whether the notification should persist until dismissed.

  • banner (bool, default: False ) –

    Whether to use banner format instead of text format.

  • show_prefix (bool, default: False ) –

    Whether to show the normal prefix.

  • identifier (str | None, default: None ) –

    Optional identifier for targeted dismissal.

Source code in dev_tool/services/notification/service.py 
271
272
273
274
275
276
277
278
279
280
281
282
283
284
def normal(self, message: str, duration: float = 5.0, persistent: bool = False, banner: bool = False, show_prefix: bool = False, identifier: str | None = None) -> None:
    """
    A method that adds a normal notification with plain styling.

    :param message: The notification message text.
    :param duration: The display duration in seconds.
    :param persistent: Whether the notification should persist until dismissed.
    :param banner: Whether to use banner format instead of text format.
    :param show_prefix: Whether to show the normal prefix.
    :param identifier: Optional identifier for targeted dismissal.
    """

    format_type = NotificationFormat.BANNER if banner else NotificationFormat.TEXT
    self.add_notification(message, NotificationType.NORMAL, format_type, duration, persistent, show_prefix, identifier)

normal_banner

A method that adds a normal notification with banner format.

Parameters:

  • message (str) –

    The notification message text.

  • duration (float, default: 5.0 ) –

    The display duration in seconds.

  • persistent (bool, default: False ) –

    Whether the notification should persist until dismissed.

  • show_prefix (bool, default: False ) –

    Whether to show the normal prefix.

  • identifier (str | None, default: None ) –

    Optional identifier for targeted dismissal.

Source code in dev_tool/services/notification/service.py 
286
287
288
289
290
291
292
293
294
295
296
297
def normal_banner(self, message: str, duration: float = 5.0, persistent: bool = False, show_prefix: bool = False, identifier: str | None = None) -> None:
    """
    A method that adds a normal notification with banner format.

    :param message: The notification message text.
    :param duration: The display duration in seconds.
    :param persistent: Whether the notification should persist until dismissed.
    :param show_prefix: Whether to show the normal prefix.
    :param identifier: Optional identifier for targeted dismissal.
    """

    self.add_notification(message, NotificationType.NORMAL, NotificationFormat.BANNER, duration, persistent, show_prefix, identifier)

normal_text

A method that adds a normal notification with text format.

Parameters:

  • message (str) –

    The notification message text.

  • duration (float, default: 5.0 ) –

    The display duration in seconds.

  • persistent (bool, default: False ) –

    Whether the notification should persist until dismissed.

  • show_prefix (bool, default: False ) –

    Whether to show the normal prefix.

  • identifier (str | None, default: None ) –

    Optional identifier for targeted dismissal.

Source code in dev_tool/services/notification/service.py 
299
300
301
302
303
304
305
306
307
308
309
310
def normal_text(self, message: str, duration: float = 5.0, persistent: bool = False, show_prefix: bool = False, identifier: str | None = None) -> None:
    """
    A method that adds a normal notification with text format.

    :param message: The notification message text.
    :param duration: The display duration in seconds.
    :param persistent: Whether the notification should persist until dismissed.
    :param show_prefix: Whether to show the normal prefix.
    :param identifier: Optional identifier for targeted dismissal.
    """

    self.add_notification(message, NotificationType.NORMAL, NotificationFormat.TEXT, duration, persistent, show_prefix, identifier)

success

A method that adds a success notification with green styling.

Parameters:

  • message (str) –

    The success message text.

  • duration (float, default: 3.0 ) –

    The display duration in seconds.

  • persistent (bool, default: False ) –

    Whether the notification should persist until dismissed.

  • banner (bool, default: False ) –

    Whether to use banner format instead of text format.

  • show_prefix (bool, default: False ) –

    Whether to show the success prefix.

  • identifier (str | None, default: None ) –

    Optional identifier for targeted dismissal.

Source code in dev_tool/services/notification/service.py 
312
313
314
315
316
317
318
319
320
321
322
323
324
325
def success(self, message: str, duration: float = 3.0, persistent: bool = False, banner: bool = False, show_prefix: bool = False, identifier: str | None = None) -> None:
    """
    A method that adds a success notification with green styling.

    :param message: The success message text.
    :param duration: The display duration in seconds.
    :param persistent: Whether the notification should persist until dismissed.
    :param banner: Whether to use banner format instead of text format.
    :param show_prefix: Whether to show the success prefix.
    :param identifier: Optional identifier for targeted dismissal.
    """

    format_type = NotificationFormat.BANNER if banner else NotificationFormat.TEXT
    self.add_notification(message, NotificationType.SUCCESS, format_type, duration, persistent, show_prefix, identifier)

success_banner

A method that adds a success notification with banner format.

Parameters:

  • message (str) –

    The success message text.

  • duration (float, default: 3.0 ) –

    The display duration in seconds.

  • persistent (bool, default: False ) –

    Whether the notification should persist until dismissed.

  • show_prefix (bool, default: False ) –

    Whether to show the success prefix.

  • identifier (str | None, default: None ) –

    Optional identifier for targeted dismissal.

Source code in dev_tool/services/notification/service.py 
327
328
329
330
331
332
333
334
335
336
337
338
def success_banner(self, message: str, duration: float = 3.0, persistent: bool = False, show_prefix: bool = False, identifier: str | None = None) -> None:
    """
    A method that adds a success notification with banner format.

    :param message: The success message text.
    :param duration: The display duration in seconds.
    :param persistent: Whether the notification should persist until dismissed.
    :param show_prefix: Whether to show the success prefix.
    :param identifier: Optional identifier for targeted dismissal.
    """

    self.add_notification(message, NotificationType.SUCCESS, NotificationFormat.BANNER, duration, persistent, show_prefix, identifier)

success_text

A method that adds a success notification with text format.

Parameters:

  • message (str) –

    The success message text.

  • duration (float, default: 3.0 ) –

    The display duration in seconds.

  • persistent (bool, default: False ) –

    Whether the notification should persist until dismissed.

  • show_prefix (bool, default: False ) –

    Whether to show the success prefix.

  • identifier (str | None, default: None ) –

    Optional identifier for targeted dismissal.

Source code in dev_tool/services/notification/service.py 
340
341
342
343
344
345
346
347
348
349
350
351
def success_text(self, message: str, duration: float = 3.0, persistent: bool = False, show_prefix: bool = False, identifier: str | None = None) -> None:
    """
    A method that adds a success notification with text format.

    :param message: The success message text.
    :param duration: The display duration in seconds.
    :param persistent: Whether the notification should persist until dismissed.
    :param show_prefix: Whether to show the success prefix.
    :param identifier: Optional identifier for targeted dismissal.
    """

    self.add_notification(message, NotificationType.SUCCESS, NotificationFormat.TEXT, duration, persistent, show_prefix, identifier)

warning

A method that adds a warning notification with yellow styling.

Parameters:

  • message (str) –

    The warning message text.

  • duration (float, default: 7.0 ) –

    The display duration in seconds.

  • persistent (bool, default: False ) –

    Whether the notification should persist until dismissed.

  • banner (bool, default: False ) –

    Whether to use banner format instead of text format.

  • show_prefix (bool, default: False ) –

    Whether to show the warning prefix.

  • identifier (str | None, default: None ) –

    Optional identifier for targeted dismissal.

Source code in dev_tool/services/notification/service.py 
353
354
355
356
357
358
359
360
361
362
363
364
365
366
def warning(self, message: str, duration: float = 7.0, persistent: bool = False, banner: bool = False, show_prefix: bool = False, identifier: str | None = None) -> None:
    """
    A method that adds a warning notification with yellow styling.

    :param message: The warning message text.
    :param duration: The display duration in seconds.
    :param persistent: Whether the notification should persist until dismissed.
    :param banner: Whether to use banner format instead of text format.
    :param show_prefix: Whether to show the warning prefix.
    :param identifier: Optional identifier for targeted dismissal.
    """

    format_type = NotificationFormat.BANNER if banner else NotificationFormat.TEXT
    self.add_notification(message, NotificationType.WARNING, format_type, duration, persistent, show_prefix, identifier)

warning_banner

A method that adds a warning notification with banner format.

Parameters:

  • message (str) –

    The warning message text.

  • duration (float, default: 7.0 ) –

    The display duration in seconds.

  • persistent (bool, default: False ) –

    Whether the notification should persist until dismissed.

  • show_prefix (bool, default: False ) –

    Whether to show the warning prefix.

  • identifier (str | None, default: None ) –

    Optional identifier for targeted dismissal.

Source code in dev_tool/services/notification/service.py 
368
369
370
371
372
373
374
375
376
377
378
379
def warning_banner(self, message: str, duration: float = 7.0, persistent: bool = False, show_prefix: bool = False, identifier: str | None = None) -> None:
    """
    A method that adds a warning notification with banner format.

    :param message: The warning message text.
    :param duration: The display duration in seconds.
    :param persistent: Whether the notification should persist until dismissed.
    :param show_prefix: Whether to show the warning prefix.
    :param identifier: Optional identifier for targeted dismissal.
    """

    self.add_notification(message, NotificationType.WARNING, NotificationFormat.BANNER, duration, persistent, show_prefix, identifier)

warning_text

A method that adds a warning notification with text format.

Parameters:

  • message (str) –

    The warning message text.

  • duration (float, default: 7.0 ) –

    The display duration in seconds.

  • persistent (bool, default: False ) –

    Whether the notification should persist until dismissed.

  • show_prefix (bool, default: False ) –

    Whether to show the warning prefix.

  • identifier (str | None, default: None ) –

    Optional identifier for targeted dismissal.

Source code in dev_tool/services/notification/service.py 
381
382
383
384
385
386
387
388
389
390
391
392
def warning_text(self, message: str, duration: float = 7.0, persistent: bool = False, show_prefix: bool = False, identifier: str | None = None) -> None:
    """
    A method that adds a warning notification with text format.

    :param message: The warning message text.
    :param duration: The display duration in seconds.
    :param persistent: Whether the notification should persist until dismissed.
    :param show_prefix: Whether to show the warning prefix.
    :param identifier: Optional identifier for targeted dismissal.
    """

    self.add_notification(message, NotificationType.WARNING, NotificationFormat.TEXT, duration, persistent, show_prefix, identifier)