rotary_logger.constants.StdMode Class Reference

Inheritance diagram for rotary_logger.constants.StdMode:

Collaboration diagram for rotary_logger.constants.StdMode:

Static Public Attributes
	STDIN = STDIN
	STDOUT = STDOUT
	STDERR = STDERR
	STDUNKNOWN = STDUNKNOWN
str	LOG_FOLDER_BASE_NAME = "logs"
str	FOLDER_STDOUT = "stdout"
str	FOLDER_STDERR = "stderr"
str	FOLDER_STDIN = "stdin"
str	FOLDER_STDUNKNOWN = "std_unknown"
dict	CORRECT_FOLDER
int	BUFFER_FLUSH_SIZE = 8 * KB1
str	DEFAULT_ENCODING = "utf-8"
int	DEFAULT_LOG_MAX_FILE_SIZE = 2 * GB1
int	DEFAULT_LOG_BUFFER_FLUSH_SIZE = BUFFER_FLUSH_SIZE
Path	DEFAULT_LOG_FOLDER = Path(__file__).parent / LOG_FOLDER_BASE_NAME
str	ERROR_MODE_WARN = "Warn"
str	ERROR_MODE_WARN_NO_PIPE = "Warn No pipe"
str	ERROR_MODE_EXIT = "Exit"
str	ERROR_MODE_EXIT_NO_PIPE = "Exit No pipe"

Detailed Description

Enumeration of the standard stream identifiers.

Used throughout the package to distinguish which standard stream a
TeeStream instance is wrapping, and to look up the correct folder
name and log prefix for that stream.

Definition at line 83 of file constants.py.

Field Documentation

BUFFER_FLUSH_SIZE

int rotary_logger.constants.StdMode.BUFFER_FLUSH_SIZE = 8 * KB1

static

Definition at line 110 of file constants.py.

CORRECT_FOLDER

dict rotary_logger.constants.StdMode.CORRECT_FOLDER

static

Initial value:

=  {
    StdMode.STDIN: FOLDER_STDIN,
    StdMode.STDOUT: FOLDER_STDOUT,
    StdMode.STDERR: FOLDER_STDERR,
    StdMode.STDUNKNOWN: FOLDER_STDUNKNOWN,
}

Definition at line 103 of file constants.py.

DEFAULT_ENCODING

str rotary_logger.constants.StdMode.DEFAULT_ENCODING = "utf-8"

static

Definition at line 112 of file constants.py.

DEFAULT_LOG_BUFFER_FLUSH_SIZE

int rotary_logger.constants.StdMode.DEFAULT_LOG_BUFFER_FLUSH_SIZE = BUFFER_FLUSH_SIZE

static

Definition at line 114 of file constants.py.

DEFAULT_LOG_FOLDER

Path rotary_logger.constants.StdMode.DEFAULT_LOG_FOLDER = Path(__file__).parent / LOG_FOLDER_BASE_NAME

static

Definition at line 115 of file constants.py.

DEFAULT_LOG_MAX_FILE_SIZE

int rotary_logger.constants.StdMode.DEFAULT_LOG_MAX_FILE_SIZE = 2 * GB1

static

Definition at line 113 of file constants.py.

ERROR_MODE_EXIT

str rotary_logger.constants.StdMode.ERROR_MODE_EXIT = "Exit"

static

Definition at line 120 of file constants.py.

ERROR_MODE_EXIT_NO_PIPE

str rotary_logger.constants.StdMode.ERROR_MODE_EXIT_NO_PIPE = "Exit No pipe"

static

Definition at line 121 of file constants.py.

ERROR_MODE_WARN

str rotary_logger.constants.StdMode.ERROR_MODE_WARN = "Warn"

static

Definition at line 118 of file constants.py.

ERROR_MODE_WARN_NO_PIPE

str rotary_logger.constants.StdMode.ERROR_MODE_WARN_NO_PIPE = "Warn No pipe"

static

Definition at line 119 of file constants.py.

FOLDER_STDERR

str rotary_logger.constants.StdMode.FOLDER_STDERR = "stderr"

static

Definition at line 99 of file constants.py.

FOLDER_STDIN

str rotary_logger.constants.StdMode.FOLDER_STDIN = "stdin"

static

Definition at line 100 of file constants.py.

FOLDER_STDOUT

str rotary_logger.constants.StdMode.FOLDER_STDOUT = "stdout"

static

Definition at line 98 of file constants.py.

FOLDER_STDUNKNOWN

str rotary_logger.constants.StdMode.FOLDER_STDUNKNOWN = "std_unknown"

static

Definition at line 101 of file constants.py.

LOG_FOLDER_BASE_NAME

str rotary_logger.constants.StdMode.LOG_FOLDER_BASE_NAME = "logs"

static

Definition at line 96 of file constants.py.

STDERR

rotary_logger.constants.StdMode.STDERR = STDERR

static

Definition at line 92 of file constants.py.

STDIN

rotary_logger.constants.StdMode.STDIN = STDIN

static

Definition at line 90 of file constants.py.

STDOUT

rotary_logger.constants.StdMode.STDOUT = STDOUT

static

Definition at line 91 of file constants.py.

STDUNKNOWN

rotary_logger.constants.StdMode.STDUNKNOWN = STDUNKNOWN

static

Definition at line 93 of file constants.py.

---

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

• rotary_logger/constants.py