stackholm package#
- class stackholm.Context[source]#
Bases:
ContextDecorator
- Return type
None
- classmethod get_checkpoint_value(key: str) Optional[VALUE_T] [source]#
- classmethod get_checkpoint_value(key: str, default: VALUE_T) Union[VALUE_T, T]
- classmethod pop_checkpoint_value(key: str) Optional[VALUE_T] [source]#
- classmethod pop_checkpoint_value(key: str, default: VALUE_T) Union[VALUE_T, T]
- get_block_value(key: str) Optional[VALUE_T] [source]#
- get_block_value(key: str, default: VALUE_T) Union[VALUE_T, T]
- exception stackholm.NoContextIsActive(message: str = 'No context is active.')[source]#
Bases:
Exception
- Parameters
message (str) –
- Return type
None
- exception stackholm.ContextIsNotActive(context: Context, message: str = 'Context is not active.')[source]#
Bases:
Exception
- class stackholm.State[source]#
Bases:
object
- class stackholm.Storage[source]#
Bases:
object
- create_context_class(name: Optional[str] = None, bases: Optional[Tuple[Type, ...]] = None, namespace: Optional[Dict[str, Any]] = None) Type[Context] [source]#
- create_context_class(name: Optional[str] = None, base: Type[CONTEXT_T_co] = None, bases: Optional[Tuple[Type, ...]] = None, namespace: Optional[Dict[str, Any]] = None) Type[CONTEXT_T_co]
- property state: stackholm.state.State#
- class stackholm.ContextVarStorage(context_var: ContextVar[State], *args: Any, **kwargs: Any)[source]#
Bases:
OptimizedListStorage
- class stackholm.OptimizedListState[source]#
Bases:
State
- Return type
None
- contexts: List[stackholm.context.Context]#
- class stackholm.OptimizedListStorage(*args: Any, **kwargs: Any)[source]#
Bases:
Storage
- class stackholm.ThreadLocal(*args: Any, **kwargs: Any)[source]#
Bases:
_local
- state: stackholm.state.State#
- class stackholm.ThreadLocalStorage(*args: Any, local: Optional[ThreadLocal] = None, **kwargs: Any)[source]#
Bases:
OptimizedListStorage
- Parameters
args (Any) –
local (Optional[ThreadLocal]) –
kwargs (Any) –
- Return type
None
- class stackholm.ASGIRefLocal(*args: Any, **kwargs: Any)[source]#
Bases:
Local
- state: stackholm.state.State#
- class stackholm.ASGIRefLocalStorage(*args: Any, local: Optional[ASGIRefLocal] = None, thread_critical: bool = False, **kwargs: Any)[source]#
Bases:
OptimizedListStorage
- Parameters
args (Any) –
local (Optional[ASGIRefLocal]) –
thread_critical (bool) –
kwargs (Any) –
- Return type
None
Subpackages#
Submodules#
stackholm.context module#
- class stackholm.context.Context[source]#
Bases:
ContextDecorator
- Return type
None
- classmethod get_checkpoint_value(key: str) Optional[VALUE_T] [source]#
- classmethod get_checkpoint_value(key: str, default: VALUE_T) Union[VALUE_T, T]
- classmethod pop_checkpoint_value(key: str) Optional[VALUE_T] [source]#
- classmethod pop_checkpoint_value(key: str, default: VALUE_T) Union[VALUE_T, T]
- get_block_value(key: str) Optional[VALUE_T] [source]#
- get_block_value(key: str, default: VALUE_T) Union[VALUE_T, T]
stackholm.exceptions module#
stackholm.state module#
- class stackholm.state.State[source]#
Bases:
object
stackholm.storage module#
- class stackholm.storage.Storage[source]#
Bases:
object
- create_context_class(name: Optional[str] = None, bases: Optional[Tuple[Type, ...]] = None, namespace: Optional[Dict[str, Any]] = None) Type[Context] [source]#
- create_context_class(name: Optional[str] = None, base: Type[CONTEXT_T_co] = None, bases: Optional[Tuple[Type, ...]] = None, namespace: Optional[Dict[str, Any]] = None) Type[CONTEXT_T_co]
- property state: stackholm.state.State#