Enable mypy in CI (#1388)

Co-authored-by: jan iversen <[email protected]>

Author: alexrudd2

.github/workflows/ci.yml

@@ -46,6 +46,9 @@ jobs:
           - name: docs
             cmd: make -C doc/ html
             type: lint
+          - name: mypy
+            cmd: mypy pymodbus
+            type: lint
           - name: pytest
             cmd: pytest --cov=pymodbus --cov=test --cov-report=term-missing --cov-report=xml -v --full-trace --timeout=20
             type: test

check_ci.sh

@@ -10,5 +10,6 @@ black --safe --quiet examples/ pymodbus/ test/
 isort .
 pylint --recursive=y examples pymodbus test
 flake8
+mypy pymodbus
 pytest --numprocesses auto
 echo "Ready to push"

pymodbus/client/base.py

@@ -149,7 +149,7 @@ def register(self, custom_response_class: ModbusResponse) -> None:
         """
         self.framer.decoder.register(custom_response_class)
 
-    def connect(self) -> None:
+    def connect(self):
         """Connect to the modbus remote host (call **sync/async**).
 
         :raises ModbusException: Different exceptions, check exception text.

pymodbus/framer/__init__.py

@@ -18,6 +18,14 @@ class ModbusFramer:
 
     name = ""
 
+    def __init__(self, decoder, client=None):
+        """Initialize a new instance of the framer.
+
+        :param decoder: The decoder implementation to use
+        """
+        self.decoder = decoder
+        self.client = client
+
     def _validate_unit_id(self, units, single):
         """Validate if the received data is valid for the client.
 
@@ -40,7 +48,7 @@ def sendPacket(self, message):
         :param message: Message to be sent over the bus
         :return:
         """
-        return self.client.send(message)  # pylint: disable=no-member
+        return self.client.send(message)
 
     def recvPacket(self, size):
         """Receive packet from the bus.
@@ -49,4 +57,4 @@ def recvPacket(self, size):
         :param size: Number of bytes to read
         :return:
         """
-        return self.client.recv(size)  # pylint: disable=no-member
+        return self.client.recv(size)

pymodbus/framer/ascii_framer.py

@@ -37,13 +37,12 @@ def __init__(self, decoder, client=None):
 
         :param decoder: The decoder implementation to use
         """
+        super().__init__(decoder, client)
         self._buffer = b""
         self._header = {"lrc": "0000", "len": 0, "uid": 0x00}
         self._hsize = 0x02
         self._start = b":"
         self._end = b"\r\n"
-        self.decoder = decoder
-        self.client = client
 
     # ----------------------------------------------------------------------- #
     # Private Helper Functions

pymodbus/framer/binary_framer.py

@@ -46,14 +46,13 @@ def __init__(self, decoder, client=None):
 
         :param decoder: The decoder implementation to use
         """
+        super().__init__(decoder, client)
         self._buffer = b""
         self._header = {"crc": 0x0000, "len": 0, "uid": 0x00}
         self._hsize = 0x01
         self._start = b"\x7b"  # {
         self._end = b"\x7d"  # }
         self._repeat = [b"}"[0], b"{"[0]]  # python3 hack
-        self.decoder = decoder
-        self.client = client
 
     # ----------------------------------------------------------------------- #
     # Private Helper Functions

pymodbus/framer/rtu_framer.py

@@ -58,13 +58,12 @@ def __init__(self, decoder, client=None):
 
         :param decoder: The decoder factory implementation to use
         """
+        super().__init__(decoder, client)
         self._buffer = b""
         self._header = {"uid": 0x00, "len": 0, "crc": b"\x00\x00"}
         self._hsize = 0x01
         self._end = b"\x0d\x0a"
         self._min_frame_size = 4
-        self.decoder = decoder
-        self.client = client
 
     # ----------------------------------------------------------------------- #
     # Private Helper Functions

pymodbus/framer/socket_framer.py

@@ -41,11 +41,10 @@ def __init__(self, decoder, client=None):
 
         :param decoder: The decoder factory implementation to use
         """
+        super().__init__(decoder, client)
         self._buffer = b""
         self._header = {"tid": 0, "pid": 0, "len": 0, "uid": 0}
         self._hsize = 0x07
-        self.decoder = decoder
-        self.client = client
 
     # ----------------------------------------------------------------------- #
     # Private Helper Functions

pymodbus/framer/tls_framer.py

@@ -33,11 +33,10 @@ def __init__(self, decoder, client=None):
 
         :param decoder: The decoder factory implementation to use
         """
+        super().__init__(decoder, client)
         self._buffer = b""
         self._header = {}
         self._hsize = 0x0
-        self.decoder = decoder
-        self.client = client
 
     # ----------------------------------------------------------------------- #
     # Private Helper Functions