deprecation warnings

[JarbasAl]

closes #109 per #107 review

Summary by CodeRabbit

• New Features

  • Improved logging for deprecated parameters, enhancing clarity for users regarding upcoming changes.

• Bug Fixes

  • Deprecated parameters will now be ignored, preventing potential confusion for users.

[coderabbitai]

Walkthrough

The changes involve the deprecation of the tts_prefs and stt_prefs keyword arguments in the Session class constructor within the ovos_bus_client/session.py file. The logging of deprecation warnings has been updated to utilize a new function, log_deprecation, enhancing the clarity of these warnings. The constructor's functionality remains intact, but the logging mechanism has been standardized for better maintenance.

Changes

Files	Change Summary
ovos_bus_client/session.py	Deprecated tts_prefs and stt_prefs in Session constructor; updated logging to log_deprecation.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Session
    participant Logger

    User->>Session: Initialize Session with deprecated params
    Session->>Logger: Call log_deprecation for tts_prefs and stt_prefs
    Logger-->>Session: Log warning message
    Session-->>User: Session initialized without deprecated params

Loading

Assessment against linked issues

Objective	Addressed	Explanation
These should use the log_deprecation decorator to be searchable in logs (#109)	✅

🐰 In the meadow, I hop with glee,
No more tts_prefs, just let it be!
With log_deprecation, clear and bright,
Warnings now shine, a lovely sight!
Hooray for changes, let’s dance and play,
In code we trust, hip-hip-hooray! 🌼

---

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9acbce6 and 49f3758.

Files selected for processing (1)

• ovos_bus_client/session.py (2 hunks)

Additional comments not posted (1)

ovos_bus_client/session.py (1)

292-294: Approved: Use of log_deprecation for clearer deprecation warnings.

The changes to use log_deprecation for the tts_prefs and stt_prefs keyword arguments are correctly implemented. This approach enhances the searchability and maintainability of deprecation warnings, aligning with the PR's objectives. The inclusion of the version number "0.1.0" in the deprecation messages is a good practice, providing clear communication about the deprecation timeline.