Remove deprecate from payload. (#2532)

janiversen · web-flow · commit 9c8a14c18539 · 2025-01-05T21:12:20.000+01:00
diff --git a/pymodbus/payload.py b/pymodbus/payload.py
@@ -57,7 +57,7 @@ def __init__(
         :param wordorder: The endianness of the word (when wordcount is >= 2)
         :param repack: Repack the provided payload based on BO
         """
-        self.deprecate()
+        # self.deprecate()
         self._payload = payload or []
         self._byteorder = byteorder
         self._wordorder = wordorder
@@ -89,7 +89,7 @@ def _pack_words(self, fstring: str, value) -> bytes:
 
     def encode(self) -> bytes:
         """Get the payload buffer encoded in bytes."""
-        self.deprecate()
+        # self.deprecate()
         return b"".join(self._payload)
 
     def __str__(self) -> str:
@@ -101,15 +101,15 @@ def __str__(self) -> str:
 
     def reset(self) -> None:
         """Reset the payload buffer."""
-        self.deprecate()
+        # self.deprecate()
         self._payload = []
 
     def to_registers(self):
         """Convert the payload buffer to register layout that can be used as a context block.
 
         :returns: The register layout to use as a block
         """
-        self.deprecate()
+        # self.deprecate()
         # fstring = self._byteorder+"H"
         fstring = "!H"
         payload = self.build()
@@ -125,7 +125,7 @@ def to_coils(self) -> list[bool]:
 
         :returns: The coil layout to use as a block
         """
-        self.deprecate()
+        # self.deprecate()
         payload = self.to_registers()
         coils = [bool(int(bit)) for reg in payload for bit in format(reg, "016b")]
         return coils
@@ -138,7 +138,7 @@ def build(self) -> list[bytes]:
 
         :returns: The payload buffer as a list
         """
-        self.deprecate()
+        # self.deprecate()
         buffer = self.encode()
         length = len(buffer)
         buffer += b"\x00" * (length % 2)
@@ -153,7 +153,7 @@ def add_bits(self, values: list[bool]) -> None:
 
         :param values: The value to add to the buffer
         """
-        self.deprecate()
+        # self.deprecate()
         value = pack_bitstring(values)
         self._payload.append(value)
 
@@ -162,7 +162,7 @@ def add_8bit_uint(self, value: int) -> None:
 
         :param value: The value to add to the buffer
         """
-        self.deprecate()
+        # self.deprecate()
         fstring = self._byteorder + "B"
         self._payload.append(pack(fstring, value))
 
@@ -171,7 +171,7 @@ def add_16bit_uint(self, value: int) -> None:
 
         :param value: The value to add to the buffer
         """
-        self.deprecate()
+        # self.deprecate()
         fstring = self._byteorder + "H"
         self._payload.append(pack(fstring, value))
 
@@ -180,7 +180,7 @@ def add_32bit_uint(self, value: int) -> None:
 
         :param value: The value to add to the buffer
         """
-        self.deprecate()
+        # self.deprecate()
         fstring = "I"
         # fstring = self._byteorder + "I"
         p_string = self._pack_words(fstring, value)
@@ -191,7 +191,7 @@ def add_64bit_uint(self, value: int) -> None:
 
         :param value: The value to add to the buffer
         """
-        self.deprecate()
+        # self.deprecate()
         fstring = "Q"
         p_string = self._pack_words(fstring, value)
         self._payload.append(p_string)
@@ -201,7 +201,7 @@ def add_8bit_int(self, value: int) -> None:
 
         :param value: The value to add to the buffer
         """
-        self.deprecate()
+        # self.deprecate()
         fstring = self._byteorder + "b"
         self._payload.append(pack(fstring, value))
 
@@ -210,7 +210,7 @@ def add_16bit_int(self, value: int) -> None:
 
         :param value: The value to add to the buffer
         """
-        self.deprecate()
+        # self.deprecate()
         fstring = self._byteorder + "h"
         self._payload.append(pack(fstring, value))
 
@@ -219,7 +219,7 @@ def add_32bit_int(self, value: int) -> None:
 
         :param value: The value to add to the buffer
         """
-        self.deprecate()
+        # self.deprecate()
         fstring = "i"
         p_string = self._pack_words(fstring, value)
         self._payload.append(p_string)
@@ -229,7 +229,7 @@ def add_64bit_int(self, value: int) -> None:
 
         :param value: The value to add to the buffer
         """
-        self.deprecate()
+        # self.deprecate()
         fstring = "q"
         p_string = self._pack_words(fstring, value)
         self._payload.append(p_string)
@@ -239,7 +239,7 @@ def add_16bit_float(self, value: float) -> None:
 
         :param value: The value to add to the buffer
         """
-        self.deprecate()
+        # self.deprecate()
         fstring = "e"
         p_string = self._pack_words(fstring, value)
         self._payload.append(p_string)
@@ -249,7 +249,7 @@ def add_32bit_float(self, value: float) -> None:
 
         :param value: The value to add to the buffer
         """
-        self.deprecate()
+        # self.deprecate()
         fstring = "f"
         p_string = self._pack_words(fstring, value)
         self._payload.append(p_string)
@@ -259,7 +259,7 @@ def add_64bit_float(self, value: float) -> None:
 
         :param value: The value to add to the buffer
         """
-        self.deprecate()
+        # self.deprecate()
         fstring = "d"
         p_string = self._pack_words(fstring, value)
         self._payload.append(p_string)
@@ -269,7 +269,7 @@ def add_string(self, value: str) -> None:
 
         :param value: The value to add to the buffer
         """
-        self.deprecate()
+        # self.deprecate()
         fstring = self._byteorder + str(len(value)) + "s"
         self._payload.append(pack(fstring, value.encode()))
 
@@ -302,7 +302,7 @@ def __init__(self, payload, byteorder=Endian.LITTLE, wordorder=Endian.BIG):
         :param byteorder: The endianness of the payload
         :param wordorder: The endianness of the word (when wordcount is >= 2)
         """
-        self.deprecate()
+        # self.deprecate()
         self._payload = payload
         self._pointer = 0x00
         self._byteorder = byteorder
@@ -385,36 +385,36 @@ def _unpack_words(self, handle) -> bytes:
 
     def reset(self):
         """Reset the decoder pointer back to the start."""
-        self.deprecate()
+        # self.deprecate()
         self._pointer = 0x00
 
     def decode_8bit_uint(self):
         """Decode a 8 bit unsigned int from the buffer."""
-        self.deprecate()
+        # self.deprecate()
         self._pointer += 1
         fstring = self._byteorder + "B"
         handle = self._payload[self._pointer - 1 : self._pointer]
         return unpack(fstring, handle)[0]
 
     def decode_bits(self, package_len=1):
         """Decode a byte worth of bits from the buffer."""
-        self.deprecate()
+        # self.deprecate()
         self._pointer += package_len
         # fstring = self._endian + "B"
         handle = self._payload[self._pointer - 1 : self._pointer]
         return unpack_bitstring(handle)
 
     def decode_16bit_uint(self):
         """Decode a 16 bit unsigned int from the buffer."""
-        self.deprecate()
+        # self.deprecate()
         self._pointer += 2
         fstring = self._byteorder + "H"
         handle = self._payload[self._pointer - 2 : self._pointer]
         return unpack(fstring, handle)[0]
 
     def decode_32bit_uint(self):
         """Decode a 32 bit unsigned int from the buffer."""
-        self.deprecate()
+        # self.deprecate()
         self._pointer += 4
         fstring = "I"
         handle = self._payload[self._pointer - 4 : self._pointer]
@@ -423,7 +423,7 @@ def decode_32bit_uint(self):
 
     def decode_64bit_uint(self):
         """Decode a 64 bit unsigned int from the buffer."""
-        self.deprecate()
+        # self.deprecate()
         self._pointer += 8
         fstring = "Q"
         handle = self._payload[self._pointer - 8 : self._pointer]
@@ -432,23 +432,23 @@ def decode_64bit_uint(self):
 
     def decode_8bit_int(self):
         """Decode a 8 bit signed int from the buffer."""
-        self.deprecate()
+        # self.deprecate()
         self._pointer += 1
         fstring = self._byteorder + "b"
         handle = self._payload[self._pointer - 1 : self._pointer]
         return unpack(fstring, handle)[0]
 
     def decode_16bit_int(self):
         """Decode a 16 bit signed int from the buffer."""
-        self.deprecate()
+        # self.deprecate()
         self._pointer += 2
         fstring = self._byteorder + "h"
         handle = self._payload[self._pointer - 2 : self._pointer]
         return unpack(fstring, handle)[0]
 
     def decode_32bit_int(self):
         """Decode a 32 bit signed int from the buffer."""
-        self.deprecate()
+        # self.deprecate()
         self._pointer += 4
         fstring = "i"
         handle = self._payload[self._pointer - 4 : self._pointer]
@@ -457,7 +457,7 @@ def decode_32bit_int(self):
 
     def decode_64bit_int(self):
         """Decode a 64 bit signed int from the buffer."""
-        self.deprecate()
+        # self.deprecate()
         self._pointer += 8
         fstring = "q"
         handle = self._payload[self._pointer - 8 : self._pointer]
@@ -466,7 +466,7 @@ def decode_64bit_int(self):
 
     def decode_16bit_float(self):
         """Decode a 16 bit float from the buffer."""
-        self.deprecate()
+        # self.deprecate()
         self._pointer += 2
         fstring = "e"
         handle = self._payload[self._pointer - 2 : self._pointer]
@@ -475,7 +475,7 @@ def decode_16bit_float(self):
 
     def decode_32bit_float(self):
         """Decode a 32 bit float from the buffer."""
-        self.deprecate()
+        # self.deprecate()
         self._pointer += 4
         fstring = "f"
         handle = self._payload[self._pointer - 4 : self._pointer]
@@ -484,7 +484,7 @@ def decode_32bit_float(self):
 
     def decode_64bit_float(self):
         """Decode a 64 bit float(double) from the buffer."""
-        self.deprecate()
+        # self.deprecate()
         self._pointer += 8
         fstring = "d"
         handle = self._payload[self._pointer - 8 : self._pointer]
@@ -496,7 +496,7 @@ def decode_string(self, size=1):
 
         :param size: The size of the string to decode
         """
-        self.deprecate()
+        # self.deprecate()
         self._pointer += size
         return self._payload[self._pointer - size : self._pointer]
 
@@ -505,5 +505,5 @@ def skip_bytes(self, nbytes):
 
         :param nbytes: The number of bytes to skip
         """
-        self.deprecate()
+        # self.deprecate()
         self._pointer += nbytes
