ドキュメントを更新し、型注釈を追加してコードの可読性とメンテナンス性を向上。各モジュールの使用例や依存関係を明示化し、エラーハンドリングを改善。

src-python/models/transcription/transcription_recorder.py

@@ -1,9 +1,18 @@
+"""Recorders that wrap speech_recognition microphone interfaces.
+
+These classes provide small adapters that push raw audio bytes into queues.
+They intentionally keep a thin API so the rest of the system can mock them
+in tests.
+"""
+
+from typing import Any
 from speech_recognition import Recognizer, Microphone
 from pyaudiowpatch import get_sample_size, paInt16
 from datetime import datetime
 
+
 class BaseRecorder:
-    def __init__(self, source, energy_threshold, dynamic_energy_threshold, record_timeout):
+    def __init__(self, source: Any, energy_threshold: int, dynamic_energy_threshold: bool, record_timeout: int) -> None:
         self.recorder = Recognizer()
         self.recorder.energy_threshold = energy_threshold
         self.recorder.dynamic_energy_threshold = dynamic_energy_threshold
@@ -15,27 +24,29 @@ class BaseRecorder:
 
         self.source = source
 
-    def adjustForNoise(self):
+    def adjustForNoise(self) -> None:
         with self.source:
             self.recorder.adjust_for_ambient_noise(self.source)
 
-    def recordIntoQueue(self, audio_queue):
+    def recordIntoQueue(self, audio_queue: Any) -> None:
         def record_callback(_, audio):
             audio_queue.put((audio.get_raw_data(), datetime.now()))
 
         self.stop, self.pause, self.resume = self.recorder.listen_in_background(self.source, record_callback, phrase_time_limit=self.record_timeout)
 
+
 class SelectedMicRecorder(BaseRecorder):
-    def __init__(self, device, energy_threshold, dynamic_energy_threshold, record_timeout):
-        source=Microphone(
+    def __init__(self, device: dict, energy_threshold: int, dynamic_energy_threshold: bool, record_timeout: int) -> None:
+        source = Microphone(
             device_index=device['index'],
             sample_rate=int(device["defaultSampleRate"]),
         )
         super().__init__(source=source, energy_threshold=energy_threshold, dynamic_energy_threshold=dynamic_energy_threshold, record_timeout=record_timeout)
         # self.adjustForNoise()
 
+
 class SelectedSpeakerRecorder(BaseRecorder):
-    def __init__(self, device, energy_threshold, dynamic_energy_threshold, record_timeout):
+    def __init__(self, device: dict, energy_threshold: int, dynamic_energy_threshold: bool, record_timeout: int) -> None:
 
         source = Microphone(speaker=True,
             device_index= device["index"],
@@ -47,7 +58,7 @@ class SelectedSpeakerRecorder(BaseRecorder):
         # self.adjustForNoise()
 
 class BaseEnergyRecorder:
-    def __init__(self, source):
+    def __init__(self, source: Any) -> None:
         self.recorder = Recognizer()
         self.recorder.energy_threshold = 0
         self.recorder.dynamic_energy_threshold = False
@@ -59,27 +70,29 @@ class BaseEnergyRecorder:
 
         self.source = source
 
-    def adjustForNoise(self):
+    def adjustForNoise(self) -> None:
         with self.source:
             self.recorder.adjust_for_ambient_noise(self.source)
 
-    def recordIntoQueue(self, energy_queue):
+    def recordIntoQueue(self, energy_queue: Any) -> None:
         def recordCallback(_, energy):
             energy_queue.put(energy)
 
         self.stop, self.pause, self.resume = self.recorder.listen_energy_in_background(self.source, recordCallback)
 
+
 class SelectedMicEnergyRecorder(BaseEnergyRecorder):
-    def __init__(self, device):
-        source=Microphone(
+    def __init__(self, device: dict) -> None:
+        source = Microphone(
             device_index=device['index'],
             sample_rate=int(device["defaultSampleRate"]),
         )
         super().__init__(source=source)
         # self.adjustForNoise()
 
+
 class SelectedSpeakerEnergyRecorder(BaseEnergyRecorder):
-    def __init__(self, device):
+    def __init__(self, device: dict) -> None:
 
         source = Microphone(speaker=True,
             device_index= device["index"],
@@ -90,7 +103,15 @@ class SelectedSpeakerEnergyRecorder(BaseEnergyRecorder):
         # self.adjustForNoise()
 
 class BaseEnergyAndAudioRecorder:
-    def __init__(self, source, energy_threshold, dynamic_energy_threshold, phrase_time_limit, phrase_timeout, record_timeout):
+    def __init__(
+        self,
+        source: Any,
+        energy_threshold: int,
+        dynamic_energy_threshold: bool,
+        phrase_time_limit: int,
+        phrase_timeout: int,
+        record_timeout: int,
+    ) -> None:
         self.recorder = Recognizer()
         self.recorder.energy_threshold = energy_threshold
         self.recorder.dynamic_energy_threshold = dynamic_energy_threshold
@@ -104,11 +125,11 @@ class BaseEnergyAndAudioRecorder:
 
         self.source = source
 
-    def adjustForNoise(self):
+    def adjustForNoise(self) -> None:
         with self.source:
             self.recorder.adjust_for_ambient_noise(self.source)
 
-    def recordIntoQueue(self, audio_queue, energy_queue=None):
+    def recordIntoQueue(self, audio_queue: Any, energy_queue: Any = None) -> None:
         def audioRecordCallback(_, audio):
             audio_queue.put((audio.get_raw_data(), datetime.now()))
 
@@ -121,11 +142,21 @@ class BaseEnergyAndAudioRecorder:
             phrase_time_limit=self.phrase_time_limit,
             callback_energy=energyRecordCallback if energy_queue is not None else None,
             phrase_timeout=self.phrase_timeout,
-            record_timeout=self.record_timeout)
+            record_timeout=self.record_timeout,
+        )
+
 
 class SelectedMicEnergyAndAudioRecorder(BaseEnergyAndAudioRecorder):
-    def __init__(self, device, energy_threshold, dynamic_energy_threshold, phrase_time_limit, phrase_timeout:int=1, record_timeout:int=5):
-        source=Microphone(
+    def __init__(
+        self,
+        device: dict,
+        energy_threshold: int,
+        dynamic_energy_threshold: bool,
+        phrase_time_limit: int,
+        phrase_timeout: int = 1,
+        record_timeout: int = 5,
+    ) -> None:
+        source = Microphone(
             device_index=device['index'],
             sample_rate=int(device["defaultSampleRate"]),
         )
@@ -139,14 +170,23 @@ class SelectedMicEnergyAndAudioRecorder(BaseEnergyAndAudioRecorder):
         )
         # self.adjustForNoise()
 
+
 class SelectedSpeakerEnergyAndAudioRecorder(BaseEnergyAndAudioRecorder):
-    def __init__(self, device, energy_threshold, dynamic_energy_threshold, phrase_time_limit, phrase_timeout:int=1, record_timeout:int=5):
+    def __init__(
+        self,
+        device: dict,
+        energy_threshold: int,
+        dynamic_energy_threshold: bool,
+        phrase_time_limit: int,
+        phrase_timeout: int = 1,
+        record_timeout: int = 5,
+    ) -> None:
 
         source = Microphone(speaker=True,
             device_index= device["index"],
             sample_rate=int(device["defaultSampleRate"]),
             chunk_size=get_sample_size(paInt16),
-            channels=device["maxInputChannels"]
+            channels=device["maxInputChannels"],
         )
         super().__init__(
             source=source,