Add pre commit hooks to validate the commits

It also fixes all validation errors.

Author: unaiur

.pre-commit-config.yaml

@@ -0,0 +1,64 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 20.8b1
+    hooks:
+      - id: black
+        args:
+          - --safe
+          - --quiet
+        files: ^((maxcube|sample|tests)/.+)?[^/]+\.py$
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.0.0
+    hooks:
+      - id: codespell
+        args:
+          - --ignore-words-list=maxcube
+          - --skip="./.*"
+          - --quiet-level=2
+        exclude_types: [csv, json]
+        exclude: ^tests/fixtures/
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.9.0
+    hooks:
+      - id: flake8
+        additional_dependencies:
+          - pycodestyle==2.7.0
+          - pyflakes==2.3.1
+          - pydocstyle==6.0.0
+          - flake8-comprehensions==3.4.0
+          - flake8-noqa==1.1.0
+        files: ^(maxcube|sample|tests)/.+\.py$
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.7.0
+    hooks:
+      - id: isort
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+      - id: check-executables-have-shebangs
+        stages: [manual]
+      - id: no-commit-to-branch
+        args:
+          - --branch=master
+  - repo: https://github.com/adrienverge/yamllint.git
+    rev: v1.24.2
+    hooks:
+      - id: yamllint
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v2.2.1
+    hooks:
+      - id: prettier
+        stages: [manual]
+  - repo: https://github.com/cdce8p/python-typing-update
+    rev: v0.3.2
+    hooks:
+      # Run `python-typing-update` hook manually from time to time
+      # to update python typing syntax.
+      # Will require manual work, before submitting changes!
+      - id: python-typing-update
+        stages: [manual]
+        args:
+          - --py38-plus
+          - --force
+          - --keep-updates
+        files: ^(homeassistant|tests|script)/.+\.py$

.travis.yml

@@ -5,7 +5,7 @@ python:
   - 3.9
 
 install:
-- pip install coveralls
+  - pip install coveralls
 
 script: coverage run setup.py test
 

maxcube/commander.py

@@ -1,7 +1,5 @@
 import base64
 import logging
-import socket
-
 from time import sleep
 from typing import List
 
@@ -11,15 +9,15 @@
 
 logger = logging.getLogger(__name__)
 
-QUIT_MSG = Message('q')
-L_MSG = Message('l')
+QUIT_MSG = Message("q")
+L_MSG = Message("l")
 L_REPLY_CMD = L_MSG.reply_cmd()
 
-UPDATE_TIMEOUT = Timeout('update', 3.0)
-CONNECT_TIMEOUT = Timeout('connect', 3.0)
-FLUSH_INPUT_TIMEOUT = Timeout('flush-input', 0)
-SEND_RADIO_MSG_TIMEOUT = Timeout('send-radio-msg', 30.0)
-CMD_REPLY_TIMEOUT = Timeout('cmd-reply', 2.0)
+UPDATE_TIMEOUT = Timeout("update", 3.0)
+CONNECT_TIMEOUT = Timeout("connect", 3.0)
+FLUSH_INPUT_TIMEOUT = Timeout("flush-input", 0)
+SEND_RADIO_MSG_TIMEOUT = Timeout("send-radio-msg", 30.0)
+CMD_REPLY_TIMEOUT = Timeout("cmd-reply", 2.0)
 
 
 class Commander(object):
@@ -34,8 +32,10 @@ def disconnect(self):
         if self.__connection:
             try:
                 self.__connection.send(QUIT_MSG)
-            except:
-                logger.debug('Unable to properly shutdown MAX Cube connection. Resetting it...')
+            except Exception:
+                logger.debug(
+                    "Unable to properly shutdown MAX Cube connection. Resetting it..."
+                )
             finally:
                 self.__close()
 
@@ -51,7 +51,7 @@ def update(self) -> List[Message]:
                 response = self.__call(L_MSG, deadline)
                 if response:
                     self.__unsolicited_messages.append(response)
-            except:
+            except Exception:
                 self.__connect(deadline)
         else:
             self.__connect(deadline)
@@ -61,7 +61,9 @@ def update(self) -> List[Message]:
 
     def send_radio_msg(self, hex_radio_msg: str) -> bool:
         deadline = SEND_RADIO_MSG_TIMEOUT.deadline()
-        request = Message('s', base64.b64encode(bytearray.fromhex(hex_radio_msg)).decode('utf-8'))
+        request = Message(
+            "s", base64.b64encode(bytearray.fromhex(hex_radio_msg)).decode("utf-8")
+        )
         while not deadline.is_expired():
             if self.__cmd_send_radio_msg(request, deadline):
                 return True
@@ -70,15 +72,17 @@ def send_radio_msg(self, hex_radio_msg: str) -> bool:
     def __cmd_send_radio_msg(self, request: Message, deadline: Deadline) -> bool:
         try:
             response = self.__call(request, deadline)
-            duty_cycle, status_code, free_slots = response.arg.split(',', 3)
+            duty_cycle, status_code, free_slots = response.arg.split(",", 3)
             if int(status_code) == 0:
                 return True
-            logger.debug('Radio message %s was not send [DutyCycle:%s, StatusCode:%s, FreeSlots:%s]' %
-                (request, duty_cycle, status_code, free_slots))
+            logger.debug(
+                "Radio message %s was not send [DutyCycle:%s, StatusCode:%s, FreeSlots:%s]"
+                % (request, duty_cycle, status_code, free_slots)
+            )
             if int(duty_cycle) == 100 and int(free_slots) == 0:
                 sleep(deadline.remaining(upper_bound=10.0))
         except Exception as ex:
-            logger.error('Error sending radio message to Max! Cube: ' + str(ex))
+            logger.error("Error sending radio message to Max! Cube: " + str(ex))
         return False
 
     def __call(self, msg: Message, deadline: Deadline) -> Message:
@@ -97,7 +101,7 @@ def __call(self, msg: Message, deadline: Deadline) -> Message:
                 raise TimeoutError(str(subdeadline))
             return result
 
-        except:
+        except Exception:
             self.__close()
             if already_connected:
                 return self.__call(msg, deadline)
@@ -114,7 +118,9 @@ def __is_connected(self) -> bool:
     def __connect(self, deadline: Deadline):
         self.__unsolicited_messages = []
         self.__connection = Connection(self.__host, self.__port)
-        reply = self.__wait_for_reply(L_REPLY_CMD, deadline.subtimeout(CMD_REPLY_TIMEOUT))
+        reply = self.__wait_for_reply(
+            L_REPLY_CMD, deadline.subtimeout(CMD_REPLY_TIMEOUT)
+        )
         if reply:
             self.__unsolicited_messages.append(reply)
 

maxcube/connection.py

@@ -1,6 +1,5 @@
-import socket
 import logging
-import time
+import socket
 
 from .deadline import Deadline
 from .message import Message
@@ -10,21 +9,22 @@
 BLOCK_SIZE = 4096
 DEFAULT_TIMEOUT = 2.0
 
+
 class Connection(object):
     def __init__(self, host: str, port: int):
         self.__buffer: bytearray = bytearray()
         self.__socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
         self.__socket.settimeout(DEFAULT_TIMEOUT)
         self.__socket.connect((host, port))
-        logger.debug('Connected to %s:%d!' % (host, port))
+        logger.debug("Connected to %s:%d!" % (host, port))
 
     def __read_buffered_msg(self) -> Message:
         buf = self.__buffer
-        pos = buf.find(b'\r\n')
+        pos = buf.find(b"\r\n")
         if pos < 0:
             return None
         result = buf[0:pos]
-        del buf[0:pos+2]
+        del buf[0 : pos + 2]
         return Message.decode(result)
 
     def recv(self, deadline: Deadline) -> Message:
@@ -38,11 +38,11 @@ def recv(self, deadline: Deadline) -> Message:
                     msg = self.__read_buffered_msg()
                     logger.debug("received: %s" % msg)
                 else:
-                    logger.debug('Connection shutdown by remote peer')
+                    logger.debug("Connection shutdown by remote peer")
                     self.close()
                     return None
         except socket.timeout:
-            logger.debug('readline timed out')
+            logger.debug("readline timed out")
         finally:
             self.__socket.settimeout(DEFAULT_TIMEOUT)
         return msg
@@ -54,6 +54,6 @@ def send(self, msg: Message):
     def close(self):
         try:
             self.__socket.close()
-            logger.debug('closed')
-        except:
-            logger.debug('Unable to close connection. Dropping it...')
+            logger.debug("closed")
+        except Exception:
+            logger.debug("Unable to close connection. Dropping it...")