Remove interface classes.

Author: janiversen

API_changes.rst

@@ -5,6 +5,9 @@ PyModbus - API changes.
 -------------
 Version 3.2.0
 -------------
+- pymodbus/interfaces/IModbusDecoder removed.
+- pymodbus/interfaces/IModbusFramer removed.
+- pymodbus/interfaces/IModbusSlaveContext -> pymodbus/datastore/ModbusBaseSlaveContext.
 - StartAsync<type>Server, removed defer_start argument, return is None.
   instead of using defer_start instantiate the Modbus<type>Server directly.
 - `ReturnSlaveNoReponseCountResponse` has been corrected to

doc/source/library/pymodbus.rst

@@ -47,11 +47,6 @@ Extra functions
     :undoc-members:
     :show-inheritance:
 
-.. automodule:: pymodbus.interfaces
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 .. automodule:: pymodbus.mei_message
     :members:
     :undoc-members:

examples/v2.5.3/bcd_payload.py

@@ -9,7 +9,6 @@
 
 from pymodbus.constants import Endian
 from pymodbus.exceptions import ParameterException
-from pymodbus.interfaces import IPayloadBuilder
 from pymodbus.payload import BinaryPayloadDecoder
 from pymodbus.utilities import pack_bitstring, unpack_bitstring
 
@@ -57,7 +56,7 @@ def count_bcd_digits(bcd):
     return count
 
 
-class BcdPayloadBuilder(IPayloadBuilder):
+class BcdPayloadBuilder:
     """A utility that helps build binary coded decimal payload messages
 
     to be written with the various modbus messages.

examples/v2.5.3/modicon_payload.py

@@ -9,11 +9,10 @@
 
 from pymodbus.constants import Endian
 from pymodbus.exceptions import ParameterException
-from pymodbus.interfaces import IPayloadBuilder
 from pymodbus.utilities import pack_bitstring, unpack_bitstring
 
 
-class ModiconPayloadBuilder(IPayloadBuilder):
+class ModiconPayloadBuilder:
     """A utility that helps build modicon encoded payload messages.
 
     to be written with the various modbus messages.

examples/v2.5.3/remote_server_context.py

@@ -22,8 +22,8 @@
 """
 import logging
 
+from pymodbus.datastore import ModbusBaseSlaveContext
 from pymodbus.exceptions import NotImplementedException
-from pymodbus.interfaces import IModbusSlaveContext
 
 
 # -------------------------------------------------------------------------- #
@@ -40,7 +40,7 @@
 # -------------------------------------------------------------------------- #
 
 
-class RemoteSingleSlaveContext(IModbusSlaveContext):
+class RemoteSingleSlaveContext(ModbusBaseSlaveContext):
     """This is a remote server context,
 
     that allows one to create a server context backed by a single client that

pymodbus/datastore/__init__.py

@@ -1,5 +1,9 @@
 """Datastore."""
-from pymodbus.datastore.context import ModbusServerContext, ModbusSlaveContext
+from pymodbus.datastore.context import (
+    ModbusBaseSlaveContext,
+    ModbusServerContext,
+    ModbusSlaveContext,
+)
 from pymodbus.datastore.database.redis_datastore import RedisSlaveContext
 from pymodbus.datastore.database.sql_datastore import SqlSlaveContext
 from pymodbus.datastore.simulator import ModbusSimulatorContext
@@ -13,6 +17,7 @@
 #  Exported symbols
 # ---------------------------------------------------------------------------#
 __all__ = [
+    "ModbusBaseSlaveContext",
     "ModbusSequentialDataBlock",
     "ModbusSparseDataBlock",
     "ModbusSlaveContext",

pymodbus/datastore/context.py

@@ -3,14 +3,36 @@
 from pymodbus.constants import Defaults
 from pymodbus.datastore.store import ModbusSequentialDataBlock
 from pymodbus.exceptions import NoSuchSlaveException
-from pymodbus.interfaces import IModbusSlaveContext
 from pymodbus.logging import Log
 
 
+class ModbusBaseSlaveContext:  # pylint: disable=too-few-public-methods
+    """Interface for a modbus slave data context.
+
+    Derived classes must implemented the following methods:
+            reset(self)
+            validate(self, fx, address, count=1)
+            getValues(self, fx, address, count=1)
+            setValues(self, fx, address, values)
+    """
+
+    __fx_mapper = {2: "d", 4: "i"}
+    __fx_mapper.update([(i, "h") for i in (3, 6, 16, 22, 23)])
+    __fx_mapper.update([(i, "c") for i in (1, 5, 15)])
+
+    def decode(self, fx):  # pylint: disable=invalid-name
+        """Convert the function code to the datastore to.
+
+        :param fx: The function we are working with
+        :returns: one of [d(iscretes),i(nputs),h(olding),c(oils)
+        """
+        return self.__fx_mapper[fx]
+
+
 # ---------------------------------------------------------------------------#
 #  Slave Contexts
 # ---------------------------------------------------------------------------#
-class ModbusSlaveContext(IModbusSlaveContext):
+class ModbusSlaveContext(ModbusBaseSlaveContext):
     """This creates a modbus data model with each data access stored in a block."""
 
     def __init__(self, *args, **kwargs):  # pylint: disable=unused-argument
@@ -91,9 +113,7 @@ def register(self, function_code, fc_as_hex, datablock=None):
         :param datablock: datablock to associate with this function code
         """
         self.store[fc_as_hex] = datablock or ModbusSequentialDataBlock.create()
-        self._IModbusSlaveContext__fx_mapper[  # pylint: disable=no-member
-            function_code
-        ] = fc_as_hex
+        self.__fx_mapper[function_code] = fc_as_hex
 
 
 class ModbusServerContext:

pymodbus/datastore/database/redis_datastore.py

@@ -7,15 +7,15 @@
 except ImportError:
     pass
 
-from pymodbus.interfaces import IModbusSlaveContext
+from pymodbus.datastore import ModbusBaseSlaveContext
 from pymodbus.logging import Log
 from pymodbus.utilities import pack_bitstring, unpack_bitstring
 
 
 # ---------------------------------------------------------------------------#
 #  Context
 # ---------------------------------------------------------------------------#
-class RedisSlaveContext(IModbusSlaveContext):
+class RedisSlaveContext(ModbusBaseSlaveContext):
     """This is a modbus slave context using redis as a backing store."""
 
     def __init__(self, **kwargs):
@@ -42,40 +42,40 @@ def reset(self):
         """Reset all the datastores to their default values."""
         self.client.flushall()
 
-    def validate(self, fx, address, count=1):
+    def validate(self, fc, address, count=1):
         """Validate the request to make sure it is in range.
 
-        :param fx: The function we are working with
+        :param fc: The function we are working with
         :param address: The starting address
         :param count: The number of values to test
         :returns: True if the request in within range, False otherwise
         """
         address = address + 1  # section 4.4 of specification
-        Log.debug("validate[{}] {}:{}", fx, address, count)
-        return self._val_callbacks[self.decode(fx)](address, count)
+        Log.debug("validate[{}] {}:{}", fc, address, count)
+        return self._val_callbacks[self.decode(fc)](address, count)
 
-    def getValues(self, fx, address, count=1):
+    def getValues(self, fc, address, count=1):
         """Get `count` values from datastore.
 
-        :param fx: The function we are working with
+        :param fc: The function we are working with
         :param address: The starting address
         :param count: The number of values to retrieve
         :returns: The requested values from a:a+c
         """
         address = address + 1  # section 4.4 of specification
-        Log.debug("getValues[{}] {}:{}", fx, address, count)
-        return self._get_callbacks[self.decode(fx)](address, count)
+        Log.debug("getValues[{}] {}:{}", fc, address, count)
+        return self._get_callbacks[self.decode(fc)](address, count)
 
-    def setValues(self, fx, address, values):
+    def setValues(self, fc, address, values):
         """Set the datastore with the supplied values.
 
-        :param fx: The function we are working with
+        :param fc: The function we are working with
         :param address: The starting address
         :param values: The new values to be set
         """
         address = address + 1  # section 4.4 of specification
-        Log.debug("setValues[{}] {}:{}", fx, address, len(values))
-        self._set_callbacks[self.decode(fx)](address, values)
+        Log.debug("setValues[{}] {}:{}", fc, address, len(values))
+        self._set_callbacks[self.decode(fc)](address, values)
 
     # --------------------------------------------------------------------------#
     #  Redis Helper Methods

pymodbus/datastore/database/sql_datastore.py

@@ -10,14 +10,14 @@
 except ImportError:
     pass
 
-from pymodbus.interfaces import IModbusSlaveContext
+from pymodbus.datastore import ModbusBaseSlaveContext
 from pymodbus.logging import Log
 
 
 # --------------------------------------------------------------------------- #
 # Context
 # --------------------------------------------------------------------------- #
-class SqlSlaveContext(IModbusSlaveContext):
+class SqlSlaveContext(ModbusBaseSlaveContext):
     """This creates a modbus data model with each data access in its a block."""
 
     def __init__(self, *args, **kwargs):  # pylint: disable=unused-argument
@@ -45,44 +45,44 @@ def reset(self):
         self._metadata.drop_all(None)
         self._db_create(self.table, self.database)
 
-    def validate(self, fx, address, count=1):
+    def validate(self, fc, address, count=1):
         """Validate the request to make sure it is in range.
 
-        :param fx: The function we are working with
+        :param fc: The function we are working with
         :param address: The starting address
         :param count: The number of values to test
         :returns: True if the request in within range, False otherwise
         """
         address = address + 1  # section 4.4 of specification
-        Log.debug("validate[{}] {}:{}", fx, address, count)
-        return self._validate(self.decode(fx), address, count)
+        Log.debug("validate[{}] {}:{}", fc, address, count)
+        return self._validate(self.decode(fc), address, count)
 
-    def getValues(self, fx, address, count=1):
+    def getValues(self, fc, address, count=1):
         """Get `count` values from datastore.
 
-        :param fx: The function we are working with
+        :param fc: The function we are working with
         :param address: The starting address
         :param count: The number of values to retrieve
         :returns: The requested values from a:a+c
         """
         address = address + 1  # section 4.4 of specification
-        Log.debug("get-values[{}] {}:{}", fx, address, count)
-        return self._get(self.decode(fx), address, count)
+        Log.debug("get-values[{}] {}:{}", fc, address, count)
+        return self._get(self.decode(fc), address, count)
 
-    def setValues(self, fx, address, values, update=True):
+    def setValues(self, fc, address, values, update=True):
         """Set the datastore with the supplied values.
 
-        :param fx: The function we are working with
+        :param fc: The function we are working with
         :param address: The starting address
         :param values: The new values to be set
         :param update: Update existing register in the db
         """
         address = address + 1  # section 4.4 of specification
-        Log.debug("set-values[{}] {}:{}", fx, address, len(values))
+        Log.debug("set-values[{}] {}:{}", fc, address, len(values))
         if update:
-            self._update(self.decode(fx), address, values)
+            self._update(self.decode(fc), address, values)
         else:
-            self._set(self.decode(fx), address, values)
+            self._set(self.decode(fc), address, values)
 
     # ----------------------------------------------------------------------- #
     # Sqlite Helper Methods

pymodbus/datastore/remote.py

@@ -1,14 +1,14 @@
 """Remote datastore."""
 # pylint: disable=missing-type-doc
+from pymodbus.datastore import ModbusBaseSlaveContext
 from pymodbus.exceptions import NotImplementedException
-from pymodbus.interfaces import IModbusSlaveContext
 from pymodbus.logging import Log
 
 
 # ---------------------------------------------------------------------------#
 #  Context
 # ---------------------------------------------------------------------------#
-class RemoteSlaveContext(IModbusSlaveContext):
+class RemoteSlaveContext(ModbusBaseSlaveContext):
     """TODO.
 
     This creates a modbus data model that connects to
@@ -49,7 +49,7 @@ def validate(self, fc_as_hex, address, count=1):
         self.result = func_fc(address, count)
         return not self.result.isError()
 
-    def getValues(self, fc_as_hex, address, count=1):
+    def getValues(self, fc_as_hex, _address, _count=1):
         """Get values from real call in validate"""
         if fc_as_hex in self._write_fc:
             return [0]