Coverage for lynceus/core/lynceus_message_status.py: 100%

1""" 

2This enum is mainly intended to be used by the client project to define 

3 which messages worth to be shown in UX. 

4""" 

5 

6from enum import Enum 

7 

8 

9class LynceusMessageStatus(Enum): 

10 """ 

11 Enumeration defining message status types for Lynceus framework communication. 

12 

13 This enum is primarily intended for client projects to categorize messages 

14 and determine which messages are worth displaying in the user experience. 

15 It provides a standardized way to classify message severity and impact. 

16 

17 The enum values help in: 

18 - UI message filtering and presentation 

19 - behaviour based on positive/negative impacts 

20 - Error and warning handling 

21 - User feedback categorization 

22 

23 Attributes: 

24 NEUTRAL: Neutral informational messages 

25 POSITIVE: Positive informational messages 

26 NEGATIVE: Negative informational messages 

27 WARNING: Alert messages requiring attention 

28 ERROR: Critical failure messages 

29 """ 

30 

31 NEUTRAL = 'neutral' 

32 POSITIVE = 'positive' 

33 NEGATIVE = 'negative' 

34 WARNING = 'warning' 

35 ERROR = 'error'