Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat:utterance_modifiers #291

Merged
merged 2 commits into from
Nov 20, 2024
Merged

feat:utterance_modifiers #291

merged 2 commits into from
Nov 20, 2024

Conversation

JarbasAl
Copy link
Member

@JarbasAl JarbasAl commented Nov 15, 2024

allow skills to access the utterance choosen by self.speak_dialog

either to modify it (eg, pronounce numbers) or just to passively monitor it

example usage OpenVoiceOS/ovos-skill-days-in-history#18

Summary by CodeRabbit

  • New Features

    • Enhanced speak_dialog method to allow custom transformations of spoken utterances through an optional render_callback parameter.
  • Documentation

    • Updated comments and documentation for the speak_dialog method to reflect the new parameter and its functionality.

allow skills to access the utterance choosen by self.speak_dialog

either to modify it (eg, pronounce numbers) or just to passively monitor it
allow skills to access the utterance choosen by self.speak_dialog

either to modify it (eg, pronounce numbers) or just to passively monitor it
Copy link
Contributor

coderabbitai bot commented Nov 15, 2024

Walkthrough

The pull request modifies the speak_dialog method in the OVOSSkill class by adding an optional parameter called render_callback. This parameter allows for custom transformations of the utterance before it is spoken. The method implementation is updated to utilize this new parameter, and the documentation has been revised to reflect these changes, enhancing the method's flexibility.

Changes

File Change Summary
ovos_workshop/skills/ovos.py Updated speak_dialog method signature to include render_callback. Adjusted implementation to apply this callback if provided. Revised comments and documentation for clarity.

Possibly related PRs

  • fix: drop lingua_franca #268: The changes in this PR also involve modifications to the OVOSSkill class in ovos.py, indicating a direct connection to the same file and class, although the focus is on different methods.

Suggested reviewers

  • NeonDaniel

Poem

In the burrow where skills do play,
A new callback has come to stay.
Transform the words before they fly,
With a hop and a skip, let them sigh.
Oh, what joy this change will bring,
As we dance and hear the utterance sing! 🐇✨


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
🪧 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>, 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 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.

JarbasAl added a commit to OpenVoiceOS/ovos-skill-days-in-history that referenced this pull request Nov 15, 2024
Copy link

codecov bot commented Nov 15, 2024

Codecov Report

Attention: Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.

Project coverage is 51.52%. Comparing base (7c02206) to head (5ab535f).
Report is 150 commits behind head on dev.

Files with missing lines Patch % Lines
ovos_workshop/skills/ovos.py 0.00% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##              dev     #291      +/-   ##
==========================================
- Coverage   53.41%   51.52%   -1.89%     
==========================================
  Files          37       36       -1     
  Lines        4362     4316      -46     
==========================================
- Hits         2330     2224     -106     
- Misses       2032     2092      +60     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
ovos_workshop/skills/ovos.py (1)

1730-1734: Consider adding return value validation for render_callback.

While the implementation is correct, it might be good to add validation to ensure the callback returns a string. This would help catch potential errors early.

 utterance = self.dialog_renderer.render(key, data)
 if render_callback is not None:
-    utterance = render_callback(utterance, self.lang)
+    modified = render_callback(utterance, self.lang)
+    if not isinstance(modified, str):
+        self.log.warning(f"render_callback returned {type(modified)}, expected str. Using original utterance.")
+    else:
+        utterance = modified
 self.speak(
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1478f04 and 5ab535f.

📒 Files selected for processing (1)
  • ovos_workshop/skills/ovos.py (2 hunks)
🔇 Additional comments (1)
ovos_workshop/skills/ovos.py (1)

Line range hint 1699-1726: LGTM! Well-documented signature change.

The new render_callback parameter is properly type-hinted and well-documented. The docstring clearly explains the parameter's purpose and expected behavior.

Copy link
Contributor

@mikejgray mikejgray left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like a nice addition

@mikejgray
Copy link
Contributor

Codecov is complaining due to lack of tests

@JarbasAl JarbasAl merged commit 7bd9062 into dev Nov 20, 2024
11 of 12 checks passed
JarbasAl added a commit to OpenVoiceOS/ovos-skill-days-in-history that referenced this pull request Nov 20, 2024
* fix: pronounce year

needs OpenVoiceOS/OVOS-workshop#291

* Update requirements.txt

* Update __init__.py

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Update __init__.py

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Update __init__.py

* Update __init__.py

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@coderabbitai coderabbitai bot mentioned this pull request Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants