rotary_logger.constants.PrefixFunctionCall Class Reference

Inheritance diagram for rotary_logger.constants.PrefixFunctionCall:

Collaboration diagram for rotary_logger.constants.PrefixFunctionCall:

Static Public Attributes
	EMPTY = PREFIX_FUNCTION_CALL_EMPTY
	WRITE = PREFIX_FUNCTION_CALL_WRITE
	WRITELINES = PREFIX_FUNCTION_CALL_WRITELINES
	FLUSH = PREFIX_FUNCTION_CALL_FLUSH
	READ = PREFIX_FUNCTION_CALL_READ
	READLINE = PREFIX_FUNCTION_CALL_READLINE
	READLINES = PREFIX_FUNCTION_CALL_READLINES
bool	LOG_TO_FILE_ENV
str	RAW_LOG_FOLDER_ENV

Detailed Description

Optional per-call prefix appended to log entries for precise tracing.

When enabled, each log entry is tagged with the name of the stream
method that produced it (e.g. [WRITE], [READLINE]), making it easy
to distinguish writes from reads in a shared log file.

Definition at line 189 of file constants.py.

Field Documentation

EMPTY

rotary_logger.constants.PrefixFunctionCall.EMPTY = PREFIX_FUNCTION_CALL_EMPTY

static

Definition at line 196 of file constants.py.

FLUSH

rotary_logger.constants.PrefixFunctionCall.FLUSH = PREFIX_FUNCTION_CALL_FLUSH

static

Definition at line 199 of file constants.py.

LOG_TO_FILE_ENV

bool rotary_logger.constants.PrefixFunctionCall.LOG_TO_FILE_ENV

static

Initial value:

=  os.environ.get(
    "LOG_TO_FILE",
    "true"
).lower() in ("1", "true", "yes")

Definition at line 205 of file constants.py.

RAW_LOG_FOLDER_ENV

str rotary_logger.constants.PrefixFunctionCall.RAW_LOG_FOLDER_ENV

static

Initial value:

=  os.environ.get(
    "LOG_FOLDER_NAME",
    str(DEFAULT_LOG_FOLDER)
)

Definition at line 210 of file constants.py.

READ

rotary_logger.constants.PrefixFunctionCall.READ = PREFIX_FUNCTION_CALL_READ

static

Definition at line 200 of file constants.py.

READLINE

rotary_logger.constants.PrefixFunctionCall.READLINE = PREFIX_FUNCTION_CALL_READLINE

static

Definition at line 201 of file constants.py.

READLINES

rotary_logger.constants.PrefixFunctionCall.READLINES = PREFIX_FUNCTION_CALL_READLINES

static

Definition at line 202 of file constants.py.

WRITE

rotary_logger.constants.PrefixFunctionCall.WRITE = PREFIX_FUNCTION_CALL_WRITE

static

Definition at line 197 of file constants.py.

WRITELINES

rotary_logger.constants.PrefixFunctionCall.WRITELINES = PREFIX_FUNCTION_CALL_WRITELINES

static

Definition at line 198 of file constants.py.

---

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

• rotary_logger/constants.py