Allow casting from UBInt() to native int()

Author: hdiogenes

pyof/foundation/base.py

@@ -33,15 +33,15 @@
 
 # This will determine the order on sphinx documentation.
 __all__ = ('GenericStruct', 'GenericMessage', 'GenericType', 'GenericBitMask',
-           'MetaStruct', 'MetaBitMask')
+           'MetaStruct', 'MetaBitMask', 'UBIntBase')
 
 # Classes
 
 
 class GenericType:
     """Foundation class for all custom attributes.
 
-    Base class for :class:`~.UBInt8`, :class:`~.Char`
+    Base class for :class:`~.UBIntBase`, :class:`~.Char`
     and others.
     """
 
@@ -259,6 +259,15 @@ def is_bitmask(self):
         return self._value and issubclass(type(self._value), GenericBitMask)
 
 
+class UBIntBase(GenericType):
+    """Base class for UBInt{8,16,32,64,128}."""
+    def __int__(self):
+        """Allow converting an UBInt() back to an int()."""
+        # Skip GenericType's checking if this is an Enum ou BitMask
+        # (because it won't be), and convert directly from _value
+        return int(self._value)
+
+
 class MetaStruct(type):
     """MetaClass that dynamically handles openflow version of class attributes.
 

pyof/foundation/basic_types.py

@@ -6,7 +6,7 @@
 
 # Local source tree imports
 from pyof.foundation import exceptions
-from pyof.foundation.base import GenericStruct, GenericType
+from pyof.foundation.base import GenericStruct, GenericType, UBIntBase
 
 __all__ = ('BinaryData', 'Char', 'ConstantTypeList', 'FixedTypeList',
            'IPAddress', 'DPID', 'HWAddress', 'Pad', 'UBInt8', 'UBInt16',
@@ -77,7 +77,7 @@ def __deepcopy__(self, memo):
         return Pad(length=self._length)
 
 
-class UBInt8(GenericType):
+class UBInt8(UBIntBase):
     """Format character for an Unsigned Char.
 
     Class for an 8-bit (1-byte) Unsigned Integer.
@@ -86,7 +86,7 @@ class UBInt8(GenericType):
     _fmt = "!B"
 
 
-class UBInt16(GenericType):
+class UBInt16(UBIntBase):
     """Format character for an Unsigned Short.
 
     Class for an 16-bit (2-byte) Unsigned Integer.
@@ -95,7 +95,7 @@ class UBInt16(GenericType):
     _fmt = "!H"
 
 
-class UBInt32(GenericType):
+class UBInt32(UBIntBase):
     """Format character for an Unsigned Int.
 
     Class for an 32-bit (4-byte) Unsigned Integer.
@@ -104,7 +104,7 @@ class UBInt32(GenericType):
     _fmt = "!I"
 
 
-class UBInt64(GenericType):
+class UBInt64(UBIntBase):
     """Format character for an Unsigned Long Long.
 
     Class for an 64-bit (8-byte) Unsigned Integer.
@@ -113,7 +113,7 @@ class UBInt64(GenericType):
     _fmt = "!Q"
 
 
-class UBInt128(GenericType):
+class UBInt128(UBIntBase):
     """Format character for an Unsigned Long Long.
 
     Class for an 128-bit (16-byte) Unsigned Integer.

tests/unit/test_foundation/test_basic_types.py

@@ -32,6 +32,9 @@ def test_pack_error(self):
         u = basic_types.UBInt8(256)
         self.assertRaises(PackException, u.pack)
 
+    def test_cast_to_int(self):
+        self.assertEqual(255, int(self.ubint8))
+
 
 class TestUBInt16(unittest.TestCase):
     """Test of UBInt16 BasicType."""