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

fix:langcodes #241

Merged
merged 3 commits into from
Oct 11, 2024
Merged

fix:langcodes #241

merged 3 commits into from
Oct 11, 2024

Conversation

JarbasAl
Copy link
Member

@JarbasAl JarbasAl commented Oct 11, 2024

the lang code standard assumes region is upper case, however mycroft forced a lower case lang code which is now causing issues if the standard is used

besides handling this, dialect support is now improved by using langcodes library distance function, ensuring the best dialect is selected

Summary by CodeRabbit

  • New Features

    • Enhanced language resource management for improved directory handling.
    • Introduced a scoring mechanism for assessing language code similarities.
  • Bug Fixes

    • Updated logic for determining the appropriate language resource directory.
  • Documentation

    • Added deprecation warnings for certain parameters and functions to improve clarity.
    • Updated comments to reflect changes in language directory handling.
  • Chores

    • Updated version constraint for the ovos-utils package and added a new dependency, langcodes.
  • Tests

    • Removed test case for the new skill GUI implementation while retaining legacy skill GUI tests.

the lang code standard assumes region is upper case, however mycroft forced a lower case lang code which is now causing issues if the standard is used

besides handling this, dialect support is now improved by using langcodes library distance function, ensuring the best dialect is selected
@JarbasAl JarbasAl requested review from goldyfruit and a team October 11, 2024 16:48
@github-actions github-actions bot added the fix label Oct 11, 2024
Copy link
Contributor

coderabbitai bot commented Oct 11, 2024

Walkthrough

The changes in this pull request involve modifications to the OVOSAbstractApplication class in ovos_workshop/app.py and enhancements to language directory handling in ovos_workshop/resource_files.py. Key updates include the introduction of a new import for standardize_lang_tag, adjustments to the get_language_dir method for improved language resource directory determination, and the use of the tag_distance function for better language code comparison. Deprecation warnings and logging have been added to maintain backward compatibility and clarify changes.

Changes

File Path Change Summary
ovos_workshop/app.py - Updated OVOSAbstractApplication class with new import for standardize_lang_tag.
- Modified __init__ method to include deprecation warnings for settings.
- Revised get_language_dir logic to standardize lang parameter.
ovos_workshop/resource_files.py - Enhanced locate_lang_directories to use tag_distance for language code similarity.
- Updated resolve_resource_file to include deprecation log for relocation notice.
requirements/requirements.txt - Updated ovos-utils version from >=0.0.38,<1.0.0 to >=0.2.1,<1.0.0.
- Added new dependency langcodes.
test/unittests/skills/test_base.py - Removed test case for new skill GUI in TestSkillGui class while retaining legacy skill GUI test case.

Poem

🐇 In the workshop where rabbits play,
Language flows in a new, bright way.
With tags standardized and scores in sight,
Our resource paths are now just right!
Hopping through code, we cheer and sing,
For clarity and ease, these changes bring! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between e675688 and 434f749.

📒 Files selected for processing (1)
  • test/unittests/skills/test_base.py (0 hunks)
💤 Files with no reviewable changes (1)
  • test/unittests/skills/test_base.py

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.

@github-actions github-actions bot added fix and removed fix labels Oct 11, 2024
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: 3

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between bb0d3da and a1ea2ea.

📒 Files selected for processing (2)
  • ovos_workshop/app.py (2 hunks)
  • ovos_workshop/resource_files.py (2 hunks)
🧰 Additional context used
🔇 Additional comments (3)
ovos_workshop/app.py (2)

5-5: Import of standardize_lang_tag is appropriate.

The import statement correctly brings in standardize_lang_tag, which is used to standardize language tags in the code below.


95-95: Clarify the comment regarding sorted directories.

The comment correctly notes that the directories returned by locate_lang_directories are already sorted, with the first being the best match. This provides clear guidance on the selection logic.

ovos_workshop/resource_files.py (1)

87-96: Improved language code matching using tag_distance

The updated logic in locate_lang_directories enhances language directory selection by evaluating the distance between language codes using tag_distance. This allows for better matching of language variants and dialects. The implementation appears correct and should improve the functionality as intended.

ovos_workshop/app.py Show resolved Hide resolved
ovos_workshop/app.py Show resolved Hide resolved
ovos_workshop/resource_files.py Show resolved Hide resolved
@github-actions github-actions bot added fix and removed fix labels Oct 11, 2024
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)
requirements/requirements.txt (1)

7-7: Consider adding a version constraint for langcodes

The addition of langcodes is appropriate and aligns with the PR objectives for improving dialect support. However, it's recommended to specify a version constraint to ensure compatibility and reproducibility.

Consider updating the line to include a version constraint, for example:

-langcodes
+langcodes>=1.4.1,<2.0.0

Replace 1.4.1 with the minimum version that includes the features you need. This will help prevent potential issues if breaking changes are introduced in future versions of langcodes.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a1ea2ea and e675688.

📒 Files selected for processing (1)
  • requirements/requirements.txt (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
requirements/requirements.txt (1)

1-1: LGTM: Version update for ovos-utils

The update to ovos-utils>=0.2.1,<1.0.0 is appropriate. It increases the minimum required version, which likely includes necessary features or bug fixes, while maintaining the same upper bound for compatibility.

To ensure compatibility, please verify that the project works correctly with the new minimum version of ovos-utils. You can use the following command to check for any potential issues:

no longer applies when latest ovos-utils is installed
Copy link

codecov bot commented Oct 11, 2024

Codecov Report

Attention: Patch coverage is 64.28571% with 5 lines in your changes missing coverage. Please review.

Project coverage is 49.16%. Comparing base (7c02206) to head (434f749).
Report is 19 commits behind head on dev.

Files with missing lines Patch % Lines
ovos_workshop/app.py 16.66% 5 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##              dev     #241      +/-   ##
==========================================
- Coverage   53.41%   49.16%   -4.26%     
==========================================
  Files          37       37              
  Lines        4362     4365       +3     
==========================================
- Hits         2330     2146     -184     
- Misses       2032     2219     +187     

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

@JarbasAl
Copy link
Member Author

closes #243

@JarbasAl JarbasAl merged commit 6843f0f into dev Oct 11, 2024
9 of 10 checks passed
@JarbasAl JarbasAl deleted the fix/langcodes branch October 11, 2024 17:56
@coderabbitai coderabbitai bot mentioned this pull request Oct 18, 2024
This was referenced Nov 7, 2024
This was referenced Nov 15, 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.

1 participant