Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve factory types #2060

Merged
merged 2 commits into from
Feb 25, 2024
Merged

Improve factory types #2060

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
09ed858
Improve factory types
alexrudd2 Feb 25, 2024
0a080c4
Merge branch 'dev' into factory-types
janiversen Feb 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 18 additions & 15 deletions pymodbus/factory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
"""

# pylint: disable=missing-type-doc
from typing import Callable, Dict

from pymodbus.bit_read_message import (
ReadCoilsRequest,
ReadCoilsResponse,
Expand Down Expand Up @@ -161,17 +163,17 @@ class ServerDecoder:
]

@classmethod
def getFCdict(cls):
def getFCdict(cls) -> Dict[int, Callable]:
"""Build function code - class list."""
return {f.function_code: f for f in cls.__function_table}
return {f.function_code: f for f in cls.__function_table} # type: ignore[attr-defined]

def __init__(self):
def __init__(self) -> None:
"""Initialize the client lookup tables."""
functions = {f.function_code for f in self.__function_table}
functions = {f.function_code for f in self.__function_table} # type: ignore[attr-defined]
self.lookup = self.getFCdict()
self.__sub_lookup = {f: {} for f in functions}
self.__sub_lookup: Dict[int, Dict[int, Callable]] = {f: {} for f in functions}
for f in self.__sub_function_table:
self.__sub_lookup[f.function_code][f.sub_function_code] = f
self.__sub_lookup[f.function_code][f.sub_function_code] = f # type: ignore[attr-defined]

def decode(self, message):
"""Decode a request packet.
Expand All @@ -193,7 +195,7 @@ def lookupPduClass(self, function_code):
"""
return self.lookup.get(function_code, ExceptionResponse)

def _helper(self, data):
def _helper(self, data: str):
"""Generate the correct request object from a valid request packet.

This decodes from a list of the currently implemented request types.
Expand Down Expand Up @@ -294,13 +296,13 @@ class ClientDecoder:
ReadDeviceInformationResponse,
]

def __init__(self):
def __init__(self) -> None:
"""Initialize the client lookup tables."""
functions = {f.function_code for f in self.function_table}
self.lookup = {f.function_code: f for f in self.function_table}
self.__sub_lookup = {f: {} for f in functions}
functions = {f.function_code for f in self.function_table} # type: ignore[attr-defined]
self.lookup = {f.function_code: f for f in self.function_table} # type: ignore[attr-defined]
self.__sub_lookup: Dict[int, Dict[int, Callable]] = {f: {} for f in functions}
for f in self.__sub_function_table:
self.__sub_lookup[f.function_code][f.sub_function_code] = f
self.__sub_lookup[f.function_code][f.sub_function_code] = f # type: ignore[attr-defined]

def lookupPduClass(self, function_code):
"""Use `function_code` to determine the class of the PDU.
Expand All @@ -324,7 +326,7 @@ def decode(self, message):
Log.error("General exception: {}", exc)
return None

def _helper(self, data):
def _helper(self, data: str):
"""Generate the correct response object from a valid response packet.

This decodes from a list of the currently implemented request types.
Expand All @@ -333,8 +335,9 @@ def _helper(self, data):
:returns: The decoded request or an exception response object
:raises ModbusException:
"""
fc_string = function_code = int(data[0])
if function_code in self.lookup:
fc_string = data[0]
function_code = int(fc_string)
if function_code in self.lookup: # pylint: disable=consider-using-assignment-expr
fc_string = "{}: {}".format( # pylint: disable=consider-using-f-string
str(self.lookup[function_code]) # pylint: disable=use-maxsplit-arg
.split(".")[-1]
Expand Down