docs: missing comments

Author: gpongelli

gpio_expander.py

@@ -67,6 +67,7 @@ def _get_registry_params(value, x):
     if value > 8:
         _reg_address_multiplier = 2
         _adder = 1
+        # datasheet bit field's name has underscore in place of dot for 16 bit expander
         if x >= 8:
             _name = "1_"
         else:

tests/conftest.py

@@ -1,19 +1,29 @@
+"""Pytest common features module."""
+
 # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 # SPDX-FileCopyrightText: Copyright (c) 2022 Gabriele Pongelli
 #
 # SPDX-License-Identifier: MIT
 
+from typing import List
+
 import pytest
 
 
 @pytest.fixture()
 def mock_i2c(mocker):
+    """Common I2C mock."""
     mocker.patch("adafruit_bus_device.i2c_device.I2CDevice", return_value=True)
     mocker.patch("busio.I2C.init")
 
 
 @pytest.fixture()
-def registry_list_8_gpio():
+def registry_list_8_gpio() -> List:
+    """Get registry list for 8 bit device.
+
+    Returns:
+        List of registry names.
+    """
     _sub_bit = [str(x) for x in range(8)]
     _reg = ["C", "N", "I", "O"]
 
@@ -31,7 +41,12 @@ def registry_list_8_gpio():
 
 
 @pytest.fixture()
-def registry_list_16_gpio():
+def registry_list_16_gpio() -> List:
+    """Get registry list for 16 bit device.
+
+    Returns:
+        List of registry names.
+    """
     _sub_bit = [str(x) for x in range(8)]
     _reg_part = ["0", "1"]
     _reg = ["C", "N", "I", "O"]

tests/test_pca9534.py

@@ -1,3 +1,5 @@
+"""PCA9534 pytest module file."""
+
 # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 # SPDX-FileCopyrightText: Copyright (c) 2022 Gabriele Pongelli
 #
@@ -9,12 +11,14 @@
 
 
 def test_pca9534_object(mock_i2c, registry_list_8_gpio):  # pylint: disable=unused-argument
+    """Test registries existence."""
     _dev = gpio_expander.PCA9534(I2C(2, 3), 4)  # fake addresses
     _dev_attribs = dir(_dev)
     for _r in registry_list_8_gpio:
         assert _r in _dev_attribs
 
 
 def test_pca9534_num_gpios(mock_i2c):  # pylint: disable=unused-argument
+    """Check attribute return value."""
     _dev = gpio_expander.PCA9534(I2C(2, 3), 4)  # fake addresses
     assert _dev.max_gpios() == 8

tests/test_pca9535.py

@@ -1,3 +1,5 @@
+"""PCA9535 pytest module file."""
+
 # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 # SPDX-FileCopyrightText: Copyright (c) 2022 Gabriele Pongelli
 #
@@ -9,12 +11,14 @@
 
 
 def test_pca9535_object(mock_i2c, registry_list_16_gpio):  # pylint: disable=unused-argument
+    """Test registries existence."""
     _dev = gpio_expander.PCA9535(I2C(2, 3), 4)  # fake addresses
     _dev_attribs = dir(_dev)
     for _r in registry_list_16_gpio:
         assert _r in _dev_attribs
 
 
 def test_pca9535_num_gpios(mock_i2c):  # pylint: disable=unused-argument
+    """Check attribute return value."""
     _dev = gpio_expander.PCA9535(I2C(2, 3), 4)  # fake addresses
     assert _dev.max_gpios() == 16

tests/test_pca9555.py

@@ -1,3 +1,5 @@
+"""PCA9555 pytest module file."""
+
 # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 # SPDX-FileCopyrightText: Copyright (c) 2022 Gabriele Pongelli
 #
@@ -9,12 +11,14 @@
 
 
 def test_pca9555_object(mock_i2c, registry_list_16_gpio):  # pylint: disable=unused-argument
+    """Test registries existence."""
     _dev = gpio_expander.PCA9555(I2C(2, 3), 4)  # fake addresses
     _dev_attribs = dir(_dev)
     for _r in registry_list_16_gpio:
         assert _r in _dev_attribs
 
 
 def test_pca9555_num_gpios(mock_i2c):  # pylint: disable=unused-argument
+    """Check attribute return value."""
     _dev = gpio_expander.PCA9555(I2C(2, 3), 4)  # fake addresses
     assert _dev.max_gpios() == 16

tests/test_tca9534.py

@@ -1,3 +1,5 @@
+"""TCA9534 pytest module file."""
+
 # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 # SPDX-FileCopyrightText: Copyright (c) 2022 Gabriele Pongelli
 #
@@ -9,12 +11,14 @@
 
 
 def test_tca9534_object(mock_i2c, registry_list_8_gpio):  # pylint: disable=unused-argument
+    """Test registries existence."""
     _dev = gpio_expander.TCA9534(I2C(2, 3), 4)  # fake addresses
     _dev_attribs = dir(_dev)
     for _r in registry_list_8_gpio:
         assert _r in _dev_attribs
 
 
 def test_tca9534_num_gpios(mock_i2c):  # pylint: disable=unused-argument
+    """Check attribute return value."""
     _dev = gpio_expander.TCA9534(I2C(2, 3), 4)  # fake addresses
     assert _dev.max_gpios() == 8

tests/test_tca9535.py

@@ -1,3 +1,5 @@
+"""TCA9535 pytest module file."""
+
 # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 # SPDX-FileCopyrightText: Copyright (c) 2022 Gabriele Pongelli
 #
@@ -9,12 +11,14 @@
 
 
 def test_tca9535_object(mock_i2c, registry_list_16_gpio):  # pylint: disable=unused-argument
+    """Test registries existence."""
     _dev = gpio_expander.TCA9535(I2C(2, 3), 4)  # fake addresses
     _dev_attribs = dir(_dev)
     for _r in registry_list_16_gpio:
         assert _r in _dev_attribs
 
 
 def test_tca9535_num_gpios(mock_i2c):  # pylint: disable=unused-argument
+    """Check attribute return value."""
     _dev = gpio_expander.TCA9535(I2C(2, 3), 4)  # fake addresses
     assert _dev.max_gpios() == 16

tests/test_tca9555.py

@@ -1,3 +1,5 @@
+"""TCA9555 pytest module file."""
+
 # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 # SPDX-FileCopyrightText: Copyright (c) 2022 Gabriele Pongelli
 #
@@ -9,12 +11,14 @@
 
 
 def test_tca9555_object(mock_i2c, registry_list_16_gpio):  # pylint: disable=unused-argument
+    """Test registries existence."""
     _dev = gpio_expander.TCA9555(I2C(2, 3), 4)  # fake addresses
     _dev_attribs = dir(_dev)
     for _r in registry_list_16_gpio:
         assert _r in _dev_attribs
 
 
 def test_tca9555_num_gpios(mock_i2c):  # pylint: disable=unused-argument
+    """Check attribute return value."""
     _dev = gpio_expander.TCA9555(I2C(2, 3), 4)  # fake addresses
     assert _dev.max_gpios() == 16