Constants.py

Go to the documentation of this file.

"""Useful/conventional constants."""
 
from enum import IntEnum, unique
 
__all__ = [
    "MessageLevel",
    "NIL",
    "ALL",
    "VERBOSE",
    "DEBUG",
    "INFO",
    "WARNING",
    "ERROR",
    "FATAL",
    "ALWAYS",
    "TRUE",
    "FALSE",
]
 
 
@unique
class MessageLevel(IntEnum):
    """Message severity and output-threshold levels matching ``MSG::Level``."""
 
    NIL = 0
    VERBOSE = 1
    DEBUG = 2
    INFO = 3
    WARNING = 4
    ERROR = 5
    FATAL = 6
    ALWAYS = 7
 
 
# message levels -----------------------------------------------------------
NIL = MessageLevel.NIL.value
ALL = NIL
VERBOSE = MessageLevel.VERBOSE.value
DEBUG = MessageLevel.DEBUG.value
INFO = MessageLevel.INFO.value
WARNING = MessageLevel.WARNING.value
ERROR = MessageLevel.ERROR.value
FATAL = MessageLevel.FATAL.value
ALWAYS = MessageLevel.ALWAYS.value
 
# for job options legacy (TODO: get rid of these!) -------------------------
TRUE = True
FALSE = False
 
# message to notify folks that they really have to fix their codes:
error_explanation = """
     ==> After this line, a hack will be executed, attempting to rectify the
     ==> problem just reported. Since this hack may fail, and since it is a
     ==> rather temporary measure hack, this is an ERROR, not a WARNING."""