Merge pull request #536 from hdiogenes/object-reprs

Easier debugging with repr's

Author: beraldoleal

pyof/foundation/base.py

@@ -750,6 +750,11 @@ def __init__(self, xid=None):
         super().__init__()
         self.header.xid = randint(0, MAXID) if xid is None else xid
 
+    def __repr__(self):
+        """Show a full representation of the object."""
+        return "%s(xid=%r)" % (self.__class__.__name__,
+                               self.header.xid if self.header else None)
+
     def __init_subclass__(cls, **kwargs):
         if cls.header is None or cls.header.__class__.__name__ != 'Header':
             msg = "The header attribute must be implemented on the class "

pyof/v0x01/common/header.py

@@ -83,3 +83,13 @@ def __init__(self, message_type=None, length=None, xid=None):
         self.message_type = message_type
         self.length = length
         self.xid = xid
+
+    def __str__(self):
+        """Get just the header type. Eg.: 'OFPT_SET_CONFIG'."""
+        return self.message_type.name
+
+    def __repr__(self):
+        """Show a full representation of the Header, including version."""
+        return "%s(message_type=%s, length=%r, xid=%r, version=%r)" \
+            % (self.__class__.__name__, self.message_type, self.length,
+               self.xid, self.version)

pyof/v0x01/controller2switch/common.py

@@ -86,6 +86,12 @@ def __init__(self, xid=None, flags=None, miss_send_len=None):
         self.flags = flags
         self.miss_send_len = miss_send_len
 
+    def __repr__(self):
+        """Show a full representation of the object."""
+        return "%s(xid=%r, flags=%s, miss_send_len=%r)" \
+               % (self.__class__.__name__, self.header.xid, self.flags,
+                  self.miss_send_len)
+
 
 class AggregateStatsReply(GenericStruct):
     """Body of reply to OFPST_AGGREGATE request."""

tests/raw_dump.py

@@ -22,6 +22,12 @@ def __init__(self, version, basename):
         """
         self._path = 'raw/{}/{}.dat'.format(version, basename)
 
+    def __repr__(self):
+        return repr(self.unpack())
+
+    def __bytes__(self):
+        return self.read()
+
     def read(self):
         """Read the raw file.
 
@@ -35,8 +41,8 @@ def unpack(self):
         """Unpack header and message from a byte sequence.
 
         Returns:
-            The object type specified in the header with the coresponding
-                header.
+            The object type specified in the header with the corresponding
+            header.
         """
         content = self.read()
         raw_header = content[:self._HEADER_BYTES]