remove kwargs II. (#2237)

Author: janiversen

API_changes.rst

@@ -13,6 +13,7 @@ API changes 3.7.0
 - Framer.<type> renamed to FramerType.<type>
 - PDU classes moved to pymodbus/pdu
 - Simulator config custom actions kwargs -> parameters
+- Non defined parameters (kwargs) no longer valid
 
 
 API changes 3.6.0

examples/client_custom_msg.py

@@ -36,9 +36,9 @@ class CustomModbusResponse(ModbusResponse):
     function_code = 55
     _rtu_byte_count_pos = 2
 
-    def __init__(self, values=None, **kwargs):
+    def __init__(self, values=None, slave=0, transaction=0, protocol=0, skip_encode=False, **_kwargs):
         """Initialize."""
-        ModbusResponse.__init__(self, **kwargs)
+        ModbusResponse.__init__(self, slave, transaction, protocol, skip_encode)
         self.values = values or []
 
     def encode(self):
@@ -68,9 +68,9 @@ class CustomModbusRequest(ModbusRequest):
     function_code = 55
     _rtu_frame_size = 8
 
-    def __init__(self, address=None, **kwargs):
+    def __init__(self, address=None, slave=0, transaction=0, protocol=0, skip_encode=False, **_kwargs):
         """Initialize."""
-        ModbusRequest.__init__(self, **kwargs)
+        ModbusRequest.__init__(self, slave, transaction, protocol, skip_encode)
         self.address = address
         self.count = 16
 

pymodbus/client/base.py

@@ -303,7 +303,11 @@ def __init__(
             framer, cast(type[ModbusFramer], framer)
         )(ClientDecoder(), self)
         self.transaction = SyncModbusTransactionManager(
-            self, retries=retries, retry_on_empty=retry_on_empty, **kwargs
+            self,
+            kwargs.get("backoff", 0.3),
+            retry_on_empty,
+            kwargs.get("retry_on_invalid", False),
+            retries,
         )
         self.reconnect_delay_current = self.params.reconnect_delay or 0
         self.use_udp = False

pymodbus/factory.py

@@ -120,7 +120,7 @@ def _helper(self, data: str):
         function_code = int(data[0])
         if not (request := self.lookup.get(function_code, lambda: None)()):
             Log.debug("Factory Request[{}]", function_code)
-            request = pdu.IllegalFunctionRequest(function_code)
+            request = pdu.IllegalFunctionRequest(function_code, 0, 0, 0, False)
         else:
             fc_string = "{}: {}".format(  # pylint: disable=consider-using-f-string
                 str(self.lookup[function_code])  # pylint: disable=use-maxsplit-arg

pymodbus/pdu/bit_read_message.py

@@ -21,14 +21,14 @@ class ReadBitsRequestBase(ModbusRequest):
 
     _rtu_frame_size = 8
 
-    def __init__(self, address, count, slave=0, **kwargs):
+    def __init__(self, address, count, slave=0, transaction=0, protocol=0, skip_encode=False, **_kwargs):
         """Initialize the read request data.
 
         :param address: The start address to read from
         :param count: The number of bits after "address" to read
         :param slave: Modbus slave slave ID
         """
-        ModbusRequest.__init__(self, slave, **kwargs)
+        ModbusRequest.__init__(self, slave, transaction, protocol, skip_encode)
         self.address = address
         self.count = count
 
@@ -75,13 +75,13 @@ class ReadBitsResponseBase(ModbusResponse):
 
     _rtu_byte_count_pos = 2
 
-    def __init__(self, values, slave=0, **kwargs):
+    def __init__(self, values, slave=0, transaction=0, protocol=0, skip_encode=False, **_kwargs):
         """Initialize a new instance.
 
         :param values: The requested values to be returned
         :param slave: Modbus slave slave ID
         """
-        ModbusResponse.__init__(self, slave, **kwargs)
+        ModbusResponse.__init__(self, slave, transaction, protocol, skip_encode)
 
         #: A list of booleans representing bit values
         self.bits = values or []
@@ -146,14 +146,14 @@ class ReadCoilsRequest(ReadBitsRequestBase):
     function_code = 1
     function_code_name = "read_coils"
 
-    def __init__(self, address=None, count=None, slave=0, **kwargs):
+    def __init__(self, address=None, count=None, slave=0, transaction=0, protocol=0, skip_encode=False, **_kwargs):
         """Initialize a new instance.
 
         :param address: The address to start reading from
         :param count: The number of bits to read
         :param slave: Modbus slave slave ID
         """
-        ReadBitsRequestBase.__init__(self, address, count, slave, **kwargs)
+        ReadBitsRequestBase.__init__(self, address, count, slave, transaction, protocol, skip_encode)
 
     async def execute(self, context):
         """Run a read coils request against a datastore.
@@ -193,13 +193,13 @@ class ReadCoilsResponse(ReadBitsResponseBase):
 
     function_code = 1
 
-    def __init__(self, values=None, slave=0, **kwargs):
+    def __init__(self, values=None, slave=0, transaction=0, protocol=0, skip_encode=False, **_kwargs):
         """Initialize a new instance.
 
         :param values: The request values to respond with
         :param slave: Modbus slave slave ID
         """
-        ReadBitsResponseBase.__init__(self, values, slave, **kwargs)
+        ReadBitsResponseBase.__init__(self, values, slave, transaction, protocol, skip_encode)
 
 
 class ReadDiscreteInputsRequest(ReadBitsRequestBase):
@@ -214,14 +214,14 @@ class ReadDiscreteInputsRequest(ReadBitsRequestBase):
     function_code = 2
     function_code_name = "read_discrete_input"
 
-    def __init__(self, address=None, count=None, slave=0, **kwargs):
+    def __init__(self, address=None, count=None, slave=0, transaction=0, protocol=0, skip_encode=False, **_kwargs):
         """Initialize a new instance.
 
         :param address: The address to start reading from
         :param count: The number of bits to read
         :param slave: Modbus slave slave ID
         """
-        ReadBitsRequestBase.__init__(self, address, count, slave, **kwargs)
+        ReadBitsRequestBase.__init__(self, address, count, slave, transaction, protocol, skip_encode)
 
     async def execute(self, context):
         """Run a read discrete input request against a datastore.
@@ -261,10 +261,10 @@ class ReadDiscreteInputsResponse(ReadBitsResponseBase):
 
     function_code = 2
 
-    def __init__(self, values=None, slave=0, **kwargs):
+    def __init__(self, values=None, slave=0, transaction=0, protocol=0, skip_encode=False, **_kwargs):
         """Initialize a new instance.
 
         :param values: The request values to respond with
         :param slave: Modbus slave slave ID
         """
-        ReadBitsResponseBase.__init__(self, values, slave, **kwargs)
+        ReadBitsResponseBase.__init__(self, values, slave, transaction, protocol, skip_encode)

pymodbus/pdu/bit_write_message.py

@@ -49,13 +49,13 @@ class WriteSingleCoilRequest(ModbusRequest):
 
     _rtu_frame_size = 8
 
-    def __init__(self, address=None, value=None, slave=None, **kwargs):
+    def __init__(self, address=None, value=None, slave=None, transaction=0, protocol=0, skip_encode=0, **_kwargs):
         """Initialize a new instance.
 
         :param address: The variable address to write
         :param value: The value to write at address
         """
-        ModbusRequest.__init__(self, slave=slave, **kwargs)
+        ModbusRequest.__init__(self, slave, transaction, protocol, skip_encode)
         self.address = address
         self.value = bool(value)
 
@@ -119,13 +119,13 @@ class WriteSingleCoilResponse(ModbusResponse):
     function_code = 5
     _rtu_frame_size = 8
 
-    def __init__(self, address=None, value=None, **kwargs):
+    def __init__(self, address=None, value=None, slave=0, transaction=0, protocol=0, skip_encode=False, **_kwargs):
         """Initialize a new instance.
 
         :param address: The variable address written to
         :param value: The value written at address
         """
-        ModbusResponse.__init__(self, **kwargs)
+        ModbusResponse.__init__(self, slave, transaction, protocol, skip_encode)
         self.address = address
         self.value = value
 
@@ -173,13 +173,13 @@ class WriteMultipleCoilsRequest(ModbusRequest):
     function_code_name = "write_coils"
     _rtu_byte_count_pos = 6
 
-    def __init__(self, address=None, values=None, slave=None, **kwargs):
+    def __init__(self, address=None, values=None, slave=None, transaction=0, protocol=0, skip_encode=0, **_kwargs):
         """Initialize a new instance.
 
         :param address: The starting request address
         :param values: The values to write
         """
-        ModbusRequest.__init__(self, slave=slave, **kwargs)
+        ModbusRequest.__init__(self, slave, transaction, protocol, skip_encode)
         self.address = address
         if values is None:
             values = []
@@ -256,13 +256,13 @@ class WriteMultipleCoilsResponse(ModbusResponse):
     function_code = 15
     _rtu_frame_size = 8
 
-    def __init__(self, address=None, count=None, **kwargs):
+    def __init__(self, address=None, count=None, slave=0, transaction=0, protocol=0, skip_encode=False, **_kwargs):
         """Initialize a new instance.
 
         :param address: The starting variable address written to
         :param count: The number of values written
         """
-        ModbusResponse.__init__(self, **kwargs)
+        ModbusResponse.__init__(self, slave, transaction, protocol, skip_encode)
         self.address = address
         self.count = count
 

pymodbus/pdu/diag_message.py

@@ -69,9 +69,9 @@ class DiagnosticStatusRequest(ModbusRequest):
     function_code_name = "diagnostic_status"
     _rtu_frame_size = 8
 
-    def __init__(self, **kwargs):
+    def __init__(self, slave=0, transaction=0, protocol=0, skip_encode=False, **_kwargs):
         """Initialize a diagnostic request."""
-        ModbusRequest.__init__(self, **kwargs)
+        ModbusRequest.__init__(self, slave, transaction, protocol, skip_encode)
         self.message = None
 
     def encode(self):
@@ -131,9 +131,9 @@ class DiagnosticStatusResponse(ModbusResponse):
     function_code = 0x08
     _rtu_frame_size = 8
 
-    def __init__(self, **kwargs):
+    def __init__(self, slave=0, transaction=0, protocol=0, skip_encode=False, **_kwargs):
         """Initialize a diagnostic response."""
-        ModbusResponse.__init__(self, **kwargs)
+        ModbusResponse.__init__(self, slave, transaction, protocol, skip_encode)
         self.message = None
 
     def encode(self):

pymodbus/pdu/file_message.py

@@ -100,12 +100,12 @@ class ReadFileRecordRequest(ModbusRequest):
     function_code_name = "read_file_record"
     _rtu_byte_count_pos = 2
 
-    def __init__(self, records=None, **kwargs):
+    def __init__(self, records=None, slave=0, transaction=0, protocol=0, skip_encode=False, **_kwargs):
         """Initialize a new instance.
 
         :param records: The file record requests to be read
         """
-        ModbusRequest.__init__(self, **kwargs)
+        ModbusRequest.__init__(self, slave, transaction, protocol, skip_encode)
         self.records = records or []
 
     def encode(self):
@@ -165,12 +165,12 @@ class ReadFileRecordResponse(ModbusResponse):
     function_code = 0x14
     _rtu_byte_count_pos = 2
 
-    def __init__(self, records=None, **kwargs):
+    def __init__(self, records=None, slave=0, transaction=0, protocol=0, skip_encode=False, **_kwargs):
         """Initialize a new instance.
 
         :param records: The requested file records
         """
-        ModbusResponse.__init__(self, **kwargs)
+        ModbusResponse.__init__(self, slave, transaction, protocol, skip_encode)
         self.records = records or []
 
     def encode(self):
@@ -218,12 +218,12 @@ class WriteFileRecordRequest(ModbusRequest):
     function_code_name = "write_file_record"
     _rtu_byte_count_pos = 2
 
-    def __init__(self, records=None, **kwargs):
+    def __init__(self, records=None, slave=0, transaction=0, protocol=0, skip_encode=False, **_kwargs):
         """Initialize a new instance.
 
         :param records: The file record requests to be read
         """
-        ModbusRequest.__init__(self, **kwargs)
+        ModbusRequest.__init__(self, slave, transaction, protocol, skip_encode)
         self.records = records or []
 
     def encode(self):
@@ -282,12 +282,12 @@ class WriteFileRecordResponse(ModbusResponse):
     function_code = 0x15
     _rtu_byte_count_pos = 2
 
-    def __init__(self, records=None, **kwargs):
+    def __init__(self, records=None, slave=0, transaction=0, protocol=0, skip_encode=False, **_kwargs):
         """Initialize a new instance.
 
         :param records: The file record requests to be read
         """
-        ModbusResponse.__init__(self, **kwargs)
+        ModbusResponse.__init__(self, slave, transaction, protocol, skip_encode)
         self.records = records or []
 
     def encode(self):
@@ -347,12 +347,12 @@ class ReadFifoQueueRequest(ModbusRequest):
     function_code_name = "read_fifo_queue"
     _rtu_frame_size = 6
 
-    def __init__(self, address=0x0000, **kwargs):
+    def __init__(self, address=0x0000, slave=0, transaction=0, protocol=0, skip_encode=False, **_kwargs):
         """Initialize a new instance.
 
         :param address: The fifo pointer address (0x0000 to 0xffff)
         """
-        ModbusRequest.__init__(self, **kwargs)
+        ModbusRequest.__init__(self, slave, transaction, protocol, skip_encode)
         self.address = address
         self.values = []  # this should be added to the context
 
@@ -408,12 +408,12 @@ def calculateRtuFrameSize(cls, buffer):
         lo_byte = int(buffer[3])
         return (hi_byte << 16) + lo_byte + 6
 
-    def __init__(self, values=None, **kwargs):
+    def __init__(self, values=None, slave=0, transaction=0, protocol=0, skip_encode=False, **_kwargs):
         """Initialize a new instance.
 
         :param values: The list of values of the fifo to return
         """
-        ModbusResponse.__init__(self, **kwargs)
+        ModbusResponse.__init__(self, slave, transaction, protocol, skip_encode)
         self.values = values or []
 
     def encode(self):

pymodbus/pdu/mei_message.py

@@ -56,13 +56,13 @@ class ReadDeviceInformationRequest(ModbusRequest):
     function_code_name = "read_device_information"
     _rtu_frame_size = 7
 
-    def __init__(self, read_code=None, object_id=0x00, **kwargs):
+    def __init__(self, read_code=None, object_id=0x00, slave=0, transaction=0, protocol=0, skip_encode=False, **_kwargs):
         """Initialize a new instance.
 
         :param read_code: The device information read code
         :param object_id: The object to read from
         """
-        ModbusRequest.__init__(self, **kwargs)
+        ModbusRequest.__init__(self, slave, transaction, protocol, skip_encode)
         self.read_code = read_code or DeviceInformation.BASIC
         self.object_id = object_id
 
@@ -134,13 +134,13 @@ def calculateRtuFrameSize(cls, buffer):
         except struct.error as exc:
             raise IndexError from exc
 
-    def __init__(self, read_code=None, information=None, **kwargs):
+    def __init__(self, read_code=None, information=None, slave=0, transaction=0, protocol=0, skip_encode=False, **_kwargs):
         """Initialize a new instance.
 
         :param read_code: The device information read code
         :param information: The requested information request
         """
-        ModbusResponse.__init__(self, **kwargs)
+        ModbusResponse.__init__(self, slave, transaction, protocol, skip_encode)
         self.read_code = read_code or DeviceInformation.BASIC
         self.information = information or {}
         self.number_of_objects = 0