Skip to content

Color

Qt Base Class: QColor

Signature: QColor(self) -> None QColor(self, arg__1: Any) -> None QColor(self, color: PySide6.QtCore.Qt.GlobalColor) -> None QColor(self, name: str) -> None QColor(self, r: int, g: int, b: int, a: int = 255) -> None QColor(self, rgb: int) -> None QColor(self, rgba64: PySide6.QtGui.QRgba64) -> None QColor(self, spec: PySide6.QtGui.QColor.Spec, a1: int, a2: int, a3: int, a4: int, a5: int = 0) -> None

Base classes

Name Children Inherits
QColor
PySide6.QtGui
QColor(self) -> None

⋔ Inheritance diagram

graph TD
  1473245596304["gui.Color"]
  1473300180944["QtGui.QColor"]
  1473291690208["Shiboken.Object"]
  140713234304496["builtins.object"]
  1473300180944 --> 1473245596304
  1473291690208 --> 1473300180944
  140713234304496 --> 1473291690208

🛈 DocStrings

Bases: QColor

Colors based on RGB, HSV or CMYK values.

Source code in prettyqt\gui\color.py 
 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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
class Color(QtGui.QColor):
    """Colors based on RGB, HSV or CMYK values."""

    def __init__(self, *args):
        match args:
            case (QtGui.QColor(),):
                super().__init__()
                self.setRgba(args[0].rgba())
            case (str(),):
                if not is_valid_color(args[0]):
                    raise ValueError(args[0])
                super().__init__(args[0])
            case _:
                super().__init__(*args)

    def __repr__(self):
        return get_repr(self, self.red(), self.green(), self.blue(), self.alpha())

    def __str__(self):
        return self.name() if self.alpha() == 255 else self.name(self.NameFormat.HexArgb)

    def __reduce__(self):
        return type(self), (self.red(), self.green(), self.blue(), self.alpha())

    def __format__(self, format_spec: NameStr):
        try:
            return self.get_name(format_spec)
        except ValueError:
            return super().__format__(format_spec)

    @property
    def _red(self) -> int:
        return self.red()

    @property
    def _green(self) -> int:
        return self.green()

    @property
    def _blue(self) -> int:
        return self.blue()

    @property
    def _alpha(self) -> int:
        return self.alpha()

    __match_args__ = ("_red", "_green", "_blue", "_alpha")

    def serialize(self) -> dict[str, Any]:
        return dict(color=self.name())

    def set_color(self, color: str | tuple):
        if isinstance(color, str):
            self.setNamedColor(color)
        else:
            self.setRgb(*color)

    @classmethod
    def from_cmyk(cls, c: float, m: float, y: float, k: float, a: float = 1.0) -> Self:
        return cls(cls.fromCmykF(c, m, y, k, a))

    @classmethod
    def from_hsv(cls, h: float, s: float, v: float, a: float = 1.0) -> Self:
        return cls(cls.fromHsvF(h, s, v, a))

    # @classmethod
    # def interpolate_color(
    #     cls,
    #     start: QtGui.QColor,
    #     end: QtGui.QColor,
    #     percent: int,
    #     colorspace: SpecStr | QtGui.QColor.Spec = "rgb",
    # ) -> Self:
    #     """Get an interpolated color value.

    #     Args:
    #         start: The start color.
    #         end: The end color.
    #         percent: Which value to get (0 - 100)
    #         colorspace: The desired interpolation color system. If None, take
    #                     system from start color.
    #     Return:
    #         The interpolated QColor, with the same spec as the given start color.
    #     """
    #     def _get_color(colorspace, start, end):
    #         out = cls()
    #         match colorspace:
    #             case "rgb":
    #                 components = helpers.get_color_percentage(
    #                     start.getRgb(), end.getRgb(), percent  # type: ignore
    #                 )
    #                 out.setRgb(*components)
    #             case "hsv":
    #                 components = helpers.get_color_percentage(
    #                     start.getHsv(), end.getHsv(), percent  # type: ignore
    #                 )
    #                 out.setHsv(*components)
    #             case "hsl":
    #                 components = helpers.get_color_percentage(
    #                     start.getHsl(), end.getHsl(), percent  # type: ignore
    #                 )
    #                 out.setHsl(*components)
    #         return out

    #     match colorspace:
    #         case None:
    #             colorspace = SPEC.inverse[start.spec()]
    #             color = _get_color(colorspace, start, end)
    #         case str() | QtGui.QColor.Spec():
    #             colorspace = SPEC.get_str_value(colorspace)
    #             color = _get_color(colorspace, start, end)
    #         case _:
    #             raise ValueError("Invalid colorspace!")
    #     return cls(color.convert_to(colorspace))

    @classmethod
    def interpolate_color(
        cls,
        start: QtGui.QColor,
        end: QtGui.QColor,
        percent: int,
        colorspace: SpecStr | None = "rgb",
    ) -> Self:
        """Get an interpolated color value.

        Args:
            start: The start color.
            end: The end color.
            percent: Which value to get (0 - 100)
            colorspace: The desired interpolation color system,
                        QColor::{Rgb,Hsv,Hsl} (from QColor::Spec enum)
                        If None, start is used except when percent is 100.

        Return:
            The interpolated QColor, with the same spec as the given start color.
        """
        if colorspace is None:
            return cls(*end.getRgb()) if percent == 100 else cls(*start.getRgb())
        out = cls()
        match colorspace:
            case "rgb":
                components = helpers.get_color_percentage(
                    start.getRgb(), end.getRgb(), percent  # type: ignore
                )
                out.setRgb(*components)
            case "hsv":
                components = helpers.get_color_percentage(
                    start.getHsv(), end.getHsv(), percent  # type: ignore
                )
                out.setHsv(*components)
            case "hsl":
                components = helpers.get_color_percentage(
                    start.getHsl(), end.getHsl(), percent  # type: ignore
                )
                out.setHsl(*components)
            case _:
                raise ValueError("Invalid colorspace!")
        return cls(out.convertTo(start.spec()))

    def is_dark(self) -> bool:
        """Check whether a color is 'dark'."""
        return self.lightness() < 128

    def get_spec(self) -> SpecStr:
        return SPEC.inverse[self.spec()]

    def convert_to(self, spec: SpecStr) -> Self:
        # return Color(self.convertTo(SPEC[spec]))
        color = type(self)()
        match spec:
            case "rgb":
                rgb = self.getRgb()
                color.setRgb(*rgb)
            case "hsv":
                hsv = self.getHsv()
                color.setHsv(*hsv)
            case "cmyk":
                cmyk = self.getCmyk()
                color.setCmyk(*cmyk)
            case "hsl":
                hsl = self.getHsl()
                color.setHsl(*hsl)
            case "extended_rgb":
                ergb = self.getRgbF()
                color.setRgbF(*ergb)
        return color

    def get_name(self, name_format: NameStr = "hex_argb") -> str:
        match name_format:
            case "svg_rgb" | "svg_argb" if not self.isValid():
                return 'fill=""'
            case "svg_rgb":
                return f'fill="rgb({self.red()}, {self.green()}, {self.blue()})"'
            case "svg_argb":
                fill_str = f"rgb({self.red()}, {self.green()}, {self.blue()})"
                return f'fill="{fill_str}" fill-opacity="{self.alpha()}"'
            case "qcss_argb" | "qcss_rgb":
                return self.get_css(fmt="rgba" if name_format == "qcss_argb" else "rgb")
            case _ if name_format in NAME_FORMAT:
                return self.name(NAME_FORMAT[name_format])
            case _:
                raise ValueError(name_format)

    def get_css(self, fmt: Literal["rgb", "rgba", "hsva", "hsla"] | None = None) -> str:
        css_format = fmt or self.spec()
        match css_format:
            case self.Spec.Rgb | "rgba":
                string = ", ".join([str(i) for i in self.getRgb()])
                return f"rgba({string})"
            case self.Spec.Hsv | "hsva":
                string = ", ".join([str(i) for i in self.getHsv()])
                return f"hsva({string})"
            case self.Spec.Hsl | "hsla":
                string = ", ".join([str(i) for i in self.getHsl()])
                return f"hsla({string})"
            case "rgb":
                return f"rgb({self.red()}, {self.green()}, {self.blue()})"
            case _:
                raise ValueError(css_format)

    def as_qt(self) -> QtGui.QColor:
        return self.convertTo(self.spec())

    def inverted(self, invert_alpha: bool = False) -> Self:
        return type(self)(
            255 - self.red(),
            255 - self.green(),
            255 - self.blue(),
            255 - self.alpha() if invert_alpha else self.alpha(),
        )

    def drift(self, factor: int = 1.0) -> Self:
        """Return color that is lighter or darker than the base color."""
        Cls = type(self)
        if self == Color("#000000"):
            return Cls(Color("#050505").lighter(int(factor * 100)))
        elif self.lightness() > 128:
            return Cls(self.darker(int(factor * 100)))
        else:
            return Cls(self.lighter(int(factor * 100)))

drift(factor: int = 1.0) -> Self

Return color that is lighter or darker than the base color.

Source code in prettyqt\gui\color.py 
267
268
269
270
271
272
273
274
275
def drift(self, factor: int = 1.0) -> Self:
    """Return color that is lighter or darker than the base color."""
    Cls = type(self)
    if self == Color("#000000"):
        return Cls(Color("#050505").lighter(int(factor * 100)))
    elif self.lightness() > 128:
        return Cls(self.darker(int(factor * 100)))
    else:
        return Cls(self.lighter(int(factor * 100)))

interpolate_color(start: QtGui.QColor, end: QtGui.QColor, percent: int, colorspace: SpecStr | None = 'rgb') -> Self classmethod

Get an interpolated color value.

Parameters:

Name Type Description Default
start QColor

The start color.

 required
end QColor

The end color.

 required
percent int

Which value to get (0 - 100)

 required
colorspace SpecStr | None

The desired interpolation color system, QColor::{Rgb,Hsv,Hsl} (from QColor::Spec enum) If None, start is used except when percent is 100.

 'rgb'
Return

The interpolated QColor, with the same spec as the given start color.

Source code in prettyqt\gui\color.py 
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
@classmethod
def interpolate_color(
    cls,
    start: QtGui.QColor,
    end: QtGui.QColor,
    percent: int,
    colorspace: SpecStr | None = "rgb",
) -> Self:
    """Get an interpolated color value.

    Args:
        start: The start color.
        end: The end color.
        percent: Which value to get (0 - 100)
        colorspace: The desired interpolation color system,
                    QColor::{Rgb,Hsv,Hsl} (from QColor::Spec enum)
                    If None, start is used except when percent is 100.

    Return:
        The interpolated QColor, with the same spec as the given start color.
    """
    if colorspace is None:
        return cls(*end.getRgb()) if percent == 100 else cls(*start.getRgb())
    out = cls()
    match colorspace:
        case "rgb":
            components = helpers.get_color_percentage(
                start.getRgb(), end.getRgb(), percent  # type: ignore
            )
            out.setRgb(*components)
        case "hsv":
            components = helpers.get_color_percentage(
                start.getHsv(), end.getHsv(), percent  # type: ignore
            )
            out.setHsv(*components)
        case "hsl":
            components = helpers.get_color_percentage(
                start.getHsl(), end.getHsl(), percent  # type: ignore
            )
            out.setHsl(*components)
        case _:
            raise ValueError("Invalid colorspace!")
    return cls(out.convertTo(start.spec()))

is_dark() -> bool

Check whether a color is 'dark'.

Source code in prettyqt\gui\color.py 
195
196
197
def is_dark(self) -> bool:
    """Check whether a color is 'dark'."""
    return self.lightness() < 128