Add proper caching to LocaleDataMap

[LeonarddeR]

Link to issue number:

Fixes #16981
Follow up of #16823

Summary of the issue:

Since #16823, the log is spammed with errors re loading of nonexistent symbol dictionaries.

Description of user facing changes

No spamming with errors in the log.

Description of development approach

Before #16823, there were sets for caching locales without symbol dictionaries. When no dictionaries existed, the locales were saved in the cache and upon next request, _getSpeechSymbolsForLocale returned early.
That caching mechanism was apparently removed in #16823. I now restored similar caching, but the cache is now stored on the LocaleDataMap instance. This should also be beneficial for character descriptions.

Testing strategy:

Ensured that the error @XLTechie had only occurs once per dictionary.

Known issues with pull request:

None known

Code Review Checklist:

• Documentation:
  • Change log entry
  • User Documentation
  • Developer / Technical Documentation
  • Context sensitive help for GUI changes
• Testing:
  • Unit tests
  • System (end to end) tests
  • Manual testing
• UX of all users considered:
  • Speech
  • Braille
  • Low Vision
  • Different web browsers
  • Localization in other languages / culture than English
• API is compatible with existing add-ons.
• Security precautions taken.

Summary by CodeRabbit

• New Features

  • Enhanced locale data fetching efficiency by introducing a cache for locales with no associated data.

• Bug Fixes

  • Modified methods to ensure proper management of the cache when locale data is invalidated or cleared.

[coderabbitai]

Walkthrough

The recent enhancements to the LocaleDataMap class improve efficiency in locale data fetching by implementing a caching mechanism for locales that lack associated data. This change reduces repetitive lookups and log spamming related to missing files, optimizing both performance and clarity in log outputs.

Changes

Files	Change Summary
source/characterProcessing.py	Added _noDataLocalesCache to cache locales without data and updated methods to utilize this cache for efficiency.

Assessment against linked issues

Objective	Addressed	Explanation
Minimize log spam regarding missing symbol files (#16981)	✅
Improve performance of locale data fetch operations (#16981)	✅

---

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

[XLTechie]

Thanks for such quick work, @LeonarddeR!

[seanbudd]

is there a reason why this was added to the class rather than kept in __init__?

[LeonarddeR]

This is only a type hint, the set itself is initiated in __init__
or should I provide the type hint in __init__

[seanbudd]

normally the type hint would go in __init__ though right?