Coretex
Public Member Functions | Static Public Member Functions | List of all members
coretex.logging.log_severity.LogSeverity Class Reference

Inherits IntEnum.

Public Member Functions

str color (self)
 
logging._Level stdSeverity (self)
 
str prefix (self)
 

Static Public Member Functions

LogSeverity fromStd (int logLevel)
 

Detailed Description

    List of all log severities supported by Coretex

Definition at line 24 of file log_severity.py.

Member Function Documentation

◆ color()

str coretex.logging.log_severity.LogSeverity.color (   self) 
    Color of the log severity

    Returns
    -------
    str -> color

Definition at line 37 of file log_severity.py.

37  def color(self) -> str:
38  """
39  Color of the log severity
40 
41  Returns
42  -------
43  str -> color
44  """
45 
46  if self == LogSeverity.fatal:
47  return "red"
48 
49  if self == LogSeverity.error:
50  return "red"
51 
52  if self == LogSeverity.warning:
53  return "yellow"
54 
55  if self == LogSeverity.info:
56  return "white"
57 
58  if self == LogSeverity.debug:
59  return "yellow"
60 
61  raise RuntimeError(">> [Coretex] Invalid enum value")
62 

◆ fromStd()

LogSeverity coretex.logging.log_severity.LogSeverity.fromStd ( int  logLevel)
static 
    Converts python std module logging level
    into the equivalent log severity from coretex

    Returns
    -------
    LogSeverity -> Coretex log severity

    Example
    -------
    >>> import logging
    \b
    >>> from coretex.logging.log_severity import LogSeverity
    >>> logSeverityValue = LogSeverity.fromStd(logging.INFO)
    >>> print(logSeverityValue)
    LogSeverity.info

Definition at line 111 of file log_severity.py.

111  def fromStd(logLevel: int) -> LogSeverity:
112  """
113  Converts python std module logging level
114  into the equivalent log severity from coretex
115 
116  Returns
117  -------
118  LogSeverity -> Coretex log severity
119 
120  Example
121  -------
122  >>> import logging
123  \b
124  >>> from coretex.logging.log_severity import LogSeverity
125  >>> logSeverityValue = LogSeverity.fromStd(logging.INFO)
126  >>> print(logSeverityValue)
127  LogSeverity.info
128  """
129 
130  if logLevel == logging.FATAL:
131  return LogSeverity.fatal
132 
133  if logLevel == logging.ERROR:
134  return LogSeverity.error
135 
136  if logLevel == logging.WARNING:
137  return LogSeverity.warning
138 
139  if logLevel == logging.INFO:
140  return LogSeverity.info
141 
142  if logLevel == logging.DEBUG:
143  return LogSeverity.debug
144 
145  raise ValueError(">> [Coretex] Invalid enum value")

◆ prefix()

str coretex.logging.log_severity.LogSeverity.prefix (   self) 
    Prefix of the log severity

    Returns
    -------
    str -> prefix

Definition at line 99 of file log_severity.py.

99  def prefix(self) -> str:
100  """
101  Prefix of the log severity
102 
103  Returns
104  -------
105  str -> prefix
106  """
107 
108  return self.name.capitalize()
109 

◆ stdSeverity()

logging._Level coretex.logging.log_severity.LogSeverity.stdSeverity (   self) 
    Converts Coretex log severity into the
    equivalent log level from python std module logging

    Returns
    -------
    int -> python std module logging level

    Example
    -------
    >>> from coretex.logging import LogSeverity
    \b
    >>> print(LogSeverity.info.stdSeverity)
    20

Definition at line 64 of file log_severity.py.

64  def stdSeverity(self) -> logging._Level:
65  """
66  Converts Coretex log severity into the
67  equivalent log level from python std module logging
68 
69  Returns
70  -------
71  int -> python std module logging level
72 
73  Example
74  -------
75  >>> from coretex.logging import LogSeverity
76  \b
77  >>> print(LogSeverity.info.stdSeverity)
78  20
79  """
80 
81  if self == LogSeverity.fatal:
82  return logging.FATAL
83 
84  if self == LogSeverity.error:
85  return logging.ERROR
86 
87  if self == LogSeverity.warning:
88  return logging.WARNING
89 
90  if self == LogSeverity.info:
91  return logging.INFO
92 
93  if self == LogSeverity.debug:
94  return logging.DEBUG
95 
96  raise RuntimeError(">> [Coretex] Invalid enum value")
97 
The documentation for this class was generated from the following file: