improve types

Author: alexrudd2

examples/custom_msg.py

@@ -43,10 +43,10 @@ class CustomModbusResponse(ModbusPDU):
     function_code = 55
     rtu_byte_count_pos = 2
 
-    def __init__(self, values=None, device_id=1, transaction=0):
+    def __init__(self, values: list[int] | None = None, device_id=1, transaction=0):
         """Initialize."""
         super().__init__(dev_id=device_id, transaction_id=transaction)
-        self.values = values or []
+        self.values: list[int] = values or []
 
     def encode(self):
         """Encode response pdu.

examples/server_async.py

@@ -85,7 +85,7 @@ def setup_server(description=None, context=None, cmdline=None):
         elif args.store == "sparse":  # pragma: no cover
             # Continuing, or use a sparse DataBlock which can have gaps
             datablock = lambda : ModbusSparseDataBlock({0x00: 0, 0x05: 1})  # pylint: disable=unnecessary-lambda-assignment
-        elif args.store == "factory":  # pragma: no cover
+        elif args.store == "factory" or True:  # pragma: no cover
             # Alternately, use the factory methods to initialize the DataBlocks
             # or simply do not pass them to have them initialized to 0x00 on the
             # full address range::
@@ -98,15 +98,15 @@ def setup_server(description=None, context=None, cmdline=None):
             # (broadcast mode).
             # However, this can be overloaded by setting the single flag to False and
             # then supplying a dictionary of device id to context mapping::
-            context = {}
-
-            for device_id in range(args.device_ids):
-                context[device_id] = ModbusDeviceContext(
+            context = {
+                device_id : ModbusDeviceContext(
                     di=datablock(),
                     co=datablock(),
                     hr=datablock(),
                     ir=datablock(),
                 )
+                for device_id in range(args.device_ids)
+            }
 
             single = False
         else:

pymodbus/client/mixin.py

@@ -760,9 +760,10 @@ def convert_to_registers(  # noqa: C901
         if data_type == cls.DATATYPE.BITS:
             if not isinstance(value, list):
                 raise TypeError(f"Value should be list of bool but is {type(value)}.")
+            value = cast(list[bool], value)
             if (missing := len(value) % 16):
                 value = value + [False] * (16 - missing)
-            byte_list = pack_bitstring(cast(list[bool], value))
+            byte_list = pack_bitstring(value)
         elif data_type == cls.DATATYPE.STRING:
             if not isinstance(value, str):
                 raise TypeError(f"Value should be string but is {type(value)}.")

pymodbus/datastore/context.py

@@ -161,7 +161,7 @@ def __init__(self, devices=None, single=True):
         :param single: Set to true to treat this as a single context
         """
         self.single = single
-        self._devices = devices or {}
+        self._devices: dict = devices or {}
         if self.single:
             self._devices = {0: self._devices}
 

pymodbus/pdu/device.py

@@ -97,7 +97,7 @@ def __iter__(self):
         """
         return iter(self.stat_data.items())
 
-    def reset(self):
+    def reset(self) -> None:
         """Clear all of the modbus plus statistics."""
         for key in self.stat_data:
             self.stat_data[key] = [0x00] * len(self.stat_data[key])
@@ -109,14 +109,14 @@ def summary(self):
         """
         return iter(self.stat_data.values())
 
-    def encode(self):
+    def encode(self) -> list[int]:
         """Return a summary of the modbus plus statistics.
 
-        :returns: 54 16-bit words representing the status
+        :returns: An iterator over lists of 8-bit integers representing each statistic
         """
-        total, values = [], sum(self.stat_data.values(), [])  # noqa: RUF017
-        for i in range(0, len(values), 2):
-            total.append((values[i] << 8) | values[i + 1])
+        values = [v for sublist in self.stat_data.values() for v in sublist]
+        total = [(values[i] << 8) | values[i + 1]
+                 for i in range(0, len(values), 2)]
         return total
 
 
@@ -446,6 +446,8 @@ class ModbusControlBlock:
     _plus = ModbusPlusStatistics()
     _events: list[ModbusEvent] = []
 
+    _inst: ModbusControlBlock | None = None
+
     # -------------------------------------------------------------------------#
     #  Magic
     # -------------------------------------------------------------------------#
@@ -465,7 +467,7 @@ def __iter__(self):
 
     def __new__(cls):
         """Create a new instance."""
-        if "_inst" not in vars(cls):
+        if cls._inst is None:
             cls._inst = object.__new__(cls)
         return cls._inst
 

pymodbus/pdu/file_message.py

@@ -105,7 +105,8 @@ def encode(self) -> bytes:
 
     def decode(self, data: bytes) -> None:
         """Decode the response."""
-        count, self.records = 1, []
+        count = 1
+        self.records.clear()
         byte_count = int(data[0])
         while count < byte_count:
             calc_length, _ = struct.unpack(
@@ -151,7 +152,8 @@ def encode(self) -> bytes:
     def decode(self, data: bytes) -> None:
         """Decode the incoming request."""
         byte_count = int(data[0])
-        count, self.records = 1, []
+        count = 1
+        self.records.clear()
         while count < byte_count:
             decoded = struct.unpack(">BHHH", data[count : count + 7])
             calc_length = decoded[3] * 2
@@ -204,7 +206,8 @@ def encode(self) -> bytes:
 
     def decode(self, data: bytes) -> None:
         """Decode the incoming request."""
-        count, self.records = 1, []
+        count = 1
+        self.records.clear()
         byte_count = int(data[0])
         while count < byte_count:
             decoded = struct.unpack(">BHHH", data[count : count + 7])

pymodbus/pdu/mei_message.py

@@ -2,6 +2,7 @@
 from __future__ import annotations
 
 import struct
+from typing import Any
 
 from pymodbus.constants import DeviceInformation, ExcCodes, MoreData
 from pymodbus.datastore import ModbusDeviceContext
@@ -96,7 +97,7 @@ def __init__(self, read_code: int | None = None, information: dict | None = None
         """Initialize a new instance."""
         super().__init__(transaction_id=transaction_id, dev_id=dev_id)
         self.read_code = read_code or DeviceInformation.BASIC
-        self.information = information or {}
+        self.information: dict[int, Any] = information or {}
         self.number_of_objects = 0
         self.conformity = 0x83  # I support everything right now
         self.next_object_id = 0x00
@@ -150,7 +151,8 @@ def decode(self, data: bytes) -> None:
         self.sub_function_code, self.read_code = params[0:2]
         self.conformity, self.more_follows = params[2:4]
         self.next_object_id, self.number_of_objects = params[4:6]
-        self.information, count = {}, 6  # skip the header information
+        count = 6  # skip the header information
+        self.information.clear()
 
         while count < len(data):
             object_id, object_length = struct.unpack(">BB", data[count : count + 2])

pymodbus/server/simulator/http_server.py

@@ -7,11 +7,15 @@
 import importlib
 import json
 import os
+from typing import TYPE_CHECKING
 
 
 with contextlib.suppress(ImportError):
     from aiohttp import web
 
+if TYPE_CHECKING:
+    from aiohttp import web
+
 from pymodbus.datastore import ModbusServerContext, ModbusSimulatorContext
 from pymodbus.datastore.simulator import Label
 from pymodbus.logging import Log
@@ -137,7 +141,7 @@ def __init__(
             del server["port"]
         device = setup["device_list"][modbus_device]
         self.datastore_context = ModbusSimulatorContext(
-            device, custom_actions_dict or {}
+            device, custom_actions_dict or None
         )
         datastore = None
         if "device_id" in server:
@@ -251,7 +255,7 @@ async def stop(self):
             self.serving.set_result(True)
         await asyncio.sleep(0)
 
-    async def handle_html_static(self, request):  # pragma: no cover
+    async def handle_html_static(self, request: web.Request):  # pragma: no cover
         """Handle static html."""
         if not (page := request.path[1:]):
             page = "index.html"
@@ -264,7 +268,7 @@ async def handle_html_static(self, request):  # pragma: no cover
         except (FileNotFoundError, IsADirectoryError) as exc:
             raise web.HTTPNotFound(reason="File not found") from exc
 
-    async def handle_html(self, request):  # pragma: no cover
+    async def handle_html(self, request: web.Request):  # pragma: no cover
         """Handle html."""
         page_type = request.path.split("/")[-1]
         params = dict(request.query)
@@ -280,7 +284,7 @@ async def handle_html(self, request):  # pragma: no cover
         new_page = self.generator_html[page_type][1](params, html)
         return web.Response(text=new_page, content_type="text/html")
 
-    async def handle_json(self, request):
+    async def handle_json(self, request: web.Request):
         """Handle api registers."""
         command = request.path.split("/")[-1]
         params = await request.json()

pymodbus/transport/transport.py

@@ -126,7 +126,7 @@ def generate_ssl(
             )
         return new_sslctx
 
-    def copy(self) -> CommParams:
+    def copy(self: CommParams) -> CommParams:
         """Create a copy."""
         return dataclasses.replace(self)
 

pyproject.toml

@@ -250,7 +250,7 @@ skip = "./build,./doc/source/_static,venv,.venv,.git,htmlcov,CHANGELOG.rst,.*_ca
 ignore-words-list = "asend"
 
 [tool.ruff]
-target-version="py39"
+target-version="py310"
 extend-exclude = [
     "build",
     "doc",
@@ -312,3 +312,4 @@ line-ending = "auto"
 
 [tool.pyright]
 disableBytesTypePromotions = false
+typeCheckingMode = "standard"