class documentation

class CaseInsensitiveOrderedMultiDict(MutableMapping[K, V], Generic[K, V]):

Constructor: CaseInsensitiveOrderedMultiDict(default_factory)

View In Hierarchy

A case-insensitive ordered dictionary that can store multiple values per key.

This class maintains the order of insertions and allows multiple values for the same key. Keys are compared case-insensitively.

Class Method make Create a CaseInsensitiveOrderedMultiDict from an existing mapping.
Method __delitem__ Delete all values for a key.
Method __getitem__ Get the last value for a key.
Method __init__ Initialize a CaseInsensitiveOrderedMultiDict.
Method __iter__ Iterate over the dictionary's keys.
Method __len__ Return the number of unique keys in the dictionary.
Method __setitem__ Set a value for a key, appending to existing values.
Method get Get the last value for a key, or a default if not found.
Method get_all Get all values for a key in insertion order.
Method items Return a view of the dictionary's (key, value) pairs in insertion order.
Method keys Return a view of the dictionary's keys.
Method set Set a value for a key, replacing all existing values.
Method setdefault Get value for key, setting it to default if not present.
Method values Return a view of the dictionary's values.
Instance Variable _default_factory Undocumented
Instance Variable _keyed Undocumented
Instance Variable _real Undocumented
def make(cls, dict_in: MutableMapping[K, V] | CaseInsensitiveOrderedMultiDict[K, V] | None = None, default_factory: Callable[[], V] | None = None) -> CaseInsensitiveOrderedMultiDict[K, V]:

Create a CaseInsensitiveOrderedMultiDict from an existing mapping.

Parameters
dict_in:MutableMapping[K, V] | CaseInsensitiveOrderedMultiDict[K, V] | NoneOptional mapping to initialize from
default_factory:Callable[[], V] | NoneOptional factory function for default values
Returns
CaseInsensitiveOrderedMultiDict[K, V]New CaseInsensitiveOrderedMultiDict instance
Raises
TypeErrorIf dict_in is not a mapping or None
def __delitem__(self, key: K):

Delete all values for a key.

Raises
KeyErrorIf the key is not found
def __getitem__(self, item: K) -> V:

Get the last value for a key.

Raises
KeyErrorIf the key is not found
def __init__(self, default_factory: Callable[[], V] | None = None):

Initialize a CaseInsensitiveOrderedMultiDict.

Parameters
default_factory:Callable[[], V] | NoneOptional factory function for default values
def __iter__(self) -> Iterator[K]:

Iterate over the dictionary's keys.

def __len__(self) -> int:

Return the number of unique keys in the dictionary.

def __setitem__(self, key: K, value: V):

Set a value for a key, appending to existing values.

def get(self, key: K, /, default: V | _T | None = None) -> V | _T | None:

Get the last value for a key, or a default if not found.

Parameters
key:KThe key to look up
default:V | _T | NoneDefault value to return if key not found
Returns
V | _T | NoneThe value for the key, or default/default_factory result if not found
def get_all(self, key: K) -> Iterator[V]:

Get all values for a key in insertion order.

Parameters
key:KThe key to look up
Returns
Iterator[V]Iterator of all values for the key
def items(self) -> ItemsView[K, V]:

Return a view of the dictionary's (key, value) pairs in insertion order.

def keys(self) -> KeysView[K]:

Return a view of the dictionary's keys.

def set(self, key: K, value: V):

Set a value for a key, replacing all existing values.

Parameters
key:KThe key to set
value:VThe value to set
def setdefault(self, key: K, default: V | None = None) -> V:

Get value for key, setting it to default if not present.

Parameters
key:KThe key to look up
default:V | NoneDefault value to set if key not found
Returns
VThe existing value or the newly set default
Raises
KeyErrorIf key not found and no default or default_factory
def values(self) -> ValuesView[V]:

Return a view of the dictionary's values.

_default_factory =

Undocumented

_keyed: dict[ConfigKey, V] =

Undocumented

_real: list[tuple[K, V]] =

Undocumented