Skip to content

Serialize complex ZCL attribute types for database persistence #1792

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

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

Serialize complex ZCL attribute types for database persistence #1792

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
081743d
Serialize non-basic types to `bytes` before saving to DB
TheJulianJES Mar 16, 2026
9aaf879
Add tests
TheJulianJES Mar 16, 2026
22a0983
Also deserialize objects after restart
TheJulianJES Mar 16, 2026
40ac143
Revert serialization guard in `_save_attribute_cache` for now
TheJulianJES Mar 16, 2026
75c00cc
Add test for serialization in `_save_attribute_cache`
TheJulianJES Mar 16, 2026
cea0a6b
Add test for deserialization only happening when needed
TheJulianJES Mar 16, 2026
8ec3b5b
TEST: Do not deserialize SQLite-compatible attr types
TheJulianJES Mar 16, 2026
357cff8
Revert "TEST: Do not deserialize SQLite-compatible attr types"
TheJulianJES Mar 16, 2026
6949152
Fix existing DB test to use ints for int attr def
TheJulianJES Mar 16, 2026
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
Prev Previous commit
Next Next commit
Also deserialize objects after restart
  • Loading branch information
@TheJulianJES
TheJulianJES committed Mar 16, 2026
commit 22a0983290d19ff30e436fa5c2d44c87d1dc6c6c
12 changes: 12 additions & 0 deletions tests/test_appdb.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1720,6 +1720,18 @@ class AttributeDefs(BaseAttributeDefs):
assert isinstance(row[0], bytes)
assert row[0] == test_value.serialize()

# Load the database again and verify the value is deserialized back
app2 = await make_app_with_db(db)
dev2 = app2.get_device(t.EUI64.convert("00:1f:ee:00:00:00:96:f5"))
ubisys2 = dev2.endpoints[232].in_clusters[0xFC00]

loaded_value = ubisys2.get_cached_value(
UbisysCluster.AttributeDefs.output_configurations
)
assert list(loaded_value) == list(test_value)

await app2.shutdown()


def test_save_attribute_cache_skips_unserializable() -> None:
"""Test that _serialize_for_db raises ValueError for unserializable types,
Expand Down
26 changes: 25 additions & 1 deletion zigpy/appdb.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,30 @@ def _serialize_for_db(value: Any) -> None | int | float | str | bytes:
)


def _deserialize_from_db(value: Any, attr_type: type | None) -> Any:
"""Attempt to deserialize a bytes value loaded from the database back into its
original ZCL type, if applicable.
"""
if (
not isinstance(value, bytes)
or attr_type is None
or not hasattr(attr_type, "deserialize")
or issubclass(attr_type, bytes)
):
return value

try:
result, _ = attr_type.deserialize(value) # type: ignore[attr-defined]
except (ValueError, KeyError):
LOGGER.debug(
"Failed to deserialize cached value for type %s, using raw bytes",
attr_type,
)
return value

return result


def decode_str_attribute(value: str | bytes) -> str:
if isinstance(value, str):
return value
Expand Down Expand Up @@ -880,7 +904,7 @@ async def _populate_attribute_cache(
if row.status == Status.SUCCESS:
cluster._attr_cache.set_value(
attr_def,
row.value,
_deserialize_from_db(row.value, attr_def.type),
last_updated=datetime.fromtimestamp(row.last_updated, UTC),
)
else:
Expand Down