Module Content

Color class

When this module is imported, you will have access to individual colors with the Color class.

To get the value of a color, one must use the following structure: Color.<type>.<color name> such as Color.foreground.DARK_RED. The only exception to that structure, is the ENDC color code, which is accessed with Color.ENDC.

The <type> can be either “foreground” or “background” and <color name> can be any of the color codes (that don’t have a *) in the List of Color Codes section, in Getting Started.

Hint

Generally, you needn’t use this class unless it is to change the ANSI escape sequences used or any other value.

Methods

paint

paint(*value, **options)

paint(value, ..., print=True, ret=True, overflow=False, sep=' ', end='n', file=sys.stdout, flush=False)

Returns a string that will have color codes converted to ANSI escape sequences. This is meant to work similar to the built-in print function.

Having print as False, makes the arguments end, file and flush to not be considered whatever their values may be, because those are only used when printing.

When there is more than one value argument, and overflow is True, any unfinished color will pass through to other strings. Otherwise, colors will be finished at the end of each object.

Note

Regardless of any argument, this function will always finish all color codes at the end of the last string (the same as adding a ;:).

ARGUMENT	DESCRIPTION
value	One or more objects to be parsed.
print	If True, the obtained string will be printed.
ret	If true, the obtained string will be returned.
overflow	If true, allow unfinished colors to overflow onto other stirngs.
sep	Inserted between the given values.
end	Appended after the last value (when it’s printed).
file	A file-like object (stream).
flush	Whether to forcibly flush the stream (when the strings are printed).

codes

codes()

Prints a list of all the color codes available. It also displays what the colors look as background type and foreground type.

true_color

true_color(value=None)

If no argument is given, it returns the current state of the global value for true color. Otherwise, it changes it to whatever boolean argument is given.

When set to True, it means that the set of foreground colors will be using RGB values directly for each ANSI escape sequence. This does not apply to the background colors, as they do not allow RGB values in their codes. Be aware that not all terminals support true colors in ANSI escape sequences, so by default it’s set to false at the start.

ARGUMENT	DESCRIPTION
value	If true color should be activated or not, using boolean arguments.

change_defaults

change_defaults(fn, **kwargs)

This function is meant to be used at the beggining of the program, to set permanent default values. This way, it helps to avoid having to constantly set the same arguments that would otherwise be omitted. The kwargs argument recieves one or more key/value pairs for the function fn.

It was designed to help both for future functions that may be added and to make lines of code shorter.

The following example sets the default argument for printing as False in the function paint (originally True):

>>> from colorparse import paint, change_defaults
>>> change_defaults(paint, print=False)
>>> # same as:
>>> change_defaults("paint", print=False)

ARGUMENT	DESCRIPTION
fn	The name or the function itself to set the default values.
**kwargs	Key/value pairs for each default argument to set.