typeshed/stubs/colour/colour.pyi at 78b09e2ab2f0cc9cff5664d85e896fe2117542cd · python/typeshed · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
import re
from collections.abc import Callable, Generator, Hashable
from types import NotImplementedType
from typing import Any, Final, final, overload
from typing_extensions import Self

FLOAT_ERROR: Final[float] = 0.0000005

RGB_TO_COLOR_NAMES: Final[dict[tuple[int, int, int], list[str]]]

COLOR_NAME_TO_RGB: Final[dict[list[str], tuple[int, int, int]]]

LONG_HEX_COLOR: Final[re.Pattern[str]]
SHORT_HEX_COLOR: Final[re.Pattern[str]]

@final
class C_HSL:
    def __getattr__(self, value: str) -> tuple[float, float, float]: ...

@final
class C_RGB:
    def __getattr__(self, value: str) -> tuple[float, float, float]: ...

@final
class C_HEX:
    def __getattr__(self, value: str) -> str: ...

HSL: Final[C_HSL]
RGB: Final[C_RGB]
HEX: Final[C_HEX]

def hsl2rgb(hsl: tuple[float, float, float]) -> tuple[float, float, float]: ...
def rgb2hsl(rgb: tuple[float, float, float]) -> tuple[float, float, float]: ...
def _hue2rgb(v1: float, v2: float, vH: float) -> float: ...
def rgb2hex(rgb: tuple[float, float, float], force_long: bool = False) -> str: ...
def hex2rgb(str_rgb: str) -> tuple[float, float, float]: ...
def hex2web(hex: str) -> str: ...
def web2hex(web: str, force_long: bool = False) -> str: ...

hsl2hex: Final[Callable[[tuple[float, float, float]], str]]
hex2hsl: Final[Callable[[str], tuple[float, float, float]]]
rgb2web: Final[Callable[[tuple[float, float, float]], str]]
web2rgb: Final[Callable[[str], tuple[float, float, float]]]
web2hsl: Final[Callable[[str], tuple[float, float, float]]]
hsl2web: Final[Callable[[tuple[float, float, float]], str]]

def color_scale(
    begin_hsl: tuple[float, float, float], end_hsl: tuple[float, float, float], nb: int
) -> tuple[float, float, float]: ...
def RGB_color_picker(obj: Any) -> Color: ...

@overload
def hash_or_str(obj: Hashable) -> int: ...
@overload
def hash_or_str(obj: object) -> str: ...  # type: ignore[overload-cannot-match]

class Color:
    def __init__(
        self,
        color: Self | str | None = None,
        pick_for: object | None = None,
        picker: Callable[[object], Color] = ...,
        pick_key: Callable[[object], int | str] = ...,
        **kwargs: Any,
    ) -> None: ...
    def __getattr__(self, label: str) -> Any: ...
    def __setattr__(self, label: str, value: Any) -> None: ...
    def get_hsl(self) -> tuple[float, float, float]: ...
    def get_hex(self) -> str: ...
    def get_hex_l(self) -> str: ...
    def get_rgb(self) -> tuple[float, float, float]: ...
    def get_hue(self) -> float: ...
    def get_saturation(self) -> float: ...
    def get_luminance(self) -> float: ...
    def get_red(self) -> float: ...
    def get_green(self) -> float: ...
    def get_blue(self) -> float: ...
    def get_web(self) -> str: ...
    def set_hsl(self, value: float) -> None: ...
    def set_rgb(self, value: float) -> None: ...
    def set_hue(self, value: float) -> None: ...
    def set_saturation(self, value: float) -> None: ...
    def set_luminance(self, value: float) -> None: ...
    def set_red(self, value: float) -> None: ...
    def set_green(self, value: float) -> None: ...
    def set_blue(self, value: float) -> None: ...
    def set_hex(self, value: str) -> None: ...

    set_hex_l: Final[Callable[[str], None]] = ...

    def set_web(self, value: str) -> None: ...
    def range_to(self, value: str | Color | None, steps: int) -> Generator[Color]: ...
    def __eq__(self, other: object) -> bool | NotImplementedType: ...  # type: ignore[override]

RGB_equivalence: Final[Callable[[Color, Color], bool]]
HSL_equivalence: Final[Callable[[Color, Color], bool]]

def make_color_factory(
    **kwargs_defaults: Any,
) -> Callable[
    [Color | str | None, object | None, Callable[[object], Color], object | None, Callable[[object], int | str]], Color
]: ...