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

Refactor translations to reduce dict lookups #107425

Merged
merged 2 commits into from Jan 8, 2024
Merged

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Jan 7, 2024

Proposed change

TLDR: the O(n) lookup (set of components) is now at the tail of the cache instead of having to transverse it in the middle of the cache. This allows the cache fetch to avoid looking up the category each loop.

This started to matter a bit more now that we translate a lot more things.

All of our cache lookups used:

cache[language][O(component)][category]

The cache was designed as

cache[language][component][category][flatted_key]

The lookups are now

cache[language][category][O(component)]

The cache is now stored as

cache[language][category][component][flatted_key]

This provides better alignment with how the fetch function asks for the data

        language: str,
        category: str,
        components: set[str],

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

All of our cache lookups used:

`cache[language][O(component)][category]`

The cache was designed as

`cache[language][component][category][flatted_key]`

The lookups are now

`cache[language][category][O(component)]`

The cache is now stored as

`cache[language][category][component][flatted_key]`

This allows the catch fetch to avoid looking up
the category each loop
@home-assistant home-assistant bot added cla-signed code-quality core small-pr PRs with less than 30 lines. labels Jan 7, 2024
@bdraco bdraco marked this pull request as ready for review January 7, 2024 01:57
@bdraco bdraco requested a review from a team as a code owner January 7, 2024 01:57
@balloob balloob merged commit 368feec into dev Jan 8, 2024
53 checks passed
@balloob balloob deleted the refactor_translations branch January 8, 2024 03:29
@github-actions github-actions bot locked and limited conversation to collaborators Jan 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants