Adding repr to all clients (#296)

* Added REPR statements for all syncchronous clients

* Added Repr tests and pytest cache to gitignore

Author: rahulraghu94

.gitignore

@@ -30,3 +30,4 @@ test/__pycache__/
 /doc/sphinx/
 /doc/html/
 /doc/_build/
+.pytest_cache/

pymodbus/client/sync.py

@@ -270,6 +270,13 @@ def __str__(self):
         """
         return "ModbusTcpClient(%s:%s)" % (self.host, self.port)
 
+    def __repr__(self):
+        return (
+            "<{} at {} socket={self.socket}, ipaddr={self.host}, "
+            "port={self.port}, timeout={self.timeout}>"
+        ).format(self.__class__.__name__, hex(id(self)), self=self)
+
+
 
 # --------------------------------------------------------------------------- #
 # Modbus UDP Client Transport Implementation
@@ -360,6 +367,11 @@ def __str__(self):
         """
         return "ModbusUdpClient(%s:%s)" % (self.host, self.port)
 
+    def __repr__(self):
+        return (
+            "<{} at {} socket={self.socket}, ipaddr={self.host}, "
+            "port={self.port}, timeout={self.timeout}>"
+        ).format(self.__class__.__name__, hex(id(self)), self=self)
 
 # --------------------------------------------------------------------------- #
 # Modbus Serial Client Transport Implementation
@@ -527,6 +539,12 @@ def __str__(self):
         """
         return "ModbusSerialClient(%s baud[%s])" % (self.method, self.baudrate)
 
+    def __repr__(self):
+        return (
+            "<{} at {} socket={self.socket}, method={self.method}, "
+            "timeout={self.timeout}>"
+        ).format(self.__class__.__name__, hex(id(self)), self=self)
+
 # --------------------------------------------------------------------------- #
 # Exported symbols
 # --------------------------------------------------------------------------- #

test/test_client_sync.py

@@ -149,7 +149,13 @@ def testUdpClientRecv(self):
         self.assertEqual(b'', client._recv(0))
         self.assertEqual(b'\x00' * 4, client._recv(4))
 
-
+    def testUdpClientRepr(self):
+        client = ModbusUdpClient()
+        rep = "<{} at {} socket={}, ipaddr={}, port={}, timeout={}>".format(
+            client.__class__.__name__, hex(id(client)), client.socket,
+            client.host, client.port, client.timeout
+        )
+        self.assertEqual(repr(client), rep)
     # -----------------------------------------------------------------------#
     # Test TCP Client
     # -----------------------------------------------------------------------#
@@ -221,7 +227,13 @@ def testTcpClientRecv(self):
         client.socket.timeout = 0.1
         self.assertIn(b'\x00', client._recv(None))
 
-
+    def testSerialClientRpr(self):
+        client = ModbusTcpClient()
+        rep = "<{} at {} socket={}, ipaddr={}, port={}, timeout={}>".format(
+            client.__class__.__name__, hex(id(client)), client.socket,
+            client.host, client.port, client.timeout
+        )
+        self.assertEqual(repr(client), rep)
 
     # -----------------------------------------------------------------------#
     # Test Serial Client
@@ -327,7 +339,13 @@ def testSerialClientRecv(self):
         client.socket.timeout = 0
         self.assertEqual(b'', client._recv(0))
 
-
+    def testSerialClientRepr(self):
+        client = ModbusSerialClient()
+        rep = "<{} at {} socket={}, method={}, timeout={}>".format(
+            client.__class__.__name__, hex(id(client)), client.socket,
+            client.method, client.timeout
+        )
+        self.assertEqual(repr(client), rep)
 # ---------------------------------------------------------------------------#
 # Main
 # ---------------------------------------------------------------------------#