pydoctor.templatewriter.util.CaseInsensitiveDict

class documentation

class CaseInsensitiveDict(MutableMapping[str, _VT], Generic[_VT]): (source)

Constructor: CaseInsensitiveDict(data, **kwargs)

View In Hierarchy

A case-insensitive ``dict``-like object. Implements all methods and operations of ``collections.MutableMapping`` as well as dict's ``copy``. Also provides ``lower_items``. All keys are expected to be strings. The structure remembers the case of the last key to be set, and ``iter(instance)``, ``keys()``, ``items()``, ``iterkeys()``, and ``iteritems()`` will contain case-sensitive keys. However, querying and contains testing is case insensitive:

    cid = CaseInsensitiveDict()
    cid['Accept'] = 'application/json'
    cid['aCCEPT'] == 'application/json'  # True
    list(cid) == ['Accept']  # True

For example, ``headers['content-encoding']`` will return the value of a ``'Content-Encoding'`` response header, regardless of how the header name was originally stored. If the constructor, ``.update``, or equality comparison operations are given keys that have equal ``.lower()``s, the behavior is undefined.

Method __delitem__ Undocumented
Method __eq__ Undocumented
Method __getitem__ Undocumented
Method __init__ Undocumented
Method __iter__ Undocumented
Method __len__ Undocumented
Method __repr__ Undocumented
Method __setitem__ Undocumented
Method copy Undocumented
Method lower_items Like iteritems(), but with all lowercase keys.
Instance Variable _store Undocumented
def __delitem__(self, key: str): (source)

Undocumented

def __eq__(self, other: Any) -> bool: (source)

Undocumented

def __getitem__(self, key: str) -> _VT: (source)

Undocumented

def __init__(self, data: Mapping[str, _VT] | Iterable[tuple[str, _VT]] | None = None, **kwargs: Any): (source)

Undocumented

def __iter__(self) -> Iterator[str]: (source)

Undocumented

def __len__(self) -> int: (source)

Undocumented

def __repr__(self) -> str: (source)

Undocumented

def __setitem__(self, key: str, value: _VT): (source)

Undocumented

def copy(self) -> CaseInsensitiveDict[_VT]: (source)

Undocumented

def lower_items(self) -> Iterator[tuple[str, _VT]]: (source)

Like iteritems(), but with all lowercase keys.

_store: dict[str, tuple[str, _VT]] = (source)

Undocumented