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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix translation typing #66516

Merged
merged 1 commit into from Feb 14, 2022
Merged

Conversation

cdce8p
Copy link
Member

@cdce8p cdce8p commented Feb 14, 2022

Proposed change

The return type for _build_resources should be changed to dict[str, dict[str, Any] | str], since not all dictionary values are itself dictionaries. For example

_build_category_cache already has code to handle that case.

if isinstance(resource, dict):
category_cache.update(
recursive_flatten(
f"component.{component}.{category}.",
resource,
)
)
else:
category_cache[f"component.{component}.{category}"] = resource

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

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:

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.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 馃 Silver
  • 馃 Gold
  • 馃弳 Platinum

To help with the load of incoming pull requests:

@cdce8p cdce8p requested a review from a team as a code owner February 14, 2022 13:55
@probot-home-assistant probot-home-assistant bot added code-quality core small-pr PRs with less than 30 lines. labels Feb 14, 2022
@@ -251,6 +252,7 @@ def _build_category_cache(
translation_strings: dict[str, dict[str, Any]],
) -> None:
"""Extract resources into the cache."""
resource: dict[str, Any] | str
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be able to be referenced from translation_strings? And so we should update the type of the translation-strings param instead?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The type for translation_strings is correct as far as I can tell. Any is basically dict[str, Any] | str there.

Shouldn't this be able to be referenced from translation_strings?

Yeah it is, but that's also the issue. Just from translation_strings, resource would be typed as dict[str, Any] and thus wouldn't allow str. The alternative would be to rename resource in the third for loop to something like resource2. That would allow for dedicated types.

Otherwise, we need the type definition here. The type inference still works like you would expect it to. I.e. inside the first the for ... translation_strings.values() block, resource is only dict[str, Any].

@@ -260,7 +262,8 @@ def _build_category_cache(
resource_func = (
_merge_resources if category == "state" else _build_resources
)
new_resources = resource_func(translation_strings, components, category)
new_resources: Mapping[str, dict[str, Any] | str]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this the preferred approach over casting?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think type: ignore with a type definition is slightly better here.
Once mypy is able to infer resource_func correctly, we could just remove the comment. With cast we wouldn't even know that's the case, since the inferred type will be different from, but compatible with Mapping.

dict[str, dict[str, Any]]  |  dict[str, dict[str, Any] | str]

@balloob balloob merged commit 3b3e12a into home-assistant:dev Feb 14, 2022
@cdce8p cdce8p deleted the fix-typing-translation branch February 14, 2022 17:25
@github-actions github-actions bot locked and limited conversation to collaborators Feb 15, 2022
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

3 participants