Merge branch 'main' into Error_check_colors

# Conflicts:
#	adafruit_rgbled.py

Author: FoamyGuy

.pre-commit-config.yaml

@@ -4,21 +4,21 @@
 
 repos:
   - repo: https://github.com/python/black
-    rev: 22.3.0
+    rev: 23.3.0
     hooks:
       - id: black
   - repo: https://github.com/fsfe/reuse-tool
-    rev: v0.14.0
+    rev: v1.1.2
     hooks:
       - id: reuse
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.2.0
+    rev: v4.4.0
     hooks:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/pycqa/pylint
-    rev: v2.15.5
+    rev: v2.17.4
     hooks:
       - id: pylint
         name: pylint (library code)

.pylintrc

@@ -396,4 +396,4 @@ min-public-methods=1
 
 # Exceptions that will emit a warning when being caught. Defaults to
 # "Exception"
-overgeneral-exceptions=Exception
+overgeneral-exceptions=builtins.Exception

adafruit_rgbled.py

@@ -20,7 +20,11 @@
   https://github.com/adafruit/circuitpython/releases
 """
 try:
-    from typing import Union
+    from typing import Union, Optional, Type
+    from types import TracebackType
+    from microcontroller import Pin
+    from adafruit_pca9685 import PWMChannel
+    from circuitpython_typing.led import ColorBasedColorUnion
 except ImportError:
     pass
 
@@ -32,9 +36,9 @@
 
 class RGBLED:
     """
-    Creates a RGBLED object given three physical pins or PWMOut objects.
+    Create an RGBLED object given three physical pins or PWMOut objects.
 
-    Example for setting a RGB LED using a RGB Tuple (Red, Green, Blue):
+    Example for setting an RGB LED using an RGB Tuple (Red, Green, Blue):
 
     .. code-block:: python
 
@@ -49,7 +53,7 @@ class RGBLED:
         led = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED)
         led.color = (255, 0, 0)
 
-    Example for setting a RGB LED using a 24-bit integer (hex syntax):
+    Example for setting an RGB LED using a 24-bit integer (hex syntax):
 
     .. code-block:: python
 
@@ -60,11 +64,11 @@ class RGBLED:
         GREEN_LED = board.D6
         BLUE_LED = board.D7
 
-        # Create a RGB LED object
+        # Create an RGB LED object
         led = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED)
         led.color = 0x100000
 
-    Example for setting a RGB LED using a ContextManager:
+    Example for setting an RGB LED using a ContextManager:
 
     .. code-block:: python
 
@@ -115,7 +119,12 @@ def __init__(
     def __enter__(self) -> "RGBLED":
         return self
 
-    def __exit__(self, exception_type, exception_value, traceback) -> None:
+    def __exit__(
+        self,
+        exception_type: Optional[Type[type]],
+        exception_value: Optional[BaseException],
+        traceback: Optional[TracebackType],
+    ) -> None:
         self.deinit()
 
     def deinit(self) -> None:
@@ -125,11 +134,15 @@ def deinit(self) -> None:
         self._current_color = (0, 0, 0)
 
     @property
-    def color(self) -> Union[int, tuple]:
+    def color(self) -> ColorBasedColorUnion:
         """
         Sets the RGB LED to a desired color.
-        :param Union[int, tuple] value: RGB LED desired value - can be a RGB tuple of values
-        0 - 255 or a 24-bit integer. e.g. (255, 64, 35) and 0xff4023 are equivalent.
+
+        :param ColorBasedColorUnion value: RGB LED desired value - can be a RGB
+            tuple of values 0 - 255 or a 24-bit integer. e.g. (255, 64, 35) and 0xff4023
+            are equivalent.
+
+        :returns Union[int, Tuple[int, int, int]]: The current LED color setting.
 
         :raises ValueError: If the input is an int > 0xffffff or is a tuple that does not
           contain 3 integers of 0 - 255.
@@ -138,7 +151,7 @@ def color(self) -> Union[int, tuple]:
         return self._current_color
 
     @color.setter
-    def color(self, value: Union[int, tuple]):
+    def color(self, value: ColorBasedColorUnion):
         if isinstance(value, int):
             try:
                 # Check that integer is <= 0xffffff and create an iterable.

docs/conf.py

@@ -17,6 +17,7 @@
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinxcontrib.jquery",
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
     "sphinx.ext.todo",

docs/requirements.txt

@@ -3,3 +3,4 @@
 # SPDX-License-Identifier: Unlicense
 
 sphinx>=4.0.0
+sphinxcontrib-jquery

requirements.txt

@@ -3,3 +3,5 @@
 # SPDX-License-Identifier: Unlicense
 
 Adafruit-Blinka
+adafruit-circuitpython-typing~=1.4
+adafruit-circuitpython-pca9685