lsst.pex.config.history.Color Class Reference

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

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.

Definition at line 35 of file history.py.

Constructor & Destructor Documentation

__init__()

lsst.pex.config.history.Color.__init__	(		self,
			text,
			category )

Definition at line 96 of file history.py.

    def __init__(self, text, category):
        try:
            color = Color.categories[category]
        except KeyError:
            raise RuntimeError("Unknown category: %s" % category)
 
        self.rawText = str(text)
        x = color.lower().split(";")
        self.color, bold = x.pop(0), False
        if x:
            props = x.pop(0)
            if props in ("bold",):
                bold = True
 
        try:
            self._code = "%s" % (30 + Color.colors[self.color])
        except KeyError:
            raise RuntimeError("Unknown colour: %s" % self.color)
 
        if bold:
            self._code += ";1"
 

Member Function Documentation

__str__()

lsst.pex.config.history.Color.__str__

(

self

)

Definition at line 156 of file history.py.

    def __str__(self):
        if not self.colorize():
            return self.rawText
 
        base = "\033["
 
        prefix = base + self._code + "m"
        suffix = base + "m"
 
        return prefix + self.rawText + suffix
 
 

colorize()

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.

Definition at line 119 of file history.py.

    def colorize(val=None):
        """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.
        """
        if val is not None:
            Color._colorize = val
 
            if isinstance(val, dict):
                unknown = []
                for k in val:
                    if k in Color.categories:
                        if val[k] in Color.colors:
                            Color.categories[k] = val[k]
                        else:
                            print(f"Unknown colour {val[k]} for category {k}", file=sys.stderr)
                    else:
                        unknown.append(k)
 
                if unknown:
                    print("Unknown colourizing category: %s" % " ".join(unknown), file=sys.stderr)
 
        return Color._colorize if sys.stdout.isatty() else False
 

Member Data Documentation

_code

lsst.pex.config.history.Color._code

protected

Definition at line 111 of file history.py.

_colorize

bool lsst.pex.config.history.Color._colorize = True

staticprotected

Definition at line 94 of file history.py.

categories

dict lsst.pex.config.history.Color.categories

static

Initial value:

=  {
        "NAME": "blue",
        "VALUE": "yellow",
        "FILE": "green",
        "TEXT": "red",
        "FUNCTION_NAME": "blue",
    }

Definition at line 61 of file history.py.

color

lsst.pex.config.history.Color.color

Definition at line 104 of file history.py.

colors

dict 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,
    }

Definition at line 81 of file history.py.

rawText

lsst.pex.config.history.Color.rawText

Definition at line 102 of file history.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pex_config/gba4ed39666+c2a2e4ac27/python/lsst/pex/config/history.py