29 update constants format (#30)

S0L0GUY · web-flow · commit 17bdb6e2cfb8 · 2025-01-29T17:30:04.000-08:00
* Refactor constants into classes for better organization and clarity

* Fix method signature in JsonWrapper and update error handling in HTTP server

* Refactor constants into classes for better organization and clarity

* Fix method signature in JsonWrapper and update error handling in HTTP server

* Enhance documentation and improve code readability across multiple modules

* Remove redundant methods and comments from VRChatOSC class for improved clarity

* Refactor WhisperTranscriber initialization and silence duration; update constant references in main and add static methods to configuration classes

* Refactor constant references to improve code organization and readability across multiple modules
diff --git a/classes/osc.py b/classes/osc.py
@@ -26,16 +26,6 @@ def __init__(self, ip: str, port: int):
 
         self.client = udp_client.SimpleUDPClient(ip, port)
 
-    def send_message(self, message: str):
-        """
-        Sends a message to the chatbox.
-        Args:
-            message (str): The message to be sent to the chatbox.
-        """
-
-        self.client.send_message("/chatbox/input", [message, True])
-        self.client.send_message("/chatbox/typing", False)
-
     def set_typing_indicator(self, typing: bool):
         """
         Sets the typing indicator status in the chatbox.
@@ -45,3 +35,13 @@ def set_typing_indicator(self, typing: bool):
         """
 
         self.client.send_message("/chatbox/typing", typing)
+
+    def send_message(self, message: str):
+        """
+        Sends a message to the chatbox.
+        Args:
+            message (str): The message to be sent to the chatbox.
+        """
+
+        self.client.send_message("/chatbox/input", [message, True])
+        self.client.send_message("/chatbox/typing", False)
diff --git a/classes/whisper.py b/classes/whisper.py
@@ -19,7 +19,7 @@ class WhisperTranscriber:
 
     def __init__(self):
         """Initialize the WhisperTranscriber with the base Whisper model."""
-        self.model = whisper.load_model("base")
+        self.model = whisper.load("base")
 
     def transcribe_file(self, audio_file_path):
         """
@@ -53,7 +53,7 @@ def get_speech_input(self):
         rate = 16000
         chunk = 1024
         silence_threshold = -40  # Silence threshold in dB
-        silence_duration = 1000  # Duration of silence in ms (1 second)
+        silence_duration = 1  # Duration of silence in seconds
 
         # Open the audio stream
         stream = p.open(format=audio_format,
@@ -96,7 +96,7 @@ def get_speech_input(self):
         # Save the recorded data to a WAV file
         with wave.open('temp.wav', 'wb') as wf:
             wf.setnchannels(channels)
-            wf.setsampwidth(p.get_sample_size(format))
+            wf.setsampwidth(p.get_sample_size(audio_format))
             wf.setframerate(rate)
             wf.writeframes(b''.join(frames))
 
@@ -115,5 +115,4 @@ def get_speech_input(self):
 
         if text not in unwanted_responses:
             return text
-        else:
-            return ""
+        return ""
diff --git a/constants.py b/constants.py
@@ -1,37 +1,68 @@
-"""
-Constants module for Nova AI project.
-This module contains all the configuration constants used throughout the
-project.
-Constants:
-    Network Settings:
-        LOCAL_IP (str): Local IP address of the computer
-        VRC_PORT (int): VRChat port number, default is 9000
-    Audio Settings:
-        AUDIO_OUTPUT_INDEX (int): Index number for audio output device
-        (VB-Audio Cable B)
-    Language Model Settings:
-        MODEL_ID (str): Identifier for the language model being used
-        LM_TEMPERATURE (float): Temperature setting for language model output
-        generation
-    File Paths:
-        HISTORY_PATH (str): Path to the history JSON file
-Note:
-    Make sure to adjust LOCAL_IP and AUDIO_OUTPUT_INDEX according to your
-    system configuration.
-"""
-
-# Network Settings
-
-LOCAL_IP = "192.168.0.195"  # Your computers local IP
-VRC_PORT = 9000  # VR Chat VRC_PORT, 9000 is the default
-
-# Audio Settings
-# The index of the audio output device (VB-Audio Cable B)
-AUDIO_OUTPUT_INDEX = 10
-
-# LM Settings
-# The model ID of the LM
-MODEL_ID = "lmstudio-community/Meta-Llama-3.1-8B-Instruct-GGUF"
-LM_TEMPERATURE = 0.5  # The temperature of the LM
-
-HISTORY_PATH = "json_files/history.json"
+@staticmethod
+class Network:
+    """
+    Class representing network configuration parameters.
+    Attributes:
+        LOCAL_IP (str): The local IP address of the computer running the
+        application.
+        VRC_PORT (int): The port number used for VRChat communication. Default
+        is 9000.
+    """
+    LOCAL_IP = "192.168.0.195"
+    VRC_PORT = 9000
+
+
+@staticmethod
+class Audio:
+    """
+    A class containing audio device configuration constants.
+    This class defines constants for audio input and output device indices,
+    specifically for VB-Audio Cable virtual audio devices.
+    Attributes:
+        AUDIO_OUTPUT_INDEX (int): The device index for audio output,
+            configured for VB-Audio Cable B Input (default: 10)
+        AUDIO_INPUT_INDEX (int): The device index for audio input,
+            configured for VB-Audio Cable A Output (default: 16)
+    """
+    AUDIO_OUTPUT_INDEX = 10
+    AUDIO_INPUT_INDEX = 16
+
+
+@staticmethod
+class Voice:
+    """
+    A class that defines constants for voice-related configurations in
+    Text-to-Speech (TTS) operations.
+    Attributes:
+        VOICE_NAME (str): The default voice name used for text-to-speech
+        synthesis. Currently set to "Zira".
+    """
+    VOICE_NAME = "Zira"
+
+
+@staticmethod
+class LanguageModel:
+    """
+    A class representing configuration settings for a language model.
+    This class contains constant values that define the behavior and identity
+    of the language model being used.
+    Attributes:
+        MODEL_ID (str): The identifier for the specific language model being
+        used. Currently set to Meta-Llama 3.1 8B Instruct GGUF model.
+        LM_TEMPERATURE (float): The temperature parameter for the language
+        model's output. Controls randomness in text generation (0.0 to 1.0,
+        where higher means more random).
+    """
+    MODEL_ID = "lmstudio-community/Meta-Llama-3.1-8B-Instruct-GGUF"
+    LM_TEMPERATURE = 0.5
+
+
+@staticmethod
+class FilePaths:
+    """
+    A class containing file path constants used in the application.
+    Attributes:
+        HISTORY_PATH (str): The path to the JSON file storing history data.
+                           Default is "json_files/history.json"
+    """
+    HISTORY_PATH = "json_files/history.json"
diff --git a/debug_function_library.py b/debug_function_library.py
diff --git a/http_server.py b/http_server.py
@@ -71,7 +71,10 @@ def add_message(message):
             to the history.
         """
 
-        json_wrapper.JsonWrapper.write(constant.HISTORY_PATH, message)
+        json_wrapper.JsonWrapper.write(
+            constant.FilePaths.HISTORY_PATH,
+            message
+        )
 
         return f"Added '{message}' to history."
 
@@ -83,7 +86,8 @@ def logs():
             str: The logs read from the history path.
         """
 
-        history = json_wrapper.JsonWrapper.read_json(constant.HISTORY_PATH)
+        history = json_wrapper.JsonWrapper.read_json(
+            constant.FilePaths.HISTORY_PATH)
         logs = history.toString()
 
         return logs
@@ -107,7 +111,7 @@ def reset_logs():
             cleared.
         """
 
-        json_wrapper.JsonWrapper.write(constant.HISTORY_PATH, [])
+        json_wrapper.JsonWrapper.write(constant.FilePaths.HISTORY_PATH, [])
 
         return "Logs Cleared"
 
diff --git a/main.py b/main.py
@@ -33,7 +33,7 @@ def main():
         Exception: If an error occurs during the execution of nova.run_code().
     """
 
-    osc = VRChatOSC(constant.LOCAL_IP, constant.VRC_PORT)
+    osc = VRChatOSC(constant.Network.LOCAL_IP, constant.Network.VRC_PORT)
     while True:
         try:
             print("Program Starting...")
diff --git a/nova.py b/nova.py
@@ -42,7 +42,7 @@ def initialize_components():
             - openai_client (OpenAI): An instance of the OpenAI client.
     """
 
-    osc = VRChatOSC(constant.LOCAL_IP, constant.VRC_PORT)
+    osc = VRChatOSC(constant.Network.LOCAL_IP, constant.Network.VRC_PORT)
     transcriber = WhisperTranscriber()
     system_prompt = SystemPrompt.get_full_prompt("normal")
     now = datetime.datetime.now()
@@ -135,15 +135,15 @@ def process_completion(completion, osc):
                 osc.send_message(sentence)
                 play_tts(
                     sentence,
-                    output_device_index=constant.AUDIO_OUTPUT_INDEX
+                    output_device_index=constant.Audio.AUDIO_OUTPUT_INDEX
                 )
             buffer = sentence_chunks[0]
     if buffer:
         osc.set_typing_indicator(True)
         full_response += f" {buffer}"
         print(f"AI: {buffer}")
         osc.send_message(buffer)
-        play_tts(buffer, output_device_index=constant.AUDIO_OUTPUT_INDEX)
+        play_tts(buffer, output_device_index=constant.Audio.AUDIO_OUTPUT_INDEX)
     osc.set_typing_indicator(False)
     return full_response
 
@@ -176,9 +176,9 @@ def run_code():
     while True:
         # Creates model parameters
         completion = openai_client.chat.completions.create(
-            model=constant.MODEL_ID,
+            model=constant.LanguageModel.MODEL_ID,
             messages=history,
-            temperature=constant.LM_TEMPERATURE,
+            temperature=constant.LanguageModel.LM_TEMPERATURE,
             stream=True,
         )
 
@@ -189,12 +189,12 @@ def run_code():
         full_response = process_completion(completion, osc)
         new_message["content"] = full_response
 
-        JsonWrapper.write(constant.HISTORY_PATH, new_message)
+        JsonWrapper.write(constant.FilePaths.HISTORY_PATH, new_message)
 
         # Get user speech input
         user_speech = ""
         while not user_speech:
             user_speech = transcriber.get_speech_input()
 
         print(f"HUMAN: {user_speech}")
-        JsonWrapper.write(constant.HISTORY_PATH, user_speech)
+        JsonWrapper.write(constant.FilePaths.HISTORY_PATH, user_speech)
diff --git a/nova_placement.py b/nova_placement.py
@@ -37,7 +37,10 @@
 time.sleep(15)
 
 # Set up OSC
-osc_client = udp_client.SimpleUDPClient(constant.LOCAL_IP, constant.VRC_PORT)
+osc_client = udp_client.SimpleUDPClient(
+    constant.Network.LOCAL_IP,
+    constant.Network.VRC_PORT
+)
 osc_client.send_message("/chatbox/input", ["Positioning...", True])
 
 ##########################################################################
diff --git a/requirements.txt b/requirements.txt
@@ -10,4 +10,4 @@ translate
 googletrans
 requests
 sounddevice
-soundfile
+soundfile
