jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-19 07:16:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add blog post about changes in entity descriptions (#2007)

Browse Source 
Co-authored-by: J. Nick Koston <nick@koston.org>
Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Erik Montnemery 2023-12-11 20:01:31 +01:00 committed by GitHub
parent c45ef246b2
commit 5d1eeabad2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
blog/2023-12-11-entity-description-changes.md Normal file
View File

@ -0,0 +1,16 @@
---
author: Erik Montnémery
authorURL: https://github.com/emontnemery
title: "Changes to EntityDescription data classes"
---
The `EntityDescription` classes have changed; derived `dataclasses` should now set `frozen=True` and `kw_only=True`.
Setting `frozen` to `True` makes the `EntityDescription` instances immutable, which means they cannot be accidentally updated after creation.
Setting `kw_only` to `True` ensures the order of fields can be changed in the base class without breaking users.
During a deprecation period, which will end with HA Core 2025.1, it will still be possible to derive `dataclasses` not setting `frozen=True` or `kw_only=True`, but this will be logged, and the user will be asked to create an issue with the custom integration.
Once HA Core 2025.1 is released, it will no longer be possible to derive `dataclasses` without setting `frozen=True` or `kw_only=True`.
More details can be found in the [core PR #105211](https://github.com/home-assistant/core/pull/105211).