Prefix area to entity ID

[arturpragacz]

Proposed change

Prefix area to entity ID.

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 Include area in entity ID during first-time generation #168899
• This PR is related to issue:
• Link to documentation pull request:
• Link to developer documentation pull request:
• Link to frontend pull request:

Checklist

• I understand the code I am submitting and can explain how it works.
• 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.
• Any generated code has been carefully reviewed for correctness and compliance with project standards.

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.
• For the updated dependencies a diff between library versions and ideally a link to the changelog/release notes is added to the PR description.

To help with the load of incoming pull requests:

• I have reviewed two other open pull requests in this repository.

[Copilot]

Pull request overview

This PR updates entity ID generation to optionally prefix an entity’s object ID with the associated area name (primarily based on device area during initial creation), and adds test coverage to ensure friendly names are unaffected by area assignment.

Changes:

• Extend entity ID generation to include an area prefix when an applicable area can be resolved.
• Add/adjust helper tests for entity ID regeneration scenarios involving device/entity areas.
• Refactor area_registry imports to avoid a new circular dependency after introducing area_registry usage in entity_registry.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File	Description
homeassistant/helpers/entity_registry.py	Adds area-aware name construction and threads area_id into entity ID generation paths.
homeassistant/helpers/area_registry.py	Moves entity_registry import into async_delete to break a circular import chain.
tests/helpers/test_entity_registry.py	Expands regeneration test matrix to cover device-area and entity-area interactions.
tests/helpers/test_entity.py	Adds coverage asserting friendly names do not include area.

[Copilot]

Copilot wasn't able to review this pull request because it exceeds the maximum number of lines (20,000). Try reducing the number of changed lines and requesting a review from Copilot again.

[Copilot]

Copilot wasn't able to review this pull request because it exceeds the maximum number of lines (20,000). Try reducing the number of changed lines and requesting a review from Copilot again.

[Copilot]

Copilot wasn't able to review this pull request because it exceeds the maximum number of lines (20,000). Try reducing the number of changed lines and requesting a review from Copilot again.

[emontnemery]

LGTM from an implementation / code quality perspective.

[emontnemery]

As discussed on Discord, we should add or update a test to show how entity ID generation is affected by the change.

[Copilot]

Copilot wasn't able to review this pull request because it exceeds the maximum number of lines (20,000). Try reducing the number of changed lines and requesting a review from Copilot again.

[thecode]

I hope you realize this is going to trigger again the frustration from users about this change.
I don't understand how it make sense to prefix an area to entity id when the area can be changed by the user.

[andreasbrett]

I hope you realize this is going to trigger again the frustration from users about this change. I don't understand how it make sense to prefix an area to entity id when the area can be changed by the user.

There will always be haters and lovers. I personally love this as I finally have order again and don't have to have to ceiling_light1, ceiling_light1, ceiling_light2 and so on just because I follow HAs naming convention of not including the area in the friendly name anymore. I really dig that in the UI any if my ceiling lights is just "ceiling light" and there's no other metadata mixed into the name just for the sake of differentiating them. I just don't like that this caused ugly entity IDs based on "what came first".

[raman325]

IMO this shouldn't have been merged until @thecode's concern was resolved, and I don't consider the comment in response a resolution

[arturpragacz]

This is not the right place to make any such comments, this PR implements a task from our official roadmap (which is linked in the PR description).

[raman325]

understood but you added many reviewers including @thecode, and the only reason I was notified is because Z-Wave is tagged here as well

[arturpragacz]

Reviewers were added automatically by GitHub, because of the necessary changes to all the integrations' snapshots.

Let's stop this conversation now, as people keep getting unneeded pings, as you've yourself noticed.