Skip to content

domain.enums.snapshot_source

src.domain.enums.snapshot_source

Snapshot source enumeration.

Defines the source/trigger of a balance snapshot capture.

Architecture
  • Domain layer enum (no infrastructure dependencies)
  • Used in BalanceSnapshot entity to track origin
  • Enables analytics by source type
Reference
  • docs/architecture/balance-tracking-architecture.md
Usage

from src.domain.enums import SnapshotSource

snapshot = BalanceSnapshot( source=SnapshotSource.MANUAL_SYNC, ... )

Classes

SnapshotSource

Bases: StrEnum

Source/trigger of a balance snapshot.

Tracks how/why a balance snapshot was captured. Enables filtering and analytics by capture method.

Values

ACCOUNT_SYNC: Captured during account data sync. HOLDINGS_SYNC: Captured during holdings sync operation. MANUAL_SYNC: User-initiated sync request. SCHEDULED_SYNC: Automated background sync job. INITIAL_CONNECTION: First sync after provider connection.

Example

snapshot.source == SnapshotSource.MANUAL_SYNC True

Source code in src/domain/enums/snapshot_source.py 
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
class SnapshotSource(StrEnum):
    """Source/trigger of a balance snapshot.

    Tracks how/why a balance snapshot was captured.
    Enables filtering and analytics by capture method.

    Values:
        ACCOUNT_SYNC: Captured during account data sync.
        HOLDINGS_SYNC: Captured during holdings sync operation.
        MANUAL_SYNC: User-initiated sync request.
        SCHEDULED_SYNC: Automated background sync job.
        INITIAL_CONNECTION: First sync after provider connection.

    Example:
        >>> snapshot.source == SnapshotSource.MANUAL_SYNC
        True
    """

    ACCOUNT_SYNC = "account_sync"
    """Captured during account data sync."""

    HOLDINGS_SYNC = "holdings_sync"
    """Captured during holdings sync operation."""

    MANUAL_SYNC = "manual_sync"
    """User-initiated sync request."""

    SCHEDULED_SYNC = "scheduled_sync"
    """Automated background sync job."""

    INITIAL_CONNECTION = "initial_connection"
    """First sync after provider connection."""

    # -------------------------------------------------------------------------
    # Query Methods
    # -------------------------------------------------------------------------

    def is_automated(self) -> bool:
        """Check if snapshot was captured automatically.

        Returns:
            True if source is automated (scheduled or sync operations).
        """
        return self in {
            SnapshotSource.ACCOUNT_SYNC,
            SnapshotSource.HOLDINGS_SYNC,
            SnapshotSource.SCHEDULED_SYNC,
        }

    def is_user_initiated(self) -> bool:
        """Check if snapshot was triggered by user action.

        Returns:
            True if source is user-initiated.
        """
        return self in {
            SnapshotSource.MANUAL_SYNC,
            SnapshotSource.INITIAL_CONNECTION,
        }
Attributes
ACCOUNT_SYNC class-attribute instance-attribute 
ACCOUNT_SYNC = 'account_sync'

Captured during account data sync.

HOLDINGS_SYNC class-attribute instance-attribute 
HOLDINGS_SYNC = 'holdings_sync'

Captured during holdings sync operation.

MANUAL_SYNC class-attribute instance-attribute 
MANUAL_SYNC = 'manual_sync'

User-initiated sync request.

SCHEDULED_SYNC class-attribute instance-attribute 
SCHEDULED_SYNC = 'scheduled_sync'

Automated background sync job.

INITIAL_CONNECTION class-attribute instance-attribute 
INITIAL_CONNECTION = 'initial_connection'

First sync after provider connection.

Functions
is_automated 
is_automated() -> bool

Check if snapshot was captured automatically.

Returns:

Type Description
bool

True if source is automated (scheduled or sync operations).
Source code in src/domain/enums/snapshot_source.py 
62
63
64
65
66
67
68
69
70
71
72
def is_automated(self) -> bool:
    """Check if snapshot was captured automatically.

    Returns:
        True if source is automated (scheduled or sync operations).
    """
    return self in {
        SnapshotSource.ACCOUNT_SYNC,
        SnapshotSource.HOLDINGS_SYNC,
        SnapshotSource.SCHEDULED_SYNC,
    }
is_user_initiated 
is_user_initiated() -> bool

Check if snapshot was triggered by user action.

Returns:

Type Description
bool

True if source is user-initiated.
Source code in src/domain/enums/snapshot_source.py 
74
75
76
77
78
79
80
81
82
83
def is_user_initiated(self) -> bool:
    """Check if snapshot was triggered by user action.

    Returns:
        True if source is user-initiated.
    """
    return self in {
        SnapshotSource.MANUAL_SYNC,
        SnapshotSource.INITIAL_CONNECTION,
    }