py_research.colors module

Simple & semi-automatic color-system for data visualization purposes.

default_highlights()

Return default highlight colors.

default_scales()

Return default color scale.

class ColorTheme(highlights=<factory>, scales=<factory>)

Bases: object

Define a color theme. Can be used as context manager to activate the theme.

Parameters:

• highlights (dict[Any, str]) –

• scales (dict[Any, list[tuple[float, str]]]) –

highlights: dict[Any, str]

Highlight colors for different, known categories.

scales: dict[Any, list[tuple[float, str]]]

Named or numbered color sclales.

activate()

Set this as the current theme.

get_theme()

Return active color theme (may be derived from current execution context).

Return type:

ColorTheme

to_bg_color(color, lightness=0.8)

Turn a highlight color into a background color.

Parameters:

• color (str) –

• lightness (float) –

Return type:

str

default_file_path = PosixPath('/home/runner/work/py-research/py-research/colors.yaml')

Default path to color theme file.

load_from_file(path=None)

Load color theme from file.

Parameters:

path (Path | str | None) – Path to file. If None, the default file path is used.

Returns:

Path to the loaded file, if not given as argument.

Return type:

Path | None