Re-expose Error Classes

[davidvonthenen]

Proposed changes

Addresses: #461

Exposes the error classes.

Local testing make unit-test is good.

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)
• 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.

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

Further comments

NA

Summary by CodeRabbit

• New Features

  • Enhanced error handling capabilities across various modules, adding specific error classes for better clarity and management.

• Bug Fixes

  • Removed deprecated error classes to streamline error handling and improve functionality.

• Chores

  • Refactored import statements for better organization and clarity in error management across the codebase.

[coderabbitai]

Walkthrough

The pull request introduces significant modifications to the Deepgram library's error handling framework. It expands the set of error classes imported across various modules, consolidating the management of exceptions related to API interactions and microphone operations. Several existing imports have been removed, indicating a restructuring of dependencies and a shift in how client options are handled across different components of the library.

Changes

Files	Change Summary
deepgram/__init__.py, deepgram/audio/__init__.py, deepgram/audio/microphone/__init__.py, deepgram/client.py, deepgram/clients/__init__.py, deepgram/clients/abstract_async_client.py, deepgram/clients/abstract_sync_client.py, deepgram/clients/analyze/__init__.py, deepgram/clients/analyze/v1/__init__.py, deepgram/clients/analyze/v1/async_client.py, deepgram/clients/analyze/v1/client.py, deepgram/clients/common/__init__.py, deepgram/clients/common/v1/__init__.py	Added new error classes and removed obsolete imports, enhancing error handling capabilities.
deepgram/clients/errors.py	Removed DeepgramError class, indicating a shift in error management strategy.
deepgram/clients/listen/__init__.py, deepgram/clients/listen/client.py, deepgram/clients/listen/v1/__init__.py, deepgram/clients/listen/v1/rest/__init__.py, deepgram/clients/listen/v1/rest/async_client.py, deepgram/clients/listen/v1/rest/client.py, deepgram/clients/listen/v1/websocket/__init__.py, deepgram/clients/listen/v1/websocket/async_client.py, deepgram/clients/listen/v1/websocket/client.py	Removed imports related to DeepgramClientOptions and ClientOptionsFromEnv, suggesting a refactoring of dependencies.
deepgram/clients/live/__init__.py, deepgram/clients/live/v1/__init__.py	Removed error classes DeepgramError, DeepgramTypeError, and DeepgramWebsocketError, indicating a potential refactor.
deepgram/clients/manage/__init__.py, deepgram/clients/prerecorded/__init__.py, deepgram/clients/prerecorded/v1/__init__.py, deepgram/clients/selfhosted/__init__.py, deepgram/clients/selfhosted/v1/__init__.py, deepgram/clients/speak/__init__.py, deepgram/clients/speak/v1/__init__.py	Removed imports for DeepgramClientOptions and ClientOptionsFromEnv, indicating a simplification of module dependencies.

Tip

Announcements

• The review status is no longer posted as a separate comment when there are no actionable or nitpick comments. In such cases, the review status is included in the walkthrough comment.
• We have updated our review workflow to use the Anthropic's Claude family of models. Please share any feedback in the discussion post on our Discord.
• Possibly related PRs: Walkthrough comment now includes a list of potentially related PRs to help you recall past context. Please share any feedback in the discussion post on our Discord.
• Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs in the walkthrough comment. You can also provide custom labeling instructions in the UI or configuration file.
• Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0cb8467 and 0afce18.

Files selected for processing (35)

• deepgram/init.py (2 hunks)
• deepgram/audio/init.py (1 hunks)
• deepgram/audio/microphone/init.py (1 hunks)
• deepgram/client.py (2 hunks)
• deepgram/clients/init.py (1 hunks)
• deepgram/clients/abstract_async_client.py (1 hunks)
• deepgram/clients/abstract_sync_client.py (1 hunks)
• deepgram/clients/analyze/init.py (1 hunks)
• deepgram/clients/analyze/v1/init.py (1 hunks)
• deepgram/clients/analyze/v1/async_client.py (1 hunks)
• deepgram/clients/analyze/v1/client.py (1 hunks)
• deepgram/clients/common/init.py (2 hunks)
• deepgram/clients/common/v1/init.py (1 hunks)
• deepgram/clients/errors.py (1 hunks)
• deepgram/clients/listen/init.py (1 hunks)
• deepgram/clients/listen/client.py (1 hunks)
• deepgram/clients/listen/v1/init.py (1 hunks)
• deepgram/clients/listen/v1/rest/init.py (1 hunks)
• deepgram/clients/listen/v1/rest/async_client.py (1 hunks)
• deepgram/clients/listen/v1/rest/client.py (1 hunks)
• deepgram/clients/listen/v1/websocket/init.py (1 hunks)
• deepgram/clients/listen/v1/websocket/async_client.py (1 hunks)
• deepgram/clients/listen/v1/websocket/client.py (1 hunks)
• deepgram/clients/live/init.py (1 hunks)
• deepgram/clients/live/v1/init.py (1 hunks)
• deepgram/clients/manage/init.py (1 hunks)
• deepgram/clients/prerecorded/init.py (1 hunks)
• deepgram/clients/prerecorded/v1/init.py (1 hunks)
• deepgram/clients/selfhosted/init.py (1 hunks)
• deepgram/clients/selfhosted/v1/init.py (1 hunks)
• deepgram/clients/speak/init.py (1 hunks)
• deepgram/clients/speak/v1/init.py (1 hunks)
• deepgram/clients/speak/v1/rest/async_client.py (1 hunks)
• deepgram/clients/speak/v1/rest/client.py (1 hunks)
• deepgram/errors.py (1 hunks)

Files skipped from review due to trivial changes (31)

• deepgram/audio/init.py
• deepgram/audio/microphone/init.py
• deepgram/clients/init.py
• deepgram/clients/analyze/init.py
• deepgram/clients/analyze/v1/init.py
• deepgram/clients/analyze/v1/async_client.py
• deepgram/clients/analyze/v1/client.py
• deepgram/clients/common/init.py
• deepgram/clients/common/v1/init.py
• deepgram/clients/errors.py
• deepgram/clients/listen/init.py
• deepgram/clients/listen/client.py
• deepgram/clients/listen/v1/init.py
• deepgram/clients/listen/v1/rest/init.py
• deepgram/clients/listen/v1/rest/async_client.py
• deepgram/clients/listen/v1/rest/client.py
• deepgram/clients/listen/v1/websocket/init.py
• deepgram/clients/listen/v1/websocket/async_client.py
• deepgram/clients/listen/v1/websocket/client.py
• deepgram/clients/live/init.py
• deepgram/clients/live/v1/init.py
• deepgram/clients/manage/init.py
• deepgram/clients/prerecorded/init.py
• deepgram/clients/prerecorded/v1/init.py
• deepgram/clients/selfhosted/init.py
• deepgram/clients/selfhosted/v1/init.py
• deepgram/clients/speak/init.py
• deepgram/clients/speak/v1/init.py
• deepgram/clients/speak/v1/rest/async_client.py
• deepgram/clients/speak/v1/rest/client.py
• deepgram/errors.py

Additional comments not posted (4)

deepgram/__init__.py (1)

27-34: LGTM!

The changes enhance error handling capabilities by importing a comprehensive set of error classes from the client module. This allows users to catch and respond to a wider variety of error conditions related to API interactions.

The addition of DeepgramMicrophoneError import from the audio module suggests improved error handling for microphone operations, making the audio functionalities more robust.

Overall, these changes reflect an effort to improve the error management framework within the Deepgram library.

Also applies to: 183-183

deepgram/clients/abstract_sync_client.py (1)

13-14: LGTM, but verify the impact of the import change.

The changes suggest a restructuring of error handling by importing DeepgramError from .common.v1.errors instead of the local errors module. This potentially indicates that DeepgramError has been relocated to a different module for better organization or to reflect a new hierarchy in the codebase.

The overall functionality of the AbstractSyncRestClient class remains intact, but the way errors are managed may be affected by this change in import structure.

To verify the impact of the import change, run the following script:

deepgram/clients/abstract_async_client.py (1)

13-14: LGTM!

The changes in this file are similar to the ones in abstract_sync_client.py. Please refer to the previous comment for a detailed review.

deepgram/client.py (1)

31-37: LGTM!

The changes consolidate the import of error classes from the .clients module and remove the redundant DeepgramModuleError import from the .errors module. This refactor improves the clarity and specificity of error handling.

The code changes are approved.

---

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
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.