tdl-xoa-driver 1.5.1__py3-none-any.whl → 1.6.1__py3-none-any.whl

xoa_driver/internals/hli/ports/port_l23/{bases/port_l23.py → trafficgen/tgen.py}

@@ -62,7 +62,7 @@ from xoa_driver.internals.state_storage import ports_state
 from xoa_driver.internals.hli.indices.length_term import LengthTermIdx
 from xoa_driver.internals.hli.indices.match_term import MatchTermIdx
 
-from .port_capture import PortCapture
+from .capture import PortCapture
 
 LengthTermIndices = idx_mgr.IndexManager[LengthTermIdx]
 MatchTermIndices = idx_mgr.IndexManager[MatchTermIdx]
@@ -138,7 +138,7 @@ class TxConfiguration:
         """
 
 
-class Rate:
+class TxRate:
     """L23 port TX rate"""
 
     def __init__(self, conn: "itf.IConnection", module_id: int, port_id: int) -> None:
@@ -161,6 +161,24 @@ class Rate:
         """
 
 
+class MacControl:
+    """MAC control configuration
+    """
+    def __init__(self, conn: "itf.IConnection", module_id: int, port_id: int) -> None:
+
+        self.address = P_MACADDRESS(conn, module_id, port_id)
+        """MAC address configuration. This attribute allows the user to configure the MAC address for the port.
+
+        :type: P_MACADDRESS
+        """
+
+        self.autotrain = P_AUTOTRAIN(conn, module_id, port_id)
+        """Interval between MAC auto training packets. This attribute allows the user to configure the interval at which MAC auto training packets are sent. Auto training packets are used to optimize the performance of the MAC layer and to ensure proper communication between devices.
+
+        :type: P_AUTOTRAIN
+        """
+
+
 class Multicast:
     """L23 port multicast configuration"""
 
@@ -240,23 +258,26 @@ class IPv6:
         :type: P_PINGV6REPLY
         """
 
-
-class NetworkConfiguration:  # will be extended in genuine ports
-    """L23 port networking configuration"""
+class NetConfig:
+    """L23 port network interface configuration"""
 
     def __init__(self, conn: "itf.IConnection", module_id: int, port_id: int) -> None:
-        self.mac_address = P_MACADDRESS(conn, module_id, port_id)
-        """L23 port MAC address.
+        self.mac = MacControl(conn, module_id, port_id)
+        """L23 port MAC address and control.
 
-        :type: P_MACADDRESS
+        :type: P_IPV6ADDRESS
         """
 
         self.ipv4 = IPv4(conn, module_id, port_id)
-        """L23 port IPv4 address configuration.
+        """L23 port IPv4 configuration.
+
+        :type: IPv4
         """
 
         self.ipv6 = IPv6(conn, module_id, port_id)
-        """L23 port IPv6 address configuration.
+        """L23 port IPv6 configuration.
+
+        :type: IPv6
         """
 
 
@@ -329,206 +350,3 @@ class Traffic:
 
         :type: P_TRAFFICERR
         """
-
-
-class BasePortL23(base_port.BasePort[ports_state.PortL23LocalState]):
-    """L23 port layout which is relevant to all L23 ports."""
-
-    def __init__(self, conn: "itf.IConnection", module_id: int, port_id: int) -> None:
-        super().__init__(conn, module_id, port_id)
-        self.capabilities = P_CAPABILITIES(conn, module_id, port_id)
-        """L23 port capabilities.
-
-        :type: P_CAPABILITIES
-        """
-
-        self.capabilities_ext = P_CAPABILITIES_EXT(conn, module_id, port_id)
-        """L23 port capabilities ext.
-
-        :type: P_CAPABILITIES_EXT
-        """
-
-        self.pause = P_PAUSE(conn, module_id, port_id)
-        """L23 port response to Ethernet PAUSE frames.
-
-        :type: P_PAUSE
-        """
-
-        self.loop_back = P_LOOPBACK(conn, module_id, port_id)
-        """L23 port loopback mode.
-
-        :type: P_LOOPBACK
-        """
-
-        self.errors_count = P_ERRORS(conn, module_id, port_id)
-        """L23 port errors.
-
-        :type: P_ERRORS
-        """
-
-        self.interframe_gap = P_INTERFRAMEGAP(conn, module_id, port_id)
-        """L23 port interframe gap.
-
-        :type: P_INTERFRAMEGAP
-        """
-
-        self.max_header_length = P_MAXHEADERLENGTH(conn, module_id, port_id)
-        """L23 port maximum header length.
-
-        :type: P_MAXHEADERLENGTH
-        """
-
-        self.tpld_mode = P_TPLDMODE(conn, module_id, port_id)
-        """L23 port test payload mode.
-
-        :type: P_TPLDMODE
-        """
-
-        self.pfc_enable = P_PFCENABLE(conn, module_id, port_id)
-        """L23 port Ethernet Priority Flow Control (PFC).
-
-        :type: P_PFCENABLE
-        """
-
-        self.random_seed = P_RANDOMSEED(conn, module_id, port_id)
-        """L23 port seed value.
-
-        :type: P_RANDOMSEED
-        """
-
-        self.payload_mode = P_PAYLOADMODE(conn, module_id, port_id)
-        """L23 port payload mode.
-
-        :type: P_PAYLOADMODE
-        """
-
-        self.autotrain = P_AUTOTRAIN(conn, module_id, port_id)
-        """L23 port interval between auto training packets.
-
-        :type: P_AUTOTRAIN
-        """
-
-        self.gap_monitor = P_GAPMONITOR(conn, module_id, port_id)
-        """L23 port gap monitor.
-
-        :type: P_GAPMONITOR
-        """
-
-        self.checksum = P_CHECKSUM(conn, module_id, port_id)
-        """L23 port extra payload integrity checksum.
-
-        :type: P_CHECKSUM
-        """
-
-        self.arp_rx_table = P_ARPRXTABLE(conn, module_id, port_id)
-        """L23 port ARP table.
-
-        :type: P_ARPRXTABLE
-        """
-
-        self.ndp_rx_table = P_NDPRXTABLE(conn, module_id, port_id)
-        """L23 port NDP table.
-
-        :type: P_NDPRXTABLE
-        """
-
-        self.capturer = PortCapture(conn, module_id, port_id)
-        """L23 port capturer configuration.
-
-        :type: PortCapture
-        """
-
-        self.speed = Speed(conn, module_id, port_id)
-        """L23 port speed configuration.
-
-        :type: Speed
-        """
-
-        self.traffic = Traffic(conn, module_id, port_id)
-        """L23 port traffic configuration.
-
-        :type: Traffic
-        """
-
-        self.mix = Mix(conn, module_id, port_id)
-        """L23 port IMIX configuration.
-
-        :type: Mix
-        """
-
-        self.latency_config = LatencyConfiguration(conn, module_id, port_id)
-        """L23 port latency configuration.
-
-        self.latency_config = LatencyConfiguration(conn, module_id, port_id)
-        :type:
-        """
-
-        self.rate = Rate(conn, module_id, port_id)
-        """L23 port rate.
-
-        :type: Rate
-        """
-
-        self.tx_config = TxConfiguration(conn, module_id, port_id)
-        """L23 port TX configuration.
-
-        :type: TxConfiguration
-        """
-
-        self.tx_single_pkt = TxSinglePacket(conn, module_id, port_id)
-        """L23 port single-packet TX configuration.
-
-        :type: TxSinglePacket
-        """
-
-        self.multicast = Multicast(conn, module_id, port_id)
-        """L23 port multicast configuration.
-
-        :type: Multicast
-        """
-
-        self.net_config = NetworkConfiguration(conn, module_id, port_id)
-        """L23 port network configuration.
-
-        :type: NetworkConfiguration
-        """
-
-        self.local_states = ports_state.PortL23LocalState()
-        """L23 port local states.
-
-        :type: PortL23LocalState
-        """
-
-        self.length_terms: LengthTermIndices = idx_mgr.IndexManager(
-            conn,
-            LengthTermIdx,
-            module_id,
-            port_id
-        )
-        """L23 port's length term index manager.
-
-        :type: LengthTermIndices
-        """
-
-        self.match_terms: MatchTermIndices = idx_mgr.IndexManager(
-            conn,
-            MatchTermIdx,
-            module_id,
-            port_id
-        )
-        """L23 port's match term index manager.
-
-        :type: MatchTermIndices
-        """
-
-        self.used_tpld_ids = P_USED_TPLDID(conn, module_id, port_id)
-        """TG port's used TPLD IDs.
-
-        :type: P_USED_TPLDID
-        """
-
-    on_speed_change = functools.partialmethod(utils.on_event, P_SPEED)
-    """Register a callback to the event that the port's speed changes."""
-
-    on_traffic_change = functools.partialmethod(utils.on_event, P_TRAFFIC)
-    """Register a callback to the event that the port's traffic status changes."""

xoa_driver/internals/hli/ports/port_l23/{bases/port_transmission_statistics.py → trafficgen/tx_stats.py}

@@ -14,13 +14,11 @@ from xoa_driver.internals.commands import (
     PT_TOTALEXT,
     PT_NOTPLDEXT,
     PT_STREAMEXT,
-    P_MACSEC_TX_STATS,
-    P_MACSEC_TX_CLEAR,
 )
 
 # region All Ports
 
-class PortTransmissionStatistics:
+class PortTxStats:
     """L23 port TX statistics"""
 
     def __init__(self, conn: "itf.IConnection", module_id: int, port_id: int) -> None:
@@ -101,31 +99,13 @@ class PortTransmissionStatistics:
 
 # region Genuine Ports
 
-class MACSecTxStats:
-    """MACSec TX SC Statistics"""
-    def __init__(self, conn: "itf.IConnection", module_id: int, port_id: int) -> None:
-
-        self.total = P_MACSEC_TX_STATS(conn, module_id, port_id)
-        """Port's total MACsec TX statistics
-
-        :type: P_MACSEC_TX_STATS
-        """
 
-        self.clear = P_MACSEC_TX_CLEAR(conn, module_id, port_id)
-        """Clear Port's MACsec TX statistics
 
-        :type: P_MACSEC_TX_CLEAR
-        """
-
-
-class GenuinePortTransmissionStatistics(PortTransmissionStatistics):
+class GenuinePortTransmissionStatistics(PortTxStats):
     """L23 port RX statistics."""
 
     def __init__(self, conn: "itf.IConnection", module_id: int, port_id: int) -> None:
         super().__init__(conn, module_id, port_id)
 
-        self.macsec = MACSecTxStats(conn, module_id, port_id)
-        """L23 port's MACsec TX statistics.
-        """
 
 # endregion

xoa_driver/internals/hli/testers/l23_tester.py

@@ -57,9 +57,7 @@ def get_module_type(revision: str) -> Type:
 
 class L23Tester(BaseTester["testers_state.GenuineTesterLocalState"]):
     """
-    This is a conceptual class of Xena Valkyrie Tester.
-    It is essentially an extended :class:`BaseTester`.
-
+    Create an instanace to connect to a Xena chassis.
 
     :param host: tester's address/hostname
     :type host: str

xoa_driver/internals/utils/indices/_interfaces.py

@@ -1,18 +1,19 @@
 from typing import (
     Protocol,
     List,
-    Type,
+    TypeVar,
+    Self,
     TYPE_CHECKING,
 )
 
 if TYPE_CHECKING:
     from xoa_driver.internals.core import interfaces as itf
-    from .. import kind
-    from . import observer
+    from .. import kind as kind_module
+    from . import observer as idx_obs
 
 
 class IIndexType(Protocol):
-    def __init__(self, conn: "itf.IConnection", kind: "kind.IndicesKind", observer: "observer.IndicesObserver") -> None: ...  # noqa: E704
+    def __init__(self, conn: "itf.IConnection", kind: "kind_module.IndicesKind", observer: "idx_obs.IndicesObserver") -> None: ...  # noqa: E704
 
     async def delete(self) -> None: ...  # noqa: E704
 
@@ -20,7 +21,18 @@ class IIndexType(Protocol):
     def idx(self) -> int: ...  # noqa: E704
 
     @classmethod
-    async def _fetch(cls, conn, module_id, port_id) -> List[int]: ...  # noqa: E704
+    async def _fetch(
+        cls, 
+        conn: "itf.IConnection", 
+        module_id: int, 
+        port_id: int) -> List[int]: ...  # noqa: E704
 
     @classmethod
-    async def _new(cls, conn: "itf.IConnection", kind: "kind.IndicesKind", observer: "observer.IndicesObserver") -> Type: ...  # noqa: E704
+    async def _new(
+        cls, 
+        conn: "itf.IConnection", 
+        kind: "kind_module.IndicesKind", 
+        observer: "idx_obs.IndicesObserver"
+        ) -> Self: ...  # noqa: E704
+    
+IT = TypeVar("IT", bound=IIndexType)

xoa_driver/internals/utils/indices/index_manager.py

@@ -60,7 +60,13 @@ class IndexManager(Generic[IT]):
         return self._indices[key]
 
     def obtain_multiple(self, *keys: int):
-        """Obtain multiple resources as a tuple of indices"""
+        """Obtain multiple index objects
+
+        :param keys: Indices of the desired index objects
+        :type keys: int
+        :return: Tuple of index objects corresponding to the provided keys
+        :rtype: tuple[IT, ...]
+        """
         return tuple(self._indices[k] for k in keys)
 
     def __detect_empty_idx_slot(self) -> int:
@@ -74,7 +80,7 @@ class IndexManager(Generic[IT]):
         ]
         return min(empties) if empties else len(existing_indices)
 
-    def __remove_from_slot(self, index_inst: Type) -> None:
+    def __remove_from_slot(self, index_inst: IT) -> None:
         # throws ValueError if element is not exists in list of indices
         self._indices.remove(index_inst)
 

xoa_driver/internals/utils/managers/ports_manager.py

@@ -111,6 +111,9 @@ class PortsCombiManager(PortBaseManager[PT]):
             for port_id in range(self._ports_count)
         )
         ports = await asyncio.gather(*coros)
-        self._items = OrderedDict(
-            (port.kind.port_id, port) for port in ports
+        self._items = cast(
+            OrderedDict[int, PT],
+            OrderedDict(
+                (port.kind.port_id, port) for port in ports
+            )
         )

xoa_driver/misc.py

@@ -5,9 +5,9 @@
 from .internals.core.token import Token
 from .internals.core.transporter.protocol.payload.types import Hex
 from .internals.commands.subtypes import (
-    ArpChunk,
-    NdpChunk,
-    DhcpChunk,
+    ArpEntry,
+    NdpEntry,
+    DhcpEntry,
     GroupAddressElem,
     VlanTag,
     QueueStatsElem,
@@ -31,9 +31,9 @@ from xoa_driver.internals.hli.indices.macsecscs.genuine_macsecsc import GenuineM
 __all__ = (
     "Token",
     "Hex",
-    "ArpChunk",
-    "NdpChunk",
-    "DhcpChunk",
+    "ArpEntry",
+    "NdpEntry",
+    "DhcpEntry",
     "GroupAddressElem",
     "VlanTag",
     "QueueStatsElem",

xoa_driver/modules.py

@@ -1,21 +1,26 @@
 #: All available test module types.
 """Xena test module types."""
-
+from typing import Union
 from .internals.hli.modules.modules_l23.module_l23_base import ModuleL23
-from .internals.hli.modules.modules_l23.family_d import (
+from .internals.hli.modules.module_l23ve import ModuleL23VE
+from .internals.hli.modules.module_chimera import (
+    ModuleChimera,
+    MChi100G5S2P,
+    MChi100G5S2P_b,
+    MChi40G2S2P,
+)
+from .internals.hli.modules.module_l47 import ModuleL47
+from .internals.hli.modules.module_l47ve import ModuleL47VE
+from .internals.hli.modules.modules_l23.family_odin import (
     MOdin1G3S2PT,
     MOdin1G3S6P,
     MOdin1G3S6P_b,
     MOdin1G3S6PE,
-)
-from .internals.hli.modules.modules_l23.family_e import (
     MOdin5G4S6PCU,
     MOdin10G3S2PCU,
     MOdin10G3S6PCU,
     MOdin10G5S6PCU,
     MOdin10G5S6PCU_b,
-)
-from .internals.hli.modules.modules_l23.family_f import (
     MOdin10G1S2P,
     MOdin10G1S2P_b,
     MOdin10G1S2P_c,
@@ -25,31 +30,32 @@ from .internals.hli.modules.modules_l23.family_f import (
     MOdin10G1S6P_b,
     MOdin10G1S12P,
     MOdin10G6S6P_a,
+    MOdin100G3S1P,
+    MOdin1G3S6PT1RJ45,
+    MOdin10G4S2PCombi,
+    MOdin10G4S2PCombi_b,
+    MOdin40G2S2P,
+    MOdin40G2S2PB,
 )
-from .internals.hli.modules.modules_l23.family_g import (
+from .internals.hli.modules.modules_l23.family_loki import (
     MLoki100G3S1P,
     MLoki100G3S1P_b,
     MLoki100G3S1PSE,
     MLoki100G3S1PB,
     MLoki100G3S1PB_b,
     MLoki100G5S4P_a,
-)
-from .internals.hli.modules.modules_l23.family_h import (
     MLoki100G5S1P,
-    MOdin100G3S1P,
+    MLoki100G5S2P,
 )
-from .internals.hli.modules.modules_l23.family_i import MLoki100G5S2P
-from .internals.hli.modules.modules_l23.family_j import MThor100G5S4P
-from .internals.hli.modules.modules_l23.family_k import (
+from .internals.hli.modules.modules_l23.family_thor import (
+    MThor100G5S4P,
     MThor400G7S1P,
     MThor400G7S1PLE,
-)
-from .internals.hli.modules.modules_l23.family_l import (
     MThor400G7S1P_b,
     MThor400G7S1P_c,
     MThor400G7S1P_d,
 )
-from .internals.hli.modules.modules_l23.family_l1 import (
+from .internals.hli.modules.modules_l23.family_freya import (
     MFreya800G1S1P_a,
     MFreya800G1S1P_b,
     MFreya800G1S1POSFP_a,
@@ -99,33 +105,11 @@ from .internals.hli.modules.modules_l23.family_l1 import (
     MFreya800G4S1POSFP_e_g2,
     MFreya800G4S1POSFP_f_g2,
 )
-from .internals.hli.modules.modules_l23.family_m import MOdin1G3S6PT1RJ45
-from .internals.hli.modules.modules_l23.family_n import (
-    MOdin40G2S2P,
-    MOdin40G2S2PB,
-)
-from .internals.hli.modules.modules_l23.family_combi import (
-    MOdin10G4S2PCombi,
-    MOdin10G4S2PCombi_b,
-)
-from .internals.hli.modules.module_l23ve import ModuleL23VE
-from .internals.hli.modules.module_chimera import (
-    ModuleChimera,
-    MChi100G5S2P,
-    MChi100G5S2P_b,
-    MChi40G2S2P,
-)
-from .internals.hli.modules.module_l47 import ModuleL47
-from .internals.hli.modules.module_l47ve import ModuleL47VE
-
 from .internals.hli.modules.modules_l23.family_edun import (
     MEdun800G3S1PSMPX_a,
     MEdun1600G4S1POSFP_a
 )
-
-import typing
-
-Z10OdinModule = typing.Union[
+Z10OdinModule = Union[
     MOdin1G3S2PT,
     MOdin1G3S6P,
     MOdin1G3S6P_b,
@@ -152,7 +136,7 @@ Z10OdinModule = typing.Union[
     MOdin100G3S1P,
 ]
 
-Z100LokiModule = typing.Union[
+Z100LokiModule = Union[
     MLoki100G3S1P,
     MLoki100G3S1P_b,
     MLoki100G3S1PSE,
@@ -163,7 +147,7 @@ Z100LokiModule = typing.Union[
     MLoki100G5S4P_a,
 ]
 
-Z400ThorModule = typing.Union[
+Z400ThorModule = Union[
     MThor100G5S4P,
     MThor400G7S1P,
     MThor400G7S1PLE,
@@ -172,7 +156,7 @@ Z400ThorModule = typing.Union[
     MThor400G7S1P_d,
 ]
 
-Z800FreyaModule = typing.Union[
+Z800FreyaModule = Union[
     MFreya800G1S1P_a,
     MFreya800G1S1P_b,
     MFreya800G1S1POSFP_a,
@@ -223,25 +207,25 @@ Z800FreyaModule = typing.Union[
     MFreya800G4S1POSFP_f_g2,
 ]
 
-Z1600EdunModule = typing.Union[
+Z1600EdunModule = Union[
     MEdun800G3S1PSMPX_a,
     MEdun1600G4S1POSFP_a
 ]
 
-E100ChimeraModule = typing.Union[
+E100ChimeraModule = Union[
     ModuleChimera,
     MChi100G5S2P,
     MChi100G5S2P_b,
     MChi40G2S2P,
 ]
 
-LegacyModule = typing.Union[
+LegacyModule = Union[
     ModuleL23VE,
     ModuleL47,
     ModuleL47VE,
 ]
 
-GenericL23Module = typing.Union[
+GenericL23Module = Union[
     "MOdin1G3S2PT",
     "MOdin1G3S6P",
     "MOdin1G3S6P_b",
@@ -336,7 +320,7 @@ GenericL23Module = typing.Union[
     "MEdun1600G4S1POSFP_a",
 ]
 
-GenericAnyModule = typing.Union[
+GenericAnyModule = Union[
     GenericL23Module,
     
     "ModuleL23VE",