Skip to content

theme ¤

Classes:

Functions:

ColorParameter ¤

ColorParameter(*args, **kwargs)

Bases: Parameter

Methods:

Attributes:

color_function instance-attribute ¤

color_function: Callable[[object], str]

name instance-attribute ¤

name = name

default instance-attribute ¤

default = default

param_class instance-attribute ¤

param_class = param_class or PARAM_CLASSES[type(default)]

set_show_doc instance-attribute ¤

set_show_doc = set_show_doc

help_docstring instance-attribute ¤

help_docstring = help_docstring

enum_sequence instance-attribute ¤

enum_sequence = enum_sequence

scope instance-attribute ¤

scope = scope

update_listeners instance-attribute ¤

update_listeners: list[Callable[[Any], None]] = []

value property writable ¤

value: Any

is_changed property ¤

is_changed: bool

update_color_function ¤

update_color_function()

add_update_listener ¤

add_update_listener(listener: Callable[[Any], None]) -> None

revert_default ¤

revert_default() -> None

attr_name ¤

attr_name() -> str

Returns the attribute name associated with this config option, i.e. my-config has the attribute name my_config

__getattr__ ¤

__getattr__(name: str)

pretty_val ¤

pretty_val(val: Any) -> str

Convert a value this object could contain to its pretty string representation.

pretty ¤

pretty() -> str

pretty_default ¤

pretty_default() -> str

__int__ ¤

__int__() -> int

__str__ ¤

__str__() -> str

__bool__ ¤

__bool__() -> bool

__eq__ ¤

__eq__(other: object) -> bool

__lt__ ¤

__lt__(other: object) -> bool

__add__ ¤

__add__(other: int) -> int

__radd__ ¤

__radd__(other: int) -> int

__sub__ ¤

__sub__(other: int) -> int

__rsub__ ¤

__rsub__(other: int) -> int

__mul__ ¤

__mul__(other: int) -> int

__rmul__ ¤

__rmul__(other: int) -> str

__div__ ¤

__div__(other: float) -> float

__floordiv__ ¤

__floordiv__(other: int) -> int

__pow__ ¤

__pow__(other: int) -> int

__mod__ ¤

__mod__(other: int) -> int

__len__ ¤

__len__() -> int

add_param ¤

add_param(
    name: str,
    default: Any,
    set_show_doc: str,
    *,
    help_docstring: str = "",
    param_class: int | None = None,
    enum_sequence: Sequence[str] | None = None,
) -> Parameter

add_color_param ¤

add_color_param(
    name: str, default: Any, set_show_doc: str, *, help_docstring: str = ""
) -> ColorParameter