Refactor: centralize spectrum average cap

- add a shared default spectrum analyzer averages constant
- set the shared spectrum analyzer averages value to 5
- use the shared constant for spectrum command defaults and runtime cap
- update the spectrum analyzer averages regression test - 2026-03-20 17:53:15

Author: mgarcia01752

pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name            = "pypnm-docsis"
-version         = "1.5.9.0"
+version         = "1.5.9.1"
 description     = "DOCSIS 3.x/4.0 Proactive Network Maintenance Toolkit"
 readme          = "README.md"
 requires-python = ">=3.10"

src/pypnm/api/routes/common/extended/common_measure_service.py

@@ -64,6 +64,7 @@
 from pypnm.lib.file_processor import FileProcessor
 from pypnm.lib.ftp.ftp_connector import FTPConnector
 from pypnm.lib.host_endpoint import HostEndpoint
+from pypnm.lib.constants import DEFAULT_SPECTRUM_ANALYZER_NUM_AVERAGES
 from pypnm.lib.inet import Inet
 from pypnm.lib.ping import Ping
 from pypnm.lib.ssh.ssh_connector import SSHConnector
@@ -105,7 +106,7 @@ class MeasureServiceReturnTypes(Enum):
                                 DocsIf3CmSpectrumAnalysisEntry
 
 class CommonMeasureService(CommonMessagingService):
-    SPECTRUM_ANALYZER_AVERAGES_CAP: int = 1
+    SPECTRUM_ANALYZER_AVERAGES_CAP: int = DEFAULT_SPECTRUM_ANALYZER_NUM_AVERAGES
     """
     Base service class for executing common Proactive Network Maintenance (PNM) measurement tests.
 

src/pypnm/lib/constants.py

@@ -213,6 +213,7 @@ def from_int(cls, value: int | None) -> DocsIf31CmDsOfdmChanIndicator | None:
 T = TypeVar("T")
 
 DEFAULT_SPECTRUM_ANALYZER_INDICES: Final[list[int]] = [0]
+DEFAULT_SPECTRUM_ANALYZER_NUM_AVERAGES: Final[int] = 5
 
 
 FEC_SUMMARY_TYPE_STEP_SECONDS: dict[int, int] = {
@@ -248,5 +249,6 @@ def from_int(cls, value: int | None) -> DocsIf31CmDsOfdmChanIndicator | None:
     "DocsIf31CmStatusOfdmaUsRangingStatus",
     "DocsIf31CmDsOfdmChanIndicator",
     "DEFAULT_SPECTRUM_ANALYZER_INDICES",
+    "DEFAULT_SPECTRUM_ANALYZER_NUM_AVERAGES",
     "FEC_SUMMARY_TYPE_STEP_SECONDS", "FEC_SUMMARY_TYPE_LABEL",
 ]

src/pypnm/pnm/data_type/DocsIf3CmSpectrumAnalysisCtrlCmd.py

@@ -9,6 +9,7 @@
 from enum import IntEnum
 from typing import Any
 
+from pypnm.lib.constants import DEFAULT_SPECTRUM_ANALYZER_NUM_AVERAGES
 from pypnm.lib.types import STATUS, ResolutionBw
 from pypnm.lib.utils import Generate
 
@@ -90,7 +91,7 @@ class SpectrumAnalysisDefaults(IntEnum):
     NUM_BINS_PER_SEGMENT = 256
     NOISE_BW = 110
     WINDOW_FUNCTION = WindowFunction.HANN
-    NUM_AVERAGES = 1
+    NUM_AVERAGES = DEFAULT_SPECTRUM_ANALYZER_NUM_AVERAGES
 
     @classmethod
     def to_dict(cls) -> dict:

src/pypnm/version.py

@@ -6,4 +6,4 @@
 __all__ = ["__version__"]
 
 # MAJOR.MINOR.MAINTENANCE.BUILD
-__version__: str = "1.5.9.0"
+__version__: str = "1.5.9.1"

tests/test_spectrum_analyzer_averages_cap.py

@@ -9,6 +9,7 @@
 from pypnm.api.routes.common.extended.common_measure_service import CommonMeasureService
 from pypnm.api.routes.common.service.status_codes import ServiceStatusCode
 from pypnm.docsis.cm_snmp_operation import DocsPnmCmCtlTest
+from pypnm.lib.constants import DEFAULT_SPECTRUM_ANALYZER_NUM_AVERAGES
 from pypnm.lib.inet import Inet
 from pypnm.pnm.data_type.DocsIf3CmSpectrumAnalysisCtrlCmd import SpectrumRetrievalType
 
@@ -33,7 +34,7 @@ async def setDocsIf3CmSpectrumAnalysisCtrlCmd(self, cmd: object, _retrieval_type
 
 
 @pytest.mark.asyncio
-async def test_spectrum_analyzer_averages_capped_to_one() -> None:
+async def test_spectrum_analyzer_averages_capped_to_shared_default() -> None:
     cm = _FakeCableModem()
     service = CommonMeasureService(
         pnm_test_type=DocsPnmCmCtlTest.SPECTRUM_ANALYZER_SNMP_AMP_DATA,
@@ -57,4 +58,4 @@ async def test_spectrum_analyzer_averages_capped_to_one() -> None:
 
     assert status == ServiceStatusCode.SUCCESS
     assert cm.last_cmd is not None
-    assert cm.last_cmd.docsIf3CmSpectrumAnalysisCtrlCmdNumberOfAverages == 1
+    assert cm.last_cmd.docsIf3CmSpectrumAnalysisCtrlCmdNumberOfAverages == DEFAULT_SPECTRUM_ANALYZER_NUM_AVERAGES