1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
"""Asynchronous Python client for SwitchBot."""
from __future__ import annotations
from dataclasses import asdict, is_dataclass
from typing import TYPE_CHECKING, Any
from syrupy.extensions import AmberSnapshotExtension
from syrupy.extensions.amber import AmberDataSerializer
if TYPE_CHECKING:
from syrupy.types import (
PropertyFilter,
PropertyMatcher,
PropertyPath,
SerializableData,
)
class SwitchBotSnapshotSerializer(AmberDataSerializer):
"""SwitchBot snapshot serializer for Syrupy.
Handles special cases for SwitchBot data structures.
"""
@classmethod
def _serialize( # pylint: disable=too-many-arguments
cls,
data: SerializableData,
*,
depth: int = 0,
exclude: PropertyFilter | None = None,
include: PropertyFilter | None = None,
matcher: PropertyMatcher | None = None,
path: PropertyPath = (),
visited: set[Any] | None = None,
) -> str:
"""Pre-process data before serializing.
This allows us to handle specific cases for
SwitchBot data structures.
"""
serializable_data = data
if is_dataclass(type(data)):
serializable_data = asdict(data)
return super()._serialize(
serializable_data,
depth=depth,
exclude=exclude,
include=include,
matcher=matcher,
path=path,
visited=visited,
)
class SwitchBotSnapshotExtension(AmberSnapshotExtension):
"""SwitchBot extension for Syrupy."""
VERSION = "1"
"""Current version of serialization format.
Need to be bumped when we change the SwitchBotSnapshotSerializer.
"""
serializer_class: type[AmberDataSerializer] = SwitchBotSnapshotSerializer
|
