stackholm.storages package#

class stackholm.storages.ContextVarStorage(context_var: ContextVar[State], *args: Any, **kwargs: Any)[source]#

Bases: OptimizedListStorage

Parameters
  • context_var (ContextVar[State]) –

  • args (Any) –

  • kwargs (Any) –

Return type

None

__init__(context_var: ContextVar[State], *args: Any, **kwargs: Any) None[source]#
Parameters
  • context_var (ContextVar[State]) –

  • args (Any) –

  • kwargs (Any) –

Return type

None

get_state() State[source]#
Return type

State

set_state(state: State) None[source]#
Parameters

state (State) –

Return type

None

class stackholm.storages.OptimizedListState[source]#

Bases: State

Return type

None

__init__() None[source]#
Return type

None

context_sequence: int#
contexts: List[stackholm.context.Context]#
checkpoint_sequences: Dict[str, int]#
checkpoint_indexes: Dict[str, List[int]]#
checkpoint_optimization_mapping: Dict[str, Dict[int, int]]#
push_context(context: Context) int[source]#
Parameters

context (Context) –

Return type

int

pop_context(index: int = - 1) Optional[Context][source]#
Parameters

index (int) –

Return type

Optional[Context]

get_last_context() Optional[Context][source]#
Return type

Optional[Context]

add_checkpoint(key: str, context_index: int) None[source]#
Parameters
  • key (str) –

  • context_index (int) –

Return type

None

remove_checkpoint(key: str, context_index: int) None[source]#
Parameters
  • key (str) –

  • context_index (int) –

Return type

None

get_nearest_checkpoint(key: str) Optional[Context][source]#
Parameters

key (str) –

Return type

Optional[Context]

class stackholm.storages.OptimizedListStorage(*args: Any, **kwargs: Any)[source]#

Bases: Storage

Parameters
  • args (Any) –

  • kwargs (Any) –

Return type

None

__init__(*args: Any, **kwargs: Any) None[source]#
Parameters
  • args (Any) –

  • kwargs (Any) –

Return type

None

get_state() State[source]#
Return type

State

set_state(state: State) None[source]#
Parameters

state (State) –

Return type

None

class stackholm.storages.ThreadLocal(*args: Any, **kwargs: Any)[source]#

Bases: _local

Parameters
  • args (Any) –

  • kwargs (Any) –

Return type

None

state: stackholm.state.State#
__init__(*args: Any, **kwargs: Any) None[source]#
Parameters
  • args (Any) –

  • kwargs (Any) –

Return type

None

class stackholm.storages.ThreadLocalStorage(*args: Any, local: Optional[ThreadLocal] = None, **kwargs: Any)[source]#

Bases: OptimizedListStorage

Parameters
Return type

None

__init__(*args: Any, local: Optional[ThreadLocal] = None, **kwargs: Any) None[source]#
Parameters
Return type

None

get_state() State[source]#
Return type

State

set_state(state: State) None[source]#
Parameters

state (State) –

Return type

None

class stackholm.storages.ASGIRefLocal(*args: Any, **kwargs: Any)[source]#

Bases: Local

Parameters
  • args (Any) –

  • kwargs (Any) –

Return type

None

state: stackholm.state.State#
__init__(*args: Any, **kwargs: Any) None[source]#
Parameters
  • args (Any) –

  • kwargs (Any) –

Return type

None

class stackholm.storages.ASGIRefLocalStorage(*args: Any, local: Optional[ASGIRefLocal] = None, thread_critical: bool = False, **kwargs: Any)[source]#

Bases: OptimizedListStorage

Parameters
Return type

None

__init__(*args: Any, local: Optional[ASGIRefLocal] = None, thread_critical: bool = False, **kwargs: Any) None[source]#
Parameters
Return type

None

get_state() State[source]#
Return type

State

set_state(state: State) None[source]#
Parameters

state (State) –

Return type

None

Subpackages#