Skip to content

Always include platform in config/entity_registry/list_for_display #88601

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.

Sign up for GitHub

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

Merged
bramkragten merged 1 commit into from
Feb 22, 2023
Merged

Always include platform in config/entity_registry/list_for_display #88601

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 1 addition & 7 deletions homeassistant/helpers/entity_registry.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,12 +173,10 @@ def _as_display_dict(self) -> dict[str, Any] | None:
This version only includes what's needed for display.
Returns None if there's no data needed for display.
"""
display_dict: dict[str, Any] = {}
display_dict: dict[str, Any] = {"ei": self.entity_id, "pl": self.platform}
for key, attr_name in DISLAY_DICT_OPTIONAL:
if (attr_val := getattr(self, attr_name)) is not None:
display_dict[key] = attr_val
if "tk" in display_dict:
display_dict["pl"] = self.platform
if (category := self.entity_category) is not None:
display_dict["ec"] = ENTITY_CATEGORY_VALUE_TO_INDEX[category]
if self.hidden_by is not None:
Expand All @@ -192,10 +190,6 @@ def _as_display_dict(self) -> dict[str, Any] | None:
precision := sensor_options.get("suggested_display_precision")
) is not None:
display_dict["dp"] = precision
if not display_dict:
# We didn't gather any data needed for display
return None
display_dict["ei"] = self.entity_id
return display_dict

@property
Expand Down
10 changes: 10 additions & 0 deletions tests/components/config/test_entity_registry.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,23 +239,32 @@ async def test_list_entities_for_display(
"di": "device123",
"ei": "test_domain.nameless",
"en": None,
"pl": "test_platform",
},
{
"ai": "area52",
"di": "device123",
"ei": "test_domain.renamed",
"pl": "test_platform",
},
{
"ei": "test_domain.boring",
"pl": "test_platform",
},
{
"ei": "test_domain.hidden",
"hb": True,
"pl": "test_platform",
},
{
"dp": 0,
"ei": "sensor.default_precision",
"pl": "test_platform",
},
{
"dp": 0,
"ei": "sensor.user_precision",
"pl": "test_platform",
},
],
}
Expand Down Expand Up @@ -296,6 +305,7 @@ class Unserializable:
"di": "device123",
"ei": "test_domain.test",
"en": "Hello World",
"pl": "test_platform",
},
],
}
Expand Down