diff --git a/discord/colour.py b/discord/colour.py index c24dd0832..5baf379fa 100644 --- a/discord/colour.py +++ b/discord/colour.py @@ -25,11 +25,23 @@ DEALINGS IN THE SOFTWARE. import colorsys import random +from typing import ( + Any, + Optional, + Tuple, + Type, + TypeVar, + Union, +) + __all__ = ( 'Colour', 'Color', ) +CT = TypeVar('CT', bound='Colour') + + class Colour: """Represents a Discord role colour. This class is similar to a (red, green, blue) :class:`tuple`. @@ -70,66 +82,66 @@ class Colour: if not isinstance(value, int): raise TypeError(f'Expected int parameter, received {value.__class__.__name__} instead.') - self.value = value + self.value: int = value - def _get_byte(self, byte): + def _get_byte(self, byte: int) -> int: return (self.value >> (8 * byte)) & 0xff - def __eq__(self, other): + def __eq__(self, other: Any) -> bool: return isinstance(other, Colour) and self.value == other.value - def __ne__(self, other): + def __ne__(self, other: Any) -> bool: return not self.__eq__(other) - def __str__(self): + def __str__(self) -> str: return f'#{self.value:0>6x}' - def __int__(self): + def __int__(self) -> int: return self.value - def __repr__(self): + def __repr__(self) -> str: return f'' - def __hash__(self): + def __hash__(self) -> int: return hash(self.value) @property - def r(self): + def r(self) -> int: """:class:`int`: Returns the red component of the colour.""" return self._get_byte(2) @property - def g(self): + def g(self) -> int: """:class:`int`: Returns the green component of the colour.""" return self._get_byte(1) @property - def b(self): + def b(self) -> int: """:class:`int`: Returns the blue component of the colour.""" return self._get_byte(0) - def to_rgb(self): + def to_rgb(self) -> Tuple[int, int, int]: """Tuple[:class:`int`, :class:`int`, :class:`int`]: Returns an (r, g, b) tuple representing the colour.""" return (self.r, self.g, self.b) @classmethod - def from_rgb(cls, r, g, b): + def from_rgb(cls: Type[CT], r: int, g: int, b: int) -> CT: """Constructs a :class:`Colour` from an RGB tuple.""" return cls((r << 16) + (g << 8) + b) @classmethod - def from_hsv(cls, h, s, v): + def from_hsv(cls: Type[CT], h: float, s: float, v: float) -> CT: """Constructs a :class:`Colour` from an HSV tuple.""" rgb = colorsys.hsv_to_rgb(h, s, v) return cls.from_rgb(*(int(x * 255) for x in rgb)) @classmethod - def default(cls): + def default(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0``.""" return cls(0) @classmethod - def random(cls, *, seed=None): + def random(cls: Type[CT], *, seed: Optional[Union[int, str, float, bytes, bytearray]] = None) -> CT: """A factory method that returns a :class:`Colour` with a random hue. .. note:: @@ -150,125 +162,125 @@ class Colour: return cls.from_hsv(rand.random(), 1, 1) @classmethod - def teal(cls): + def teal(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0x1abc9c``.""" return cls(0x1abc9c) @classmethod - def dark_teal(cls): + def dark_teal(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0x11806a``.""" return cls(0x11806a) @classmethod - def green(cls): + def green(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0x2ecc71``.""" return cls(0x2ecc71) @classmethod - def dark_green(cls): + def dark_green(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0x1f8b4c``.""" return cls(0x1f8b4c) @classmethod - def blue(cls): + def blue(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0x3498db``.""" return cls(0x3498db) @classmethod - def dark_blue(cls): + def dark_blue(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0x206694``.""" return cls(0x206694) @classmethod - def purple(cls): + def purple(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0x9b59b6``.""" return cls(0x9b59b6) @classmethod - def dark_purple(cls): + def dark_purple(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0x71368a``.""" return cls(0x71368a) @classmethod - def magenta(cls): + def magenta(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0xe91e63``.""" return cls(0xe91e63) @classmethod - def dark_magenta(cls): + def dark_magenta(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0xad1457``.""" return cls(0xad1457) @classmethod - def gold(cls): + def gold(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0xf1c40f``.""" return cls(0xf1c40f) @classmethod - def dark_gold(cls): + def dark_gold(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0xc27c0e``.""" return cls(0xc27c0e) @classmethod - def orange(cls): + def orange(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0xe67e22``.""" return cls(0xe67e22) @classmethod - def dark_orange(cls): + def dark_orange(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0xa84300``.""" return cls(0xa84300) @classmethod - def red(cls): + def red(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0xe74c3c``.""" return cls(0xe74c3c) @classmethod - def dark_red(cls): + def dark_red(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0x992d22``.""" return cls(0x992d22) @classmethod - def lighter_grey(cls): + def lighter_grey(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0x95a5a6``.""" return cls(0x95a5a6) lighter_gray = lighter_grey @classmethod - def dark_grey(cls): + def dark_grey(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0x607d8b``.""" return cls(0x607d8b) dark_gray = dark_grey @classmethod - def light_grey(cls): + def light_grey(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0x979c9f``.""" return cls(0x979c9f) light_gray = light_grey @classmethod - def darker_grey(cls): + def darker_grey(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0x546e7a``.""" return cls(0x546e7a) darker_gray = darker_grey @classmethod - def blurple(cls): + def blurple(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0x7289da``.""" return cls(0x7289da) @classmethod - def greyple(cls): + def greyple(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0x99aab5``.""" return cls(0x99aab5) @classmethod - def dark_theme(cls): + def dark_theme(cls: Type[CT]) -> CT: """A factory method that returns a :class:`Colour` with a value of ``0x36393F``. This will appear transparent on Discord's dark theme.