Collaboration diagram for display_tty.src.log_level_tracker.LogLevelTracker:

Data Structures
class	Levels

Public Member Functions
	__init__ (self, bool bypass_check=False)

bool	add_level (self, str level_name, int level)

Union[int, None]	get_level (self, str level_name)

Union[str, None]	get_level_name (self, int level)

bool	check_presence (self)

bool	inject_class (self)

Data Fields
dict	levels

Detailed Description

@class LogLevelTracker
@brief Class in charge of tracking the logging levels of the logger library.

Definition at line 19 of file log_level_tracker.py.

Constructor & Destructor Documentation

◆ init()

display_tty.src.log_level_tracker.LogLevelTracker.__init__	(		self,
		bool	bypass_check = False )

@brief Constructor for the LogLevelTracker class.
@param bypass_check If True, bypasses the injection of the class into the logging library.

Definition at line 25 of file log_level_tracker.py.

Member Function Documentation

◆ add_level()

bool display_tty.src.log_level_tracker.LogLevelTracker.add_level	(		self,
		str	level_name,
		int	level )

@brief Adds a new logging level.
@param level_name The name of the new logging level.
@param level The integer value of the new logging level.
@return True if the level was added successfully, False if the level already exists.

Definition at line 68 of file log_level_tracker.py.

◆ check_presence()

bool display_tty.src.log_level_tracker.LogLevelTracker.check_presence ( self )

@brief Checks if this class is already present in the logging library.
@return True if the class is present, False otherwise.

Definition at line 99 of file log_level_tracker.py.

◆ get_level()

Union[int, None] display_tty.src.log_level_tracker.LogLevelTracker.get_level	(		self,
		str	level_name )

@brief Retrieves the logging level for a given level name.
@param level_name The name of the logging level.
@return The integer value of the logging level, or None if the level name does not exist.

Definition at line 80 of file log_level_tracker.py.

◆ get_level_name()

Union[str, None] display_tty.src.log_level_tracker.LogLevelTracker.get_level_name	(		self,
		int	level )

@brief Retrieves the logging level name for a given level value.
@param level The integer value of the logging level.
@return The name of the logging level, or None if the level value does not exist.

Definition at line 88 of file log_level_tracker.py.

◆ inject_class()

bool display_tty.src.log_level_tracker.LogLevelTracker.inject_class ( self )

@brief Injects this class into the logging library if it is not already present.
@return True if the class was successfully injected, False otherwise.

Definition at line 109 of file log_level_tracker.py.

Field Documentation

◆ levels

display_tty.src.log_level_tracker.LogLevelTracker.levels

Initial value:

=  {
            "DEBUG": logging.DEBUG,
            "INFO": logging.INFO,
            "WARN": logging.WARN,
            "ERROR": logging.ERROR,
            "CRITICAL": logging.CRITICAL,
        }

Definition at line 30 of file log_level_tracker.py.

The documentation for this class was generated from the following file:

display_tty/src/log_level_tracker.py

Data Structures

Public Member Functions

Data Fields