Merge pull request #513 from renanrodrigo/renames

Rename Enums to the default of the project

Author: beraldoleal

pyof/v0x01/controller2switch/common.py

@@ -16,7 +16,7 @@
 
 # Third-party imports
 
-__all__ = ('ConfigFlags', 'StatsTypes', 'AggregateStatsReply',
+__all__ = ('ConfigFlag', 'StatsType', 'AggregateStatsReply',
            'AggregateStatsRequest', 'DescStats', 'FlowStats',
            'FlowStatsRequest', 'PortStats', 'PortStatsRequest', 'QueueStats',
            'QueueStatsRequest', 'TableStats', 'VendorStats',
@@ -25,7 +25,7 @@
 # Enums
 
 
-class ConfigFlags(IntEnum):
+class ConfigFlag(IntEnum):
     """Configuration Flags. Handling of IP Fragments."""
 
     #: No special handling for fragments
@@ -37,7 +37,7 @@ class ConfigFlags(IntEnum):
     OFPC_FRAG_MASK = 3
 
 
-class StatsTypes(IntEnum):
+class StatsType(IntEnum):
     """Type field to be used both in both request and reply.
 
     It specifies the kind of information being passed and determines how the
@@ -70,15 +70,15 @@ class SwitchConfig(GenericMessage):
     """Used as base class for SET_CONFIG and GET_CONFIG_REPLY messages."""
 
     header = Header()
-    flags = UBInt16(enum_ref=ConfigFlags)
+    flags = UBInt16(enum_ref=ConfigFlag)
     miss_send_len = UBInt16()
 
     def __init__(self, xid=None, flags=None, miss_send_len=None):
         """Create a SwitchConfig with the optional parameters below.
 
         Args:
             xid (int): xid to be used on the message header.
-            flags (ConfigFlags): OFPC_* flags.
+            flags (ConfigFlag): OFPC_* flags.
             miss_send_len (int): UBInt16 max bytes of new flow that the
                 datapath should send to the controller.
         """

pyof/v0x01/controller2switch/get_config_reply.py

@@ -18,7 +18,7 @@ def __init__(self, xid=None, flags=None, miss_send_len=None):
 
         Args:
             xid (int): xid to be used on the message header.
-            flags (~pyof.v0x01.controller2switch.common.ConfigFlags):
+            flags (~pyof.v0x01.controller2switch.common.ConfigFlag):
                 OFPC_* flags.
             miss_send_len (int): UBInt16 max bytes of new flow that the
                 datapath should send to the controller.

pyof/v0x01/controller2switch/set_config.py

@@ -19,7 +19,7 @@ def __init__(self, xid=None, flags=None, miss_send_len=None):
 
         Args:
             xid (int): xid to be used on the message header.
-            flags (~pyof.v0x01.controller2switch.common.ConfigFlags):
+            flags (~pyof.v0x01.controller2switch.common.ConfigFlag):
                 OFPC_* flags.
             miss_send_len (int): UBInt16 max bytes of new flow that the
                 datapath should send to the controller.

pyof/v0x01/controller2switch/stats_reply.py

@@ -4,7 +4,7 @@
 from pyof.foundation.base import GenericMessage
 from pyof.foundation.basic_types import BinaryData, FixedTypeList, UBInt16
 from pyof.v0x01.common.header import Header, Type
-from pyof.v0x01.controller2switch.common import DescStats, StatsTypes
+from pyof.v0x01.controller2switch.common import DescStats, StatsType
 
 __all__ = ('StatsReply',)
 
@@ -14,7 +14,7 @@ class StatsReply(GenericMessage):
 
     #: OpenFlow :class:`~pyof.v0x01.common.header.Header`
     header = Header(message_type=Type.OFPT_STATS_REPLY)
-    body_type = UBInt16(enum_ref=StatsTypes)
+    body_type = UBInt16(enum_ref=StatsType)
     flags = UBInt16()
     body = BinaryData()
 
@@ -23,7 +23,7 @@ def __init__(self, xid=None, body_type=None, flags=None, body=b''):
 
         Args:
             xid (int): xid to be used on the message header.
-            body_type (StatsTypes): One of the OFPST_* constants.
+            body_type (StatsType): One of the OFPST_* constants.
             flags (int): OFPSF_REQ_* flags (none yet defined).
             body (BinaryData): Body of the request.
         """

pyof/v0x01/controller2switch/stats_request.py

@@ -10,7 +10,7 @@
 from pyof.foundation.basic_types import BinaryData, FixedTypeList, UBInt16
 # Local imports
 from pyof.v0x01.common.header import Header, Type
-from pyof.v0x01.controller2switch.common import StatsTypes
+from pyof.v0x01.controller2switch.common import StatsType
 
 __all__ = ('StatsRequest',)
 
@@ -20,7 +20,7 @@ class StatsRequest(GenericMessage):
 
     #: OpenFlow :class:`~pyof.v0x01.common.header.Header`
     header = Header(message_type=Type.OFPT_STATS_REQUEST)
-    body_type = UBInt16(enum_ref=StatsTypes)
+    body_type = UBInt16(enum_ref=StatsType)
     flags = UBInt16()
     body = BinaryData()
 
@@ -29,7 +29,7 @@ def __init__(self, xid=None, body_type=None, flags=0, body=b''):
 
         Args:
             xid (int): xid to be used on the message header.
-            body_type (StatsTypes): One of the OFPST_* constants.
+            body_type (StatsType): One of the OFPST_* constants.
             flags (int): OFPSF_REQ_* flags (none yet defined).
             body (BinaryData): Body of the request.
         """

pyof/v0x04/controller2switch/common.py

@@ -18,16 +18,16 @@
 from pyof.v0x04.common.header import Header
 from pyof.v0x04.controller2switch.table_mod import Table
 
-__all__ = ('ConfigFlags', 'ControllerRole', 'Bucket', 'BucketCounter',
-           'ExperimenterMultipartHeader', 'MultipartTypes',
+__all__ = ('ConfigFlag', 'ControllerRole', 'Bucket', 'BucketCounter',
+           'ExperimenterMultipartHeader', 'MultipartType',
            'TableFeaturePropType', 'Property', 'InstructionsProperty',
            'NextTablesProperty', 'ActionsProperty', 'OxmProperty',
            'ListOfProperty', 'TableFeatures')
 
 # Enum
 
 
-class ConfigFlags(IntEnum):
+class ConfigFlag(IntEnum):
     """Handling of IP fragments."""
 
     #: No special handling for fragments.
@@ -104,7 +104,7 @@ def find_class(self):
         return OxmProperty
 
 
-class MultipartTypes(IntEnum):
+class MultipartType(IntEnum):
     """Types of Multipart Messages, both Request and Reply."""
 
     #: Description of this OpenFlow switch.
@@ -338,16 +338,16 @@ class SwitchConfig(GenericMessage):
 
     #: OpenFlow :class:`~pyof.v0x04.common.header.Header`
     header = Header()
-    flags = UBInt16(enum_ref=ConfigFlags)
+    flags = UBInt16(enum_ref=ConfigFlag)
     miss_send_len = UBInt16()
 
-    def __init__(self, xid=None, flags=ConfigFlags.OFPC_FRAG_NORMAL,
+    def __init__(self, xid=None, flags=ConfigFlag.OFPC_FRAG_NORMAL,
                  miss_send_len=ControllerMaxLen.OFPCML_NO_BUFFER):
         """Create a SwitchConfig with the optional parameters below.
 
         Args:
             xid (int): xid to be used on the message header.
-            flags (ConfigFlags): OFPC_* flags.
+            flags (ConfigFlag): OFPC_* flags.
             miss_send_len (int): UBInt16 max bytes of new flow that the
                 datapath should send to the controller.
         """

pyof/v0x04/controller2switch/get_config_reply.py

@@ -18,7 +18,7 @@ def __init__(self, xid=None, flags=None, miss_send_len=None):
 
         Args:
             xid (int): xid to be used on the message header.
-            flags (~pyof.v0x04.controller2switch.common.ConfigFlags):
+            flags (~pyof.v0x04.controller2switch.common.ConfigFlag):
                 OFPC_* flags.
             miss_send_len (int): UBInt16 max bytes of new flow that the
                 datapath should send to the controller.

pyof/v0x04/controller2switch/multipart_reply.py

@@ -13,7 +13,7 @@
 from pyof.v0x04.common.header import Header, Type
 from pyof.v0x04.common.port import Port
 from pyof.v0x04.controller2switch.common import (
-    Bucket, BucketCounter, ExperimenterMultipartHeader, MultipartTypes,
+    Bucket, BucketCounter, ExperimenterMultipartHeader, MultipartType,
     TableFeatures)
 from pyof.v0x04.controller2switch.meter_mod import (
     ListOfMeterBandHeader, MeterBandType, MeterFlags)
@@ -62,7 +62,7 @@ class MultipartReply(GenericMessage):
     #: Openflow :class:`~pyof.v0x04.common.header.Header`
     header = Header(message_type=Type.OFPT_MULTIPART_REPLY)
     #: One of the OFPMP_* constants.
-    multipart_type = UBInt16(enum_ref=MultipartTypes)
+    multipart_type = UBInt16(enum_ref=MultipartType)
     #: OFPMPF_REPLY_* flags.
     flags = UBInt16()
     #: Padding
@@ -139,22 +139,22 @@ def _unpack_body(self):
     def _get_body_instance(self):
         """Return the body instance."""
         exp_header = ExperimenterMultipartHeader
-        simple_body = {MultipartTypes.OFPMP_DESC: Desc,
-                       MultipartTypes.OFPMP_GROUP_FEATURES: GroupFeatures,
-                       MultipartTypes.OFPMP_METER_FEATURES: MeterFeatures,
-                       MultipartTypes.OFPMP_EXPERIMENTER: exp_header}
-
-        array_of_bodies = {MultipartTypes.OFPMP_FLOW: FlowStats,
-                           MultipartTypes.OFPMP_AGGREGATE: AggregateStatsReply,
-                           MultipartTypes.OFPMP_TABLE: TableStats,
-                           MultipartTypes.OFPMP_PORT_STATS: PortStats,
-                           MultipartTypes.OFPMP_QUEUE: QueueStats,
-                           MultipartTypes.OFPMP_GROUP: GroupStats,
-                           MultipartTypes.OFPMP_GROUP_DESC: GroupDescStats,
-                           MultipartTypes.OFPMP_METER: MeterStats,
-                           MultipartTypes.OFPMP_METER_CONFIG: MeterConfig,
-                           MultipartTypes.OFPMP_TABLE_FEATURES: TableFeatures,
-                           MultipartTypes.OFPMP_PORT_DESC: Port}
+        simple_body = {MultipartType.OFPMP_DESC: Desc,
+                       MultipartType.OFPMP_GROUP_FEATURES: GroupFeatures,
+                       MultipartType.OFPMP_METER_FEATURES: MeterFeatures,
+                       MultipartType.OFPMP_EXPERIMENTER: exp_header}
+
+        array_of_bodies = {MultipartType.OFPMP_FLOW: FlowStats,
+                           MultipartType.OFPMP_AGGREGATE: AggregateStatsReply,
+                           MultipartType.OFPMP_TABLE: TableStats,
+                           MultipartType.OFPMP_PORT_STATS: PortStats,
+                           MultipartType.OFPMP_QUEUE: QueueStats,
+                           MultipartType.OFPMP_GROUP: GroupStats,
+                           MultipartType.OFPMP_GROUP_DESC: GroupDescStats,
+                           MultipartType.OFPMP_METER: MeterStats,
+                           MultipartType.OFPMP_METER_CONFIG: MeterConfig,
+                           MultipartType.OFPMP_TABLE_FEATURES: TableFeatures,
+                           MultipartType.OFPMP_PORT_DESC: Port}
 
         if isinstance(self.multipart_type, (int, UBInt16)):
             self.multipart_type = self.multipart_type.enum_ref(

pyof/v0x04/controller2switch/multipart_request.py

@@ -11,7 +11,7 @@
 from pyof.v0x04.common.header import Header, Type
 from pyof.v0x04.common.port import PortNo
 from pyof.v0x04.controller2switch.common import (
-    ExperimenterMultipartHeader, MultipartTypes, TableFeatures)
+    ExperimenterMultipartHeader, MultipartType, TableFeatures)
 from pyof.v0x04.controller2switch.group_mod import Group
 from pyof.v0x04.controller2switch.meter_mod import Meter
 from pyof.v0x04.controller2switch.table_mod import Table
@@ -46,7 +46,7 @@ class MultipartRequest(GenericMessage):
     #: Openflow :class:`~pyof.v0x04.common.header.Header`
     header = Header(message_type=Type.OFPT_MULTIPART_REQUEST)
     #: One of the OFPMP_* constants.
-    multipart_type = UBInt16(enum_ref=MultipartTypes)
+    multipart_type = UBInt16(enum_ref=MultipartType)
     #: OFPMPF_REQ_* flags.
     flags = UBInt16(enum_ref=MultipartRequestFlags)
     #: Padding
@@ -127,16 +127,16 @@ def _unpack_body(self):
     def _get_body_instance(self):
         """Return the body instance."""
         simple_body = {
-            MultipartTypes.OFPMP_FLOW: FlowStatsRequest,
-            MultipartTypes.OFPMP_AGGREGATE: AggregateStatsRequest,
-            MultipartTypes.OFPMP_PORT_STATS: PortStatsRequest,
-            MultipartTypes.OFPMP_QUEUE: QueueStatsRequest,
-            MultipartTypes.OFPMP_GROUP: GroupStatsRequest,
-            MultipartTypes.OFPMP_METER: MeterMultipartRequest,
-            MultipartTypes.OFPMP_EXPERIMENTER: ExperimenterMultipartHeader
+            MultipartType.OFPMP_FLOW: FlowStatsRequest,
+            MultipartType.OFPMP_AGGREGATE: AggregateStatsRequest,
+            MultipartType.OFPMP_PORT_STATS: PortStatsRequest,
+            MultipartType.OFPMP_QUEUE: QueueStatsRequest,
+            MultipartType.OFPMP_GROUP: GroupStatsRequest,
+            MultipartType.OFPMP_METER: MeterMultipartRequest,
+            MultipartType.OFPMP_EXPERIMENTER: ExperimenterMultipartHeader
         }
 
-        array_of_bodies = {MultipartTypes.OFPMP_TABLE_FEATURES: TableFeatures}
+        array_of_bodies = {MultipartType.OFPMP_TABLE_FEATURES: TableFeatures}
 
         if isinstance(self.multipart_type, UBInt16):
             self.multipart_type = self.multipart_type.enum_ref(
@@ -256,7 +256,7 @@ def __init__(self, port_no=PortNo.OFPP_ANY):
 
         Args:
             port_no (:class:`int`, :class:`~pyof.v0x04.common.port.PortNo`):
-                :attr:`StatsTypes.OFPST_PORT` message must request statistics
+                :attr:`StatsType.OFPST_PORT` message must request statistics
                 either for a single port (specified in ``port_no``) or for all
                 ports (if ``port_no`` == :attr:`.PortNo.OFPP_ANY`).
         """

pyof/v0x04/controller2switch/set_config.py

@@ -7,21 +7,21 @@
 # Local imports
 from pyof.v0x04.common.action import ControllerMaxLen
 from pyof.v0x04.common.header import Type
-from pyof.v0x04.controller2switch.common import ConfigFlags, SwitchConfig
+from pyof.v0x04.controller2switch.common import ConfigFlag, SwitchConfig
 
 __all__ = ('SetConfig',)
 
 
 class SetConfig(SwitchConfig):
     """Set config message."""
 
-    def __init__(self, xid=None, flags=ConfigFlags.OFPC_FRAG_NORMAL,
+    def __init__(self, xid=None, flags=ConfigFlag.OFPC_FRAG_NORMAL,
                  miss_send_len=ControllerMaxLen.OFPCML_NO_BUFFER):
         """Create a SetConfig with the optional parameters below.
 
         Args:
             xid (int): xid to be used on the message header.
-            flags (:class:`~pyof.v0x01.controller2switch.common.ConfigFlags`):
+            flags (:class:`~pyof.v0x01.controller2switch.common.ConfigFlag`):
                 OFPC_* flags.
             miss_send_len (int): UBInt16 max bytes of new flow that the
                 datapath should send to the controller.