Class Stash

src/_pytest/stash.py:29–116

r"""``Stash`` is a type-safe heterogeneous mutable mapping that allows keys and value types to be defined separately from where it (the ``Stash``) is created. Usually you will be given an object which has a ``Stash``, for example :class:`~pytest.Config` or a :class:`~_pytest.nodes.N

class Stash:
    rclass="st">"""``Stash`` is a type-safe heterogeneous mutable mapping that
    allows keys and value types to be defined separately from
    where it (the ``Stash``) is created.

    Usually you will be given an object which has a ``Stash``, for example
    :class:`~pytest.Config` or a :class:`~_pytest.nodes.Node`:

    .. code-block:: python

        stash: Stash = some_object.stash

    If a module or plugin wants to store data in this ``Stash``, it creates
    :class:`StashKey`\s for its keys (at the module level):

    .. code-block:: python

        class="cm"># At the top-level of the module
        some_str_key = StashKey[str]()
        some_bool_key = StashKey[bool]()

    To store information:

    .. code-block:: python

        class="cm"># Value type must match the key.
        stash[some_str_key] = class="st">"value"
        stash[some_bool_key] = True

    To retrieve the information:

    .. code-block:: python

        class="cm"># The static type of some_str is str.
        some_str = stash[some_str_key]
        class="cm"># The static type of some_bool is bool.
        some_bool = stash[some_bool_key]

    .. versionadded:: 7.0
    class="st">"""

    __slots__ = (class="st">"_storage",)

    def __init__(self) -> None:
        self._storage: dict[StashKey[Any], object] = {}

    def __setitem__(self, key: StashKey[T], value: T) -> None:
        class="st">""class="st">"Set a value for key."class="st">""
        self._storage[key] = value

    def __getitem__(self, key: StashKey[T]) -> T:
        class="st">"""Get the value for key.

        Raises ``KeyError`` if the key wasn&class="cm">#x27;t set before.
        class="st">"""
        return cast(T, self._storage[key])

    def get(self, key: StashKey[T], default: D) -> T | D: