콘텐츠로 이동

spakky-data

Repository, Transaction 추상화 — 데이터 접근 계층

Persistency

spakky.data.persistency.repository

EntityNotFoundError

Bases: AbstractSpakkyDomainError

Raised when an entity cannot be found by the given identifier.

VersionConflictError

Bases: AbstractSpakkyDomainError

Raised when optimistic locking detects a version conflict during save.

IGenericRepository

Bases: ABC, Generic[AggregateRootT, AggregateIdT_contra]

Synchronous generic repository interface for aggregate persistence.

get(aggregate_id) abstractmethod

Get an aggregate by ID.

Source code in core/spakky-data/src/spakky/data/persistency/repository.py 
28
29
30
31
@abstractmethod
def get(self, aggregate_id: AggregateIdT_contra) -> AggregateRootT:
    """Get an aggregate by ID."""
    ...

get_or_none(aggregate_id) abstractmethod

Get an aggregate by ID, or None if not found.

Source code in core/spakky-data/src/spakky/data/persistency/repository.py 
33
34
35
36
@abstractmethod
def get_or_none(self, aggregate_id: AggregateIdT_contra) -> AggregateRootT | None:
    """Get an aggregate by ID, or None if not found."""
    ...

contains(aggregate_id) abstractmethod

Check if an aggregate with the given ID exists.

Source code in core/spakky-data/src/spakky/data/persistency/repository.py 
38
39
40
41
@abstractmethod
def contains(self, aggregate_id: AggregateIdT_contra) -> bool:
    """Check if an aggregate with the given ID exists."""
    ...

range(aggregate_ids) abstractmethod

Get multiple aggregates by their IDs.

Source code in core/spakky-data/src/spakky/data/persistency/repository.py 
43
44
45
46
47
48
@abstractmethod
def range(
    self, aggregate_ids: Sequence[AggregateIdT_contra]
) -> Sequence[AggregateRootT]:
    """Get multiple aggregates by their IDs."""
    ...

save(aggregate) abstractmethod

Persist an aggregate and return the saved instance.

Source code in core/spakky-data/src/spakky/data/persistency/repository.py 
50
51
52
53
@abstractmethod
def save(self, aggregate: AggregateRootT) -> AggregateRootT:
    """Persist an aggregate and return the saved instance."""
    ...

save_all(aggregates) abstractmethod

Persist multiple aggregates and return the saved instances.

Source code in core/spakky-data/src/spakky/data/persistency/repository.py 
55
56
57
58
59
60
@abstractmethod
def save_all(
    self, aggregates: Sequence[AggregateRootT]
) -> Sequence[AggregateRootT]:
    """Persist multiple aggregates and return the saved instances."""
    ...

delete(aggregate) abstractmethod

Delete an aggregate and return the deleted instance.

Source code in core/spakky-data/src/spakky/data/persistency/repository.py 
62
63
64
65
@abstractmethod
def delete(self, aggregate: AggregateRootT) -> AggregateRootT:
    """Delete an aggregate and return the deleted instance."""
    ...

delete_all(aggregates) abstractmethod

Delete multiple aggregates and return the deleted instances.

Source code in core/spakky-data/src/spakky/data/persistency/repository.py 
67
68
69
70
71
72
@abstractmethod
def delete_all(
    self, aggregates: Sequence[AggregateRootT]
) -> Sequence[AggregateRootT]:
    """Delete multiple aggregates and return the deleted instances."""
    ...

IAsyncGenericRepository

Bases: ABC, Generic[AggregateRootT, AggregateIdT_contra]

Asynchronous generic repository interface for aggregate persistence.

get(aggregate_id) abstractmethod async

Get an aggregate by ID.

Source code in core/spakky-data/src/spakky/data/persistency/repository.py 
78
79
80
81
@abstractmethod
async def get(self, aggregate_id: AggregateIdT_contra) -> AggregateRootT:
    """Get an aggregate by ID."""
    ...

get_or_none(aggregate_id) abstractmethod async

Get an aggregate by ID, or None if not found.

Source code in core/spakky-data/src/spakky/data/persistency/repository.py 
83
84
85
86
87
88
@abstractmethod
async def get_or_none(
    self, aggregate_id: AggregateIdT_contra
) -> AggregateRootT | None:
    """Get an aggregate by ID, or None if not found."""
    ...

contains(aggregate_id) abstractmethod async

Check if an aggregate with the given ID exists.

Source code in core/spakky-data/src/spakky/data/persistency/repository.py 
90
91
92
93
@abstractmethod
async def contains(self, aggregate_id: AggregateIdT_contra) -> bool:
    """Check if an aggregate with the given ID exists."""
    ...

range(aggregate_ids) abstractmethod async

Get multiple aggregates by their IDs.

Source code in core/spakky-data/src/spakky/data/persistency/repository.py 
 95
 96
 97
 98
 99
100
@abstractmethod
async def range(
    self, aggregate_ids: Sequence[AggregateIdT_contra]
) -> Sequence[AggregateRootT]:
    """Get multiple aggregates by their IDs."""
    ...

save(aggregate) abstractmethod async

Persist an aggregate and return the saved instance.

Source code in core/spakky-data/src/spakky/data/persistency/repository.py 
102
103
104
105
@abstractmethod
async def save(self, aggregate: AggregateRootT) -> AggregateRootT:
    """Persist an aggregate and return the saved instance."""
    ...

save_all(aggregates) abstractmethod async

Persist multiple aggregates and return the saved instances.

Source code in core/spakky-data/src/spakky/data/persistency/repository.py 
107
108
109
110
111
112
@abstractmethod
async def save_all(
    self, aggregates: Sequence[AggregateRootT]
) -> Sequence[AggregateRootT]:
    """Persist multiple aggregates and return the saved instances."""
    ...

delete(aggregate) abstractmethod async

Delete an aggregate and return the deleted instance.

Source code in core/spakky-data/src/spakky/data/persistency/repository.py 
114
115
116
117
@abstractmethod
async def delete(self, aggregate: AggregateRootT) -> AggregateRootT:
    """Delete an aggregate and return the deleted instance."""
    ...

delete_all(aggregates) abstractmethod async

Delete multiple aggregates and return the deleted instances.

Source code in core/spakky-data/src/spakky/data/persistency/repository.py 
119
120
121
122
123
124
@abstractmethod
async def delete_all(
    self, aggregates: Sequence[AggregateRootT]
) -> Sequence[AggregateRootT]:
    """Delete multiple aggregates and return the deleted instances."""
    ...

options: show_root_heading: false

spakky.data.persistency.transaction

AbstractTransaction(autocommit=True)

Bases: IDisposable, ABC

Abstract base for synchronous transaction context managers.

Initialize the transaction.

Parameters:

Name Type Description Default
autocommit bool

Whether to auto-commit on successful exit.

 True
Source code in core/spakky-data/src/spakky/data/persistency/transaction.py 
13
14
15
16
17
18
19
def __init__(self, autocommit: bool = True) -> None:
    """Initialize the transaction.

    Args:
        autocommit: Whether to auto-commit on successful exit.
    """
    self.autocommit_enabled = autocommit

initialize() abstractmethod

Initialize the transaction (e.g. open a session).

Source code in core/spakky-data/src/spakky/data/persistency/transaction.py 
46
47
48
49
@abstractmethod
def initialize(self) -> None:
    """Initialize the transaction (e.g. open a session)."""
    ...

dispose() abstractmethod

Dispose the transaction resources (e.g. close a session).

Source code in core/spakky-data/src/spakky/data/persistency/transaction.py 
51
52
53
54
@abstractmethod
def dispose(self) -> None:
    """Dispose the transaction resources (e.g. close a session)."""
    ...

commit() abstractmethod

Commit the current transaction.

Source code in core/spakky-data/src/spakky/data/persistency/transaction.py 
56
57
58
59
@abstractmethod
def commit(self) -> None:
    """Commit the current transaction."""
    ...

rollback() abstractmethod

Roll back the current transaction.

Source code in core/spakky-data/src/spakky/data/persistency/transaction.py 
61
62
63
64
@abstractmethod
def rollback(self) -> None:
    """Roll back the current transaction."""
    ...

AbstractAsyncTransaction(autocommit=True)

Bases: IAsyncDisposable, ABC

Abstract base for asynchronous transaction context managers.

Initialize the async transaction.

Parameters:

Name Type Description Default
autocommit bool

Whether to auto-commit on successful exit.

 True
Source code in core/spakky-data/src/spakky/data/persistency/transaction.py 
72
73
74
75
76
77
78
def __init__(self, autocommit: bool = True) -> None:
    """Initialize the async transaction.

    Args:
        autocommit: Whether to auto-commit on successful exit.
    """
    self.autocommit_enabled = autocommit

initialize() abstractmethod async

Initialize the async transaction (e.g. open a session).

Source code in core/spakky-data/src/spakky/data/persistency/transaction.py 
105
106
107
108
@abstractmethod
async def initialize(self) -> None:
    """Initialize the async transaction (e.g. open a session)."""
    ...

dispose() abstractmethod async

Dispose the async transaction resources.

Source code in core/spakky-data/src/spakky/data/persistency/transaction.py 
110
111
112
113
@abstractmethod
async def dispose(self) -> None:
    """Dispose the async transaction resources."""
    ...

commit() abstractmethod async

Commit the current async transaction.

Source code in core/spakky-data/src/spakky/data/persistency/transaction.py 
115
116
117
118
@abstractmethod
async def commit(self) -> None:
    """Commit the current async transaction."""
    ...

rollback() abstractmethod async

Roll back the current async transaction.

Source code in core/spakky-data/src/spakky/data/persistency/transaction.py 
120
121
122
123
@abstractmethod
async def rollback(self) -> None:
    """Roll back the current async transaction."""
    ...

options: show_root_heading: false

spakky.data.persistency.error

AbstractSpakkyPersistencyError

Bases: AbstractSpakkyFrameworkError, ABC

Base error for persistency layer operations.

options: show_root_heading: false

External Proxy

spakky.data.external.proxy

ProxyModel

Bases: IEquatable, Generic[ProxyIdT_contra]

Immutable read-only projection model identified by an equatable ID.

__eq__(other)

Compare by ID equality.

Source code in core/spakky-data/src/spakky/data/external/proxy.py 
16
17
18
19
20
def __eq__(self, other: object) -> bool:
    """Compare by ID equality."""
    if not isinstance(other, type(self)):
        return False
    return self.id == other.id

__hash__()

Hash based on ID.

Source code in core/spakky-data/src/spakky/data/external/proxy.py 
22
23
24
def __hash__(self) -> int:
    """Hash based on ID."""
    return hash(self.id)

IGenericProxy

Bases: ABC, Generic[ProxyModelT_co, ProxyIdT_contra]

Synchronous read-only proxy interface for querying projections.

get(proxy_id) abstractmethod

Get a proxy model by ID.

Source code in core/spakky-data/src/spakky/data/external/proxy.py 
33
34
35
36
@abstractmethod
def get(self, proxy_id: ProxyIdT_contra) -> ProxyModelT_co:
    """Get a proxy model by ID."""
    ...

get_or_none(proxy_id) abstractmethod

Get a proxy model by ID, or None if not found.

Source code in core/spakky-data/src/spakky/data/external/proxy.py 
38
39
40
41
@abstractmethod
def get_or_none(self, proxy_id: ProxyIdT_contra) -> ProxyModelT_co | None:
    """Get a proxy model by ID, or None if not found."""
    ...

contains(proxy_id) abstractmethod

Check if a proxy model with the given ID exists.

Source code in core/spakky-data/src/spakky/data/external/proxy.py 
43
44
45
46
@abstractmethod
def contains(self, proxy_id: ProxyIdT_contra) -> bool:
    """Check if a proxy model with the given ID exists."""
    ...

range(proxy_ids) abstractmethod

Get multiple proxy models by their IDs.

Source code in core/spakky-data/src/spakky/data/external/proxy.py 
48
49
50
51
@abstractmethod
def range(self, proxy_ids: Sequence[ProxyIdT_contra]) -> Sequence[ProxyModelT_co]:
    """Get multiple proxy models by their IDs."""
    ...

IAsyncGenericProxy

Bases: ABC, Generic[ProxyModelT_co, ProxyIdT_contra]

Asynchronous read-only proxy interface for querying projections.

get(proxy_id) abstractmethod async

Get a proxy model by ID.

Source code in core/spakky-data/src/spakky/data/external/proxy.py 
57
58
59
60
@abstractmethod
async def get(self, proxy_id: ProxyIdT_contra) -> ProxyModelT_co:
    """Get a proxy model by ID."""
    ...

get_or_none(proxy_id) abstractmethod async

Get a proxy model by ID, or None if not found.

Source code in core/spakky-data/src/spakky/data/external/proxy.py 
62
63
64
65
@abstractmethod
async def get_or_none(self, proxy_id: ProxyIdT_contra) -> ProxyModelT_co | None:
    """Get a proxy model by ID, or None if not found."""
    ...

contains(proxy_id) abstractmethod async

Check if a proxy model with the given ID exists.

Source code in core/spakky-data/src/spakky/data/external/proxy.py 
67
68
69
70
@abstractmethod
async def contains(self, proxy_id: ProxyIdT_contra) -> bool:
    """Check if a proxy model with the given ID exists."""
    ...

range(proxy_ids) abstractmethod async

Get multiple proxy models by their IDs.

Source code in core/spakky-data/src/spakky/data/external/proxy.py 
72
73
74
75
76
77
@abstractmethod
async def range(
    self, proxy_ids: Sequence[ProxyIdT_contra]
) -> Sequence[ProxyModelT_co]:
    """Get multiple proxy models by their IDs."""
    ...

options: show_root_heading: false

spakky.data.external.error

AbstractSpakkyExternalError

Bases: AbstractSpakkyFrameworkError, ABC

Base error for external proxy operations.

options: show_root_heading: false

Aspects

spakky.data.aspects.transactional

Transactional() dataclass

Bases: FunctionAnnotation

Annotation for marking methods as transactional.

Methods decorated with @Transactional() will be executed within a transaction context, ensuring atomicity of operations.

AsyncTransactionalAspect(transaction)

Bases: IAsyncAspect

Aspect for managing transactions in async methods.

Intercepts async methods decorated with @Transactional and ensures that they are executed within a transaction context.

Source code in core/spakky-data/src/spakky/data/aspects/transactional.py 
54
55
def __init__(self, transaction: AbstractAsyncTransaction) -> None:
    self._transaction = transaction

TransactionalAspect(transaction)

Bases: IAspect

Aspect for managing transactions in sync methods.

Intercepts sync methods decorated with @Transactional and ensures that they are executed within a transaction context.

Source code in core/spakky-data/src/spakky/data/aspects/transactional.py 
76
77
def __init__(self, transaction: AbstractTransaction) -> None:
    self._transaction = transaction

transactional(func)

Decorator for marking methods as transactional.

Parameters:

Name Type Description Default
func Callable[P, R]

The function to decorate.

 required

Returns: The decorated function with transactional annotation.

Source code in core/spakky-data/src/spakky/data/aspects/transactional.py 
32
33
34
35
36
37
38
39
40
def transactional(func: Callable[P, R]) -> Callable[P, R]:
    """Decorator for marking methods as transactional.

    Args:
        func: The function to decorate.
    Returns:
        The decorated function with transactional annotation.
    """
    return Transactional()(func)

options: show_root_heading: false