LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
|
Public Member Functions | |
__init__ (self, text, category) | |
__str__ (self) | |
Static Public Member Functions | |
colorize (val=None) | |
Public Attributes | |
rawText | |
color | |
Static Public Attributes | |
dict | categories |
dict | colors |
Protected Attributes | |
_code | |
Static Protected Attributes | |
bool | _colorize = True |
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.
Definition at line 35 of file history.py.
lsst.pex.config.history.Color.__init__ | ( | self, | |
text, | |||
category ) |
Definition at line 96 of file history.py.
lsst.pex.config.history.Color.__str__ | ( | self | ) |
Definition at line 156 of file history.py.
|
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.
Definition at line 119 of file history.py.
|
protected |
Definition at line 111 of file history.py.
|
staticprotected |
Definition at line 94 of file history.py.
|
static |
Definition at line 61 of file history.py.
lsst.pex.config.history.Color.color |
Definition at line 104 of file history.py.
|
static |
Definition at line 81 of file history.py.
lsst.pex.config.history.Color.rawText |
Definition at line 102 of file history.py.