search

OpenVoiceOS / ovos-core

OpenVoiceOS Core, the FOSS Artificial Intelligence platform.
https://openvoiceos.org
Apache License 2.0
122 stars 17 forks source link

improve_typing #528

Closed JarbasAl closed 1 month ago

JarbasAl commented 1 month ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

[!WARNING]

Rate limit exceeded

@JarbasAl has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 31 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 3c27ac63e09d54381c1d79a59f3df95ac9adf133 and 328734a223e65ee8f3018cb451228873b8b17d67.

Walkthrough

The recent updates across multiple files in the ovos_core.intent_services module primarily enhance code clarity and maintainability. A key change is the transition from a locally defined IntentMatch namedtuple to an imported class from ovos_plugin_manager.templates.pipeline. This, coupled with the addition and refinement of type annotations throughout various methods, significantly improves type safety and documentation. Overall, these modifications streamline intent handling processes and align the codebase with modern Python standards.

Changes

Files Change Summary
ovos_core/intent_services/__init__.py Removed IntentMatch namedtuple, imported from ovos_plugin_manager.templates.pipeline, updated IntentService docstring.
ovos_core/intent_services/adapt_service.py Updated IntentMatch import and simplified usage in take_best function.
ovos_core/intent_services/commonqa_service.py Added Optional type hint to match method, updated IntentMatch import.
ovos_core/intent_services/converse_service.py Changed return type of converse_with_skills to Optional[IntentMatch], updated import.
ovos_core/intent_services/fallback_service.py Enhanced type annotations for methods, updated IntentMatch import.
ovos_core/intent_services/ocp_service.py Standardized IntentMatch usage, added return type annotations.
ovos_core/intent_services/padacioso_service.py Updated IntentMatch import and return type in _match_level method.
ovos_core/intent_services/padatious_service.py Simplified import of IntentMatch, updated return statement in _match_level.
ovos_core/intent_services/stop_service.py Added type hints for several methods, enhancing readability and type safety.
requirements/requirements.txt Updated ovos-plugin-manager version constraint from >=0.0.25 to >=0.0.26a33.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant IntentService
    participant IntentMatch
    participant FallbackService

    User->>IntentService: Request Intent
    IntentService->>IntentMatch: Create IntentMatch
    IntentMatch->>IntentService: Return Match Information
    IntentService->>FallbackService: Handle Fallback
    FallbackService->>User: Provide Response

🐇 In the code where rabbits play,
Intent matching finds its way.
From imports new, the paths are clear,
With type hints, there's nothing to fear!
Hop along, let's celebrate,
A sprightly code, oh, isn't it great? 🎉

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 .` - `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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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.
codecov[bot] commented 1 month ago

Codecov Report

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

Project coverage is 75.70%. Comparing base (b603751) to head (328734a).

Files Patch % Lines
ovos_core/intent_services/ocp_service.py 88.88% 2 Missing :warning:
ovos_core/intent_services/stop_service.py 91.66% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## dev #528 +/- ## ========================================== - Coverage 75.72% 75.70% -0.02% ========================================== Files 15 15 Lines 3044 3042 -2 ========================================== - Hits 2305 2303 -2 Misses 739 739 ``` | [Flag](https://app.codecov.io/gh/OpenVoiceOS/ovos-core/pull/528/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=OpenVoiceOS) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/OpenVoiceOS/ovos-core/pull/528/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=OpenVoiceOS) | `75.70% <95.23%> (-0.02%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=OpenVoiceOS#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.