Skip to content

record

django_spire.contrib.sync.database.record

SyncRecord dataclass

key instance-attribute

data instance-attribute

timestamps instance-attribute

received_at = field(default=0, compare=False) class-attribute instance-attribute

sync_field_last_modified property

__post_init__

Source code in django_spire/contrib/sync/database/record.py 
19
20
21
22
23
24
25
26
27
28
29
30
def __post_init__(self) -> None:
    if self.key == '':
        message = 'SyncRecord key must be a non-empty string'
        raise InvalidParameterError(message)

    if self.received_at < 0:
        message = (
            f'received_at must be non-negative, '
            f'got {self.received_at}'
        )

        raise InvalidParameterError(message)

from_dict classmethod

Source code in django_spire/contrib/sync/database/record.py 
 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
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
@classmethod
def from_dict(cls, key: str, data: dict[str, Any]) -> SyncRecord:
    if key == '':
        message = 'SyncRecord key must be a non-empty string'
        raise RecordFieldError(message)

    record_data = data.get('data', {})
    record_timestamps = data.get('timestamps', {})
    record_received_at = data.get('received_at', 0)

    if not isinstance(record_data, dict):
        message = (
            f"Record {key!r}: 'data' must be a dict, "
            f'got {type(record_data).__name__}'
        )

        raise RecordFieldError(message)

    if not isinstance(record_timestamps, dict):
        message = (
            f"Record {key!r}: 'timestamps' must be a "
            f'dict, got {type(record_timestamps).__name__}'
        )

        raise RecordFieldError(message)

    if (
        not isinstance(record_received_at, int)
        or isinstance(record_received_at, bool)
    ):
        message = (
            f"Record {key!r}: 'received_at' must be an int, "
            f'got {type(record_received_at).__name__}'
        )

        raise RecordFieldError(message)

    if record_received_at < 0:
        message = (
            f"Record {key!r}: 'received_at' must be "
            f'non-negative, got {record_received_at}'
        )

        raise RecordFieldError(message)

    for ts_key, ts_value in record_timestamps.items():
        if not isinstance(ts_key, str):
            message = (
                f'Record {key!r}: timestamp key '
                f'{ts_key!r} must be a string'
            )

            raise RecordFieldError(message)

        if not isinstance(ts_value, int) or isinstance(ts_value, bool):
            message = (
                f'Record {key!r}: timestamp for '
                f'{ts_key!r} must be an int, '
                f'got {type(ts_value).__name__}'
            )

            raise RecordFieldError(message)

        if ts_value < 0:
            message = (
                f'Record {key!r}: timestamp for '
                f'{ts_key!r} must be non-negative, '
                f'got {ts_value}'
            )

            raise RecordFieldError(message)

    return cls(
        key=key,
        data=record_data,
        timestamps=record_timestamps,
        received_at=record_received_at,
    )

to_dict

Source code in django_spire/contrib/sync/database/record.py 
121
122
123
124
125
def to_dict(self) -> dict[str, Any]:
    return {
        'data': self.data,
        'timestamps': self.timestamps,
    }