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:standardize_lang_tag new utils #267

Merged
merged 1 commit into from
Sep 16, 2024
Merged

feat:standardize_lang_tag new utils #267

merged 1 commit into from
Sep 16, 2024

Conversation

JarbasAl
Copy link
Member

@JarbasAl JarbasAl commented Sep 16, 2024

ported from some TTS/STT plugins, will be useful across OVOS ecosystem

Summary by CodeRabbit

  • New Features

    • Introduced a new function to standardize language tags, improving language code handling.
    • Added a new dependency for enhanced language code functionality.
  • Documentation

    • Updated requirements to include the new langcodes library.

ported from some TTS/STT plugins, will be useful across OVOS ecosystem
Copy link

coderabbitai bot commented Sep 16, 2024

Walkthrough

The changes introduce a new function, standardize_lang_tag, to the ovos_utils/lang/__init__.py file, which standardizes language tags based on a provided language code. Additionally, a new dependency, langcodes, is added to the requirements/extras.txt file to support this functionality. The modifications enhance the module's capability to handle language codes effectively.

Changes

File Change Summary
ovos_utils/lang/init.py Added def standardize_lang_tag(lang_code, macro=True) to standardize language tags.
requirements/extras.txt Added langcodes as a new dependency for language code handling.

Poem

In the meadow, tags align,
A function sprouted, oh so fine.
With langcodes by our side,
Language flows like a gentle tide.
Hopping through code, we cheer and play,
Standardized tags brighten the day! 🐇✨


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 generate interesting stats about this repository and render them as a table.
    -- @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.

Copy link

codecov bot commented Sep 16, 2024

Codecov Report

Attention: Patch coverage is 12.50000% with 7 lines in your changes missing coverage. Please review.

Project coverage is 43.88%. Comparing base (ff25730) to head (748f7b1).
Report is 4 commits behind head on dev.

Files with missing lines Patch % Lines
ovos_utils/lang/__init__.py 12.50% 7 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##              dev     #267      +/-   ##
==========================================
- Coverage   43.96%   43.88%   -0.08%     
==========================================
  Files          31       31              
  Lines        3237     3245       +8     
==========================================
+ Hits         1423     1424       +1     
- Misses       1814     1821       +7     

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

@github-actions github-actions bot added feature and removed feature labels Sep 16, 2024
Copy link

@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: 1

Outside diff range and nitpick comments (1)
requirements/extras.txt (1)

6-6: Consider adding a version constraint for the langcodes dependency.

To ensure compatibility and avoid potential issues in the future, it's a good practice to specify a version constraint for the newly added langcodes dependency.

You can add a version constraint similar to the other dependencies in the file. For example:

-langcodes
+langcodes>=1.0.0,<2.0.0

This will ensure that the project uses a compatible version of langcodes and helps prevent unexpected breakages due to future updates.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 903b6d5 and 748f7b1.

Files selected for processing (2)
  • ovos_utils/lang/init.py (1 hunks)
  • requirements/extras.txt (1 hunks)
Additional context used
Ruff
ovos_utils/lang/__init__.py

12-12: Do not use bare except

(E722)

Additional comments not posted (1)
ovos_utils/lang/__init__.py (1)

7-15: Great addition!

The standardize_lang_tag function provides a robust way to handle language codes, improving compatibility and usability across the OVOS ecosystem. The fallback logic ensures that the function works even if the langcodes library is not available, enhancing its reliability.

Tools
Ruff

12-12: Do not use bare except

(E722)

ovos_utils/lang/__init__.py Show resolved Hide resolved
@JarbasAl JarbasAl merged commit 72d2653 into dev Sep 16, 2024
10 of 11 checks passed
@JarbasAl JarbasAl deleted the standardize_lang_tag branch September 16, 2024 19:56
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