Rename WaveConfig to _WaveConfig, don't expose via YAML

ovgenpy/ovgenpy.py

@@ -11,7 +11,7 @@ from ovgenpy import outputs
 from ovgenpy.config import register_config, yaml
 from ovgenpy.renderer import MatplotlibRenderer, RendererConfig
 from ovgenpy.triggers import ITriggerConfig, CorrelationTriggerConfig
-from ovgenpy.wave import WaveConfig, Wave
+from ovgenpy.wave import _WaveConfig, Wave
 
 
 RENDER_PROFILING = True
@@ -98,7 +98,7 @@ class Ovgen:
 
         waves = sorted(wave_dir.glob('*.wav'))
         for idx, path in enumerate(waves):
-            wcfg = WaveConfig(
+            wcfg = _WaveConfig(
                 amplification=self.cfg.amplification
             )
 

ovgenpy/wave.py

@@ -1,27 +1,22 @@
-from typing import TYPE_CHECKING, Optional
+from typing import Optional
 
 import numpy as np
+from dataclasses import dataclass
 from scipy.io import wavfile
 
-from ovgenpy.config import register_config
 
-if TYPE_CHECKING:
-    from ovgenpy.triggers import Trigger
-
-
-@register_config
-class WaveConfig:
+# Internal class, not exposed via YAML (TODO replace with ChannelConfig?)
+@dataclass
+class _WaveConfig:
     amplification: float = 1
 
-def dummy_wave_config() -> WaveConfig:
-    return WaveConfig(amplification=1)
 
 FLOAT = np.single
 
 
 class Wave:
-    def __init__(self, wcfg: Optional[WaveConfig], wave_path: str):
-        self.cfg = wcfg or WaveConfig()
+    def __init__(self, wcfg: Optional[_WaveConfig], wave_path: str):
+        self.cfg = wcfg or _WaveConfig()
         self.smp_s, self.data = wavfile.read(wave_path, mmap=True)  # type: int, np.ndarray
         dtype = self.data.dtype