Variables
int	ERR = 1

int	ERROR = ERR

int	SUCCESS = 0

str	OUT_TTY = "tty"

str	OUT_STRING = "string"

str	OUT_FILE = "file"

str	OUT_DEFAULT = ''

str	KEY_OUTPUT_MODE = "OUTPUT_MODE"

str	KEY_PRETTIFY_OUTPUT = "PRETTIFY_OUTPUT"

str	KEY_PRETTIFY_OUTPUT_IN_BLOCKS = "PRETTY_OUTPUT_IN_BLOCS"

str	KEY_ANIMATION_DELAY = 'MESSAGE_ANIMATION_DELAY'

str	KEY_ANIMATION_DELAY_BLOCKY = 'MESSAGE_ANIMATION_DELAY_BLOCKY'

dict	TOML_CONF

dict	FORBIDDEN_NUMBER_LOG_LEVELS_CORRESPONDANCE

	FORBIDDEN_NUMBER_LOG_LEVELS

bool	SAVE_TO_FILE = False

str	FILE_NAME = "run_results.txt"

	FILE_DESCRIPTOR = None

Detailed Description

# +==== BEGIN display_tty =================+
# LOGO: 
# ..@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
# .@...........................#@
# @############################.@
# @...........................@.@
# @..#######################..@.@
# @.#########################.@.@
# @.##>_#####################.@.@
# @.#########################.@.@
# @.#########################.@.@
# @.#########################.@.@
# @.#########################.@.@
# @..#######################..@.@
# @...........................@.@
# @..+----+______________.....@.@
# @..+....+______________+....@.@
# @..+----+...................@.@
# @...........................@.#
# @@@@@@@@@@@@@@@@@@@@@@@@@@@@@#.
# /STOP
# PROJECT: display_tty
# FILE: constants.py
# CREATION DATE: 06-11-2025
# LAST Modified: 12:29:5 06-11-2025
# DESCRIPTION: 
# A module that allows you to display text with a few boilers (i.e. put your text in a square for titles). It also allows to log to the terminal by wrapping around the logging library.
# @file constants.py
# @brief This is the file in charge of containing the constants used in the display_tty library.
# @details This module defines constants and configuration settings used throughout the display_tty project. It includes error codes, output modes, animation delays,TOML configuration defaults, and forbidden log levels.
# /STOP
# COPYRIGHT: (c) Henry Letellier
# PURPOSE: File in charge of containing the constants of the program.
# // AR
# +==== END display_tty =================+

Variable Documentation

◆ ERR

int display_tty.src.constants.ERR = 1

Definition at line 40 of file constants.py.

◆ ERROR

int display_tty.src.constants.ERROR = ERR

Definition at line 41 of file constants.py.

◆ FILE_DESCRIPTOR

display_tty.src.constants.FILE_DESCRIPTOR = None

Definition at line 128 of file constants.py.

◆ FILE_NAME

str display_tty.src.constants.FILE_NAME = "run_results.txt"

Definition at line 122 of file constants.py.

◆ FORBIDDEN_NUMBER_LOG_LEVELS

display_tty.src.constants.FORBIDDEN_NUMBER_LOG_LEVELS

Initial value:

=  list(
    FORBIDDEN_NUMBER_LOG_LEVELS_CORRESPONDANCE.values()
)

Definition at line 107 of file constants.py.

◆ FORBIDDEN_NUMBER_LOG_LEVELS_CORRESPONDANCE

dict display_tty.src.constants.FORBIDDEN_NUMBER_LOG_LEVELS_CORRESPONDANCE

Initial value:

=  {
    "INFO": 20,  # Informational messages
    "WARN": 30,  # Warning messages
    "DEBUG": 10,  # Debugging messages
    "FATAL": 50,  # Fatal error messages
    "ERROR": 40,  # Error messages
    "NOTSET": 0,  # No specific log level
    "WARNING": 40,  # Alias for WARN
    "CRITICAL": 50  # Alias for FATAL
}

Definition at line 96 of file constants.py.

◆ KEY_ANIMATION_DELAY

str display_tty.src.constants.KEY_ANIMATION_DELAY = 'MESSAGE_ANIMATION_DELAY'

Definition at line 58 of file constants.py.

◆ KEY_ANIMATION_DELAY_BLOCKY

str display_tty.src.constants.KEY_ANIMATION_DELAY_BLOCKY = 'MESSAGE_ANIMATION_DELAY_BLOCKY'

Definition at line 60 of file constants.py.

◆ KEY_OUTPUT_MODE

str display_tty.src.constants.KEY_OUTPUT_MODE = "OUTPUT_MODE"

Definition at line 51 of file constants.py.

◆ KEY_PRETTIFY_OUTPUT

str display_tty.src.constants.KEY_PRETTIFY_OUTPUT = "PRETTIFY_OUTPUT"

Definition at line 52 of file constants.py.

◆ KEY_PRETTIFY_OUTPUT_IN_BLOCKS

str display_tty.src.constants.KEY_PRETTIFY_OUTPUT_IN_BLOCKS = "PRETTY_OUTPUT_IN_BLOCS"

Definition at line 54 of file constants.py.

◆ OUT_DEFAULT

str display_tty.src.constants.OUT_DEFAULT = ''

Definition at line 48 of file constants.py.

◆ OUT_FILE

str display_tty.src.constants.OUT_FILE = "file"

Definition at line 47 of file constants.py.

◆ OUT_STRING

str display_tty.src.constants.OUT_STRING = "string"

Definition at line 46 of file constants.py.

◆ OUT_TTY

str display_tty.src.constants.OUT_TTY = "tty"

Definition at line 45 of file constants.py.

◆ SAVE_TO_FILE

bool display_tty.src.constants.SAVE_TO_FILE = False

Definition at line 116 of file constants.py.

◆ SUCCESS

int display_tty.src.constants.SUCCESS = 0

Definition at line 42 of file constants.py.

◆ TOML_CONF

dict display_tty.src.constants.TOML_CONF

Definition at line 63 of file constants.py.

Variables