freezable

Freezable objects (can be made read only).

FreezableMap

FreezableMap(*, read_only: bool, **kwargs: VT)

Bases: MutableMapping[str, VT]

A key-value map that can be made read only.

Parameters:

Name	Type	Description	Default
read_only	bool	Whether the mapping is initially in read-only mode (frozen).	required
kwargs	VT	All other keyword arguments are used to create the underlying map object.	{}

Source code in src/msl/io/freezable.py

def __init__(self, *, read_only: bool, **kwargs: VT) -> None:
    """A key-value map that can be made read only.

    Args:
        read_only: Whether the mapping is initially in read-only mode (frozen).
        kwargs: All other keyword arguments are used to create the underlying map object.
    """
    self._read_only: bool = bool(read_only)
    self._mapping: dict[str, VT] = dict(**kwargs)

read_only property writable

read_only: bool

bool — Whether the map is in read-only mode.

clear

clear() -> None

Maybe remove all items from the map, only if the map is not in read-only mode.

Source code in src/msl/io/freezable.py

def clear(self) -> None:
    """Maybe remove all items from the map, only if the map is not in read-only mode."""
    self._raise_if_read_only()
    self._mapping.clear()

items

items() -> ItemsView[str, VT]

ItemsView[str, VT] — Return a view of the map's items.

Source code in src/msl/io/freezable.py

def items(self) -> ItemsView[str, VT]:
    """[ItemsView][collections.abc.ItemsView][[str][], VT] — Return a view of the map's items."""
    return ItemsView(self)

keys

keys() -> KeysView[str]

KeysView[str] — Returns a view of the map's keys.

Source code in src/msl/io/freezable.py

def keys(self) -> KeysView[str]:
    """[KeysView][collections.abc.KeysView][[str][]] — Returns a view of the map's keys."""
    return KeysView(self)

values

values() -> ValuesView[VT]

ValuesView[VT] — Returns a view of the map's values.

Source code in src/msl/io/freezable.py

def values(self) -> ValuesView[VT]:
    """[ValuesView][collections.abc.ValuesView][VT] — Returns a view of the map's values."""
    return ValuesView(self)