Fix Issue 264 - Using Shared WebSocket Class Implementation

[davidvonthenen]

Proposed changes

Addresses: https://github.com/deepgram/deepgram-python-sdk/issues/264

This is to make way to support Agent API in a much cleaner and reusable way. It should drastically decrease code spawl.

Tested all Speech-to-Text and Text-to-Speech examples. Basically, anything that uses a WebSocket.

Also, unit tests passed further demonstrating that users should be unaware of this internal change.

Types of changes

What types of changes does your code introduce to the community Python SDK? Put an x in the boxes that apply

• [ ] Bugfix (non-breaking change which fixes an issue)
• [x] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
• [ ] Documentation update or tests (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

• [x] I have read the CONTRIBUTING doc
• [x] I have lint'ed all of my code using repo standards
• [x] I have added tests that prove my fix is effective or that my feature works
• [x] I have added necessary documentation (if appropriate)

Further comments

NA

Summary by CodeRabbit

• New Features

  • Introduced new abstract classes for managing WebSocket connections (AbstractAsyncWebSocketClient and AbstractSyncWebSocketClient).
  • Added new error handling classes: DeepgramApiError and DeepgramUnknownApiError.
  • Implemented signal handling for graceful shutdowns in the asynchronous text-to-speech application.

• Improvements

  • Enhanced error handling in WebSocket operations.
  • Improved type safety and clarity in class attributes.
  • Streamlined import statements for better readability and maintainability across various modules.

• Bug Fixes

  • Added checks in thread management to prevent runtime errors.

[coderabbitai[bot]]

[!CAUTION]

Review failed

The head commit changed during the review from e0ad551bc5fbd94c1d73448d8650526fa98dbd90 to 4c9c63972d9a2c034c068669453569c6966e514a.

Walkthrough

The changes involve enhancements to the deepgram library, focusing on optional typing for class attributes, improved error handling in WebSocket connections, and the introduction of new abstract classes for managing WebSocket communications. The modifications also include restructured import statements for better organization and clarity across various modules. New exception classes have been added to handle specific API errors, enhancing the overall robustness of the error management system.

Changes

Files	Change Summary
deepgram/audio/speaker/speaker.py	Introduced optional typing for class attributes and enhanced error handling in _start_asyncio_receiver. Updated finish method to check for thread existence before joining.
deepgram/clients/__init__.py	Reorganized import statements for better readability.
deepgram/clients/analyze/v1/async_client.py	Modified import paths for AbstractAsyncRestClient, DeepgramError, and DeepgramTypeError to simplify the module structure.
deepgram/clients/analyze/v1/client.py	Changed import paths for AbstractSyncRestClient, DeepgramError, and DeepgramTypeError to improve clarity and maintainability.
deepgram/clients/common/__init__.py	Added new imports for DeepgramApiError, DeepgramUnknownApiError, and several abstract client classes, enhancing error handling and client abstractions.
deepgram/clients/common/v1/__init__.py	Introduced imports for new error classes and abstract client classes, expanding functionality.
deepgram/clients/common/v1/abstract_async_websocket.py	Added AbstractAsyncWebSocketClient class with methods for managing WebSocket connections asynchronously, including error handling and message processing.
deepgram/clients/common/v1/abstract_sync_websocket.py	Introduced AbstractSyncWebSocketClient class for synchronous WebSocket management, featuring methods for connection handling and message processing.
deepgram/clients/common/v1/errors.py	Added DeepgramApiError and DeepgramUnknownApiError exception classes to handle specific API-related errors.
deepgram/clients/listen/v1/rest/async_client.py	Updated import paths for AbstractAsyncRestClient, DeepgramError, and DeepgramTypeError for consistency.
deepgram/clients/listen/v1/rest/client.py	Changed import paths for AbstractSyncRestClient, DeepgramError, and DeepgramTypeError to streamline imports.
deepgram/clients/listen/v1/websocket/async_client.py	Refactored AsyncListenWebSocketClient to inherit from AbstractAsyncWebSocketClient, consolidating functionality and simplifying error handling.
deepgram/clients/listen/v1/websocket/client.py	Refactored ListenWebSocketClient to inherit from AbstractSyncWebSocketClient, improving structure and message handling.
deepgram/clients/manage/v1/async_client.py	Updated import path for AbstractAsyncRestClient to a common module.
deepgram/clients/manage/v1/client.py	Changed import path for AbstractSyncRestClient to a common module.
deepgram/clients/selfhosted/v1/async_client.py	Updated import path for AbstractAsyncRestClient to a common module.
deepgram/clients/selfhosted/v1/client.py	Changed import path for AbstractSyncRestClient to a common module.
deepgram/clients/speak/v1/rest/async_client.py	Modified import paths for AbstractAsyncRestClient, DeepgramError, and DeepgramTypeError for consistency.
deepgram/clients/speak/v1/rest/client.py	Changed import paths for AbstractSyncRestClient, DeepgramError, and DeepgramTypeError to streamline imports.
deepgram/clients/speak/v1/websocket/async_client.py	Refactored AsyncSpeakWSClient to inherit from AbstractAsyncWebSocketClient, enhancing structure and functionality.
deepgram/clients/speak/v1/websocket/client.py	Refactored SpeakWSClient to inherit from AbstractSyncWebSocketClient, improving structure and message handling.
examples/text-to-speech/websocket/async_complete/main.py	Introduced signal handling for graceful shutdowns and a global variable to control message printing.
examples/text-to-speech/websocket/complete/main.py	Added a global variable to manage message printing in the on_binary_data method and modified logging configuration.

Possibly related PRs

• #462: This PR focuses on re-exposing error classes, which aligns with the main PR's improvements in error handling within the _start_asyncio_receiver method, enhancing robustness in connection management.

Suggested reviewers

• jpvajda
• SandraRodgers
• lukeocodes

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[davidvonthenen]

Unit Tests passed.