Skip to content

mixin

django_spire.contrib.sync.django.mixin

SyncableMixin

Bases: Model

Source code in django_spire/contrib/sync/django/mixin.py 
52
53
54
55
56
def __init__(self, *args: Any, **kwargs: Any) -> None:
    super().__init__(*args, **kwargs)

    self._tracker = FieldUpdateTracker()
    self._tracker.snapshot(self._get_field_values())

id = models.UUIDField(primary_key=True, default=(uuid.uuid4), editable=False) class-attribute instance-attribute

sync_field_timestamps = models.JSONField(default=dict, editable=False) class-attribute instance-attribute

sync_field_last_modified = models.BigIntegerField(default=0, editable=False, db_index=True) class-attribute instance-attribute

objects = SyncableQuerySet.as_manager() class-attribute instance-attribute

Meta

abstract = True class-attribute instance-attribute

save

Source code in django_spire/contrib/sync/django/mixin.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
def save(self, *args: Any, **kwargs: Any) -> None:
    if not _is_bypassed():
        dirty = self.get_dirty_fields()

        if dirty:
            now = self.get_clock().now()
            timestamps = dict(self.sync_field_timestamps)

            for field_name in dirty:
                timestamps[field_name] = now

            self.sync_field_timestamps = timestamps
            self.sync_field_last_modified = now

    super().save(*args, **kwargs)
    self._tracker.snapshot(self._get_field_values())

get_dirty_fields

Source code in django_spire/contrib/sync/django/mixin.py 
82
83
84
85
86
def get_dirty_fields(self) -> set[str]:
    if self._state.adding:
        return set(self.get_syncable_field_names())

    return self._tracker.get_dirty(self._get_field_values())

refresh_from_db

Source code in django_spire/contrib/sync/django/mixin.py 
88
89
90
91
92
def refresh_from_db(
    self, *args: Any, **kwargs: Any,
) -> None:
    super().refresh_from_db(*args, **kwargs)
    self._tracker.snapshot(self._get_field_values())

configure classmethod

Source code in django_spire/contrib/sync/django/mixin.py 
94
95
96
@classmethod
def configure(cls, clock: HybridLogicalClock) -> None:
    cls._clock = clock

get_clock classmethod

Source code in django_spire/contrib/sync/django/mixin.py 
 98
 99
100
101
102
103
104
105
106
107
108
109
@classmethod
def get_clock(cls) -> HybridLogicalClock:
    if cls._clock is None:
        message = (
            'SyncableMixin clock not configured. '
            'Call SyncableMixin.configure(clock) '
            'in AppConfig.ready().'
        )

        raise ClockNotConfiguredError(message)

    return cls._clock

get_syncable_field_names classmethod

Source code in django_spire/contrib/sync/django/mixin.py 
111
112
113
114
115
116
117
@classmethod
def get_syncable_field_names(cls) -> list[str]:
    return sorted(
        field.name
        for field in cls._meta.concrete_fields
        if field.name not in cls._sync_exclude_fields
    )

get_syncable_m2m_names classmethod

Source code in django_spire/contrib/sync/django/mixin.py 
119
120
121
122
123
124
@classmethod
def get_syncable_m2m_names(cls) -> list[str]:
    return sorted(
        field.name
        for field in cls._meta.many_to_many
    )