Docstrings and global Variables got fixed

scraibe/test/test_audio.py

@@ -4,8 +4,8 @@ import torch
 
 
 
-device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
-TEST_WAVEFORM = torch.tensor([]).to(device)
+DEVICE = torch.device("cuda" if torch.cuda.is_available() else "cpu")
+TEST_WAVEFORM = torch.tensor([]).to(DEVICE)
 TEST_SR = 16000
 SAMPLE_RATE = 16000
 NORMALIZATION_FACTOR = 32768
@@ -13,12 +13,16 @@ NORMALIZATION_FACTOR = 32768
 
 @pytest.fixture
 def probe_audio_processor():
-    """Creates a dummy AudioProcessor Object
+    """Fixture for creating an instance of the AudioProcessor class with test waveform and sample rate. 
+    
+    This fixture is used to create an instance of the AudioProcessor class with a predfined test waveform and sample rate (TEST_SR). It returns the instantiated AudioProcessor , which can bes used as a 
+    dependency in other test functions.
+
 
     Returns:
-        AudioProcessor Object with given parameters test_waveform and TEST_SR
+        AudioProcessor (obj): An instance of the AudioProcessor class with the test waveform and sample rate.
     """    
-    return AudioProcessor(test_waveform, TEST_SR)
+    return AudioProcessor(TEST_WAVEFORM, TEST_SR)
 
 
 
@@ -27,20 +31,40 @@ def probe_audio_processor():
 
 def test_AudioProcessor_init(probe_audio_processor):
     """
-    testing if the audio_processor Object gets initialized correctly
+    Test the initialization of the AudioProcessor class.
+
+    This test verifies that the AUdioProcessor class is correctly initialized with the provided waveform and sample rate. It checks whether the instantiated AhdioProcessor object has the correct attributes
+    and whether the waveform and sample rate match the expected values.
+
+    Args:
+        probe_audio_processor (obj): An instance of the AudioProcessor class to be tested.
+
+
+    Returns:
+           None
+
+    
 
-    Args: probe_audio_processor Object
         
     """    
     assert isinstance(probe_audio_processor, AudioProcessor)
-    assert probe_audio_processor.waveform.device == test_waveform.device
-    assert torch.equal(probe_audio_processor.waveform, test_waveform)
-    assert probe_audio_processor.sr == test_sr
+    assert probe_audio_processor.waveform.device == TEST_WAVEFORM.device
+    assert torch.equal(probe_audio_processor.waveform, TEST_WAVEFORM)
+    assert probe_audio_processor.sr == TEST_SR
 
 
 
 def test_cut():
-    """Test for the test_cut Method for fixed parameters
+    """Test the cut function of the AudioProcessor class.
+    
+    This test verifies that the cut function correctly extracts a segment of audio data from
+     the waveform, given start and end indices. It checks whether the size of the extracted segment matches
+     the expected size based on the provided start and end indices and the sample rate.
+
+     Returns:
+            None
+
+
     """    
   
     start = 4
@@ -57,16 +81,28 @@ def test_cut():
 
 
 def test_audio_processor_invalid_sr():
-    """Testing the audio_processor Object with invalid Sample rate
+    """Test the behavior of AudioProcessor when an invalid smaple rate is provided.
+    
+    This test verifies that the AudioProcessor constructor raises a ValueError when an invalid sample rate is provided. It uses the pytest.raises context manager to check if the ValueError is raised when initializing an 
+    AudioProcessor object with an invalid sample rate.
+
+    Returns:
+           None
     """    
     with pytest.raises(ValueError):
-        AudioProcessor(test_waveform, [44100,48000])
+        AudioProcessor(TEST_WAVEFORM, [44100,48000])
 
 
 def test_audio_processor_SAMPLE_RATE():
-    """Making sure Sample Rate of Audio_processor Sample Rate matches global Sample Rate
+    """Test the default sample rate of the AudioProcessor class.
+    
+    This test verifies that the default sample rate of the AudioProcessor class matches the expected value defined by the constant SAMPLE_RATE. It instantiates an AudioProcessor object with a test waveform
+    and checks whether the sample rate attribute (sr) of the AudioProcessor object equals the predefined constant SAMPLE_RATE.
+
+    Returns:
+           None
     """    
-    probe_audio_processor = AudioProcessor(test_waveform)
+    probe_audio_processor = AudioProcessor(TEST_WAVEFORM)
     assert probe_audio_processor.sr == SAMPLE_RATE