Add docstrings to classes missing documentation (#273)

Signed-off-by: Andriy Kokhan <[email protected]>

Author: andriy-kokhan

common/sai.py

@@ -219,6 +219,12 @@ def process_command(self, command):
 
 
 class Sai():
+    """
+    Main SAI interface class for interacting with SAI objects.
+
+    Provides methods to create, remove, get, and set SAI objects and attributes.
+    Handles metadata loading and command processing through CommandProcessor.
+    """
     metadata = None
 
     def __init__(self, cfg):

common/sai_dataplane/sai_dataplane.py

@@ -1,4 +1,9 @@
 class SaiDataPlane():
+    """
+    Base class for SAI dataplane implementations.
+
+    Provides interface for packet transmission and reception in SAI test scenarios.
+    """
     def __init__(self, cfg):
         self.config = cfg
         # used by dataplane_redirect() from ptf_testutils

common/sai_dataplane/snappi/sai_snappi_dataplane.py

@@ -8,6 +8,11 @@
 BASE_TENGINE_PORT = 5555
 
 class SaiSnappiDataPlane(SaiDataPlane):
+    """
+    Snappi-based dataplane implementation for SAI testing.
+
+    Uses the Snappi API for traffic generation and packet capture in SAI test scenarios.
+    """
 
     def __init__(self, cfg):
         self.alias = cfg['alias']

common/sai_dataplane/utils/ptf_testutils.py

@@ -13,6 +13,12 @@
 
 
 class SnappiDataPlaneUtilsWrapper:
+    """
+    Wrapper for Snappi dataplane utilities.
+
+    Provides a singleton pattern wrapper around Snappi dataplane instances
+    for packet verification and testing utilities.
+    """
 
     _instances = {}
 

common/sai_dpu.py

@@ -5,6 +5,11 @@
 
 
 class SaiDpu(Sai):
+    """
+    SAI DPU (Data Processing Unit) interface.
+
+    Extends the base Sai class for managing DPU-specific SAI objects.
+    """
 
     def __init__(self, cfg):
         cfg["client"]["config"]["asic_type"] = "dpu"

common/sai_dut.py

@@ -8,6 +8,11 @@
 
 
 class SaiDut:
+    """
+    Base class for SAI Device Under Test (DUT) implementations.
+
+    Manages connections and operations for devices being tested with SAI.
+    """
     def __init__(self, cfg):
         self.alias = cfg.get("alias", "default")
         self.server_ip = cfg.get("ip", "localhost")
@@ -70,6 +75,12 @@ def spawn(cfg) -> 'SaiDut':
 
 
 class SaiDutSonic(SaiDut):
+    """
+    SONiC-specific SAI DUT implementation.
+
+    Extends SaiDut with SONiC-specific functionality for managing and testing
+    SAI operations on SONiC network operating system.
+    """
     def __init__(self, cfg):
         super().__init__(cfg)
         self.port = cfg.get("port", "6379")

common/sai_npu.py

@@ -7,6 +7,12 @@
 
 
 class SaiNpu(Sai):
+    """
+    SAI NPU (Network Processing Unit) interface.
+
+    Extends the base Sai class with NPU-specific functionality for managing
+    network forwarding elements like FDB entries, VLAN members, and routes.
+    """
 
     def __init__(self, cfg):
         cfg["client"]["config"]["asic_type"] = "npu"

common/sai_phy.py

@@ -4,6 +4,11 @@
 
 
 class SaiPhy(Sai):
+    """
+    SAI PHY (Physical Layer) interface.
+
+    Extends the base Sai class for managing physical layer SAI objects.
+    """
 
     def __init__(self, cfg):
         cfg["client"]["config"]["asic_type"] = "phy"

common/sai_testbed.py

@@ -13,6 +13,12 @@
 
 
 class SaiTestbedMeta():
+    """
+    Metadata container for SAI testbed configuration.
+
+    Loads and manages testbed configuration files including topology, SKU-specific
+    settings, and test parameters.
+    """
 
     def __init__(self, base_dir, name):
         self.base_dir = base_dir