sphinx.deprecation.DeprecatedDict

class documentation

class DeprecatedDict(Dict[str, Any]): (source)

View In Hierarchy

A deprecated dict which warns on each access.

Method __getitem__ Undocumented
Method __init__ Undocumented
Method __setitem__ Undocumented
Method get Undocumented
Method setdefault Undocumented
Method update Undocumented
Instance Variable message Undocumented
Instance Variable warning Undocumented
def __getitem__(self, key): (source)

Undocumented

Parameters
key:strUndocumented
Returns
AnyUndocumented
def __init__(self, data, message, warning): (source)

Undocumented

Parameters
data:dict[str, Any]Undocumented
message:strUndocumented
warning:type[Warning]Undocumented
def __setitem__(self, key, value): (source)

Undocumented

Parameters
key:strUndocumented
value:AnyUndocumented
def get(self, key, default=None): (source)

Undocumented

Parameters
key:strUndocumented
default:AnyUndocumented
Returns
AnyUndocumented
def setdefault(self, key, default=None): (source)

Undocumented

Parameters
key:strUndocumented
default:AnyUndocumented
Returns
AnyUndocumented
def update(self, other): (source)

Undocumented

Parameters
other:dict[str, Any]Undocumented
message = (source)

Undocumented

warning = (source)

Undocumented