lsst.pex.config main-gfde1bd31db+8e4c10ac41
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pex.config.history.Color Class Reference

Public Member Functions

def __init__ (self, text, category)
 
def __str__ (self)
 

Static Public Member Functions

def colorize (val=None)
 

Public Attributes

 rawText
 

Static Public Attributes

 categories
 
dictionary colors
 

Detailed Description

A controller that determines whether strings should be colored.

Parameters
----------
text : `str`
    Text content to print to a terminal.
category : `str`
    Semantic category of the ``text``. See `categories` for possible
    values.

Raises
------
RuntimeError
    Raised when the ``category`` is not a key of ``Color.categories``.

Notes
-----
The usual usage is ``Color(string, category)`` which returns a string that
may be printed; categories are given by the keys of `Color.categories`.

`Color.colorize` may be used to set or retrieve whether the user wants
color. It always returns `False` when `sys.stdout` is not attached to a
terminal.

Member Function Documentation

◆ colorize()

def lsst.pex.config.history.Color.colorize (   val = None)
static
Get or set whether the string should be colorized.

Parameters
----------
val : `bool` or `dict`, optional
    The value is usually a bool, but it may be a dict which is used
    to modify Color.categories

Returns
-------
shouldColorize : `bool`
    If `True`, the string should be colorized. A string **will not** be
    colorized if standard output or standard error are not attached to
    a terminal or if the ``val`` argument was `False`.

    Only strings written to a terminal are colorized.

Member Data Documentation

◆ categories

lsst.pex.config.history.Color.categories
static
Initial value:
= dict(
NAME="blue",
VALUE="yellow",
FILE="green",
TEXT="red",
FUNCTION_NAME="blue",
)

◆ colors

dictionary lsst.pex.config.history.Color.colors
static
Initial value:
= {
"black": 0,
"red": 1,
"green": 2,
"yellow": 3,
"blue": 4,
"magenta": 5,
"cyan": 6,
"white": 7,
}

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