Skip to content

Add restored entities to entity_sources #146549

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

Draft
wants to merge 4 commits into
base: dev
Choose a base branch
from

Conversation

emontnemery
Copy link
Contributor

Proposed change

Add restored entities to entity_sources, this makes it possible to pick restored entities filtered by integration in the entity selector, and to improve display of failing helpers.

Needs frontend changes for the helper panel

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:
  • Link to developer documentation pull request:
  • Link to frontend 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.

To help with the load of incoming pull requests:

@emontnemery emontnemery force-pushed the add_restored_entities_to_entity_sources branch from 4c09d0e to cfb4161 Compare June 11, 2025 16:41
@emontnemery emontnemery marked this pull request as draft June 11, 2025 16:42
@emontnemery
Copy link
Contributor Author

emontnemery commented Jun 12, 2025

A new test which ensures we clear entity sources when removing an entity which is not in the entity registry, but dont clear it for an entity which is in the entity registry is needed.

This is now covered by the test tests/helpers/test_entity.py::test_setup_source

@emontnemery emontnemery marked this pull request as ready for review June 14, 2025 07:09
@@ -1423,6 +1423,10 @@ async def __async_remove_impl(self, force_remove: bool) -> None:
# Set the entity's state will to unavailable + ATTR_RESTORED: True
self.registry_entry.write_unavailable_state(self.hass)
else:
# The check for self.platform guards against integrations not using an
# EntityComponent and can be removed in HA Core 2024.1
Copy link
Member

Choose a reason for hiding this comment

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

according to the comment, the check can be removed now.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, maybe, but not in this PR.

if entry.config_entry_id:
entity_info["config_entry"] = entry.config_entry_id

entity_sources[entry.entity_id] = entity_info
Copy link
Member

Choose a reason for hiding this comment

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

since entity.async_internal_added_to_hass already adds the entity to entity_sources why is this needed here too?
assuming it is, couldn't we somehow move it to the Entity class, and avoid a circular dependency?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This function (_write_unavailable_states) is called to create unavailable states for all entities known to the entity registry. There are no backing entity objects.

The point of this PR is to ensure we create entries in entity_sources for these unavailable states.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks. I missed that it does not create Entity objects.

So, it would still be cool to avoid a circular dependency here. Could we move entity_sources up (to core.py for maybe)? Or move it to entity_registry.py, but that doesn't seem right.

Alternatively, could entity_sources be stored in hass.data?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is stored in hass.data; homeassistant.helpers.entity.entity_sources returns hass.data["entity_info]"

@frenck frenck marked this pull request as draft June 30, 2025 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants