class documentation

class _AnsiColorizer: (source)

Constructor: _AnsiColorizer(stream)

View In Hierarchy

A colorizer is an object that loosely wraps around a stream, allowing callers to write text to the stream in a particular color.

Colorizer classes must implement supported() and write(text, color).

Class Method supported A class method that returns True if the current platform supports coloring terminal output using this method. Returns False otherwise.
Method __init__ Undocumented
Method write Write the given text to the stream in the given color.
Instance Variable stream Undocumented
Class Variable _colors Undocumented
@classmethod
def supported(cls, stream=sys.stdout): (source)

A class method that returns True if the current platform supports coloring terminal output using this method. Returns False otherwise.

def __init__(self, stream): (source)

Undocumented

def write(self, text, color): (source)

Write the given text to the stream in the given color.

Parameters
textText to be written to the stream.
colorA string label for a color. e.g. 'red', 'white'.

Undocumented

Undocumented