Refactor and improvements

[dfbustosus]

Hi, I believe these changes can contribute to enhanced code efficiency and a more standardized structure for this project. Here is an overview of the changes

voice_assistant/api_key_manager.py

1. API_KEY_MAPPING dictionary to centralize the mapping between services, models, and their corresponding API keys. This reduces code duplication and makes it easier to maintain.
2. A generic get_api_key function has been added to handle the lookup for all services. This simplifies the individual service functions and makes the code more DRY (Don't Repeat Yourself).
3. We've removed the explicit return None statements, as they are implicit in Python when a function doesn't return anything else.
4. The blank lines between function definitions improve readability, adhering to PEP 8 recommendations.
5. The use of the get method on dictionaries provides a clean way to handle cases where a key might not exist, eliminating the need for multiple if-elif statements.

voice_assistant/audio.py

1. @lru_cache decorator for the get_recognizer() function to cache the speech recognizer instance, reducing the overhead of creating new instances.
2. Configured logging at the module level for consistency and easier management.
3. Removed the else clause after the for loop, as it's redundant with the break statement.
4. Added a raise statement after the last retry to propagate the exception.
5. Replaced time.sleep(0.1) with pygame.time.wait(100), which is more efficient.
6. Added a finally clause to ensure pygame.mixer.quit() is always called, even if an exception occurs.

voice_assistant/text_to_speech.py

1. Enhanced the exception handling with a more specific message in the stream processor
2. Structured params in text_to_speech function

voice_assistant/response_generation.py

1. Code Organization with helper functions (_generate_openai_response, _generate_groq_response, _generate_ollama_response). This makes the main generate_response function cleaner and easier to read.
2. Properly formatted the docstring with the correct indentation and spacing.
3. Added optional typing for the local_model_path parameter.
4. Ensured consistent indentation and line spacing.
5. Error handling within the main generate_response function to ensure any issues are logged appropriately.

voice_assistant/transcription.py

1. Refactored the main transcription logic into separate helper functions (_transcribe_with_openai, _transcribe_with_groq, _transcribe_with_deepgram, _transcribe_with_fastwhisperapi). This makes the transcribe_audio function cleaner and improves readability.
2. Improved docstring formatting.
3. Added optional typing for local_model_path.
4. Ensured consistent indentation, line spacing, and naming conventions.
5. Used f-strings for string formatting, which is more modern and efficient.
6. Enhanced error logging in the Deepgram transcription function and ensured that exceptions are raised correctly without changing the overall functionality.

voice_assistant/config.py

1. Extracted repeated validation logic into helper methods _validate_model and _validate_api_key to avoid code duplication and improve readability.
2. Grouped related API key validations together, improving the logical flow of the validate_config method.
3. Enhanced docstrings for clarity and consistency.
4. Improved line spacing and reduced inline comments to adhere to PEP-8's recommendation for comments and spacing.
5. Used consistent formatting for string literals and variable names, ensuring clarity and uniformity.
6. Used static methods for validation logic to emphasize that they do not depend on any instance-specific data.

Regards

[dfbustosus]

@PromtEngineer Good morning! I'm so sorry, I forgot to assign you to review this, but I've tagged you here in case you'd like to take a look

[PromtEngineer]

@dfbustosus thanks for the PR, will check it out tomorrow.