rs_rich.color

Generated from the type stubs by scripts/gen_python_api.py; do not edit.

rich.color: Color, ColorTriplet, ColorSystem and ColorType.

Color

Bases: NamedTuple

name instance-attribute

name: str

type instance-attribute

type: ColorType

number class-attribute instance-attribute

number: Optional[int] = None

triplet class-attribute instance-attribute

triplet: Optional[ColorTriplet] = None

system property

system: ColorSystem

is_system_defined property

is_system_defined: bool

is_default property

is_default: bool

get_truecolor

get_truecolor(theme: Optional[TerminalTheme] = None, foreground: bool = True) -> ColorTriplet

from_ansi classmethod

from_ansi(number: int) -> Color

from_triplet classmethod

from_triplet(triplet: ColorTriplet) -> Color

from_rgb classmethod

from_rgb(red: float, green: float, blue: float) -> Color

default classmethod

default() -> Color

parse classmethod

parse(color: str) -> Color

get_ansi_codes

get_ansi_codes(foreground: bool = True) -> Tuple[str, ...]

downgrade

downgrade(system: ColorSystem) -> Color

ColorParseError

Bases: Exception

A colour that does not parse.

ColorSystem

Bases: int

STANDARD instance-attribute

STANDARD: ColorSystem

EIGHT_BIT instance-attribute

EIGHT_BIT: ColorSystem

TRUECOLOR instance-attribute

TRUECOLOR: ColorSystem

WINDOWS instance-attribute

WINDOWS: ColorSystem

name property

name: str

value property

value: int

ColorTriplet

Bases: NamedTuple

red instance-attribute

red: int

green instance-attribute

green: int

blue instance-attribute

blue: int

hex property

hex: str

rgb property

rgb: str

normalized property

normalized: Tuple[float, float, float]

ColorType

Bases: int

DEFAULT instance-attribute

DEFAULT: ColorType

STANDARD instance-attribute

STANDARD: ColorType

EIGHT_BIT instance-attribute

EIGHT_BIT: ColorType

TRUECOLOR instance-attribute

TRUECOLOR: ColorType

WINDOWS instance-attribute

WINDOWS: ColorType

name property

name: str

value property

value: int

blend_rgb

blend_rgb(color1: Tuple[int, int, int], color2: Tuple[int, int, int], cross_fade: float = 0.5) -> ColorTriplet

parse_rgb_hex

parse_rgb_hex(hex_color: str) -> ColorTriplet