Allow fetching translations by categories by balloob · Pull Request #34329 · home-assistant/core

balloob · 2020-04-17T06:30:43Z

Breaking change

Proposed change

This allows fetching translations by categories instead of fetching everything at once. This also allows specifying if you want to load a single integration, all set up integrations or all set up integrations + all integrations that have config flows.

~~Marked WIP until I finish frontend PR.~~

Frontend PR home-assistant/frontend#5560

Part of #34264

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)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Example entry for `configuration.yaml`:

# Example configuration.yaml

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
The code has been formatted using Black (black --fast homeassistant tests)
Tests have been added to verify that the new code works.

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

Documentation added/updated for www.home-assistant.io

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.
Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

No score or internal
🥈 Silver
🥇 Gold
🏆 Platinum

probot-home-assistant · 2020-04-17T06:30:52Z

Hey there @home-assistant/core, mind taking a look at this pull request as its been labeled with a integration (onboarding) you are listed as a codeowner for? Thanks!

probot-home-assistant · 2020-04-17T06:30:52Z

Hey there @home-assistant/frontend, mind taking a look at this pull request as its been labeled with a integration (frontend) you are listed as a codeowner for? Thanks!

balloob · 2020-04-17T22:09:49Z

~~One final bug left when setting up a new integration during onboarding…~~

Fixed

2020-04-17 13:22:18 ERROR (MainThread) [homeassistant.components.websocket_api.http.connection.4709422416] Error handling message: Unknown error
Traceback (most recent call last):
  File "/Users/paulus/dev/hass/home-assistant/homeassistant/components/websocket_api/decorators.py", line 20, in _handle_async_response
    await func(hass, connection, msg)
  File "/Users/paulus/dev/hass/home-assistant/homeassistant/components/frontend/__init__.py", line 558, in websocket_get_translations
    msg.get("config_flow"),
  File "/Users/paulus/dev/hass/home-assistant/homeassistant/helpers/translation.py", line 198, in async_get_translations
    results = await asyncio.gather(*tasks)
  File "/Users/paulus/dev/hass/home-assistant/homeassistant/helpers/translation.py", line 167, in async_get_component_resources
    return build_resources(translation_cache, components)
  File "/Users/paulus/dev/hass/home-assistant/homeassistant/helpers/translation.py", line 101, in build_resources
    resources[domain].update(translation_cache[component])
KeyError: 'media_player.cast'

balloob · 2020-04-18T03:57:21Z

@Mariusthvdb this should fix your Hue hiccuping when you open the frontend.

Mariusthvdb · 2020-04-18T09:26:43Z

@Mariusthvdb this should fix your Hue hiccuping when you open the frontend.

great! and thanks ;-)

happy to report that since upgrading from 107.x to 108.4 the HA instance has never been so fast, responsive and, important, without 'unavailable' (#knockonwood) Hue entities. I've re-instated all core Hue sensors, and they seem very reliable, where before, they would go just as of the 'unavailable' as the lights.

Please keep on knocking these details, HA keeps getting better and better.
Thanks for the tag and the heads-on. Appreciated.

MartinHjelmare · 2020-04-18T13:00:22Z

-    translation_cache: Dict[str, Dict[str, Any]], components: Iterable[str]
+    translation_cache: Dict[str, Dict[str, Any]],
+    components: Set[str],
+    category: Optional[str],


What are the other categories than the languages?

MartinHjelmare · 2020-04-18T13:04:43Z

-        resources[domain].update(translation_cache[component])
+
+        if category is None:
+            domain_resources.update(translation_cache[component])


Does the translation cache contain keys that are either languages or domains?

categories are the top level entries in strings.json. config, options, etc. A list is here

So the dict is

{ "light": { "device_automation": {…} }

MartinHjelmare · 2020-04-18T22:50:12Z

+    cache: Dict[str, Dict[str, Any]] = hass.data.setdefault(
+        TRANSLATION_STRING_CACHE, {}
+    )
+    translation_cache: Dict[str, Any] = cache.setdefault(language, {})


Here we seem to set a language as top level key in the translation cache. How does that match with your description in the comment?

Sorry, I got confused with all the nested dicts. The translation cache here and what we return is one level below the language key.

We return translation_cache, which has the described structure.

You're right that cache is { language: translation_cache }.

MartinHjelmare

Looks good!

Allow fetching translations by categories

58ea102

probot-home-assistant Bot added core integration: frontend integration: onboarding type: new-feature labels Apr 17, 2020

homeassistant added the cla-signed label Apr 17, 2020

This was referenced Apr 17, 2020

Translations 2.0 #34264

Closed

Ask specific translations home-assistant/frontend#5560

Merged

Fix frontend test

9a8f914

balloob marked this pull request as ready for review April 17, 2020 18:17

Lock things

c573ecf

Fix race condition

663b2a8

balloob added 2 commits April 18, 2020 01:03

Use less empty dicts

8eaefb1

Simplify

dd9ffb8

MartinHjelmare reviewed Apr 18, 2020

View reviewed changes

MartinHjelmare approved these changes Apr 18, 2020

View reviewed changes

One final cleanup

02f81af

balloob merged commit 98f1548 into dev Apr 19, 2020

balloob deleted the translation-categories branch April 19, 2020 00:13

lock Bot locked and limited conversation to collaborators Apr 25, 2020

balloob added the new-feature label May 4, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Allow fetching translations by categories#34329

Allow fetching translations by categories#34329
balloob merged 7 commits intodevfrom
translation-categories

balloob commented Apr 17, 2020 •

edited

Loading

Uh oh!

probot-home-assistant Bot commented Apr 17, 2020

Uh oh!

probot-home-assistant Bot commented Apr 17, 2020

Uh oh!

balloob commented Apr 17, 2020 •

edited

Loading

Uh oh!

balloob commented Apr 18, 2020

Uh oh!

Mariusthvdb commented Apr 18, 2020 •

edited

Loading

Uh oh!

MartinHjelmare Apr 18, 2020

Uh oh!

MartinHjelmare Apr 18, 2020

Uh oh!

balloob Apr 18, 2020

Uh oh!

MartinHjelmare Apr 18, 2020

Uh oh!

MartinHjelmare Apr 18, 2020

Uh oh!

balloob Apr 19, 2020

Uh oh!

MartinHjelmare left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

balloob commented Apr 17, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Breaking change

Proposed change

Type of change

Example entry for configuration.yaml:

Additional information

Checklist

Uh oh!

probot-home-assistant Bot commented Apr 17, 2020

Uh oh!

probot-home-assistant Bot commented Apr 17, 2020

Uh oh!

balloob commented Apr 17, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

balloob commented Apr 18, 2020

Uh oh!

Mariusthvdb commented Apr 18, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MartinHjelmare Apr 18, 2020

Choose a reason for hiding this comment

Uh oh!

MartinHjelmare Apr 18, 2020

Choose a reason for hiding this comment

Uh oh!

balloob Apr 18, 2020

Choose a reason for hiding this comment

Uh oh!

MartinHjelmare Apr 18, 2020

Choose a reason for hiding this comment

Uh oh!

MartinHjelmare Apr 18, 2020

Choose a reason for hiding this comment

Uh oh!

balloob Apr 19, 2020

Choose a reason for hiding this comment

Uh oh!

MartinHjelmare left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

balloob commented Apr 17, 2020 •

edited

Loading

Example entry for `configuration.yaml`:

balloob commented Apr 17, 2020 •

edited

Loading

Mariusthvdb commented Apr 18, 2020 •

edited

Loading