yta-colors 0.0.1__tar.gz → 0.0.2__tar.gz

{yta_colors-0.0.1 → yta_colors-0.0.2}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.3
 Name: yta-colors
-Version: 0.0.1
-Summary: 
+Version: 0.0.2
+Summary: Youtube Autonomous Colors Module
 Author: danialcala94
 Author-email: danielalcalavalera@gmail.com
 Requires-Python: ==3.9
@@ -11,6 +11,6 @@ Requires-Dist: yta_constants (>=0.0.1,<1.0.0)
 Requires-Dist: yta_validation (>=0.0.1,<1.0.0)
 Description-Content-Type: text/markdown
 
-# Youtube Autonomous Colors add-on
+# Youtube Autonomous Colors Module
 
 The way to handle and validate colors.

yta_colors-0.0.2/README.md

@@ -0,0 +1,3 @@
+# Youtube Autonomous Colors Module
+
+The way to handle and validate colors.

{yta_colors-0.0.1 → yta_colors-0.0.2}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "yta-colors"
-version = "0.0.1"
-description = ""
+version = "0.0.2"
+description = "Youtube Autonomous Colors Module"
 authors = [
     {name = "danialcala94",email = "danielalcalavalera@gmail.com"}
 ]

{yta_colors-0.0.1 → yta_colors-0.0.2}/src/yta_colors/__init__.py

@@ -40,14 +40,22 @@ class Color:
     value and 255 is everything.
     """
 
-    def __init__(self, r, g, b, a):
+    def __init__(
+        self,
+        r,
+        g,
+        b,
+        a
+    ):
         self.r, self.g, self.b, self.a = r, g, b, a
         # TODO: Precalculate and store all the values 
         # internally so we don't need to calculate them
         # later (?)
 
     @property
-    def rgb_not_normalized(self):
+    def rgb_not_normalized(
+        self
+    ):
         """
         Get the color as a tuple of the 3 RGB values that
         are, in order: red, green, blue. These values are
@@ -57,7 +65,9 @@ class Color:
         return self.r, self.g, self.b
     
     @property
-    def rgb_normalized(self):
+    def rgb_normalized(
+        self
+    ):
         """
         Get the color as a tuple of the 3 RGB values that
         are, in order: red, green, blue. These values are
@@ -66,7 +76,9 @@ class Color:
         return self.r / 255.0, self.g / 255.0, self.b / 255.0
     
     @property
-    def rgba_not_normalized(self):
+    def rgba_not_normalized(
+        self
+    ):
         """
         Get the color as a tuple of the 3 RGB values and
         a 4th value representing the transparency, that
@@ -77,7 +89,9 @@ class Color:
         self.r, self.g, self.b, self.a
 
     @property
-    def rgba_normalized(self):
+    def rgba_normalized(
+        self
+    ):
         """
         Get the color as a tuple of the 3 RGB values and
         a 4th value representing the transparency, that
@@ -88,7 +102,9 @@ class Color:
         return self.r / 255.0, self.g / 255.0, self.b / 255.0, self.a / 255.0
     
     @property
-    def rgb_array_not_normalized(self):
+    def rgb_array_not_normalized(
+        self
+    ):
         """
         Get the color as an array of the 3 RGB values that
         are, in order: red, green, blue. These values are
@@ -98,7 +114,9 @@ class Color:
         return [*self.rgba_not_normalized]
     
     @property
-    def rgb_array_normalized(self):
+    def rgb_array_normalized(
+        self
+    ):
         """
         Get the color as an array of the 3 RGB values that
         are, in order: red, green, blue. These values are
@@ -107,7 +125,9 @@ class Color:
         return [*self.rgba_normalized]
     
     @property
-    def rgba_array_not_normalized(self):
+    def rgba_array_not_normalized(
+        self
+    ):
         """
         Get the color as an array of the 3 RGB values and
         a 4th value representing the transparency, that
@@ -118,7 +138,9 @@ class Color:
         return [*self.rgba_not_normalized]
     
     @property
-    def rgba_array_normalized(self):
+    def rgba_array_normalized(
+        self
+    ):
         """
         Get the color as an array of the 3 RGB values and
         a 4th value representing the transparency, that
@@ -129,7 +151,9 @@ class Color:
         return [*self.rgba_normalized]
     
     @property
-    def hex_with_alpha(self):
+    def hex_with_alpha(
+        self
+    ):
         """
         Get the color as a string representing it in
         hexadecimal value. The result will be #RRGGBBAA
@@ -139,7 +163,9 @@ class Color:
         return ColorConverter.rgba_to_hex(self.rgba_not_normalized, True)
 
     @property
-    def hex_without_alpha(self):
+    def hex_without_alpha(
+        self
+    ):
         """
         Get the color as a string representing it in
         hexadecimal value. The result will be #RRGGBB
@@ -148,21 +174,27 @@ class Color:
         return ColorConverter.rgba_to_hex(self.rgba_not_normalized, False)
     
     @property
-    def hsl(self):
+    def hsl(
+        self
+    ):
         """
         Get the color as an HSL color.
         """
         return ColorConverter.rgba_to_hsl(self.rgba_not_normalized)
     
     @property
-    def cymk(self):
+    def cymk(
+        self
+    ):
         """
         Get the color as an CYMK color.
         """
         return ColorConverter.rgba_to_cymk(self.rgba_not_normalized)
 
     @property
-    def hsv(self):
+    def hsv(
+        self
+    ):
         """
         Get the color as a HSV color.
         """
@@ -170,7 +202,9 @@ class Color:
     
     # TODO: Use the cv2 library to make other changes
     @staticmethod
-    def parse(color: Union[list, tuple, str, 'ColorString', 'Color']):
+    def parse(
+        color: Union[list, tuple, str, 'ColorString', 'Color']
+    ):
         """
         Parse the provided 'color' parameter and return the
         color as r,g,b,a values or raises an Exception if it

{yta_colors-0.0.1 → yta_colors-0.0.2}/src/yta_colors/converter.py

@@ -1,5 +1,6 @@
 from yta_colors.utils import is_hexadecimal_color, parse_rgba_color, rgba_to_hex, hex_to_rgba, rgb_to_hex, rgba_to_hex, rgb_to_hsl, rgb_to_cymk, rgb_to_hsv, hsv_to_rgb, rgba_to_hsv, parse_color, hsv_to_rgba
 from yta_validation import PythonValidator
+from yta_validation.parameter import ParameterValidator
 from typing import Union
 
 
@@ -10,7 +11,11 @@ class ColorConverter:
     """
 
     @staticmethod
-    def rgb_to_hex(red, green, blue):
+    def rgb_to_hex(
+        red,
+        green,
+        blue
+    ):
         """
         Returns the provided RGB color as a hex color. The 'red', 'green' and
         'blue' parameters must be between 0 and 255.
@@ -18,7 +23,9 @@ class ColorConverter:
         return rgba_to_hex(red, green, blue)
     
     @staticmethod
-    def hex_to_rgb(color: str):
+    def hex_to_rgb(
+        color: str
+    ):
         """
         Parse the provided hexadecimal 'color' parameter and
         turn it into an RGB color (returned as r,g,b) or
@@ -29,14 +36,19 @@ class ColorConverter:
         return r, g, b
 
     @staticmethod
-    def hex_to_rgba(color: str):
+    def hex_to_rgba(
+        color: str
+    ):
         if not is_hexadecimal_color(color):
             raise Exception(f'The provided "color" parameter "{str(color)}" is not an hexadecimal color.')
         
         return hex_to_rgba(color)
 
     @staticmethod
-    def rgb_to_hex(color: Union[tuple, list], do_include_alpha: bool = False):
+    def rgb_to_hex(
+        color: Union[tuple, list],
+        do_include_alpha: bool = False
+    ):
         """
         Parse the provided RGB 'color' parameter and turn it to
         a hexadecimal color if valid or raises an Exception if
@@ -44,11 +56,15 @@ class ColorConverter:
         False, or #RRGGBBAA if 'do_include_alpha' is True.
         """
         validate_color(color)
+        ParameterValidator.validate_mandatory_bool('do_include_alpha', do_include_alpha)
 
         return rgb_to_hex(color, do_include_alpha)
         
     @staticmethod
-    def rgba_to_hex(color: Union[tuple, list], do_include_alpha: bool = False):
+    def rgba_to_hex(
+        color: Union[tuple, list],
+        do_include_alpha: bool = False
+    ):
         """
         Parse the provided RGBA 'color' parameter and turn it to
         a hexadecimal color if valid or raises an Exception if
@@ -56,11 +72,14 @@ class ColorConverter:
         False, or #RRGGBBAA if 'do_include_alpha' is True.
         """
         validate_color(color)
+        ParameterValidator.validate_mandatory_bool('do_include_alpha', do_include_alpha)
 
         return rgba_to_hex(color, do_include_alpha)
 
     @staticmethod
-    def rgba_to_hsl(color: Union[tuple, list]):
+    def rgba_to_hsl(
+        color: Union[tuple, list]
+    ):
         # TODO: Explain
         validate_color(color)
 
@@ -69,14 +88,18 @@ class ColorConverter:
         return *ColorConverter.rgb_to_hsl(color), a
 
     @staticmethod
-    def rgb_to_hsl(color: Union[tuple, list]):
+    def rgb_to_hsl(
+        color: Union[tuple, list]
+    ):
         # TODO: Explain
         validate_color(color)
         
         return rgb_to_hsl(color)
 
     @staticmethod
-    def rgba_to_cymk(color: Union[tuple, list]):
+    def rgba_to_cymk(
+        color: Union[tuple, list]
+    ):
         # TODO: Explain
         validate_color(color)
 
@@ -87,7 +110,9 @@ class ColorConverter:
         return ColorConverter.rgb_to_cymk(color)
 
     @staticmethod
-    def rgb_to_cymk(color: Union[tuple, list]):
+    def rgb_to_cymk(
+        color: Union[tuple, list]
+    ):
         # TODO: Explain
         # It looks like you need to know the color profile before
         # any conversion from RGB or RGBA
@@ -97,7 +122,9 @@ class ColorConverter:
         return rgb_to_cymk(color)
     
     @staticmethod
-    def rgb_to_hsv(color: Union[tuple, list]):
+    def rgb_to_hsv(
+        color: Union[tuple, list]
+    ):
         """
         Turn the provided RGB 'color' into a HSV color.
         """
@@ -106,7 +133,9 @@ class ColorConverter:
         return rgb_to_hsv(color)
 
     @staticmethod
-    def rgba_to_hsv(color: Union[tuple, list]):
+    def rgba_to_hsv(
+        color: Union[tuple, list]
+    ):
         """
         Turn the provided RGBA 'color' into a HSV color.
         The HSV color doesn't pay attention to the alpha
@@ -118,7 +147,9 @@ class ColorConverter:
         return rgba_to_hsv(color)
     
     @staticmethod
-    def hsv_to_rgb(color: Union[tuple, list]):
+    def hsv_to_rgb(
+        color: Union[tuple, list]
+    ):
         """
         Turn the provided HSV 'color' into a RGB color.
         """
@@ -129,7 +160,9 @@ class ColorConverter:
         return hsv_to_rgb(h, s, v)
     
     @staticmethod
-    def hsv_to_rgba(color: Union[tuple, list]):
+    def hsv_to_rgba(
+        color: Union[tuple, list]
+    ):
         """
         Turn the provided HSV 'color' into a RGBA color.
         The HSV color doesn't pay attention to the alpha
@@ -141,12 +174,17 @@ class ColorConverter:
 
         return hsv_to_rgba(h, s, v)
     
-def validate_color(color: Union[tuple, list]):
+def validate_color(
+    color: Union[tuple, list]
+):
     """
     Validate the provided 'color' as a tuple or list of 3
     or 4 elements.
     """
-    if not PythonValidator.is_instance(color, 'Color') and parse_color(color) is None:
+    if (
+        not PythonValidator.is_instance(color, 'Color') and
+        parse_color(color) is None
+    ):
         raise Exception('The provided "color" is not a parsable color.')
     
     return True

yta_colors-0.0.1/README.md

@@ -1,3 +0,0 @@
-# Youtube Autonomous Colors add-on
-
-The way to handle and validate colors.