added poethepoet package to manage repetitive development tasks

firmware/scripts/krux_colors.py

@@ -31,8 +31,13 @@
 import sys
 
 
+# TODO: create typings for color param and return step
 def rgb888torgb565(color):
-    """convert to gggbbbbbrrrrrggg to tuple"""
+    """
+    Convert to gggbbbbbrrrrrggg to tuple
+
+    :param color: tuple
+    """
     red, green, blue = color
     red *= 31
     red //= 255

firmware/scripts/minify.py

@@ -19,6 +19,11 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
+
+# TODO: what this script do?
+"""
+Some documentation about this script
+"""
 import ast
 import sys
 import astor

firmware/scripts/rgbconv.py

@@ -2,13 +2,22 @@
    Color conversions between 24-bit-rgb888 and 16-bit-rgb565
 """
 
-from binascii import hexlify, unhexlify
+from binascii import unhexlify
+
 
 def rgb24_to_rgb16(rgb, big=False):
     """
-        convert 3 bytes of rgb888 into 2 bytes of rgb565
-        default to little-endian, so rgb565 becomes gbrg3553
+    convert 3 bytes of rgb888 into 2 bytes of rgb565
+    default to little-endian, so rgb565 becomes gbrg3553.
+
+    :param rgb: bytes
+    :param big: boolean flag to assert big or little-endian format
+    :returns int
     """
+
+    # TODO: this throw a pylint warn C0123: Use isinstance() rather than type() for a typecheck.
+    # check if micropython support isinstance or typings
+    # pylint: disable=unidiomatic-typecheck
     assert type(rgb) == bytes and len(rgb) == 3
 
     # 5 significant bits of red shifted to far left
@@ -25,12 +34,25 @@ def rgb24_to_rgb16(rgb, big=False):
 
 def rgb16_to_rgb24(rgb, big=False):
     """
-        convert 2 bytes of rgb565 into 3 bytes of rgb888
-        default from little-endian, so rgb565 becomes gbrg3553
+    Convert 2 bytes of rgb565 into 3 bytes of rgb888
+    default from little-endian, so rgb565 becomes gbrg3553.
+
+    :param rgb: bytes
+    :param big: boolean flag to assert big or little-endian format
+    :returns bytes in string format
     """
-    def maxv(number_of_bits): 
-        return (2 ** number_of_bits) -1
 
+    def maxv(number_of_bits):
+        """
+        Return 2^number_of_bits - 1
+
+        :returns int
+        """
+        return (2**number_of_bits) - 1
+
+    # TODO: this throw a pylint warn C0123: Use isinstance() rather than type() for a typecheck.
+    # check if micropython support isinstance or typings
+    # pylint: disable=unidiomatic-typecheck
     assert type(rgb) == bytes and len(rgb) == 2
 
     rgb_int = int.from_bytes(rgb, "big" if big else "little")
@@ -44,20 +66,26 @@ def maxv(number_of_bits):
     # right 5 bits of blue multiplied to fill 8 bit space
     blue = round((rgb_int & maxv(5)) * maxv(8) / maxv(5))
 
-    return b''.join([x.to_bytes(1, "big") for x in [red, green, blue]])
+    return b"".join([x.to_bytes(1, "big") for x in [red, green, blue]])
 
 
 def main(*args):
+    """
+    Main function to convert integer in bytes format
+
+    :param *args: bytes in a 0x or integer format
+    :returns bytes: the byte representation of color
+    """
     rgb = None
 
     if len(args) == 1:
         arg = args[0]
         if arg[:2] == "0x":
             rgb = unhexlify(arg[2:])
         else:
-            rgb = (abs(int(args[0])) % 65536).to_bytes(2, 'big')
+            rgb = (abs(int(args[0])) % 65536).to_bytes(2, "big")
     else:
-        rgb = b''.join([(abs(int(x)) % 256).to_bytes(1, 'big') for x in args])
+        rgb = b"".join([(abs(int(x)) % 256).to_bytes(1, "big") for x in args])
 
     if rgb:
         if len(rgb) == 2:
@@ -67,21 +95,35 @@ def main(*args):
     else:
         answer = None
 
-    return(answer)
+    return answer
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     import sys
 
-    def help():
+    # Do not name the function below `help`
+    # it can throw a pylint warning
+    # W0622: Redefining built-in 'help' (redefined-builtin)
+    def rgb_convert_help():
+        """
+        Simple print help
+        """
         print("syntax: {} integer-bytes-or-0xhex-color".format(sys.argv[0]))
 
     if len(sys.argv) > 1:
         try:
-            print('0x' + main(*sys.argv[1:]).hex())
+            print("0x" + main(*sys.argv[1:]).hex())
         except:
-            help()
+            rgb_convert_help()
+
+            # TODO: this throw a pylint warn R1722: Consider using 'sys.exit'instead
+            # check if if in micropython is better to call sys.exit
+            # pylint: disable=consider-using-sys-exit
             exit(1)
     else:
         help()
+
+        # TODO: this throw a pylint warn R1722: Consider using 'sys.exit'instead
+        # check if if in micropython is better to call sys.exit
+        # pylint: disable=consider-using-sys-exit
         exit(1)