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-27 11:16:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Store is now a Generic class (#1386)

Browse Source 
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
This commit is contained in:
epenet 2022-07-09 22:33:32 +02:00 committed by GitHub
parent 9bd92fa1af
commit 69d51c67cf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
blog/2022-07-08-generic-store.md Normal file
View File

@ -0,0 +1,13 @@
---
author: epenet
authorURL: https://github.com/epenet
title: "Store is now a Generic class"
---
As of Home Assistant Core 2022.8, a Store (from `homeassistant/helpers/storage.py`) is defined as a Generic `Store(Generic[_T])`. It is recommended that the type of data being stored be defined in the Store definition. It should be JSON-serialisable (dict or list), for example:
- Standard definition using a dict: `self._store = Store[dict[str, int]](hass, STORAGE_VERSION, STORAGE_KEY)`
- Using a TypedDict: `self._store = Store[EnergyPreferences](hass, STORAGE_VERSION, STORAGE_KEY)`
- Accessing an existing Store: `store: Store[dict[str, Any]] = hass.data[DOMAIN][DATA_STORE]`
- Inherited Store: `class MyCustomStorage(Store[list[int]]):`
For more information about generics, see [PEP 483](https://peps.python.org/pep-0483/#generic-types)