Coloring

momapy.coloring

Color definitions and utilities for momapy.

This module provides the Color class for representing colors with RGBA components, along with a comprehensive set of predefined named colors. Colors can be created from various formats (RGB, RGBA, HEX, HEXA) and converted between formats.

Examples:

from momapy.coloring import Color, red, blue

# Using predefined colors
color = red

# Creating from hex
color = Color.from_hex("#FF5733")

# Creating from RGB
color = Color.from_rgb(255, 87, 51)

# With alpha transparency
color = Color.from_rgba(255, 87, 51, 0.5)

# Convert to different formats
color.to_hex()
color.to_rgba()

Classes:

Name	Description
Color	Represents an RGBA color.

Functions:

Name	Description
get_color	Return the named color with the given name.
has_color	Check if a named color exists.
list_colors	Return the names of all available named colors.
print_colors	Print all available named colors with their names.

Attributes:

Name	Type	Description
aliceblue		The color aliceblue | aliceblue
antiquewhite		The color antiquewhite | antiquewhite
aqua		The color aqua | aqua
aquamarine		The color aquamarine | aquamarine
azure		The color azure | azure
beige		The color beige | beige
bisque		The color bisque | bisque
black		The color black | black
blanchedalmond		The color blanchedalmond | blanchedalmond
blue		The color blue | blue
blueviolet		The color blueviolet | blueviolet
brown		The color brown | brown
burlywood		The color burlywood | burlywood
cadetblue		The color cadetblue | cadetblue
chartreuse		The color chartreuse | chartreuse
chocolate		The color chocolate | chocolate
coral		The color coral | coral
cornflowerblue		The color cornflowerblue | cornflowerblue
cornsilk		The color cornsilk | cornsilk
crimson		The color crimson | crimson
cyan		The color cyan | cyan
darkblue		The color darkblue | darkblue
darkcyan		The color darkcyan | darkcyan
darkgoldenrod		The color darkgoldenrod | darkgoldenrod
darkgray		The color darkgray | darkgray
darkgreen		The color darkgreen | darkgreen
darkgrey		The color darkgrey | darkgrey
darkkhaki		The color darkkhaki | darkkhaki
darkmagenta		The color darkmagenta | darkmagenta
darkolivegreen		The color darkolivegreen | darkolivegreen
darkorange		The color darkorange | darkorange
darkorchid		The color darkorchid | darkorchid
darkred		The color darkred | darkred
darksalmon		The color darksalmon | darksalmon
darkseagreen		The color darkseagreen | darkseagreen
darkslateblue		The color darkslateblue | darkslateblue
darkslategray		The color darkslategray | darkslategray
darkturquoise		The color darkturquoise | darkturquoise
darkviolet		The color darkviolet | darkviolet
deeppink		The color deeppink | deeppink
deepskyblue		The color deepskyblue | deepskyblue
dimgray		The color dimgray | dimgray
dimgrey		The color dimgrey | dimgrey
dodgerblue		The color dodgerblue | dodgerblue
firebrick		The color firebrick | firebrick
floralwhite		The color floralwhite | floralwhite
forestgreen		The color forestgreen | forestgreen
fuchsia		The color fuchsia | fuchsia
gainsboro		The color gainsboro | gainsboro
ghostwhite		The color ghostwhite | ghostwhite
gold		The color gold | gold
goldenrod		The color goldenrod | goldenrod
gray		The color gray | gray
green		The color green | green
greenyellow		The color greenyellow | greenyellow
grey		The color grey | grey
honeydew		The color honeydew | honeydew
hotpink		The color hotpink | hotpink
indianred		The color indianred | indianred
indigo		The color indigo | indigo
ivory		The color ivory | ivory
khaki		The color khaki | khaki
lavender		The color lavender | lavender
lavenderblush		The color lavenderblush | lavenderblush
lawngreen		The color lawngreen | lawngreen
lemonchiffon		The color lemonchiffon | lemonchiffon
lightblue		The color lightblue | lightblue
lightcoral		The color lightcoral | lightcoral
lightcyan		The color lightcyan | lightcyan
lightgoldenrodyellow		The color lightgoldenrodyellow | lightgoldenrodyellow
lightgray		The color lightgray | lightgray
lightgreen		The color lightgreen | lightgreen
lightgrey		The color lightgrey | lightgrey
lightpink		The color lightpink | lightpink
lightsalmon		The color lightsalmon | lightsalmon
lightseagreen		The color lightseagreen | lightseagreen
lightskyblue		The color lightskyblue | lightskyblue
lightslategray		The color lightslategray | lightslategray
lightsteelblue		The color lightsteelblue | lightsteelblue
lightyellow		The color lightyellow | lightyellow
lime		The color lime | lime
limegreen		The color limegreen | limegreen
linen		The color linen | linen
magenta		The color magenta | magenta
maroon		The color maroon | maroon
mediumaquamarine		The color mediumaquamarine | mediumaquamarine
mediumblue		The color mediumblue | mediumblue
mediumorchid		The color mediumorchid | mediumorchid
mediumpurple		The color mediumpurple | mediumpurple
mediumseagreen		The color mediumseagreen | mediumseagreen
mediumslateblue		The color mediumslateblue | mediumslateblue
mediumspringgreen		The color mediumspringgreen | mediumspringgreen
mediumturquoise		The color mediumturquoise | mediumturquoise
mediumvioletred		The color mediumvioletred | mediumvioletred
midnightblue		The color midnightblue | midnightblue
mintcream		The color mintcream | mintcream
mistyrose		The color mistyrose | mistyrose
moccasin		The color moccasin | moccasin
navajowhite		The color navajowhite | navajowhite
navy		The color navy | navy
oldlace		The color oldlace | oldlace
olive		The color olive | olive
olivedrab		The color olivedrab | olivedrab
orange		The color orange | orange
orangered		The color orangered | orangered
orchid		The color orchid | orchid
palegoldenrod		The color palegoldenrod | palegoldenrod
palegreen		The color palegreen | palegreen
paleturquoise		The color paleturquoise | paleturquoise
palevioletred		The color palevioletred | palevioletred
papayawhip		The color papayawhip | papayawhip
peachpuff		The color peachpuff | peachpuff
peru		The color peru | peru
pink		The color pink | pink
plum		The color plum | plum
powderblue		The color powderblue | powderblue
purple		The color purple | purple
red		The color red | red
rosybrown		The color rosybrown | rosybrown
royalblue		The color royalblue | royalblue
saddlebrown		The color saddlebrown | saddlebrown
salmon		The color salmon | salmon
sandybrown		The color sandybrown | sandybrown
seagreen		The color seagreen | seagreen
seashell		The color seashell | seashell
sienna		The color sienna | sienna
silver		The color silver | silver
skyblue		The color skyblue | skyblue
slateblue		The color slateblue | slateblue
slategray		The color slategray | slategray
snow		The color snow | snow
springgreen		The color springgreen | springgreen
steelblue		The color steelblue | steelblue
tan		The color tan | tan
teal		The color teal | teal
thistle		The color thistle | thistle
tomato		The color tomato | tomato
turquoise		The color turquoise | turquoise
violet		The color violet | violet
wheat		The color wheat | wheat
white		The color white | white
whitesmoke		The color whitesmoke | whitesmoke
yellow		The color yellow | yellow
yellowgreen		The color yellowgreen | yellowgreen

Color dataclass

Color(red: int, green: int, blue: int, alpha: float = 1.0)

Bases: object

Represents an RGBA color.

Examples:

color = Color(255, 87, 51)
color.red
color_with_alpha = Color(255, 87, 51, 0.5)

Parameters:

Name	Type	Description	Default
red	int	The red component of the color	required
green	int	The green component of the color	required
blue	int	The blue component of the color	required
alpha	float	The alpha component of the color	1.0

Methods:

Name	Description
__or__	Return a new color with the specified alpha value.
from_hex	Create a color from a hexadecimal string.
from_hexa	Create a color from a hexadecimal string with alpha.
from_rgb	Create a color from RGB components.
from_rgba	Create a color from RGBA components.
to_hex	Return the color as hexadecimal string.
to_hexa	Return the color as hexadecimal string with alpha.
to_rgb	Return the color as RGB tuple.
to_rgba	Return the color as RGBA tuple.
with_alpha	Return a copy of the color with the specified alpha.

__or__

__or__(alpha: float) -> Self

Return a new color with the specified alpha value.

The | operator takes alpha on the same 0.0-1.0 scale used by the constructor, from_rgba, and with_alpha, e.g. red | 0.5 yields an alpha of 0.5.

Parameters:

Name	Type	Description	Default
alpha	float	Alpha value (0.0-1.0).	required

Returns:

Type	Description
Self	A new Color with the specified alpha.

Raises:

Type	Description
ValueError	If alpha is not between 0.0 and 1.0.

Source code in src/momapy/coloring.py

def __or__(self, alpha: float) -> typing_extensions.Self:
    """Return a new color with the specified alpha value.

    The `|` operator takes alpha on the same 0.0-1.0 scale used by the
    constructor, `from_rgba`, and `with_alpha`, e.g. ``red | 0.5`` yields
    an alpha of ``0.5``.

    Args:
        alpha: Alpha value (0.0-1.0).

    Returns:
        A new Color with the specified alpha.

    Raises:
        ValueError: If alpha is not between 0.0 and 1.0.
    """
    if alpha < 0 or alpha > 1:
        raise ValueError("alpha should be a number between 0.0 and 1.0")
    return dataclasses.replace(self, alpha=alpha)

from_hex classmethod

from_hex(color_str: str) -> Self

Create a color from a hexadecimal string.

Parameters:

Name	Type	Description	Default
color_str	str	Hex color string (e.g., "#FF5733" or "FF5733").	required

Returns:

Type	Description
Self	A new Color instance.

Raises:

Type	Description
ValueError	If the hex string is invalid.

Examples:

Color.from_hex("#FF5733")

Source code in src/momapy/coloring.py

@classmethod
def from_hex(cls, color_str: str) -> typing_extensions.Self:
    """Create a color from a hexadecimal string.

    Args:
        color_str: Hex color string (e.g., "#FF5733" or "FF5733").

    Returns:
        A new Color instance.

    Raises:
        ValueError: If the hex string is invalid.

    Examples:
        ```python
        Color.from_hex("#FF5733")
        ```
    """
    color_str = color_str.lstrip("#")
    if len(color_str) != 6:
        raise ValueError(f"invalid hexadecimal RGB value {color_str}")
    red = int(color_str[:2], 16)
    green = int(color_str[2:4], 16)
    blue = int(color_str[4:6], 16)
    return cls(red, green, blue)

from_hexa classmethod

from_hexa(color_str: str) -> Self

Create a color from a hexadecimal string with alpha.

Parameters:

Name	Type	Description	Default
color_str	str	Hex color string with alpha (e.g., "#FF5733FF").	required

Returns:

Type	Description
Self	A new Color instance.

Raises:

Type	Description
ValueError	If the hex string is invalid.

Examples:

Color.from_hexa("#FF573380")

Source code in src/momapy/coloring.py

@classmethod
def from_hexa(cls, color_str: str) -> typing_extensions.Self:
    """Create a color from a hexadecimal string with alpha.

    Args:
        color_str: Hex color string with alpha (e.g., "#FF5733FF").

    Returns:
        A new Color instance.

    Raises:
        ValueError: If the hex string is invalid.

    Examples:
        ```python
        Color.from_hexa("#FF573380")
        ```
    """
    color_str = color_str.lstrip("#")
    if len(color_str) != 8:
        raise ValueError(f"invalid hexadecimal RGBA value {color_str}")
    red = int(color_str[:2], 16)
    green = int(color_str[2:4], 16)
    blue = int(color_str[4:6], 16)
    alpha = int(color_str[6:], 16) / 255
    return cls(red, green, blue, alpha)

from_rgb classmethod

from_rgb(red: float, green: float, blue: float, rgb_range: tuple[float, float] = (0, 255)) -> Self

Create a color from RGB components.

The rgb_range argument mirrors :meth:to_rgb, so from_rgb(*color.to_rgb(rgb_range), rgb_range) round-trips.

Parameters:

Name	Type	Description	Default
red	float	Red component, expressed in rgb_range units.	required
green	float	Green component, expressed in rgb_range units.	required
blue	float	Blue component, expressed in rgb_range units.	required
rgb_range	tuple[float, float]	Range that the RGB components are expressed in, defaults to (0, 255).	(0, 255)

Returns:

Type	Description
Self	A new Color instance with alpha=1.0, normalized to 0-255 RGB.

Examples:

Color.from_rgb(255, 87, 51)
Color.from_rgb(1.0, 0.34, 0.2, rgb_range=(0, 1))

Source code in src/momapy/coloring.py

@classmethod
def from_rgb(
    cls,
    red: float,
    green: float,
    blue: float,
    rgb_range: tuple[float, float] = (0, 255),
) -> typing_extensions.Self:
    """Create a color from RGB components.

    The ``rgb_range`` argument mirrors :meth:`to_rgb`, so
    ``from_rgb(*color.to_rgb(rgb_range), rgb_range)`` round-trips.

    Args:
        red: Red component, expressed in `rgb_range` units.
        green: Green component, expressed in `rgb_range` units.
        blue: Blue component, expressed in `rgb_range` units.
        rgb_range: Range that the RGB components are expressed in,
            defaults to (0, 255).

    Returns:
        A new Color instance with alpha=1.0, normalized to 0-255 RGB.

    Examples:
        ```python
        Color.from_rgb(255, 87, 51)
        Color.from_rgb(1.0, 0.34, 0.2, rgb_range=(0, 1))
        ```
    """
    rgb_width = rgb_range[1] - rgb_range[0]
    return cls(
        round((red - rgb_range[0]) / rgb_width * 255),
        round((green - rgb_range[0]) / rgb_width * 255),
        round((blue - rgb_range[0]) / rgb_width * 255),
    )

from_rgba classmethod

from_rgba(red: float, green: float, blue: float, alpha: float, rgb_range: tuple[float, float] = (0, 255), alpha_range: tuple[float, float] = (0.0, 1.0)) -> Self

Create a color from RGBA components.

The rgb_range and alpha_range arguments mirror :meth:to_rgba, so from_rgba(*color.to_rgba(rgb_range, alpha_range), rgb_range, alpha_range) round-trips.

Parameters:

Name	Type	Description	Default
red	float	Red component, expressed in rgb_range units.	required
green	float	Green component, expressed in rgb_range units.	required
blue	float	Blue component, expressed in rgb_range units.	required
alpha	float	Alpha component, expressed in alpha_range units.	required
rgb_range	tuple[float, float]	Range that the RGB components are expressed in, defaults to (0, 255).	(0, 255)
alpha_range	tuple[float, float]	Range that alpha is expressed in, defaults to (0.0, 1.0).	(0.0, 1.0)

Returns:

Type	Description
Self	A new Color instance, normalized to 0-255 RGB / 0.0-1.0 alpha.

Examples:

Color.from_rgba(255, 87, 51, 0.5)
Color.from_rgba(1.0, 0.34, 0.2, 0.5, rgb_range=(0, 1))

Source code in src/momapy/coloring.py

@classmethod
def from_rgba(
    cls,
    red: float,
    green: float,
    blue: float,
    alpha: float,
    rgb_range: tuple[float, float] = (0, 255),
    alpha_range: tuple[float, float] = (0.0, 1.0),
) -> typing_extensions.Self:
    """Create a color from RGBA components.

    The ``rgb_range`` and ``alpha_range`` arguments mirror
    :meth:`to_rgba`, so ``from_rgba(*color.to_rgba(rgb_range, alpha_range),
    rgb_range, alpha_range)`` round-trips.

    Args:
        red: Red component, expressed in `rgb_range` units.
        green: Green component, expressed in `rgb_range` units.
        blue: Blue component, expressed in `rgb_range` units.
        alpha: Alpha component, expressed in `alpha_range` units.
        rgb_range: Range that the RGB components are expressed in,
            defaults to (0, 255).
        alpha_range: Range that `alpha` is expressed in, defaults to
            (0.0, 1.0).

    Returns:
        A new Color instance, normalized to 0-255 RGB / 0.0-1.0 alpha.

    Examples:
        ```python
        Color.from_rgba(255, 87, 51, 0.5)
        Color.from_rgba(1.0, 0.34, 0.2, 0.5, rgb_range=(0, 1))
        ```
    """
    rgb_width = rgb_range[1] - rgb_range[0]
    alpha_width = alpha_range[1] - alpha_range[0]
    return cls(
        round((red - rgb_range[0]) / rgb_width * 255),
        round((green - rgb_range[0]) / rgb_width * 255),
        round((blue - rgb_range[0]) / rgb_width * 255),
        (alpha - alpha_range[0]) / alpha_width,
    )

to_hex

to_hex() -> str

Return the color as hexadecimal string.

Returns:

Type	Description
str	Hex color string (e.g., "#ff5733").

Examples:

color = Color(255, 87, 51)
color.to_hex()

Source code in src/momapy/coloring.py

def to_hex(self) -> str:
    """Return the color as hexadecimal string.

    Returns:
        Hex color string (e.g., "#ff5733").

    Examples:
        ```python
        color = Color(255, 87, 51)
        color.to_hex()
        ```
    """
    color_str = f"#{format(self.red, '02x')}{format(self.green, '02x')}{format(self.blue, '02x')}"
    return color_str

to_hexa

to_hexa() -> str

Return the color as hexadecimal string with alpha.

The alpha byte is rounded (not truncated), so the from_hexa / to_hexa round-trip is exact for every 8-bit alpha value.

Returns:

Type	Description
str	Hex color string with alpha (e.g., "#ff5733ff").

Examples:

color = Color(255, 87, 51, 0.5)
color.to_hexa()

Source code in src/momapy/coloring.py

def to_hexa(self) -> str:
    """Return the color as hexadecimal string with alpha.

    The alpha byte is rounded (not truncated), so the
    ``from_hexa`` / ``to_hexa`` round-trip is exact for every 8-bit
    alpha value.

    Returns:
        Hex color string with alpha (e.g., "#ff5733ff").

    Examples:
        ```python
        color = Color(255, 87, 51, 0.5)
        color.to_hexa()
        ```
    """
    color_str = f"{self.to_hex()}{format(round(self.alpha * 255), '02x')}"
    return color_str

to_rgb

to_rgb(rgb_range: tuple[float, float] = (0, 255), round_to_int: bool = False) -> tuple[int | float, int | float, int | float]

Return the color as RGB tuple.

The components are sampled onto rgb_range and returned as floats by default. Pass round_to_int=True to round them to integers (e.g. for an 8-bit (0, 255) range).

Parameters:

Name	Type	Description	Default
rgb_range	tuple[float, float]	Range for RGB components, defaults to (0, 255).	(0, 255)
round_to_int	bool	If True, round the components to integers. Defaults to False.	False

Returns:

Type	Description
tuple[int | float, int | float, int | float]	Tuple of (red, green, blue).

Examples:

color = Color(255, 128, 0)
color.to_rgb()
color.to_rgb(round_to_int=True)

Source code in src/momapy/coloring.py

def to_rgb(
    self,
    rgb_range: tuple[float, float] = (0, 255),
    round_to_int: bool = False,
) -> tuple[int | float, int | float, int | float]:
    """Return the color as RGB tuple.

    The components are sampled onto ``rgb_range`` and returned as floats by
    default. Pass ``round_to_int=True`` to round them to integers (e.g. for
    an 8-bit ``(0, 255)`` range).

    Args:
        rgb_range: Range for RGB components, defaults to (0, 255).
        round_to_int: If True, round the components to integers. Defaults to
            False.

    Returns:
        Tuple of (red, green, blue).

    Examples:
        ```python
        color = Color(255, 128, 0)
        color.to_rgb()
        color.to_rgb(round_to_int=True)
        ```
    """
    width = rgb_range[1] - rgb_range[0]
    red = rgb_range[0] + (self.red / 255) * width
    green = rgb_range[0] + (self.green / 255) * width
    blue = rgb_range[0] + (self.blue / 255) * width
    if round_to_int:
        red = int(round(red))
        green = int(round(green))
        blue = int(round(blue))
    return (red, green, blue)

to_rgba

to_rgba(rgb_range: tuple[float, float] = (0, 255), alpha_range: tuple[float, float] = (0.0, 1.0), rgba_range: tuple[float, float] | None = None, round_to_int: bool = False) -> tuple[int | float, int | float, int | float, float]

Return the color as RGBA tuple.

The RGB components are sampled onto rgb_range and returned as floats by default. Pass round_to_int=True to round them to integers (e.g. for an 8-bit (0, 255) range).

Parameters:

Name	Type	Description	Default
rgb_range	tuple[float, float]	Range for RGB components, defaults to (0, 255).	(0, 255)
alpha_range	tuple[float, float]	Range for alpha component, defaults to (0.0, 1.0).	(0.0, 1.0)
rgba_range	tuple[float, float] | None	Override range for all components.	None
round_to_int	bool	If True, round the RGB components to integers. Defaults to False.	False

Returns:

Type	Description
tuple[int | float, int | float, int | float, float]	Tuple of (red, green, blue, alpha).

Examples:

color = Color(255, 128, 0)
color.to_rgba()
color.to_rgba(rgb_range=(0.0, 1.0))
color.to_rgba(round_to_int=True)

Source code in src/momapy/coloring.py

def to_rgba(
    self,
    rgb_range: tuple[float, float] = (0, 255),
    alpha_range: tuple[float, float] = (0.0, 1.0),
    rgba_range: tuple[float, float] | None = None,
    round_to_int: bool = False,
) -> tuple[int | float, int | float, int | float, float]:
    """Return the color as RGBA tuple.

    The RGB components are sampled onto ``rgb_range`` and returned as floats
    by default. Pass ``round_to_int=True`` to round them to integers (e.g.
    for an 8-bit ``(0, 255)`` range).

    Args:
        rgb_range: Range for RGB components, defaults to (0, 255).
        alpha_range: Range for alpha component, defaults to (0.0, 1.0).
        rgba_range: Override range for all components.
        round_to_int: If True, round the RGB components to integers.
            Defaults to False.

    Returns:
        Tuple of (red, green, blue, alpha).

    Examples:
        ```python
        color = Color(255, 128, 0)
        color.to_rgba()
        color.to_rgba(rgb_range=(0.0, 1.0))
        color.to_rgba(round_to_int=True)
        ```
    """
    if rgba_range is not None:
        rgb_range = rgba_range
        alpha_range = rgba_range
    rgb_width = rgb_range[1] - rgb_range[0]
    alpha_width = alpha_range[1] - alpha_range[0]
    red = rgb_range[0] + (self.red / 255) * rgb_width
    green = rgb_range[0] + (self.green / 255) * rgb_width
    blue = rgb_range[0] + (self.blue / 255) * rgb_width
    alpha = alpha_range[0] + self.alpha * alpha_width
    if round_to_int:
        red = int(round(red))
        green = int(round(green))
        blue = int(round(blue))
    return (red, green, blue, alpha)

with_alpha

with_alpha(alpha: float, alpha_range: tuple[float, float] = (0, 1)) -> Self

Return a copy of the color with the specified alpha.

Parameters:

Name	Type	Description	Default
alpha	float	Alpha value, expressed in alpha_range units.	required
alpha_range	tuple[float, float]	Range that alpha is expressed in, defaults to (0, 1).	(0, 1)

Returns:

Type	Description
Self	A new Color with the specified alpha, normalized to 0.0-1.0.

Raises:

Type	Description
ValueError	If alpha falls outside alpha_range.

Source code in src/momapy/coloring.py

def with_alpha(
    self, alpha: float, alpha_range: tuple[float, float] = (0, 1)
) -> typing_extensions.Self:
    """Return a copy of the color with the specified alpha.

    Args:
        alpha: Alpha value, expressed in `alpha_range` units.
        alpha_range: Range that `alpha` is expressed in, defaults to
            (0, 1).

    Returns:
        A new Color with the specified alpha, normalized to 0.0-1.0.

    Raises:
        ValueError: If `alpha` falls outside `alpha_range`.
    """
    alpha_width = alpha_range[1] - alpha_range[0]
    if alpha < alpha_range[0] or alpha > alpha_range[1]:
        raise ValueError(
            f"alpha should be a number between {alpha_range[0]} and "
            f"{alpha_range[1]}"
        )
    return dataclasses.replace(self, alpha=(alpha - alpha_range[0]) / alpha_width)

aliceblue module-attribute

aliceblue = Color.from_rgb(240, 248, 255)

The color aliceblue | aliceblue

antiquewhite module-attribute

antiquewhite = Color.from_rgb(250, 235, 215)

The color antiquewhite | antiquewhite

aqua module-attribute

aqua = Color.from_rgb(0, 255, 255)

The color aqua | aqua

aquamarine module-attribute

aquamarine = Color.from_rgb(127, 255, 212)

The color aquamarine | aquamarine

azure module-attribute

azure = Color.from_rgb(240, 255, 255)

The color azure | azure

beige module-attribute

beige = Color.from_rgb(245, 245, 220)

The color beige | beige

bisque module-attribute

bisque = Color.from_rgb(255, 228, 196)

The color bisque | bisque

black module-attribute

black = Color.from_rgb(0, 0, 0)

The color black | black

blanchedalmond module-attribute

blanchedalmond = Color.from_rgb(255, 235, 205)

The color blanchedalmond | blanchedalmond

blue module-attribute

blue = Color.from_rgb(0, 0, 255)

The color blue | blue

blueviolet module-attribute

blueviolet = Color.from_rgb(138, 43, 226)

The color blueviolet | blueviolet

brown module-attribute

brown = Color.from_rgb(165, 42, 42)

The color brown | brown

burlywood module-attribute

burlywood = Color.from_rgb(222, 184, 135)

The color burlywood | burlywood

cadetblue module-attribute

cadetblue = Color.from_rgb(95, 158, 160)

The color cadetblue | cadetblue

chartreuse module-attribute

chartreuse = Color.from_rgb(127, 255, 0)

The color chartreuse | chartreuse

chocolate module-attribute

chocolate = Color.from_rgb(210, 105, 30)

The color chocolate | chocolate

coral module-attribute

coral = Color.from_rgb(255, 127, 80)

The color coral | coral

cornflowerblue module-attribute

cornflowerblue = Color.from_rgb(100, 149, 237)

The color cornflowerblue | cornflowerblue

cornsilk module-attribute

cornsilk = Color.from_rgb(255, 248, 220)

The color cornsilk | cornsilk

crimson module-attribute

crimson = Color.from_rgb(220, 20, 60)

The color crimson | crimson

cyan module-attribute

cyan = Color.from_rgb(0, 255, 255)

The color cyan | cyan

darkblue module-attribute

darkblue = Color.from_rgb(0, 0, 139)

The color darkblue | darkblue

darkcyan module-attribute

darkcyan = Color.from_rgb(0, 139, 139)

The color darkcyan | darkcyan

darkgoldenrod module-attribute

darkgoldenrod = Color.from_rgb(184, 134, 11)

The color darkgoldenrod | darkgoldenrod

darkgray module-attribute

darkgray = Color.from_rgb(169, 169, 169)

The color darkgray | darkgray

darkgreen module-attribute

darkgreen = Color.from_rgb(0, 100, 0)

The color darkgreen | darkgreen

darkgrey module-attribute

darkgrey = Color.from_rgb(169, 169, 169)

The color darkgrey | darkgrey

darkkhaki module-attribute

darkkhaki = Color.from_rgb(189, 183, 107)

The color darkkhaki | darkkhaki

darkmagenta module-attribute

darkmagenta = Color.from_rgb(139, 0, 139)

The color darkmagenta | darkmagenta

darkolivegreen module-attribute

darkolivegreen = Color.from_rgb(85, 107, 47)

The color darkolivegreen | darkolivegreen

darkorange module-attribute

darkorange = Color.from_rgb(255, 140, 0)

The color darkorange | darkorange

darkorchid module-attribute

darkorchid = Color.from_rgb(153, 50, 204)

The color darkorchid | darkorchid

darkred module-attribute

darkred = Color.from_rgb(139, 0, 0)

The color darkred | darkred

darksalmon module-attribute

darksalmon = Color.from_rgb(233, 150, 122)

The color darksalmon | darksalmon

darkseagreen module-attribute

darkseagreen = Color.from_rgb(143, 188, 143)

The color darkseagreen | darkseagreen

darkslateblue module-attribute

darkslateblue = Color.from_rgb(72, 61, 139)

The color darkslateblue | darkslateblue

darkslategray module-attribute

darkslategray = Color.from_rgb(47, 79, 79)

The color darkslategray | darkslategray

darkturquoise module-attribute

darkturquoise = Color.from_rgb(0, 206, 209)

The color darkturquoise | darkturquoise

darkviolet module-attribute

darkviolet = Color.from_rgb(148, 0, 211)

The color darkviolet | darkviolet

deeppink module-attribute

deeppink = Color.from_rgb(255, 20, 147)

The color deeppink | deeppink

deepskyblue module-attribute

deepskyblue = Color.from_rgb(0, 191, 255)

The color deepskyblue | deepskyblue

dimgray module-attribute

dimgray = Color.from_rgb(105, 105, 105)

The color dimgray | dimgray

dimgrey module-attribute

dimgrey = Color.from_rgb(105, 105, 105)

The color dimgrey | dimgrey

dodgerblue module-attribute

dodgerblue = Color.from_rgb(30, 144, 255)

The color dodgerblue | dodgerblue

firebrick module-attribute

firebrick = Color.from_rgb(178, 34, 34)

The color firebrick | firebrick

floralwhite module-attribute

floralwhite = Color.from_rgb(255, 250, 240)

The color floralwhite | floralwhite

forestgreen module-attribute

forestgreen = Color.from_rgb(34, 139, 34)

The color forestgreen | forestgreen

fuchsia module-attribute

fuchsia = Color.from_rgb(255, 0, 255)

The color fuchsia | fuchsia

gainsboro module-attribute

gainsboro = Color.from_rgb(220, 220, 220)

The color gainsboro | gainsboro

get_color

get_color(color_name: str) -> Color

Return the named color with the given name.

Parameters:

Name	Type	Description	Default
color_name	str	Name of the color to look up.	required

Returns:

Type	Description
Color	The corresponding Color.

Raises:

Type	Description
KeyError	If no color with that name exists.

Examples:

get_color("red")

Source code in src/momapy/coloring.py

def get_color(color_name: str) -> Color:
    """Return the named color with the given name.

    Args:
        color_name: Name of the color to look up.

    Returns:
        The corresponding Color.

    Raises:
        KeyError: If no color with that name exists.

    Examples:
        ```python
        get_color("red")
        ```
    """
    return _NAME_TO_COLOR[color_name]

ghostwhite module-attribute

ghostwhite = Color.from_rgb(248, 248, 255)

The color ghostwhite | ghostwhite

gold module-attribute

gold = Color.from_rgb(255, 215, 0)

The color gold | gold

goldenrod module-attribute

goldenrod = Color.from_rgb(218, 165, 32)

The color goldenrod | goldenrod

gray module-attribute

gray = Color.from_rgb(128, 128, 128)

The color gray | gray

green module-attribute

green = Color.from_rgb(0, 128, 0)

The color green | green

greenyellow module-attribute

greenyellow = Color.from_rgb(173, 255, 47)

The color greenyellow | greenyellow

grey module-attribute

grey = Color.from_rgb(128, 128, 128)

The color grey | grey

has_color

has_color(color_name: str) -> bool

Check if a named color exists.

Parameters:

Name	Type	Description	Default
color_name	str	Name of the color to check.	required

Returns:

Type	Description
bool	True if the color exists, False otherwise.

Examples:

has_color("red")
has_color("not_a_color")

Source code in src/momapy/coloring.py

def has_color(color_name: str) -> bool:
    """Check if a named color exists.

    Args:
        color_name: Name of the color to check.

    Returns:
        True if the color exists, False otherwise.

    Examples:
        ```python
        has_color("red")
        has_color("not_a_color")
        ```
    """
    return color_name in _NAME_TO_COLOR

honeydew module-attribute

honeydew = Color.from_rgb(240, 255, 240)

The color honeydew | honeydew

hotpink module-attribute

hotpink = Color.from_rgb(255, 105, 180)

The color hotpink | hotpink

indianred module-attribute

indianred = Color.from_rgb(205, 92, 92)

The color indianred | indianred

indigo module-attribute

indigo = Color.from_rgb(75, 0, 130)

The color indigo | indigo

ivory module-attribute

ivory = Color.from_rgb(255, 255, 240)

The color ivory | ivory

khaki module-attribute

khaki = Color.from_rgb(240, 230, 140)

The color khaki | khaki

lavender module-attribute

lavender = Color.from_rgb(230, 230, 250)

The color lavender | lavender

lavenderblush module-attribute

lavenderblush = Color.from_rgb(255, 240, 245)

The color lavenderblush | lavenderblush

lawngreen module-attribute

lawngreen = Color.from_rgb(124, 252, 0)

The color lawngreen | lawngreen

lemonchiffon module-attribute

lemonchiffon = Color.from_rgb(255, 250, 205)

The color lemonchiffon | lemonchiffon

lightblue module-attribute

lightblue = Color.from_rgb(173, 216, 230)

The color lightblue | lightblue

lightcoral module-attribute

lightcoral = Color.from_rgb(240, 128, 128)

The color lightcoral | lightcoral

lightcyan module-attribute

lightcyan = Color.from_rgb(224, 255, 255)

The color lightcyan | lightcyan

lightgoldenrodyellow module-attribute

lightgoldenrodyellow = Color.from_rgb(250, 250, 210)

The color lightgoldenrodyellow | lightgoldenrodyellow

lightgray module-attribute

lightgray = Color.from_rgb(211, 211, 211)

The color lightgray | lightgray

lightgreen module-attribute

lightgreen = Color.from_rgb(144, 238, 144)

The color lightgreen | lightgreen

lightgrey module-attribute

lightgrey = Color.from_rgb(211, 211, 211)

The color lightgrey | lightgrey

lightpink module-attribute

lightpink = Color.from_rgb(255, 182, 193)

The color lightpink | lightpink

lightsalmon module-attribute

lightsalmon = Color.from_rgb(255, 160, 122)

The color lightsalmon | lightsalmon

lightseagreen module-attribute

lightseagreen = Color.from_rgb(32, 178, 170)

The color lightseagreen | lightseagreen

lightskyblue module-attribute

lightskyblue = Color.from_rgb(135, 206, 250)

The color lightskyblue | lightskyblue

lightslategray module-attribute

lightslategray = Color.from_rgb(119, 136, 153)

The color lightslategray | lightslategray

lightsteelblue module-attribute

lightsteelblue = Color.from_rgb(176, 196, 222)

The color lightsteelblue | lightsteelblue

lightyellow module-attribute

lightyellow = Color.from_rgb(255, 255, 224)

The color lightyellow | lightyellow

lime module-attribute

lime = Color.from_rgb(0, 255, 0)

The color lime | lime

limegreen module-attribute

limegreen = Color.from_rgb(50, 205, 50)

The color limegreen | limegreen

linen module-attribute

linen = Color.from_rgb(250, 240, 230)

The color linen | linen

list_colors

list_colors() -> list[str]

Return the names of all available named colors.

Returns:

Type	Description
list[str]	List of color names for all predefined colors.

Examples:

colors = list_colors()
len(colors) > 0

Source code in src/momapy/coloring.py

def list_colors() -> list[str]:
    """Return the names of all available named colors.

    Returns:
        List of color names for all predefined colors.

    Examples:
        ```python
        colors = list_colors()
        len(colors) > 0
        ```
    """
    return list(_NAME_TO_COLOR.keys())

magenta module-attribute

magenta = Color.from_rgb(255, 0, 255)

The color magenta | magenta

maroon module-attribute

maroon = Color.from_rgb(128, 0, 0)

The color maroon | maroon

mediumaquamarine module-attribute

mediumaquamarine = Color.from_rgb(102, 205, 170)

The color mediumaquamarine | mediumaquamarine

mediumblue module-attribute

mediumblue = Color.from_rgb(0, 0, 205)

The color mediumblue | mediumblue

mediumorchid module-attribute

mediumorchid = Color.from_rgb(186, 85, 211)

The color mediumorchid | mediumorchid

mediumpurple module-attribute

mediumpurple = Color.from_rgb(147, 112, 219)

The color mediumpurple | mediumpurple

mediumseagreen module-attribute

mediumseagreen = Color.from_rgb(60, 179, 113)

The color mediumseagreen | mediumseagreen

mediumslateblue module-attribute

mediumslateblue = Color.from_rgb(123, 104, 238)

The color mediumslateblue | mediumslateblue

mediumspringgreen module-attribute

mediumspringgreen = Color.from_rgb(0, 250, 154)

The color mediumspringgreen | mediumspringgreen

mediumturquoise module-attribute

mediumturquoise = Color.from_rgb(72, 209, 204)

The color mediumturquoise | mediumturquoise

mediumvioletred module-attribute

mediumvioletred = Color.from_rgb(199, 21, 133)

The color mediumvioletred | mediumvioletred

midnightblue module-attribute

midnightblue = Color.from_rgb(25, 25, 112)

The color midnightblue | midnightblue

mintcream module-attribute

mintcream = Color.from_rgb(245, 255, 250)

The color mintcream | mintcream

mistyrose module-attribute

mistyrose = Color.from_rgb(255, 228, 225)

The color mistyrose | mistyrose

moccasin module-attribute

moccasin = Color.from_rgb(255, 228, 181)

The color moccasin | moccasin

navajowhite module-attribute

navajowhite = Color.from_rgb(255, 222, 173)

The color navajowhite | navajowhite

navy module-attribute

navy = Color.from_rgb(0, 0, 128)

The color navy | navy

oldlace module-attribute

oldlace = Color.from_rgb(253, 245, 230)

The color oldlace | oldlace

olive module-attribute

olive = Color.from_rgb(128, 128, 0)

The color olive | olive

olivedrab module-attribute

olivedrab = Color.from_rgb(107, 142, 35)

The color olivedrab | olivedrab

orange module-attribute

orange = Color.from_rgb(255, 165, 0)

The color orange | orange

orangered module-attribute

orangered = Color.from_rgb(255, 69, 0)

The color orangered | orangered

orchid module-attribute

orchid = Color.from_rgb(218, 112, 214)

The color orchid | orchid

palegoldenrod module-attribute

palegoldenrod = Color.from_rgb(238, 232, 170)

The color palegoldenrod | palegoldenrod

palegreen module-attribute

palegreen = Color.from_rgb(152, 251, 152)

The color palegreen | palegreen

paleturquoise module-attribute

paleturquoise = Color.from_rgb(175, 238, 238)

The color paleturquoise | paleturquoise

palevioletred module-attribute

palevioletred = Color.from_rgb(219, 112, 147)

The color palevioletred | palevioletred

papayawhip module-attribute

papayawhip = Color.from_rgb(255, 239, 213)

The color papayawhip | papayawhip

peachpuff module-attribute

peachpuff = Color.from_rgb(255, 218, 185)

The color peachpuff | peachpuff

peru module-attribute

peru = Color.from_rgb(205, 133, 63)

The color peru | peru

pink module-attribute

pink = Color.from_rgb(255, 192, 203)

The color pink | pink

plum module-attribute

plum = Color.from_rgb(221, 160, 221)

The color plum | plum

powderblue module-attribute

powderblue = Color.from_rgb(176, 224, 230)

The color powderblue | powderblue

print_colors

print_colors() -> None

Print all available named colors with their names.

Displays color names in their actual color in the terminal.

Examples:

print_colors()  # Prints all colors

Source code in src/momapy/coloring.py

def print_colors() -> None:
    """Print all available named colors with their names.

    Displays color names in their actual color in the terminal.

    Examples:
        ```python
        print_colors()  # Prints all colors
        ```
    """
    for color_name, color in _NAME_TO_COLOR.items():
        print(f"\x1b[38;2;{color.red};{color.green};{color.blue}m{color_name}\x1b[0m")

purple module-attribute

purple = Color.from_rgb(128, 0, 128)

The color purple | purple

red module-attribute

red = Color.from_rgb(255, 0, 0)

The color red | red

rosybrown module-attribute

rosybrown = Color.from_rgb(188, 143, 143)

The color rosybrown | rosybrown

royalblue module-attribute

royalblue = Color.from_rgb(65, 105, 225)

The color royalblue | royalblue

saddlebrown module-attribute

saddlebrown = Color.from_rgb(139, 69, 19)

The color saddlebrown | saddlebrown

salmon module-attribute

salmon = Color.from_rgb(250, 128, 114)

The color salmon | salmon

sandybrown module-attribute

sandybrown = Color.from_rgb(244, 164, 96)

The color sandybrown | sandybrown

seagreen module-attribute

seagreen = Color.from_rgb(46, 139, 87)

The color seagreen | seagreen

seashell module-attribute

seashell = Color.from_rgb(255, 245, 238)

The color seashell | seashell

sienna module-attribute

sienna = Color.from_rgb(160, 82, 45)

The color sienna | sienna

silver module-attribute

silver = Color.from_rgb(192, 192, 192)

The color silver | silver

skyblue module-attribute

skyblue = Color.from_rgb(135, 206, 235)

The color skyblue | skyblue

slateblue module-attribute

slateblue = Color.from_rgb(106, 90, 205)

The color slateblue | slateblue

slategray module-attribute

slategray = Color.from_rgb(112, 128, 144)

The color slategray | slategray

snow module-attribute

snow = Color.from_rgb(255, 250, 250)

The color snow | snow

springgreen module-attribute

springgreen = Color.from_rgb(0, 255, 127)

The color springgreen | springgreen

steelblue module-attribute

steelblue = Color.from_rgb(70, 130, 180)

The color steelblue | steelblue

tan module-attribute

tan = Color.from_rgb(210, 180, 140)

The color tan | tan

teal module-attribute

teal = Color.from_rgb(0, 128, 128)

The color teal | teal

thistle module-attribute

thistle = Color.from_rgb(216, 191, 216)

The color thistle | thistle

tomato module-attribute

tomato = Color.from_rgb(255, 99, 71)

The color tomato | tomato

turquoise module-attribute

turquoise = Color.from_rgb(64, 224, 208)

The color turquoise | turquoise

violet module-attribute

violet = Color.from_rgb(238, 130, 238)

The color violet | violet

wheat module-attribute

wheat = Color.from_rgb(245, 222, 179)

The color wheat | wheat

white module-attribute

white = Color.from_rgb(255, 255, 255)

The color white | white

whitesmoke module-attribute

whitesmoke = Color.from_rgb(245, 245, 245)

The color whitesmoke | whitesmoke

yellow module-attribute

yellow = Color.from_rgb(255, 255, 0)

The color yellow | yellow

yellowgreen module-attribute

yellowgreen = Color.from_rgb(154, 205, 50)

The color yellowgreen | yellowgreen