Base Classes
About
FrozenBase
is the base class for frozendict
and FrozenOrderedDict
.
If you wish to construct your own frozen dictionary classes,
you may inherit from this class.
API Reference
Classes:
Abstract Mixin class for classes that wrap a dict object or similar. |
|
|
Abstract Base Class for Frozen dictionaries. |
|
Abstract Base Class for mutable dictionaries. |
Data:
Invariant |
|
Invariant |
|
Invariant |
|
Invariant |
-
class
DictWrapper
[source] -
Abstract Mixin class for classes that wrap a dict object or similar.
Methods:
__contains__
(key)Return
key in self
.__getitem__
(key)Return
self[key]
.__iter__
()Iterates over the dictionary’s keys.
__len__
()Returns the number of keys in the dictionary.
__repr__
()Return a string representation of the
DictWrapper
.copy
(*args, **kwargs)Return a copy of the dictionary.
get
(k[, default])Return the value for
k
ifk
is in the dictionary, elsedefault
.items
()Returns a set-like object providing a view on the dictionary’s items.
keys
()Returns a set-like object providing a view on the dictionary’s keys.
values
()Returns an object providing a view on the
bdict
's values.-
__repr__
()[source] Return a string representation of the
DictWrapper
.- Return type
-
items
()[source] Returns a set-like object providing a view on the dictionary’s items.
- Return type
AbstractSet
[Tuple
[~KT
,~VT
]]
-
-
class
FrozenBase
(*args, **kwargs)[source] Bases:
DictWrapper
[~KT
,~VT
]Abstract Base Class for Frozen dictionaries.
Used by
frozendict
andFrozenOrderedDict
.Custom subclasses must implement at a minimum
__init__
,copy
,fromkeys
.Methods:
fromkeys
(iterable[, value])Create a new dictionary with keys from iterable and values set to value.
-
classmethod
fromkeys
(iterable, value=None)[source] Create a new dictionary with keys from iterable and values set to value.
- Return type
FrozenBase
[~KT
,~VT
]- Overloads
fromkeys
(iterable ) ->FrozenBase
[~KT
,Any
]fromkeys
(iterable, value:~VT
) ->FrozenBase
[~KT
,~VT
]
-
classmethod
-
KT
= TypeVar(KT) Type:
TypeVar
Invariant
TypeVar
.typing.TypeVar
used for annotating key types in mappings.
-
class
MutableBase
(*args, **kwargs)[source] Bases:
DictWrapper
[~KT
,~VT
],MutableMapping
[~KT
,~VT
]Abstract Base Class for mutable dictionaries.
Used by
NonelessDict
andNonelessOrderedDict
.Custom subclasses must implement at a minimum
__init__
,copy
,fromkeys
.Methods:
__delitem__
(key)Delete
self[key]
.__setitem__
(key, value)Set
self[key]
tovalue
.fromkeys
(iterable[, value])Create a new dictionary with keys from iterable and values set to value.
-
VT
= TypeVar(VT) Type:
TypeVar
Invariant
TypeVar
.typing.TypeVar
used for annotating value types in mappings.
-
_D
= TypeVar(_D, bound=DictWrapper) Type:
TypeVar
Invariant
TypeVar
bound tocawdrey.base.DictWrapper
.